From: Michael Tremer Date: Wed, 16 Mar 2016 22:50:25 +0000 (+0000) Subject: docs: Add man page for modem zone hook X-Git-Tag: 008~15 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7a302fa7c52c7b6a4e31c5999e30b34510bb72cb;p=network.git docs: Add man page for modem zone hook Signed-off-by: Michael Tremer --- diff --git a/Makefile.am b/Makefile.am index 19f8e0c3..0a4db571 100644 --- a/Makefile.am +++ b/Makefile.am @@ -333,6 +333,7 @@ MANPAGES = \ man/network.8 \ man/network-device.8 \ man/network-dns-server.8 \ + man/network-port.8 \ man/network-port-batman-adv.8 \ man/network-port-batman-adv-port.8 \ man/network-quick-start.8 \ @@ -344,6 +345,7 @@ MANPAGES = \ man/network-zone-aiccu.8 \ man/network-zone-bridge.8 \ man/network-zone-config-pppoe-server.8 \ + man/network-zone-modem.8 \ man/network-zone-pppoe.8 MANPAGES_XML = $(patsubst %.8,%.xml,$(MANPAGES)) diff --git a/man/network-zone-modem.xml b/man/network-zone-modem.xml new file mode 100644 index 00000000..b3948bb9 --- /dev/null +++ b/man/network-zone-modem.xml @@ -0,0 +1,236 @@ + + + + + + network-zone-modem + network + + + + Developer + Michael + Tremer + michael.tremer@ipfire.org + + + + + + network-zone-modem + 8 + + + + network-zone-modem + Network Configuration Control Program + + + + + network zone new ZONE modem ... + + + + + Description + + + The modem hook uses a serial interface to establish a PPP session to an + Internet Service Provider. This method is used by 56k modems and mobile + networks like LTE, GSM and 3G. + + + + + Options + + + The following options are understood: + + + + + + + + + + + Sets the serial device that is used to connect. + + + Example: /dev/ttyUSB0 + + + + + + + + + + + + The optional monitor device is used to collect status + information like signal strength and link quality while + the connection is established. + + + + + + + + + + + + Set the IMSI of the SIM card inside the wireless modem + to identify it when it is plugged in at runtime. + + + + + + + + + + + + The PIN number of the SIM card. + + + This will be used to unlock the SIM card when it + is locked. + + + + + + + + + + + + Sets the Access Point Name (APN) + that the modem connects to. + + + + + + + + + + + + Sets the phone number that is dialed by the modem when + the connection is to be established. + + + + + + + + + + + + Sets the username for authentication. + + + + + + + + + + + + Sets the password for authentication. + + + Use the option to transmit it + in a secure manner to the provider. + + + + + + + + + + + + The baudrate for the serial link to the modem. + + + + + + + + + + + + Sets the default MTU of the PPP connection. + The default value is 1492. + + + + + + + + + + + + Define the authentication method that is used to + authenticate against your provider. + The default is to use the provider's preference. + + + + + Challange-Handshake Authentication Protocol + (chap) is the preferred secure method. + + + + + Password Authentication Protocol + (pap) sends the plaintext password to the authentication + server which is the reason why it should be avoided to use PAP. + + + + + + + + + + See Also + + + + network + 8 + , + + network-zone + 8 + + + +