status-im
/
miniupnp
mirror of https://github.com/status-im/miniupnp.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

miniupnpd/miniupnpd.8: update man page

This commit is contained in:
yangfl 2018-02-03 01:46:09 +08:00
parent 5ca7e99fde
commit 3158862058
1 changed files with 38 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
miniupnpd/miniupnpd.8
View File

@ -3,12 +3,12 @@
miniupnpd \- UPnP Internet Gateway Device Daemon
.SH SYNOPSIS
.B miniupnpd
[\-f file] [\-i interface] [\-o address]
[\-a address] [\-p port] [\-d] [\-L] [\-U]
[\-u uuid] [\-s serial] [\-m model_number]
[\-q queue]
[\-t interval] [\-P file]
[\-B down up] [\-w url]
.RB [ "\-f \fIconfig_file" "] [" "\-i \fIext_ifname" "] [" "\-o \fIext_ip" ]
.RB [ "\-a \fIlistening_ip" "] [" "\-p \fIport" "] [" \-d "] [" \-U "] [" \-S "] [" \-N ]
.RB [ "\-u \fIuuid" "] [" "\-s \fIserial" "] [" "\-m \fImodel_number" ]
.RB [ "\-t \fInotify_interval" "] [" "\-P \fIpid_filename" ]
.RB [ "\-B \fIdown up" "] [" "\-w \fIurl" "] [" "\-r \fIclean_ruleset_interval" ]
.RB [ "\-A \fIpermission rule" "] [" "\-b \fIBOOTID" ]
.SH DESCRIPTION
miniupnpd act as a UPnP Internet Gateway Device. It is designed
to run on the gateway between the internet and a NAT'ed LAN. It provides
@ -16,58 +16,71 @@ an interface, as defined in the UPnP standard, for enabling
clients on the LAN to ask for port redirections.
.SH OPTIONS
.TP
.B \-f file
.BI \-f " config_file"
load the config from file. default is /etc/miniupnpd.conf.
.TP
.B \-i interface
.BI \-i " ext_ifname"
interface used to connect to the internet.
.TP
.B \-o address
.BI \-o " ext_ip"
address used to connect to the internet.
default address of the interface will be used if not specified.
.TP
.B \-a address
.BI \-a " listening_ip"
address on the LAN. \-a option can by used multiple time if LAN is
subdivised in several subnetworks.
.TP
.B \-p port
.BI \-p " port"
port used for HTTP.
.TP
.B \-d
debug mode : do not go to background, output messages on console
and do not filter out low priority messages.
.TP
.B \-L
set packet log in pf on
.TP
.B \-q queue
set ALTQ queue in pf. filter rules must be enabled for this option
to have any effect.
.TP
.B \-U
report system uptime instead of daemon uptime to clients.
.TP
.B \-u uuid
.B \-S
sets "secure" mode : clients can only add mappings to their own ip
.TP
.B \-N
enables NAT-PMP functionality.
.TP
.BI \-u " uuid"
set the uuid of the UPnP Internet Gateway Device.
.TP
.B \-s serial
.BI \-s " serial"
serial number for the UPnP Internet Gateway Device.
.TP
.B \-m number
.BI \-m " model_number"
model number for the UPnP Internet Gateway Device.
.TP
.B \-t interval
.BI \-t " notify_interval"
SSDP notify interval in seconds :
SSDP announce messages will be broadcasted at this interval.
.TP
.B \-P file
.BI \-P " pid_filename"
pid file. default is /var/run/miniupnpd.pid
.TP
.B \-B down up
.BI \-B " down up"
download and upload bitrates reported to clients.
.TP
.B \-w url
.BI \-w " url"
presentation url. default is first address on LAN, port 80.
.TP
.BI \-r " clean_ruleset_interval"
(minimum) interval between unused rules cleaning checks.
.TP
.BI \-A " permission rule"
use following syntax for permission rules :
(allow|deny) (external port range) ip/mask (internal port range)
.br
examples :
"allow 1024-65535 192.168.1.0/24 1024-65535"
"deny 0-65535 0.0.0.0/0 0-65535"
.TP
.BI \-b " BOOTID"
sets the value of BOOTID.UPNP.ORG SSDP header
.SH "SEE ALSO"
minissdpd(1) miniupnpc(3)
.SH BUGS