/
kcptun-server.1
100 lines (100 loc) · 2.53 KB
/
kcptun-server.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
.TH KCPTUN "1" "May 2019" "kcptun version 20190515" "User Commands"
.SH NAME
kcptun \- manual page for kcptun version 20190515
.SH DESCRIPTION
.SS "NAME:"
.IP
kcptun \- server(with SMUX)
.SS "USAGE:"
.IP
kcptun\-server [global options] command [command options] [arguments...]
.SS "VERSION:"
.IP
20190515
.SS "COMMANDS:"
.TP
help, h
Shows a list of commands or help for one command
.SS "GLOBAL OPTIONS:"
.TP
\fB\-\-listen\fR value, \fB\-l\fR value
kcp server listen address (default: ":29900")
.TP
\fB\-\-target\fR value, \fB\-t\fR value
target server address (default: "127.0.0.1:12948")
.TP
\fB\-\-key\fR value
pre\-shared secret between client and server (default: "it's a secrect") [$KCPTUN_KEY]
.TP
\fB\-\-crypt\fR value
aes, aes\-128, aes\-192, salsa20, blowfish, twofish, cast5, 3des, tea, xtea, xor, sm4, none (default: "aes")
.TP
\fB\-\-mode\fR value
profiles: fast3, fast2, fast, normal, manual (default: "fast")
.TP
\fB\-\-mtu\fR value
set maximum transmission unit for UDP packets (default: 1350)
.TP
\fB\-\-sndwnd\fR value
set send window size(num of packets) (default: 1024)
.TP
\fB\-\-rcvwnd\fR value
set receive window size(num of packets) (default: 1024)
.TP
\fB\-\-datashard\fR value, \fB\-\-ds\fR value
set reed\-solomon erasure coding \- datashard (default: 10)
.TP
\fB\-\-parityshard\fR value, \fB\-\-ps\fR value
set reed\-solomon erasure coding \- parityshard (default: 3)
.TP
\fB\-\-dscp\fR value
set DSCP(6bit) (default: 0)
.TP
\fB\-\-nocomp\fR
disable compression
.TP
\fB\-\-sockbuf\fR value
per\-socket buffer in bytes (default: 4194304)
.TP
\fB\-\-smuxbuf\fR value
the overall de\-mux buffer in bytes (default: 4194304)
.TP
\fB\-\-keepalive\fR value
seconds between heartbeats (default: 10)
.TP
\fB\-\-snmplog\fR value
collect snmp to file, aware of timeformat in golang, like: ./snmp\-20060102.log
.TP
\fB\-\-snmpperiod\fR value
snmp collect period, in seconds (default: 60)
.TP
\fB\-\-pprof\fR
start profiling server on :6060
.TP
\fB\-\-log\fR value
specify a log file to output, default goes to stderr
.TP
\fB\-\-quiet\fR
to suppress the 'stream open/close' messages
.TP
\fB\-c\fR value
config from json file, which will override the command from shell
.TP
\fB\-\-help\fR, \fB\-h\fR
show help
.TP
\fB\-\-version\fR, \fB\-v\fR
print the version
.SH "SEE ALSO"
The full documentation for
.B kcptun
is maintained as a Texinfo manual. If the
.B info
and
.B kcptun
programs are properly installed at your site, the command
.IP
.B info kcptun
.PP
should give you access to the complete manual.