From owner-svn-doc-projects@FreeBSD.ORG Mon Apr 29 22:06:39 2013 Return-Path: Delivered-To: svn-doc-projects@freebsd.org Received: from mx1.freebsd.org (mx1.FreeBSD.org [8.8.178.115]) by hub.freebsd.org (Postfix) with ESMTP id 6D4CCB86; Mon, 29 Apr 2013 22:06:39 +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 5F4931904; Mon, 29 Apr 2013 22:06:39 +0000 (UTC) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.6/8.14.6) with ESMTP id r3TM6d9F011957; Mon, 29 Apr 2013 22:06:39 GMT (envelope-from dru@svn.freebsd.org) Received: (from dru@localhost) by svn.freebsd.org (8.14.6/8.14.5/Submit) id r3TM6dfb011955; Mon, 29 Apr 2013 22:06:39 GMT (envelope-from dru@svn.freebsd.org) Message-Id: <201304292206.r3TM6dfb011955@svn.freebsd.org> From: Dru Lavigne Date: Mon, 29 Apr 2013 22:06:39 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-projects@freebsd.org Subject: svn commit: r41522 - 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, 29 Apr 2013 22:06:39 -0000 Author: dru Date: Mon Apr 29 22:06:38 2013 New Revision: 41522 URL: http://svnweb.freebsd.org/changeset/doc/41522 Log: Fix command/application tags that should be man page entities. 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 29 21:56:02 2013 (r41521) +++ projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/handbook/ppp-and-slip/chapter.xml Mon Apr 29 22:06:38 2013 (r41522) @@ -171,7 +171,7 @@ IP addresses. If it has not provided any IP addresses, include enable dns in ppp.conf and - ppp will set the name servers. This + &man.ppp.8; will set the name servers. This feature requires the ISP's PPP implementation to support DNS negotiation. @@ -194,7 +194,7 @@ This IP number is referred to as HISADDR by - ppp. + &man.ppp.8;. @@ -237,12 +237,13 @@ configuration - ppp uses the configuration files - located in /etc/ppp. + Several files located in /etc/ppp are used to + configure &man.ppp.8;. Examples can be found in /usr/share/examples/ppp/. - Configuring ppp requires a number of + Configuring &man.ppp.8; requires a number of files to be edited, depending on the requirements and whether the ISP allocates IP addresses statically or dynamically. @@ -292,7 +293,7 @@ Identifies the default entry. Commands in this entry are executed automatically when - ppp is + &man.ppp.8; is run. @@ -513,7 +514,7 @@ protocol: ppp instructions for PPP and Dynamic IP addresses. If this line is - omitted, ppp cannot run in + omitted, &man.ppp.8; cannot run in mode. @@ -530,7 +531,7 @@ protocol: ppp otherwise HISADDR will not yet be initialized. - When ppp is not run in + When &man.ppp.8; is not run in mode, this line should be moved to ppp.linkup. @@ -539,7 +540,7 @@ protocol: ppp It is not necessary to add an entry to ppp.linkup when using a static - IP address with ppp in + IP address with &man.ppp.8; in mode as the routing table entries are already correct before a connection is established. However, an entry can be created to invoke programs after @@ -566,10 +567,10 @@ protocol: ppp If the service provider does not assign static IP - addresses, ppp can be configured to + addresses, &man.ppp.8; can be configured to negotiate the local and remote addresses. This is done by guessing an IP address and allowing - ppp to set it up correctly using the IP + &man.ppp.8; to set it up correctly using the IP Configuration Protocol (IPCP) after connecting. The ppp.conf configuration is the same as PPP @@ -589,7 +590,7 @@ protocol: ppp The number after the / character is the number of bits of the address that - ppp will insist on. These + &man.ppp.8; will insist on. These IP numbers can be replaced, but the above example will always work. @@ -611,7 +612,7 @@ protocol: ppp /etc/ppp/ppp.linkup. ppp.linkup is used after a connection has been established. At this point, - ppp will have assigned the interface + &man.ppp.8; will have assigned the interface addresses and it will now be possible to add the routing table entries: @@ -624,7 +625,7 @@ protocol: ppp On establishing a connection, - ppp will look for an entry in + &man.ppp.8; will look for an entry in ppp.linkup according to the following rules: First, try to match the same label as we used in ppp.conf. If @@ -639,7 +640,7 @@ protocol: ppp Line 2: - This line tells ppp to add a + This line tells &man.ppp.8; to add a default route that points to HISADDR. HISADDR will be replaced with the @@ -664,7 +665,7 @@ protocol: ppp receiving incoming calls - When configuring ppp to receive + When configuring &man.ppp.8; to receive incoming calls on a machine connected to a LAN, decide if packets should be forwarded to the LAN. If so, allocate the peer an IP number from the LAN's subnet and use @@ -683,34 +684,34 @@ protocol: ppp Dial-up Services provides a good description on enabling dial-up services using &man.getty.8;. - An alternative to getty is An alternative to &man.getty.8; is mgetty (from comms/mgetty+sendfax - port), a smarter version of getty + port), a smarter version of &man.getty.8; designed with dial-up lines in mind. - The advantages of using mgetty is + The advantages of using &man.getty.8; is that it actively talks to modems. If the port is turned off in /etc/ttys, the modem will not answer the phone. - Later versions of mgetty (from + Later versions of &man.getty.8; (from 0.99beta onwards) also support the automatic detection of PPP streams, allowing clients scriptless access to the server. Refer to Mgetty and AutoPPP for more information on - mgetty. + &man.getty.8;. <acronym>PPP</acronym> Permissions - The ppp command must normally be + Typically, &man.ppp.8; is run as the root user. To give a - user permission to run ppp in server + user permission to run &man.ppp.8; in server mode, add their user account to the network group in /etc/group. @@ -874,10 +875,10 @@ mary: - <command>mgetty</command> and AutoPPP + &man.getty.8; and AutoPPP - mgetty + &man.getty.8; @@ -891,9 +892,9 @@ mary: By default the comms/mgetty+sendfax port comes with the AUTO_PPP option enabled - allowing mgetty to detect the LCP + allowing &man.getty.8; to detect the LCP phase of PPP connections and - automatically spawn off a ppp shell. + automatically spawn off a &man.ppp.8; shell. However, since the default login/password sequence does not occur it is necessary to authenticate users using either PAP or CHAP. @@ -909,7 +910,7 @@ mary: /AutoPPP/ - - /etc/ppp/ppp-pap-dialup - This will tell mgetty to run the + This will tell &man.getty.8; to run the ppp-pap-dialup script for detected PPP connections. @@ -1070,11 +1071,11 @@ set nbns 203.14.100.5 - Changing the <command>ppp</command> Configuration + <title>Changing the &man.ppp.8; Configuration on the Fly - It is possible to talk to the ppp - program while it is running in the background, but only + It is possible to talk to &man.ppp.8; + while it is running in the background, but only if a suitable diagnostic port has been set up. To do this, add the following line to the configuration: @@ -1133,7 +1134,7 @@ nat port tcp 10.0.0.2:http httpPPPconfiguration - Now that ppp is configured, there are + Now that &man.ppp.8; is configured, there are a few more things to edit in /etc/rc.conf. @@ -1164,7 +1165,7 @@ ifconfig_tun0= ppp -auto mysystem This script is executed at network configuration time, - starting the ppp daemon in + starting the &man.ppp.8; daemon in mode. If the machine functions as a gateway for a LAN, consider using the switch. Refer to the manual page @@ -1181,24 +1182,24 @@ ifconfig_tun0= routed - It is important that the routed - daemon is not started, as routed tends + It is important that the &man.routed.8; + daemon is not started, as &man.routed.8; tends to delete the default routing table entries created by - ppp. + &man.ppp.8;. It is probably a good idea to ensure that the sendmail_flags line does not include the option, otherwise - sendmail will attempt to do a network + &man.sendmail.8; will attempt to do a network lookup every now and then, possibly causing the machine to dial out. Try this command instead: sendmail_flags="-bd" - sendmail + Sendmail - The downside is that sendmail must be + The downside is that &man.sendmail.8; must be forced to re-examine the mail queue whenever the PPP link is up by typing: @@ -1227,7 +1228,7 @@ ifconfig_tun0= and then dial provider to start the PPP session, or, to configure - ppp to establish sessions automatically + &man.ppp.8; to establish sessions automatically when there is outbound traffic and there is no existing start_if.tun0 script, type: @@ -1346,9 +1347,9 @@ ifconfig_tun0= using PPP over a modem connection. Some ISPs present the ssword prompt, and others will present - password; if the ppp + password; if the &man.ppp.8; script is not written accordingly, the login attempt will - fail. The most common way to debug ppp + fail. The most common way to debug &man.ppp.8; connections is by connecting manually. The following information walks through a manual connection step by step. @@ -1364,7 +1365,7 @@ ifconfig_tun0= The uart device is already included in the GENERIC kernel, so no additional steps are necessary in this case. Just - check the dmesg output for the modem + check the &man.dmesg.8; output for the modem device with: &prompt.root; dmesg | grep uart @@ -1382,14 +1383,13 @@ ifconfig_tun0= Connecting Manually Connecting to the Internet by manually controlling - ppp is quick, easy, and a great way to + &man.ppp.8; is quick, easy, and a great way to debug a connection or just get information on how the - ISP treats ppp client - connections. Lets start PPP from - the command line. The following examples use + ISP treats &man.ppp.8; client + connections. The following examples use example as the hostname of the - machine running PPP. To start - ppp: + machine running &man.ppp.8;. To start + &man.ppp.8;: &prompt.root; ppp @@ -1403,10 +1403,10 @@ ifconfig_tun0= ppp ON example> set speed 115200 - This tells ppp to configure the + This tells &man.ppp.8; to configure the resolver and add the nameserver lines to /etc/resolv.conf. If - ppp cannot determine the hostname, it can + &man.ppp.8; cannot determine the hostname, it can manually be set later. ppp ON example> enable dns @@ -1423,8 +1423,8 @@ type '~h' for help OK atdt123456789 - Use at to initialize the modem, - then use atdt and the number for the + Use &man.at.1; to initialize the modem, + then type atdt and the number for the ISP to begin the dial in process. CONNECT @@ -1451,8 +1451,8 @@ OK Depending on the ISP, this prompt may never appear. Here we are being asked if we wish to use a shell on the provider, or to start - ppp. In this example, we have chosen - to use ppp as we want an Internet + &man.ppp.8;. In this example, we have chosen + to use &man.ppp.8; as we want an Internet connection. Ppp ON example> @@ -1492,7 +1492,7 @@ OK uppercase P indicates a connection to the ISP and a lowercase p indicates that the connection has been - lost. ppp only has these 2 states. + lost. &man.ppp.8; only has these 2 states. Debugging @@ -1522,7 +1522,7 @@ OK command mode, which is usually a negotiation error where the ISP is waiting for your side to start negotiating. At this point, using the ~p - command will force ppp to start + command will force &man.ppp.8; to start sending the configuration information. If a login prompt never appears, try using @@ -1617,7 +1617,7 @@ nameserver y.y.y.yNo kernel configuration is necessary for PPPoE. If the necessary netgraph support is not built into the kernel, it will be dynamically loaded by - ppp. + &man.ppp.8;. @@ -1641,7 +1641,7 @@ name_of_service_provider: - Running <command>ppp</command> + Running &man.ppp.8; As root, run: @@ -1650,7 +1650,7 @@ name_of_service_provider: - Starting <command>ppp</command> at Boot + Starting &man.ppp.8; at Boot Add the following to /etc/rc.conf: @@ -1685,8 +1685,8 @@ ppp_profile="name_of_service_provider"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 + set device command (refer to &man.ppp.8; + for details). It should look like this: set device PPPoE:xl1:ISP @@ -1801,7 +1801,7 @@ ppp_profile="name_of_service_provider"usbd_enable="YES" It is also possible to set up - ppp to dial up at startup. To do + &man.ppp.8; to dial up at startup. To do this add the following lines to /etc/rc.conf: @@ -1993,7 +1993,7 @@ ng0: flags=88d1<UP,POINTOPOINT,RUNNIN A tun virtual tunnel device will be created for interaction between the pptp and - ppp processes. Once the prompt is + &man.ppp.8; processes. Once the prompt is returned, or the pptp process has confirmed a connection, examine the tunnel: @@ -2004,7 +2004,7 @@ tun0: flags=8051<UP,POINTOPOINT,RUNNI If unable to connect, check the router configuration, which is usually accessible via - telnet or a web browser. Examine + &man.telnet.1; or a web browser. Examine the output of pptp and the contents of /var/log/ppp.log for clues.