mirror of
https://github.com/pentoo/pentoo-overlay
synced 2025-12-06 08:25:01 +01:00
109 lines
2.8 KiB
Groff
109 lines
2.8 KiB
Groff
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.10.
|
|
.TH KCPTUN "1" "September 2019" "kcptun version 20190905" "User Commands"
|
|
.SH NAME
|
|
kcptun \- manual page for kcptun version 20190905
|
|
.SH DESCRIPTION
|
|
.SS "NAME:"
|
|
.IP
|
|
kcptun \- client(with SMUX)
|
|
.SS "USAGE:"
|
|
.IP
|
|
kcptun\-client [global options] command [command options] [arguments...]
|
|
.SS "VERSION:"
|
|
.IP
|
|
20190905
|
|
.SS "COMMANDS:"
|
|
.TP
|
|
help, h
|
|
Shows a list of commands or help for one command
|
|
.SS "GLOBAL OPTIONS:"
|
|
.TP
|
|
\fB\-\-localaddr\fR value, \fB\-l\fR value
|
|
local listen address (default: ":12948")
|
|
.TP
|
|
\fB\-\-remoteaddr\fR value, \fB\-r\fR value
|
|
kcp server address (default: "vps:29900")
|
|
.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\-\-conn\fR value
|
|
set num of UDP connections to server (default: 1)
|
|
.TP
|
|
\fB\-\-autoexpire\fR value
|
|
set auto expiration time(in seconds) for a single UDP connection, 0 to disable (default: 0)
|
|
.TP
|
|
\fB\-\-scavengettl\fR value
|
|
set how long an expired connection can live(in sec), \fB\-1\fR to disable (default: 600)
|
|
.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: 128)
|
|
.TP
|
|
\fB\-\-rcvwnd\fR value
|
|
set receive window size(num of packets) (default: 512)
|
|
.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\-\-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\-\-tcp\fR
|
|
to emulate a TCP connection(linux)
|
|
.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.
|