typography.xml 3.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  3. "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  4. <!ENTITY % general-entities SYSTEM "../general.ent">
  5. %general-entities;
  6. ]>
  7. <sect1 id="pre-typography">
  8. <?dbhtml filename="typography.html"?>
  9. <title>Typography</title>
  10. <para>To make things easier to follow, there are a few typographical
  11. conventions used throughout this book. This section contains some
  12. examples of the typographical format found throughout Linux From
  13. Scratch.</para>
  14. <screen role="nodump"><userinput>./configure --prefix=/usr</userinput></screen>
  15. <para>This form of text is designed to be typed exactly as seen unless
  16. otherwise noted in the surrounding text. It is also used in the explanation
  17. sections to identify which of the commands is being referenced.</para>
  18. <para>In some cases, a logical line is extended to two or more physical lines
  19. with a backslash at the end of the line.</para>
  20. <screen role="nodump"><userinput>CC="gcc -B/usr/bin/" ../binutils-2.18/configure \
  21. --prefix=/tools --disable-nls --disable-werror</userinput></screen>
  22. <para>Note that the backslash must be followed by an immediate return. Other
  23. whitespace characters like spaces or tab characters will create incorrect
  24. results.</para>
  25. <screen><computeroutput>install-info: unknown option '--dir-file=/mnt/lfs/usr/info/dir'</computeroutput></screen>
  26. <para>This form of text (fixed-width text) shows screen output, usually as
  27. the result of commands issued. This format is also used to show filenames,
  28. such as <filename>/etc/ld.so.conf</filename>.</para>
  29. <para><emphasis>Emphasis</emphasis></para>
  30. <para>This form of text is used for several purposes in the book. Its main
  31. purpose is to emphasize important points or items.</para>
  32. <para><ulink url="&lfs-root;"/></para>
  33. <para>This format is used for hyperlinks both within the LFS community and to
  34. external pages. It includes HOWTOs, download locations, and websites.</para>
  35. <screen role="nodump"><userinput>cat &gt; $LFS/etc/group &lt;&lt; "EOF"
  36. <literal>root:x:0:
  37. bin:x:1:
  38. ......</literal>
  39. EOF</userinput></screen>
  40. <para>This format is used when creating configuration files. The first command
  41. tells the system to create the file <filename>$LFS/etc/group</filename> from
  42. whatever is typed on the following lines until the sequence End Of File (EOF)
  43. is encountered. Therefore, this entire section is generally typed as
  44. seen.</para>
  45. <para><replaceable>&lt;REPLACED TEXT&gt;</replaceable></para>
  46. <para>This format is used to encapsulate text that is not to be typed
  47. as seen or for copy-and-paste operations.</para>
  48. <para><replaceable>[OPTIONAL TEXT]</replaceable></para>
  49. <para>This format is used to encapsulate text that is optional.</para>
  50. <para><filename>passwd(5)</filename></para>
  51. <para>This format is used to refer to a specific manual (man) page. The number inside parentheses
  52. indicates a specific section inside the manuals. For example,
  53. <command>passwd</command> has two man pages. Per LFS installation instructions,
  54. those two man pages will be located at
  55. <filename>/usr/share/man/man1/passwd.1</filename> and
  56. <filename>/usr/share/man/man5/passwd.5</filename>. When the book uses <filename>passwd(5)</filename> it is
  57. specifically referring to <filename>/usr/share/man/man5/passwd.5</filename>.
  58. <command>man passwd</command> will print the first man page it finds that
  59. matches <quote>passwd</quote>, which will be
  60. <filename>/usr/share/man/man1/passwd.1</filename>. For this example, you will
  61. need to run <command>man 5 passwd</command> in order to read the specific page
  62. being referred to. It should be noted that most man pages do not have duplicate
  63. page names in different sections. Therefore, <command>man <replaceable>&lt;program
  64. name&gt;</replaceable></command> is generally sufficient.</para>
  65. </sect1>