summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRobbie Smith <zoqaeski@gmail.com>2013-04-16 11:03:52 +0200
committerJouke Witteveen <j.witteveen@gmail.com>2013-04-16 11:03:52 +0200
commite3cc2987544e3f75a793eb3d5cc95d2c40309bda (patch)
tree4109ad1cdb0719cb9ccef7d20e823d562908270f
parent281f4aa59ef07c0f3de163d59d7df678c8830d20 (diff)
downloadnetctl-e3cc2987544e3f75a793eb3d5cc95d2c40309bda.tar.gz
netctl-e3cc2987544e3f75a793eb3d5cc95d2c40309bda.tar.xz
Updated man page to include pppoe and mobile_ppp
Removed unnecessary options from example connection.
-rw-r--r--docs/examples/mobile_ppp7
-rw-r--r--docs/netctl.profile.5.txt85
2 files changed, 83 insertions, 9 deletions
diff --git a/docs/examples/mobile_ppp b/docs/examples/mobile_ppp
index 4e5079f..f3b0b8a 100644
--- a/docs/examples/mobile_ppp
+++ b/docs/examples/mobile_ppp
@@ -1,7 +1,6 @@
Description='Example PPP mobile connection'
Interface=ttyUSB0
Connection=mobile_ppp
-IdleTimeout=30
# Debug pppd / chat output (separately from netctl)
#PPPDebug=true
@@ -11,12 +10,6 @@ IdleTimeout=30
# Use DNS provided by the peer (default: true)
#UsePeerDNS=true
-# Always keep a connection established
-ConnectionMode='persist'
-# Establish connection on demand
-#ConnectionMode='demand'
-#IdleTimeout=300
-
# The user and password are not always required
#User='example@yourprovider.com'
#Password='very secret'
diff --git a/docs/netctl.profile.5.txt b/docs/netctl.profile.5.txt
index e79c831..711c0db 100644
--- a/docs/netctl.profile.5.txt
+++ b/docs/netctl.profile.5.txt
@@ -42,6 +42,8 @@ AVAILABLE CONNECTION TYPES
available.
+pppoe+::
For PPPoE connections.
++mobile_ppp+::
+ For mobile broadband PPP connections that use a USB modem.
+tunnel+::
For tunnel interfaces.
+tuntap+::
@@ -281,8 +283,87 @@ connections of the `bridge' type:
Maximum age parameter. See *brctl*(8) for details.
+OPTIONS FOR `pppoe' CONNECTIONS
+-------------------------------
+The interface to dial peer-to-peer over ethernet is specified in
+'Interface'. The following options are understood for connections of
+the `pppoe' type:
+
+'User=' and 'Password='::
+ The username and password to connect with.
+
+'ConnectionMode='::
+ This option specifies how a connection should be established, and
+ may take either `persist' or `demand' as its argument.
+
+'IdleTimeout='::
+ This option specifies the idle time (in seconds) after which `pppd'
+ should disconnect. This option is only valid if 'ConnectionMode' is
+ set to `demand'.
+
+'DefaultRoute='::
+ Use the default route provided by the peer (defaults to
+ `true')
+
+'UsePeerDNS='::
+ Use the DNS provided by the peer (defaults to `true')
+
+'LCPEchoInterval=' and 'LCPEchoFailure='::
+ These options override default LCP parameters from
+ `/etc/ppp/options'.
+
+The following advanced options are also understood:
+
+'PPPoEService='::
+ This option specifies the PPPoE service name.
+
+'PPPoEAC='::
+ This option specifies the PPPoE access concentrator name.
+
+'PPPoESession='::
+ This option specifies an existing session to attach to, and is of
+ the form `sessid:macaddr'.
+
+'PPPoEMAC='::
+ Only connect to specified MAC address
+
+'PPPoEIP6='::
+ Enable IPv6 support
+
+
+OPTIONS FOR `mobile_ppp' CONNECTIONS
+------------------------------------
+The name of the USB serial device is specified in 'Interface'. The
+following options are understood for connections of the `mobile_ppp'
+type:
+
+'DefaultRoute='::
+ Use the default route provided by the peer (defaults to
+ `true')
+
+'UsePeerDNS='::
+ Use the DNS provided by the peer (defaults to `true')
+
+'User=' and 'Password='::
+ The username and password to connect with. These are unset by
+ default, as they are often not required.
+
+'AccessPointName='::
+ The access point (apn) to connect on. This is specific to your
+ ISP.
+
+'Pin='::
+ If your modem requires a PIN to unlock, use this option.
+
+'Mode='::
+ This option is used to specify the connection mode. Can be one of
+ `3Gpref', `3Gonly', `GPRSpref', `GPRSonly', `None'. This generates
+ AT commands specific to certain Huawei modems; all other devices
+ should use `None'.
+
+
OPTIONS FOR `tunnel' CONNECTIONS
-----------------------------------
+--------------------------------
The name of the tunnel interface is specified in 'Interface'. Next to
the *ip options*, the following are understood for connections of the
`tunnel' type:
@@ -298,7 +379,7 @@ the *ip options*, the following are understood for connections of the
OPTIONS FOR `tuntap' CONNECTIONS
-----------------------------------
+--------------------------------
The name of the tuntap interface is specified in 'Interface'. Next to
the *ip options*, the following are understood for connections of the
`tuntap' type: