From 23eec7d08e289749759927bcf4c2387cbfcbdce2 Mon Sep 17 00:00:00 2001 From: Michael Tremer Date: Sun, 31 Mar 2019 17:34:10 +0200 Subject: [PATCH] man: Convert network-zone-modem(8) to asciidoc Signed-off-by: Michael Tremer --- man/network-zone-modem.txt | 66 +++++++++++ man/network-zone-modem.xml | 235 ------------------------------------- 2 files changed, 66 insertions(+), 235 deletions(-) create mode 100644 man/network-zone-modem.txt delete mode 100644 man/network-zone-modem.xml diff --git a/man/network-zone-modem.txt b/man/network-zone-modem.txt new file mode 100644 index 00000000..6b096225 --- /dev/null +++ b/man/network-zone-modem.txt @@ -0,0 +1,66 @@ += network-zone-modem(8) +Michael Tremer + +== NAME +network-zone-modem - Configure serial modems + +== SYNOPSIS +[verse] +`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: + +`--device=DEVICE`:: + Sets the serial device that is used to connect. Example: /dev/ttyUSB0 + +`--monitor-device=DEVICE`:: + The optional monitor device is used to collect status information like + signal strength and link quality while the connection is established. + +`--imsi=IMSI`:: + Set the IMSI of the SIM card inside the wireless modem to identify it when + it is plugged in at runtime. + +`--pin=PIN`:: + The PIN number of the SIM card. + This will be used to unlock the SIM card when it is locked. + +`--apn=APN`:: + Sets the Access Point Name (APN) that the modem connects to. + +`--phone-number=PHONE-NUMBER`:: + Sets the phone number that is dialled by the modem when the connection is + to be established. + +`--username=USERNAME`:: + Sets the username for authentication. + +`--password=PASSWORD`:: + Sets the password for authentication. + + + Use the `--auth=` option to transmit it in a secure manner to the provider. + +`--baudrate=921600`:: + The baudrate for the serial link to the modem. + +`--mtu=N`:: + Sets the default MTU of the PPP connection. + +`--auth=[chap|pap]`:: + 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. + +== SEE ALSO +link:network[8], +link:network-zone[8] diff --git a/man/network-zone-modem.xml b/man/network-zone-modem.xml deleted file mode 100644 index 97a1d357..00000000 --- a/man/network-zone-modem.xml +++ /dev/null @@ -1,235 +0,0 @@ - - - - - - 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. - - - - - - - - - - - - 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 - - - - -- 2.39.2