Date: Fri, 29 Aug 2025 08:22:51 GMT From: Benedict Reuschling <bcr@FreeBSD.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org Subject: git: a7ce6dddfb - main - Avoid the use of "you" in the PPP chapter Message-ID: <202508290822.57T8MpA0027121@gitrepo.freebsd.org>
next in thread | raw e-mail | index | archive | help
The branch main has been updated by bcr: URL: https://cgit.FreeBSD.org/doc/commit/?id=a7ce6dddfbc3149c26038944211be0302357b270 commit a7ce6dddfbc3149c26038944211be0302357b270 Author: Benedict Reuschling <bcr@FreeBSD.org> AuthorDate: 2025-08-28 15:45:01 +0000 Commit: Benedict Reuschling <bcr@FreeBSD.org> CommitDate: 2025-08-28 17:10:48 +0000 Avoid the use of "you" in the PPP chapter Rewrite sentences that contain 'you', which should be avoided according to the FDP Primer. The resulting sentences are easier to understand and often shorter. I did not change programlistings and other output as these are from programs, which need to be changed first (out of scope of this change). Event: Oslo Hackathon 2025 Reviewed by: carlavilla Differential Revision: https://reviews.freebsd.org/D52215 --- .../en/books/handbook/ppp-and-slip/_index.adoc | 28 +++++++++++----------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/documentation/content/en/books/handbook/ppp-and-slip/_index.adoc b/documentation/content/en/books/handbook/ppp-and-slip/_index.adoc index a267fdc7ea..3d7ec970d3 100644 --- a/documentation/content/en/books/handbook/ppp-and-slip/_index.adoc +++ b/documentation/content/en/books/handbook/ppp-and-slip/_index.adoc @@ -55,13 +55,13 @@ endif::[] FreeBSD supports the Point-to-Point (PPP) protocol which can be used to establish a network or Internet connection using a dial-up modem. This chapter describes how to configure modem-based communication services in FreeBSD. -After reading this chapter, you will know: +Read this chapter to learn: * How to configure, use, and troubleshoot a PPP connection. * How to set up PPP over Ethernet (PPPoE). * How to set up PPP over ATM (PPPoA). -Before reading this chapter, you should: +Before reading this chapter: * Be familiar with basic network terminology. * Understand the basics and purpose of a dial-up connection and PPP. @@ -289,7 +289,7 @@ This line specifies the PAP/CHAP user name.Insert the correct value for _MyUserN Line 14::: This line specifies the PAP/CHAP password. Insert the correct value for _MyPassword_. -You may want to add an additional line, such as: +An additional line may be added, such as: + [.programlisting] .... @@ -384,8 +384,8 @@ router_enable="NO" It is important that the `routed` daemon is not started, as `routed` tends to delete the default routing table entries created by `ppp`. -It is probably a good idea to ensure that the `sendmail_flags` line does not include the `-q` option, otherwise `sendmail` will attempt to do a network lookup every now and then, possibly causing your machine to dial out. -You may try: +It is probably a good idea to ensure that the `sendmail_flags` line does not include the `-q` option, otherwise `sendmail` will attempt to do a network lookup every now and then, possibly causing the machine to dial out. +Try this: [.programlisting] .... @@ -709,13 +709,13 @@ Here is an example of a working [.filename]#ppp.conf#: [.programlisting] .... default: - set log Phase tun command # you can add more detailed logging if you wish + set log Phase tun command # add more detailed logging when needed set ifaddr 10.0.0.1/0 10.0.0.2/0 name_of_service_provider: - set device PPPoE:xl1 # replace xl1 with your Ethernet device - set authname YOURLOGINNAME - set authkey YOURPASSWORD + set device PPPoE:xl1 # replace xl1 with the Ethernet device + set authname THELOGINNAME + set authkey THEPASSWORD set dial set login add default HISADDR @@ -734,7 +734,7 @@ Add the following to [.filename]#/etc/rc.conf#: .... ppp_enable="YES" ppp_mode="ddial" -ppp_nat="YES" # if you want to enable nat for your local network, otherwise NO +ppp_nat="YES" # when needing to enable nat for the local network, otherwise NO ppp_profile="name_of_service_provider" .... @@ -746,7 +746,7 @@ Service tags are used to distinguish between different PPPoE servers attached to Any required service tag information should be in the documentation provided by the ISP. As a last resort, one could try installing the package:net/rr-pppoe[] package or port. -Bear in mind however, this may de-program your modem and render it useless, so think twice before doing it. +Bear in mind however, this may de-program the modem and render it useless, so think twice before doing it. Simply install the program shipped with the modem. Then, access the menu:System[] menu from the program. The name of the profile should be listed there. @@ -838,8 +838,8 @@ adsl: open .... -<.> The username used to authenticate with your ISP. -<.> The password used to authenticate with your ISP. +<.> The username used to authenticate with the ISP. +<.> The password used to authenticate with the ISP. Information about the link, or links, to establish is found in [.filename]#mpd.links#. An example [.filename]#mpd.links# to accompany the above example is given beneath: @@ -896,7 +896,7 @@ adsl: .... <.> The username for the DSL provider. -<.> The password for your account. +<.> The password for the account. [WARNING] ====
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?202508290822.57T8MpA0027121>