From owner-svn-doc-projects@FreeBSD.ORG Mon Apr 22 16:14:28 2013 Return-Path: Delivered-To: svn-doc-projects@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) by hub.freebsd.org (Postfix) with ESMTP id EDA608EF; Mon, 22 Apr 2013 16:14:28 +0000 (UTC) (envelope-from dru@FreeBSD.org) Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:1900:2254:2068::e6a:0]) by mx1.freebsd.org (Postfix) with ESMTP id DF3CC1445; Mon, 22 Apr 2013 16:14:28 +0000 (UTC) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.6/8.14.6) with ESMTP id r3MGESgS010236; Mon, 22 Apr 2013 16:14:28 GMT (envelope-from dru@svn.freebsd.org) Received: (from dru@localhost) by svn.freebsd.org (8.14.6/8.14.5/Submit) id r3MGESLI010235; Mon, 22 Apr 2013 16:14:28 GMT (envelope-from dru@svn.freebsd.org) Message-Id: <201304221614.r3MGESLI010235@svn.freebsd.org> From: Dru Lavigne Date: Mon, 22 Apr 2013 16:14:28 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-projects@freebsd.org Subject: svn commit: r41470 - projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/handbook/ppp-and-slip X-SVN-Group: doc-projects MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-projects@freebsd.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: SVN commit messages for doc projects trees List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 22 Apr 2013 16:14:29 -0000 Author: dru Date: Mon Apr 22 16:14:28 2013 New Revision: 41470 URL: http://svnweb.freebsd.org/changeset/doc/41470 Log: Initial patch which fixes the following: - &os; - missing PPP, PPPoE, PPPoA, and ISP acronym tags - small grammo fixes I happened to notice in the paragraphs affected by those tags (most of these paragraphs still need rewording) Subsequent patches will format ppp as a command more consistently and work on outstanding grammo, rewording, and formatting fixes. This chapter needs a lot of work. Approved by: bcr (mentor) Modified: projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/handbook/ppp-and-slip/chapter.xml Modified: projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/handbook/ppp-and-slip/chapter.xml ============================================================================== --- projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/handbook/ppp-and-slip/chapter.xml Mon Apr 22 14:43:01 2013 (r41469) +++ projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/handbook/ppp-and-slip/chapter.xml Mon Apr 22 16:14:28 2013 (r41470) @@ -29,25 +29,25 @@ SLIP - FreeBSD has a number of ways to link one computer to - another. To establish a network or Internet connection through - a dial-up modem, or to allow others to do so through you, - requires the use of PPP. This chapter describes setting - up these modem-based communication services in detail. + &os; has a number of ways to link one computer to another. + To establish a network or Internet connection through a dial-up + modem, or to allow others to do so through that modem, requires + the use of PPP. This chapter details how + to set up modem-based communication services. After reading this chapter, you will know: - How to set up user PPP. + How to configure PPP. - How to set up PPPoE (PPP over - Ethernet). + How to set up PPPoE + (PPP over Ethernet). - How to set up PPPoA (PPP over - ATM). + How to set up PPPoA + (PPP over ATM). @@ -55,10 +55,6 @@ PPP user PPP - - PPP - kernel PPP - PPP over Ethernet @@ -72,7 +68,7 @@ Understand the basics and purpose of a dialup connection - and PPP. + and PPP. @@ -110,10 +106,10 @@ - Using User PPP + Using <acronym>PPP</acronym> - User PPP + User <acronym>PPP</acronym> Assumptions @@ -128,18 +124,20 @@ PPP - An account with an Internet Service Provider (ISP) - which you connect to using PPP. + An account with an Internet Service Provider + (ISP) which you connect to using + PPP. - A modem or - other device connected to your system and properly - configured to allow you to connect to your ISP. + A modem or other device connected to the &os; system + and properly configured to connect to the + ISP. - The dial-up number(s) of your ISP. + The dial-up number(s) of the + ISP. @@ -170,26 +168,29 @@ The IP address of one or more name servers. Normally, you will be given two IP addresses by your - ISP to use for this. If they have not given you at - least one, then you can use the enable - dns command in ppp.conf - and ppp will set the name - servers for you. This feature depends on your ISPs - PPP implementation supporting DNS negotiation. + ISP. If they have not given you at + least one, use the enable dns command + in ppp.conf and + ppp will set the name + servers. This feature depends on the + ISP's PPP + implementation supporting DNS negotiation. - The following information may be supplied by your ISP, - but is not completely necessary: + The following information may be supplied by the + ISP, but is not completely + necessary: - The IP address of your ISP's gateway. The gateway - is the machine to which you will connect and will be - set up as your default route. If - you do not have this information, we can make one up - and your ISP's PPP server will tell us the correct value - when we connect. + The IP address of your ISP's + gateway. The gateway is the machine to which you will + connect and will be set up as your default + route. If you do not have this + information, we can make one up and your + ISP's PPP server + will tell us the correct value when we connect. This IP number is referred to as HISADDR by @@ -197,8 +198,9 @@ - The netmask you should use. If your ISP has not - provided you with one, you can safely use The netmask you should use. If the + ISP has not provided you with one, + you can safely use 255.255.255.255. @@ -207,15 +209,14 @@ static IP address - If your ISP provides you with a static IP address - and hostname, you can enter it. Otherwise, we simply - let the peer assign whatever IP address it sees - fit. + If the ISP provides a static IP + address and hostname, enter it. Otherwise, let the peer + assign whatever IP address it sees fit. If you do not have any of the required information, - contact your ISP. + contact your ISP. Throughout this section, many of the examples showing @@ -229,7 +230,7 @@ - Automatic <application>PPP</application> + <title>Automatic <acronym>PPP</acronym> Configuration @@ -245,13 +246,14 @@ Configuring ppp requires that you edit a number of files, depending on your requirements. What you put in them depends to some extent on whether your - ISP allocates IP addresses statically (i.e., you get given - one IP address, and always use that one) or dynamically - (i.e., your IP address changes each time you connect to - your ISP). + ISP allocates IP addresses statically + (i.e., you get given one IP address, and always use that + one) or dynamically (i.e., your IP address changes each time + you connect). - PPP and Static IP Addresses + <acronym>PPP</acronym> and Static IP + Addresses PPP @@ -318,12 +320,11 @@ Line 3: - Tells PPP how to identify itself to the peer. - PPP identifies itself to the peer if it has any - trouble negotiating and setting up the link, - providing information that the peers administrator - may find useful when investigating such - problems. + Tells PPP how to identify + itself to the peer if it has any trouble negotiating + and setting up the link. This information may be + useful to the peer's administrator when + investigating such problems. @@ -360,10 +361,10 @@ user PPP - The dial string. User PPP uses an expect-send - syntax similar to the &man.chat.8; program. Refer - to the manual page for information on the features - of this language. + The dial string. PPP uses an + expect-send syntax similar to the one used by + &man.chat.8;. Refer to &man.chat.8; for information + on the features of this language. Note that this command continues onto the next line for readability. Any command in @@ -387,9 +388,10 @@ Line 9: - Tells PPP to ask the peer to confirm the local - resolver settings. If you run a local name server, - this line should be commented out or removed. + Tells PPP to ask the peer to + confirm the local resolver settings. When running a + local name server, this line should be commented out + or removed. @@ -398,7 +400,7 @@ A blank line for readability. Blank lines are - ignored by PPP. + ignored by PPP. @@ -506,18 +508,17 @@ protocol: ppp replaced by the IP address that your provider has allocated to you. The string y.y.y.y should be - replaced by the IP address that your ISP indicated - for their gateway (the machine to which you - connect). If your ISP has not given you a gateway - address, use ISP's gateway. If the ISP has + not given you a gateway address, use 10.0.0.2/0. If you need to use a guessed address, make sure that you create an entry in /etc/ppp/ppp.linkup as per the instructions for PPP and Dynamic IP - addresses. If this line is omitted, - ppp cannot run in + linkend="userppp-dynamicIP">PPP + and Dynamic IP addresses. If this line is + omitted, ppp cannot run in mode. @@ -526,10 +527,11 @@ protocol: ppp Line 18: - Adds a default route to your ISP's gateway. The - special word HISADDR is replaced - with the gateway address specified on line 17. It - is important that this line appears after line 17, + Adds a default route to the + ISP's gateway. The special word + HISADDR is replaced with the + gateway address specified on line 17. It is + important that this line appears after line 17, otherwise HISADDR will not yet be initialized. @@ -555,7 +557,8 @@ protocol: ppp - PPP and Dynamic IP Addresses + <acronym>PPP</acronym> and Dynamic IP + Addresses PPP @@ -573,8 +576,9 @@ protocol: ppp ppp to set it up correctly using the IP Configuration Protocol (IPCP) after connecting. The ppp.conf configuration is the same as - PPP and Static IP - Addresses, with the following change: + PPP + and Static IP Addresses, with the following + change: 17 set ifaddr 10.0.0.1/0 10.0.0.2/0 255.255.255.255 0.0.0.0 @@ -594,14 +598,14 @@ protocol: ppp above example will always work. The last argument (0.0.0.0) - tells PPP to start negotiations using address - 0.0.0.0 rather than - 10.0.0.1 and is - necessary for some ISPs. Do not use - 0.0.0.0 as the first argument - to set ifaddr as it prevents - PPP from setting up an initial route in - mode. + tells PPP to start negotiations + using address 0.0.0.0 + rather than 10.0.0.1 + and is necessary for some ISPs. + Do not use 0.0.0.0 as the first + argument to set ifaddr as it + prevents PPP from setting up an + initial route in mode. @@ -680,7 +684,7 @@ protocol: ppp Which getty? - Configuring FreeBSD for + Configuring &os; for Dial-up Services provides a good description on enabling dial-up services using &man.getty.8;. @@ -698,8 +702,8 @@ protocol: ppp Later versions of mgetty (from 0.99beta onwards) also support the automatic detection of - PPP streams, allowing your clients script-less access to - your server. + PPP streams, allowing your clients + script-less access to your server. Refer to Mgetty and AutoPPP for more information on @@ -707,7 +711,7 @@ protocol: ppp - <application>PPP</application> Permissions + <acronym>PPP</acronym> Permissions The ppp command must normally be run as the root user. If however, @@ -730,7 +734,8 @@ protocol: ppp - PPP Shells for Dynamic-IP Users + <acronym>PPP</acronym> Shells for Dynamic-IP + Users PPP shells @@ -763,7 +768,7 @@ exec /usr/sbin/ppp -direct $IDENTYou should use this script as the shell for all of your dialup users. This is an example from /etc/passwd - for a dialup PPP user with username + for a dialup PPP user with username pchilds (remember do not directly edit the password file, use &man.vipw.8;). @@ -782,7 +787,8 @@ exec /usr/sbin/ppp -direct $IDENT - PPP Shells for Static-IP Users + <acronym>PPP</acronym> Shells for Static-IP + Users PPP shells @@ -894,10 +900,11 @@ mary: role="package">comms/mgetty+sendfax port comes with the AUTO_PPP option enabled allowing mgetty to detect the LCP - phase of PPP connections and automatically spawn off a - ppp shell. However, since the default login/password - sequence does not occur it is necessary to authenticate - users using either PAP or CHAP. + phase of PPP connections and + automatically spawn off a ppp shell. However, since the + default login/password sequence does not occur it is + necessary to authenticate users using either PAP or + CHAP. This section assumes the user has successfully compiled, and installed the This will tell mgetty to run the ppp-pap-dialup script for detected - PPP connections. + PPP connections. Create a file called /etc/ppp/ppp-pap-dialup containing @@ -964,18 +971,21 @@ exec /usr/sbin/ppp -direct pap$IDENTMicrosoft extensions - It is possible to configure PPP to supply DNS and - NetBIOS nameserver addresses on demand. - - To enable these extensions with PPP version 1.x, the - following lines might be added to the relevant section - of /etc/ppp/ppp.conf. + It is possible to configure PPP to + supply DNS and NetBIOS nameserver addresses on + demand. + + To enable these extensions with PPP + version 1.x, the following lines might be added to the + relevant section of + /etc/ppp/ppp.conf. enable msext set ns 203.14.100.1 203.14.100.2 set nbns 203.14.100.5 - And for PPP version 2 and above: + And for PPP version 2 and + above: accept dns set dns 203.14.100.1 203.14.100.2 @@ -986,8 +996,8 @@ set nbns 203.14.100.5 host. In version 2 and above, if the - set dns line is omitted, PPP will - use the values found in + set dns line is omitted, + PPP will use the values found in /etc/resolv.conf. @@ -996,12 +1006,13 @@ set nbns 203.14.100.5 PAP CHAP - Some ISPs set their system up so that the - authentication part of your connection is done using - either of the PAP or CHAP authentication mechanisms. If - this is the case, your ISP will not give a - login: prompt when you connect, but will - start talking PPP immediately. + Some ISPs set their system up so + that the authentication part of the connection is done + using either the PAP or CHAP authentication mechanism. If + this is the case, the ISP will not give + a login: prompt when you connect, but + will start talking PPP + immediately. PAP is less secure than CHAP, but security is not normally an issue here as passwords, although being sent @@ -1010,11 +1021,11 @@ set nbns 203.14.100.5 to eavesdrop. Referring back to the PPP and Static IP - addresses or PPP and Dynamic IP - addresses sections, the following alterations must - be made: + linkend="userppp-staticIP">PPP and + Static IP addresses or PPP and + Dynamic IP addresses sections, the following + alterations must be made: 13 set authname MyUserName 14 set authkey MyPassword @@ -1057,10 +1068,10 @@ set nbns 203.14.100.5 Line 15: - Your ISP will not normally require that you log - into the server if you are using PAP or CHAP. You - must therefore disable your set login - string. + Your ISP will not normally + require you to log into the server when using PAP or + CHAP. You must therefore disable your set + login string. @@ -1077,9 +1088,9 @@ set nbns 203.14.100.5 set server /var/run/ppp-tun%d DiagnosticPassword 0177 - This will tell PPP to listen to the specified - &unix; domain socket, asking clients for the specified - password before allowing access. The + This will tell PPP to listen to the + specified &unix; domain socket, asking clients for the + specified password before allowing access. The %d in the name is replaced with the tun device number that is in use. @@ -1091,23 +1102,23 @@ set nbns 203.14.100.5 - Using PPP Network Address Translation - Capability + Using <acronym>PPP</acronym> Network Address + Translation Capability PPPNAT - PPP has ability to use internal NAT without kernel - diverting capabilities. This functionality may be enabled - by the following line in + PPP has the ability to use internal + NAT without kernel diverting capabilities. This + functionality may be enabled by the following line in /etc/ppp/ppp.conf: nat enable yes - Alternatively, PPP NAT may be enabled by command-line - option -nat. There is also - /etc/rc.conf knob named + Alternatively, PPP NAT may be enabled + by command-line option -nat. There is + also /etc/rc.conf knob named ppp_nat, which is enabled by default. @@ -1140,14 +1151,15 @@ nat port tcp 10.0.0.2:http httphostname="foo.example.com" - If your ISP has supplied you with a static IP address - and name, it is probably best that you use this name as your - host name. + If the ISP has supplied a static IP + address and name, it is probably best that you use this name + as your host name. Look for the network_interfaces variable. If you want to configure your system to dial your - ISP on demand, make sure the tun0 - device is added to the list, otherwise remove it. + ISP on demand, make sure the + tun0 device is added to the list, + otherwise remove it. network_interfaces="lo0 tun0" ifconfig_tun0= @@ -1223,9 +1235,9 @@ ifconfig_tun0= &prompt.root; ppp and then dial provider to start the - PPP session, or, if you want ppp to - establish sessions automatically when there is outbound - traffic (and you have not created the + PPP session, or, if you want + ppp to establish sessions automatically + when there is outbound traffic (and you have not created the start_if.tun0 script), type: &prompt.root; ppp -auto provider @@ -1256,7 +1268,7 @@ ifconfig_tun0= Create an entry in /etc/ppp/ppp.conf. The pmdemand example should suffice - for most ISPs. + for most ISPs. @@ -1342,9 +1354,10 @@ ifconfig_tun0= This section covers a few issues which may arise when - using PPP over a modem connection. For instance, perhaps you - need to know exactly what prompts the system you are dialing - into will present. Some ISPs present the + using PPP over a modem connection. For + instance, perhaps you need to know exactly what prompts the + system you are dialing into will present. Some + ISPs present the ssword prompt, and others will present password; if the ppp script is not written accordingly, the login attempt will @@ -1609,7 +1622,8 @@ nameserver y.y.y.y - Using PPP over Ethernet (PPPoE) + Using <acronym>PPP</acronym> over Ethernet + (<acronym>PPPoE</acronym>) PPP @@ -1621,15 +1635,15 @@ nameserver y.y.y.yPPP, over Ethernet - This section describes how to set up PPP over Ethernet - (PPPoE). + This section describes how to set up PPP + over Ethernet (PPPoE). Configuring the Kernel - No kernel configuration is necessary for PPPoE any longer. - If the necessary netgraph support is not built into the - kernel, it will be dynamically loaded by + No kernel configuration is necessary for + PPPoE. If the necessary netgraph support + is not built into the kernel, it will be dynamically loaded by ppp. @@ -1675,34 +1689,35 @@ ppp_profile="name_of_service_provider" - Using a PPPoE Service Tag + Using a <acronym>PPPoE</acronym> Service Tag Sometimes it will be necessary to use a service tag to establish your connection. Service tags are used to - distinguish between different PPPoE servers attached to a - given network. + distinguish between different PPPoE servers + attached to a given network. You should have been given any required service tag - information in the documentation provided by your ISP. If - you cannot locate it there, ask your ISP's tech support - personnel. + information in the documentation provided by the + ISP. If you cannot locate it there, ask + your ISP's tech support personnel. As a last resort, you could try the method suggested by the Roaring - Penguin PPPoE program which can be found in the Ports Collection. Bear in mind - however, this may de-program your modem and render it useless, - so think twice before doing it. Simply install the program - shipped with the modem by your provider. Then, access the - System menu from the program. The name - of your profile should be listed there. It is usually - ISP. - - The profile name (service tag) will be used in the PPPoE - configuration entry in ppp.conf as the - provider part of the set device command - (see the &man.ppp.8; manual page for full details). It should - look like this: + Penguin PPPoE program which can be + found in the Ports Collection. + Bear in mind however, this may de-program your modem and + render it useless, so think twice before doing it. Simply + install the program shipped with the modem by your provider. + Then, access the System menu from the + program. The name of your profile should be listed there. It + is usually ISP. + + The profile name (service tag) will be used in the + PPPoE configuration entry in + ppp.conf as the provider part of the + set device command (see the &man.ppp.8; + manual page for full details). It should look like + this: set device PPPoE:xl1:ISP @@ -1717,7 +1732,7 @@ ppp_profile="name_of_service_provider" Cheaper - Broadband with FreeBSD on DSL by Renaud + Broadband with &os; on DSL by Renaud Waldura. @@ -1725,21 +1740,22 @@ ppp_profile="name_of_service_provider" - PPPoE with a &tm.3com; + <title><acronym>PPPoE</acronym> with a &tm.3com; <trademark class="registered">HomeConnect</trademark> ADSL Modem Dual Link This modem does not follow RFC 2516 - (A Method for transmitting PPP over Ethernet - (PPPoE), written by L. Mamakos, K. Lidl, J. Evarts, - D. Carrel, D. Simone, and R. Wheeler). Instead, different - packet type codes have been used for the Ethernet frames. - Please complain to A Method for transmitting PPP + over Ethernet (PPPoE), written + by L. Mamakos, K. Lidl, J. Evarts, D. Carrel, D. Simone, and + R. Wheeler). Instead, different packet type codes have been + used for the Ethernet frames. Please complain to 3Com if you think it - should comply with the PPPoE specification. + should comply with the PPPoE + specification. - In order to make FreeBSD capable of communicating with + In order to make &os; capable of communicating with this device, a sysctl must be set. This can be done automatically at boot time by updating /etc/sysctl.conf: @@ -1751,17 +1767,17 @@ ppp_profile="name_of_service_provider"&prompt.root; sysctl net.graph.nonstandard_pppoe=1 Unfortunately, because this is a system-wide setting, - it is not possible to talk to a normal PPPoE client or server - and a &tm.3com; HomeConnect ADSL Modem at - the same time. + it is not possible to talk to a normal + PPPoE client or server and a &tm.3com; + HomeConnect ADSL + Modem at the same time. Using <application>PPP</application> over ATM - (PPPoA) + (PPPoA) PPP @@ -1773,17 +1789,20 @@ ppp_profile="name_of_service_provider"PPP, over ATM - The following describes how to set up PPP over ATM (PPPoA). - PPPoA is a popular choice among European DSL providers. + The following describes how to set up PPP + over ATM (PPPoA). PPPoA + is a popular choice among European DSL providers. - Using PPPoA with the Alcatel &speedtouch; USB + Using <acronym>PPPoA</acronym> with the Alcatel + &speedtouch; USB - PPPoA support for this device is supplied as a port in - FreeBSD because the firmware is distributed under PPPoA support for this device is + supplied as a port in &os; because the firmware is distributed + under Alcatel's license agreement and can not be redistributed freely - with the base system of FreeBSD. + with the base system of &os;. To install the software, simply use the Ports Collection. Install the @@ -1890,10 +1909,12 @@ adsl: - The username used to authenticate with your ISP. + The username used to authenticate with the + ISP. - The password used to authenticate with your ISP. + The password used to authenticate with the + ISP. @@ -1944,8 +1965,8 @@ ng0: flags=88d1<UP,POINTOPOINT,RUNNIN Using pptpclient - It is also possible to use FreeBSD to connect to other - PPPoA services using It is also possible to use &os; to connect to other + PPPoA services using net/pptpclient. To use net/pptpclient @@ -1991,14 +2012,14 @@ ng0: flags=88d1<UP,POINTOPOINT,RUNNIN - This will open a tunnel for a PPP session to your DSL - router. Ethernet DSL modems have a preconfigured LAN IP - address which you connect to. In the case of the Alcatel - &speedtouch; Home this address is 10.0.0.138. Your router - documentation should tell you which address your device - uses. To open the tunnel and start a PPP session execute - the following command: + This will open a tunnel for a PPP + session to the DSL router. Ethernet DSL modems have a + preconfigured LAN IP address which you connect to. In the + case of the Alcatel &speedtouch; Home, this address is 10.0.0.138. The router + documentation should tell you which address the device + uses. To open the tunnel and start a PPP + session execute the following command: &prompt.root; pptp address adsl