man/network-zone-pppoe.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS/DTD DocBook XML V4.2//EN"
   3         "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <refentry id="network-zone-pppoe">
   6         <refentryinfo>
   7                 <title>network-zone-pppoe</title>
   8                 <productname>network</productname>
   9
  10                 <authorgroup>
  11                         <author>
  12                                 <contrib>Developer</contrib>
  13                                 <firstname>Michael</firstname>
  14                                 <surname>Tremer</surname>
  15                                 <email>michael.tremer@ipfire.org</email>
  16                         </author>
  17                 </authorgroup>
  18         </refentryinfo>
  19
  20         <refmeta>
  21                 <refentrytitle>network-zone-pppoe</refentrytitle>
  22                 <manvolnum>8</manvolnum>
  23         </refmeta>
  24
  25         <refnamediv>
  26                 <refname>network-zone-pppoe</refname>
  27                 <refpurpose>Network Configuration Control Program</refpurpose>
  28         </refnamediv>
  29
  30         <refsynopsisdiv>
  31                 <cmdsynopsis>
  32                         <command>network zone new <replaceable>ZONE</replaceable> pppoe ...</command>
  33                 </cmdsynopsis>
  34         </refsynopsisdiv>
  35
  36         <refsect1>
  37                 <title>Description</title>
  38
  39                 <para>
  40                         The pppoe hook creates a PPPoE connection to your ISP.
  41                 </para>
  42         </refsect1>
  43
  44         <refsect1>
  45                 <title>Options</title>
  46
  47                 <para>
  48                         The following options are understood:
  49                 </para>
  50
  51                 <variablelist>
  52                         <varlistentry>
  53                                 <term>
  54                                         <option>--port=<replaceable>PORT</replaceable></option>
  55                                 </term>
  56
  57                                 <listitem>
  58                                         <para>
  59                                                 This options sets the port, pppd is using to connect to
  60                                                 the modem.
  61                                         </para>
  62                                         <para>
  63                                                 This may be a normal ethernet or vlan interface.
  64                                         </para>
  65                                 </listitem>
  66                         </varlistentry>
  67
  68                         <varlistentry>
  69                                 <term>
  70                                         <option>--username=<replaceable>USERNAME</replaceable></option>
  71                                 </term>
  72
  73                                 <listitem>
  74                                         <para>
  75                                                 Sets the username for authentication.
  76                                         </para>
  77                                 </listitem>
  78                         </varlistentry>
  79
  80                         <varlistentry>
  81                                 <term>
  82                                         <option>--password=<replaceable>PASSWORD</replaceable></option>
  83                                 </term>
  84
  85                                 <listitem>
  86                                         <para>
  87                                                 Sets the password for authentication.
  88                                         </para>
  89                                         <para>
  90                                                 Use the <option>--auth=</option> option to transmit it
  91                                                 in a secure manner to the provider.
  92                                         </para>
  93                                 </listitem>
  94                         </varlistentry>
  95
  96                         <varlistentry>
  97                                 <term>
  98                                         <option>--mtu=<emphasis>1492</emphasis></option>
  99                                 </term>
 100
 101                                 <listitem>
 102                                         <para>
 103                                                 Sets the default MTU of the PPP connection.
 104                                                 The default value is 1492 which is a common MTU used
 105                                                 for DSL.
 106                                         </para>
 107                                 </listitem>
 108                         </varlistentry>
 109
 110                         <varlistentry>
 111                                 <term>
 112                                         <option>--auth=[chap|pap]</option>
 113                                 </term>
 114
 115                                 <listitem>
 116                                         <para>
 117                                                 Define the authentication method that is used to
 118                                                 authenticate against your provider.
 119                                                 The default is to use the provider's preference.
 120                                         </para>
 121                                         <itemizedlist>
 122                                                 <listitem>
 123                                                         <para>
 124                                                                 <emphasis>Challange-Handshake Authentication Protocol</emphasis>
 125                                                                 (chap) is the preferred secure method.
 126                                                         </para>
 127                                                 </listitem>
 128                                                 <listitem>
 129                                                         <para>
 130                                                                 <emphasis>Password Authentication Protocol</emphasis>
 131                                                                 (pap) sends the plaintext password to the authentication
 132                                                                 server which is the reason why it should be avoided to use PAP.
 133                                                         </para>
 134                                                 </listitem>
 135                                         </itemizedlist>
 136                                 </listitem>
 137                         </varlistentry>
 138
 139                         <varlistentry>
 140                                 <term>
 141                                         <option>--access-concentrator=<replaceable>STRING</replaceable></option>
 142                                 </term>
 143
 144                                 <listitem>
 145                                         <para>
 146                                                 By this option, you may define the name of the access concentrator.
 147                                         </para>
 148                                 </listitem>
 149                         </varlistentry>
 150
 151                         <varlistentry>
 152                                 <term>
 153                                         <option>--service-name=<replaceable>STRING</replaceable></option>
 154                                 </term>
 155
 156                                 <listitem>
 157                                         <para>
 158                                                 By this option, you may define the service name.
 159                                         </para>
 160                                 </listitem>
 161                         </varlistentry>
 162                 </variablelist>
 163         </refsect1>
 164
 165         <refsect1>
 166                 <title>See Also</title>
 167
 168                 <para>
 169                         <citerefentry>
 170                                 <refentrytitle>network</refentrytitle>
 171                                 <manvolnum>8</manvolnum>
 172                         </citerefentry>,
 173                         <citerefentry>
 174                                 <refentrytitle>network-zone</refentrytitle>
 175                                 <manvolnum>8</manvolnum>
 176                         </citerefentry>
 177                 </para>
 178         </refsect1>
 179 </refentry>