Changeset ea93c11 for chapter08

Timestamp:

01/25/2024 05:59:06 PM (8 months ago)

Author:

Xi Ruoyao <xry111@…>

Branches:

12.1, 12.1-rc1, 12.2, 12.2-rc1, multilib, trunk, xry111/arm64, xry111/clfs-ng, xry111/loongarch, xry111/loongarch-12.1, xry111/loongarch-12.2, xry111/mips64el, xry111/multilib, xry111/update-glibc

Children:

31a18d02, 44850bb

Parents:

9ac6ff5

git-author:

Xi Ruoyao <xry111@…> (01/25/2024 05:49:29 PM)

git-committer:

Xi Ruoyao <xry111@…> (01/25/2024 05:59:06 PM)

Message:

treewide: Use <ulink> instead of <filename> for man pages

"gcc(1)" is really not a file name.

Use <ulink> 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.

Location:

chapter08

Files:

• e2fsprogs.xml (modified) (1 diff)
• openssl.xml (modified) (2 diffs)
• shadow.xml (modified) (1 diff)
• util-linux.xml (modified) (1 diff)

chapter08/e2fsprogs.xml

@@ -160 +160 @@
 
     <para>
-      Read the man page <filename>mke2fs.conf(5)</filename> for details.
+      Read the man page <ulink role='man'
+      url='&man;mke2fs.conf.5'>mke2fs.conf(5)</ulink> for details.
     </para>
   </sect2>

chapter08/openssl.xml

@@ -164 +164 @@
             of <application>OpenSSL</application>'s crypto library from the
             shell. It can be used for various functions which are documented in
-            <filename>openssl(1)</filename>
+            <ulink role='man' url='&man;openssl.1'>openssl(1)</ulink>
           </para>
           <indexterm zone="ch-system-openssl openssl-prog">
@@ -196 +196 @@
             implements the Transport Layer Security (TLS v1) protocol.
             It provides a rich API, documentation
-            on which can be found in <filename>ssl(7)</filename>
+            on which can be found in <ulink role='man'
+            url='&man;ssl.7'>ssl(7)</ulink>
           </para>
           <indexterm zone="ch-system-openssl libssl">

chapter08/shadow.xml

@@ -204 +204 @@
     parameter to <command>useradd</command>, or else change the setting of
     <parameter>USERGROUPS_ENAB</parameter> in
-    <filename>/etc/login.defs</filename>. See <filename>useradd(8)</filename>
-    for more information.</para>
+    <filename>/etc/login.defs</filename>. See <ulink role='man'
+    url='&man;useradd.8'>useradd(8)</ulink> for more information.</para>
 
     <para>Second, to change the default parameters, the file

chapter08/util-linux.xml

@@ -585 +585 @@
         <listitem>
           <para>Displays kernel interrupt counter information in
-          <filename>top(1)</filename> style view</para>
+          <ulink role='man' url='&man;top.1'>top(1)</ulink> style
+          view</para>
           <indexterm zone="ch-system-util-linux irqtop">
             <primary sortas="b-irqtop">irqtop</primary>