man: Fix authorship warnings
[people/ms/network.git] / man / network-zone-modem.txt
1 = network-zone-modem(8)
2
3 == NAME
4 network-zone-modem - Configure serial modems
5
6 == SYNOPSIS
7 [verse]
8 `network zone new ZONE modem ...`
9
10 == DESCRIPTION
11 The modem hook uses a serial interface to establish a PPP session to an Internet
12 Service Provider. This method is used by 56k modems and mobile networks like
13 LTE, GSM and 3G.
14
15 == OPTIONS
16 The following options are understood:
17
18 `--device=DEVICE`::
19         Sets the serial device that is used to connect. Example: /dev/ttyUSB0
20
21 `--monitor-device=DEVICE`::
22         The optional monitor device is used to collect status information like
23         signal strength and link quality while the connection is established.
24
25 `--imsi=IMSI`::
26         Set the IMSI of the SIM card inside the wireless modem to identify it when
27         it is plugged in at runtime.
28
29 `--pin=PIN`::
30         The PIN number of the SIM card.
31         This will be used to unlock the SIM card when it is locked.
32
33 `--apn=APN`::
34         Sets the Access Point Name (APN) that the modem connects to.
35
36 `--phone-number=PHONE-NUMBER`::
37         Sets the phone number that is dialled by the modem when the connection is
38         to be established.
39
40 `--username=USERNAME`::
41         Sets the username for authentication.
42
43 `--password=PASSWORD`::
44         Sets the password for authentication.
45         +
46         Use the `--auth=` option to transmit it in a secure manner to the provider.
47
48 `--baudrate=921600`::
49         The baudrate for the serial link to the modem.
50
51 `--mtu=N`::
52         Sets the default MTU of the PPP connection.
53
54 `--auth=[chap|pap]`::
55         Define the authentication method that is used to authenticate against your
56         provider. The default is to use the provider's preference.
57
58         * _Challange-Handshake Authentication Protocol_ (`chap`) is the preferred,
59         secure method.
60         * _Password Authentication Protocol_ (`pap`) sends the plaintext password
61         to the authentication server which is the reason why it should be avoided.
62
63 == AUTHORS
64 Michael Tremer
65
66 == SEE ALSO
67 link:network[8],
68 link:network-zone[8]