Improve documentation.

This commit is contained in:
Sam Hocevar 2021-02-14 12:05:29 +01:00
parent bb0d64ed5d
commit 7f76652af9
3 changed files with 11 additions and 6 deletions

View File

@ -1,5 +1,6 @@
## Version 0.71 ## Version 0.71
* IPv6 support
* fix a display overflow in data usage statistics * fix a display overflow in data usage statistics
* made the configuration parser more tolerant with service names that contain * made the configuration parser more tolerant with service names that contain
dashes (e.g. snmp-trap) or hostnames with underscores (e.g. \_http.example.com). dashes (e.g. snmp-trap) or hostnames with underscores (e.g. \_http.example.com).

View File

@ -1,4 +1,4 @@
.TH rinetd 8 "2017-09-09" "rinetd 0.70" .TH rinetd 8 "2021-09-09" "rinetd 0.70"
.SH NAME .SH NAME
rinetd \- internet redirection server rinetd \- internet redirection server
@ -80,7 +80,7 @@ Service names can be specified instead of port numbers. On most systems,
service names are defined in the file \fI/etc/services\fR. service names are defined in the file \fI/etc/services\fR.
.PP .PP
Both IP addresses and hostnames are accepted for Both IP addresses and hostnames are accepted for
bindaddress and connectaddress. bindaddress and connectaddress, including IPv6.
.PP .PP
.SS UDP timeout option .SS UDP timeout option
@ -99,10 +99,10 @@ the UDP port for 3600 seconds.
A forwarding rule option allows to bind to a specific local address when A forwarding rule option allows to bind to a specific local address when
sending data to the other end. This is done using the \fIsrc\fR option: sending data to the other end. This is done using the \fIsrc\fR option:
.PP .PP
\fB 192.168.1.1 80 10.1.1.2 80 [src=192.168.1.2]\fR \fB 192.168.1.1 80 10.1.1.127 80 [src=10.1.1.2]\fR
.PP .PP
Assuming the local host has two IP addresses, 192.168.1.1 and 192.168.1.2, this Assuming the local host has two IP addresses, 10.1.1.1 and 10.1.1.2, this
rule ensures that forwarded packets are sent using source address 192.168.1.2. rule ensures that forwarded packets are sent using source address 10.1.1.2.
.SH ALLOW AND DENY RULES .SH ALLOW AND DENY RULES
Configuration files can also contain allow and deny rules. Configuration files can also contain allow and deny rules.
@ -216,7 +216,7 @@ The logging is inadequate. The duration of each connection should be logged.
.SH LICENSE .SH LICENSE
Copyright (c) 1997, 1998, 1999, Thomas Boutell and Boutell.Com, Inc. Copyright (c) 1997, 1998, 1999, Thomas Boutell and Boutell.Com, Inc.
.PP .PP
Copyright (c) 2003\-2017 Sam Hocevar Copyright (c) 2003\-2021 Sam Hocevar
.PP .PP
This software is released for free use under the terms of This software is released for free use under the terms of
the GNU General Public License, version 2 or higher. NO WARRANTY the GNU General Public License, version 2 or higher. NO WARRANTY

View File

@ -7,6 +7,8 @@
# #
# allow 192.168.2.* # allow 192.168.2.*
# deny 192.168.2.1? # deny 192.168.2.1?
# allow fe80:*
# deny 2001:618:*:e43f
# #
@ -17,6 +19,8 @@
# #
# bindadress bindport connectaddress connectport options... # bindadress bindport connectaddress connectport options...
# 0.0.0.0 80 192.168.1.2 80 # 0.0.0.0 80 192.168.1.2 80
# ::1 80 192.168.1.2 80
# 0.0.0.0 80 fe80::1 80
# 127.0.0.1 4000 127.0.0.1 3000 # 127.0.0.1 4000 127.0.0.1 3000
# 127.0.0.1 4000/udp 127.0.0.1 22 [timeout=1200] # 127.0.0.1 4000/udp 127.0.0.1 22 [timeout=1200]
# 127.0.0.1 8000/udp 192.168.1.2 8000/udp [src=192.168.1.2,timeout=1200] # 127.0.0.1 8000/udp 192.168.1.2 8000/udp [src=192.168.1.2,timeout=1200]