pentoo-overlay/net-vpn/udp2raw-tunnel/files/man/udp2raw.1
2019-05-11 22:41:18 +03:00

133 lines
4.3 KiB
Groff
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6.
.TH [2019-05-11 "1" "May 2019" "[2019-05-11 22:22:42][INFO]argc=2 ./udp2raw --version " "User Commands"
.SH NAME
[2019-05-11 \- manual page for [2019-05-11 22:22:42][INFO]argc=2 ./udp2raw --version 
.SH DESCRIPTION
udp2raw\-tunnel
git version:0137dba1fd build date:May 11 2019 22:20:49
repository: https://github.com/wangyu\-/udp2raw\-tunnel
.SS "usage:"
.TP
run as client : ./this_program \fB\-c\fR \fB\-l\fR local_listen_ip:local_port \fB\-r\fR server_address:server_port
[options]
.TP
run as server : ./this_program \fB\-s\fR \fB\-l\fR server_listen_ip:server_port \fB\-r\fR remote_address:remote_port
[options]
.SS "common options,these options must be same on both side:"
.TP
\fB\-\-raw\-mode\fR
<string> avaliable values:faketcp(default),udp,icmp
.TP
\fB\-k\fR,\-\-key
<string> password to gen symetric key,default:"secret key"
.TP
\fB\-\-cipher\-mode\fR
<string> avaliable values:aes128cfb,aes128cbc(default),xor,none
.TP
\fB\-\-auth\-mode\fR
<string> avaliable values:hmac_sha1,md5(default),crc32,simple,none
.TP
\fB\-a\fR,\-\-auto\-rule
auto add (and delete) iptables rule
.TP
\fB\-g\fR,\-\-gen\-rule
generate iptables rule then exit,so that you can copy and
add it manually.overrides \fB\-a\fR
.TP
\fB\-\-disable\-anti\-replay\fR
disable anti\-replay,not suggested
.SS "client options:"
.TP
\fB\-\-source\-ip\fR
<ip> force source\-ip for raw socket
.TP
\fB\-\-source\-port\fR
<port> force source\-port for raw socket,tcp/udp only
this option disables port changing while re\-connecting
.SS "other options:"
.TP
\fB\-\-conf\-file\fR
<string> read options from a configuration file instead of command line.
check example.conf in repo for format
.TP
\fB\-\-fifo\fR
<string> use a fifo(named pipe) for sending commands to the running program,
check readme.md in repository for supported commands.
.TP
\fB\-\-log\-level\fR
<number> 0:never 1:fatal 2:error 3:warn
4:info (default) 5:debug 6:trace
.TP
\fB\-\-log\-position\fR
enable file name,function name,line number in log
.TP
\fB\-\-disable\-color\fR
disable log color
.TP
\fB\-\-disable\-bpf\fR
disable the kernel space filter,most time its not necessary
unless you suspect there is a bug
.TP
\fB\-\-dev\fR
<string> bind raw socket to a device, not necessary but improves performance
.TP
\fB\-\-sock\-buf\fR
<number> buf size for socket,>=10 and <=10240,unit:kbyte,default:1024
.TP
\fB\-\-force\-sock\-buf\fR
bypass system limitation while setting sock\-buf
.TP
\fB\-\-seq\-mode\fR
<number> seq increase mode for faketcp:
0:static header,do not increase seq and ack_seq
1:increase seq for every packet,simply ack last seq
2:increase seq randomly, about every 3 packets,simply ack last seq
3:simulate an almost real seq/ack procedure(default)
4:similiar to 3,but do not consider TCP Option Window_Scale,
maybe useful when firewall doesnt support TCP Option
.TP
\fB\-\-lower\-level\fR
<string> send packets at OSI level 2, format:'if_name#dest_mac_adress'
ie:'eth0#00:23:45:67:89:b9'.or try '\-\-lower\-level auto' to obtain
the parameter automatically,specify it manually if 'auto' failed
.TP
\fB\-\-wait\-lock\fR
wait for xtables lock while invoking iptables, need iptables v1.4.20+
.TP
\fB\-\-gen\-add\fR
generate iptables rule and add it permanently,then exit.overrides \fB\-g\fR
.TP
\fB\-\-keep\-rule\fR
monitor iptables and auto re\-add if necessary.implys \fB\-a\fR
.TP
\fB\-\-hb\-len\fR
<number> length of heart\-beat packet, >=0 and <=1500
.TP
\fB\-\-mtu\-warn\fR
<number> mtu warning threshold, unit:byte, default:1375
.TP
\fB\-\-clear\fR
clear any iptables rules added by this program.overrides everything
.TP
\fB\-\-retry\-on\-error\fR
retry on error, allow to start udp2raw before network is initialized
.TP
\fB\-h\fR,\-\-help
print this help message
.PP

.PP
[2019\-05\-11 22:22:42][FATAL]invaild option \fB\-\-version\fR

.SH "SEE ALSO"
The full documentation for
.B [2019-05-11
is maintained as a Texinfo manual. If the
.B info
and
.B [2019-05-11
programs are properly installed at your site, the command
.IP
.B info [2019-05-11
.PP
should give you access to the complete manual.