Changeset ea93c11 for prologue/typography.xml

Timestamp:

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

Author:

Xi Ruoyao <xry111@…>

Branches:

12.1, 12.1-rc1, multilib, trunk, xry111/arm64, xry111/clfs-ng, xry111/loongarch, xry111/loongarch-12.1, xry111/mips64el, 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.

File:

• prologue/typography.xml (modified) (3 diffs)

prologue/typography.xml

@@ -75 +75 @@
   <para>This format is used to encapsulate text that is optional.</para>
 
-  <para><filename>passwd(5)</filename></para>
+  <para><ulink role='man' url='&man;passwd.5'>passwd(5)</ulink></para>
 
   <para>This format is used to refer to a specific manual (man) page. The number inside parentheses
@@ -82 +82 @@
   those two man pages will be located at
   <filename>/usr/share/man/man1/passwd.1</filename> and
-  <filename>/usr/share/man/man5/passwd.5</filename>. When the book uses <filename>passwd(5)</filename> it is
+  <filename>/usr/share/man/man5/passwd.5</filename>. When the book uses
+  <ulink role='man' url='&man;/passwd.5'>passwd(5)</ulink> it is
   specifically referring to <filename>/usr/share/man/man5/passwd.5</filename>.
   <command>man passwd</command> will print the first man page it finds that
@@ -90 +91 @@
   being specified. Note that most man pages do not have duplicate
   page names in different sections. Therefore, <command>man <replaceable>&lt;program
-  name&gt;</replaceable></command> is generally sufficient.</para>
+  name&gt;</replaceable></command> 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
+  <ulink url='https://man.archlinux.org/'>Arch Linux manual
+  pages</ulink>.</para>
 
 </sect1>