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