From ea93c117f2971ed269d3a7d39999d8b16b6f2b7e Mon Sep 17 00:00:00 2001 From: Xi Ruoyao Date: Fri, 26 Jan 2024 01:49:29 +0800 Subject: [PATCH] treewide: Use instead of for man pages "gcc(1)" is really not a file name. Use and link to the online man page on https://man.archlinux.org/ so the user can refer to the man pages more easily. The change is done via a sed command and long lines are wrapped manually. --- chapter02/creatingpartition.xml | 3 ++- chapter04/addinguser.xml | 3 ++- chapter04/settingenviron.xml | 4 ++-- chapter05/glibc.xml | 5 +++-- chapter08/e2fsprogs.xml | 3 ++- chapter08/openssl.xml | 5 +++-- chapter08/shadow.xml | 4 ++-- chapter08/util-linux.xml | 3 ++- chapter09/networkd.xml | 14 +++++++++----- chapter09/systemd-custom.xml | 21 ++++++++++++--------- chapter09/udev.xml | 5 +++-- chapter09/usage.xml | 10 ++++++---- chapter10/fstab.xml | 2 +- chapter10/kernel.xml | 3 ++- general.ent | 1 + prologue/typography.xml | 11 ++++++++--- 16 files changed, 60 insertions(+), 37 deletions(-) diff --git a/chapter02/creatingpartition.xml b/chapter02/creatingpartition.xml index ef16c8b92..f5bb244cb 100644 --- a/chapter02/creatingpartition.xml +++ b/chapter02/creatingpartition.xml @@ -40,7 +40,8 @@ /dev/sda for the primary disk drive. Create a Linux native partition and a swap partition, if needed. Please - refer to cfdisk(8) or fdisk(8) if + refer to cfdisk(8) or + fdisk(8) if you do not yet know how to use the programs. For experienced users, other partitioning schemes are possible. diff --git a/chapter04/addinguser.xml b/chapter04/addinguser.xml index 18a9d20e6..e10a884b3 100644 --- a/chapter04/addinguser.xml +++ b/chapter04/addinguser.xml @@ -99,6 +99,7 @@ esac The - instructs su to start a login shell as opposed to a non-login shell. The difference between these two types of shells is described in detail in - bash(1) and info bash. + bash(1) and info + bash. diff --git a/chapter04/settingenviron.xml b/chapter04/settingenviron.xml index 20988bd3f..b179bb0b3 100644 --- a/chapter04/settingenviron.xml +++ b/chapter04/settingenviron.xml @@ -79,8 +79,8 @@ EOF Setting the user file-creation mask (umask) to 022 ensures that newly created files and directories are only writable by their owner, but are readable and executable by anyone (assuming default modes are used by the - open(2) system call, new files will end up with - permission mode 644 and directories with mode 755). + open(2) system call, new files + will end up with permission mode 644 and directories with mode 755). diff --git a/chapter05/glibc.xml b/chapter05/glibc.xml index f54a7d107..63c4f6387 100644 --- a/chapter05/glibc.xml +++ b/chapter05/glibc.xml @@ -59,8 +59,9 @@ esac The above command is correct. The ln command has several syntactic versions, so be sure to check - info coreutils ln and ln(1) - before reporting what may appear to be an error. + info coreutils ln and ln(1) before reporting what may appear to be + an error. diff --git a/chapter08/e2fsprogs.xml b/chapter08/e2fsprogs.xml index 6a4489dee..c5718c191 100644 --- a/chapter08/e2fsprogs.xml +++ b/chapter08/e2fsprogs.xml @@ -159,7 +159,8 @@ install-info --dir-file=/usr/share/info/dir /usr/share/info/com_err.infosed 's/metadata_csum_seed,//' -i /etc/mke2fs.conf - Read the man page mke2fs.conf(5) for details. + Read the man page mke2fs.conf(5) for details. diff --git a/chapter08/openssl.xml b/chapter08/openssl.xml index ae5d27e38..446dd226a 100644 --- a/chapter08/openssl.xml +++ b/chapter08/openssl.xml @@ -163,7 +163,7 @@ make MANSUFFIX=ssl install is a command-line tool for using the various cryptography functions of OpenSSL's crypto library from the shell. It can be used for various functions which are documented in - openssl(1) + openssl(1) openssl @@ -195,7 +195,8 @@ make MANSUFFIX=ssl install implements the Transport Layer Security (TLS v1) protocol. It provides a rich API, documentation - on which can be found in ssl(7) + on which can be found in ssl(7) libssl.so diff --git a/chapter08/shadow.xml b/chapter08/shadow.xml index 49bcae6de..89678b3f4 100644 --- a/chapter08/shadow.xml +++ b/chapter08/shadow.xml @@ -203,8 +203,8 @@ make -C man install-man to pass either the -g or -N parameter to useradd, or else change the setting of USERGROUPS_ENAB in - /etc/login.defs. See useradd(8) - for more information. + /etc/login.defs. See useradd(8) for more information. Second, to change the default parameters, the file /etc/default/useradd must be created and tailored diff --git a/chapter08/util-linux.xml b/chapter08/util-linux.xml index 183e58418..e6bb0b683 100644 --- a/chapter08/util-linux.xml +++ b/chapter08/util-linux.xml @@ -584,7 +584,8 @@ su tester -c "make -k check" irqtop Displays kernel interrupt counter information in - top(1) style view + top(1) style + view irqtop diff --git a/chapter09/networkd.xml b/chapter09/networkd.xml index 19a1f7c01..3b9dd2cda 100644 --- a/chapter09/networkd.xml +++ b/chapter09/networkd.xml @@ -50,9 +50,11 @@ .netdev and .network files. For detailed descriptions and example contents of these configuration files, consult - the systemd-link(5), - systemd-netdev(5) and - systemd-network(5) manual pages. + the systemd-link(5), + systemd-netdev(5), + and systemd-network(5) manual + pages. Network Device Naming @@ -113,7 +115,7 @@ Name=ether0 EOF - See systemd.link(5) for more information. + See systemd.link(5) for more information. @@ -357,7 +359,9 @@ EOF localhost.localdomain, or the hostname (without a domain) because they are handled by the myhostname NSS module, read - the man page nss-myhostname(8) for details. + the man page nss-myhostname(8) for + details. The ::1 entry is the IPv6 counterpart of 127.0.0.1 and represents the IPv6 loopback interface. diff --git a/chapter09/systemd-custom.xml b/chapter09/systemd-custom.xml index 81a94a148..ffca1a76f 100644 --- a/chapter09/systemd-custom.xml +++ b/chapter09/systemd-custom.xml @@ -21,8 +21,9 @@ of options to control basic systemd operations. The default file has all entries commented out with the default settings indicated. This file is where the log level may be changed as well as some basic logging settings. - See the systemd-system.conf(5) manual page for details - on each configuration option. + See the systemd-system.conf(5) manual + page for details on each configuration option. @@ -89,8 +90,8 @@ EOF /etc/tmpfiles.d override files with the same name in /usr/lib/tmpfiles.d. See - tmpfiles.d(5) manual page for file format - details. + tmpfiles.d(5) manual + page for file format details. Note that the syntax for the @@ -135,7 +136,8 @@ Restart=always RestartSec=30 EOF - See systemd.unit(5) manual page for more + See systemd.unit(5) manual page for more information. After creating the configuration file, run systemctl daemon-reload and systemctl restart foobar to activate the changes to a service. @@ -251,10 +253,11 @@ cat > /etc/systemd/coredump.conf.d/maxuse.conf << EOF MaxUse=5G EOF - See the systemd-coredump(8), - coredumpctl(1), and - coredump.conf.d(5) manual pages for more - information. + See the systemd-coredump(8), + coredumpctl(1), and + coredump.conf.d(5) manual pages for + more information. diff --git a/chapter09/udev.xml b/chapter09/udev.xml index 0fba5a8b4..bd0b75912 100644 --- a/chapter09/udev.xml +++ b/chapter09/udev.xml @@ -225,8 +225,9 @@ Note that the softdep command also allows pre: dependencies, or a mixture of both pre: and post: dependencies. See - the modprobe.d(5) manual page for more information - on softdep syntax and capabilities. + the modprobe.d(5) + manual page for more information on softdep syntax and + capabilities. If the module in question is not a wrapper and is useful by itself, configure the modules bootscript to diff --git a/chapter09/usage.xml b/chapter09/usage.xml index 1fc7189d6..25175c45f 100644 --- a/chapter09/usage.xml +++ b/chapter09/usage.xml @@ -32,7 +32,8 @@ SysVinit (which will be referred to as init from now on) uses a run levels scheme. There are seven run levels, numbered 0 to 6. (Actually, there are more run levels, but the others are for special cases and are - generally not used. See init(8) for more details.) + generally not used. See init(8) for more details.) Each one of the seven corresponds to actions the computer is supposed to perform when it starts up or shuts down. The default run level is 3. Here are the descriptions of the different run levels as they are implemented in LFS: @@ -341,9 +342,10 @@ EOF url="https://tldp.org/HOWTO/HOWTO-INDEX/other-lang.html"/>. If still in doubt, look in the /usr/share/keymaps and /usr/share/consolefonts directories - for valid keymaps and screen fonts. Read the loadkeys(1) and - setfont(8) manual pages to determine the correct - arguments for these programs. + for valid keymaps and screen fonts. Read the loadkeys(1) and setfont(8) manual pages to determine the + correct arguments for these programs. The /etc/sysconfig/console file should contain lines of the form: VARIABLE="value". The following variables are recognized: diff --git a/chapter10/fstab.xml b/chapter10/fstab.xml index c20f806dd..ad835be30 100644 --- a/chapter10/fstab.xml +++ b/chapter10/fstab.xml @@ -56,7 +56,7 @@ EOF class="partition">sda2, sda5, and ext4. For details on the six - fields in this file, see fstab(5). + fields in this file, see fstab(5). Filesystems with MS-DOS or Windows origin (i.e. vfat, ntfs, smbfs, cifs, iso9660, udf) need a special option, utf8, in order for non-ASCII diff --git a/chapter10/kernel.xml b/chapter10/kernel.xml index ce732ccb5..cf0b30f35 100644 --- a/chapter10/kernel.xml +++ b/chapter10/kernel.xml @@ -324,7 +324,8 @@ located in and in the kernel documentation in the linux-&linux-version;/Documentation directory. - Also, modprobe.d(5) may be of interest. + Also, modprobe.d(5) + may be of interest. Unless module support has been disabled in the kernel configuration, install the modules with: diff --git a/general.ent b/general.ent index 0540ac6c2..31e6daecc 100644 --- a/general.ent +++ b/general.ent @@ -125,6 +125,7 @@ + root"> lfs"> diff --git a/prologue/typography.xml b/prologue/typography.xml index 303a107c5..db66b345c 100644 --- a/prologue/typography.xml +++ b/prologue/typography.xml @@ -74,14 +74,15 @@ EOF This format is used to encapsulate text that is optional. - passwd(5) + passwd(5) This format is used to refer to a specific manual (man) page. The number inside parentheses indicates a specific section inside the manuals. For example, passwd has two man pages. Per LFS installation instructions, those two man pages will be located at /usr/share/man/man1/passwd.1 and - /usr/share/man/man5/passwd.5. When the book uses passwd(5) it is + /usr/share/man/man5/passwd.5. When the book uses + passwd(5) it is specifically referring to /usr/share/man/man5/passwd.5. man passwd will print the first man page it finds that matches passwd, which will be @@ -89,7 +90,11 @@ EOF need to run man 5 passwd in order to read the page being specified. Note that most man pages do not have duplicate page names in different sections. Therefore, man <program - name> is generally sufficient. + name> is generally sufficient. In the LFS + book these references to man pages are also hyperlinks, so clicking on + such a reference will open the man page rendered in HTML from + Arch Linux manual + pages.