Changeset 46a2e9c for prologue/typography.xml
- Timestamp:
- 01/06/2006 02:59:05 AM (19 years ago)
- Children:
- e1ca33a
- Parents:
- 1714f1a
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
prologue/typography.xml
r1714f1a r46a2e9c 1 1 <?xml version="1.0" encoding="ISO-8859-1"?> 2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ 2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" 3 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ 3 4 <!ENTITY % general-entities SYSTEM "../general.ent"> 4 5 %general-entities; 5 6 ]> 7 6 8 <sect1 id="pre-typography"> 7 <title>Typography</title> 8 <?dbhtml filename="typography.html"?> 9 <?dbhtml filename="typography.html"?> 9 10 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> 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> 14 17 15 18 <screen role="nodump"><userinput>./configure --prefix=/usr</userinput></screen> 16 19 17 <para>This form of text is designed to be typed exactly as seen unless 18 otherwise noted in the surrounding text. It is also used in the 19 explanation sections to identify which of the commands is being 20 referenced.</para> 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> 21 23 22 24 <screen><computeroutput>install-info: unknown option '--dir-file=/mnt/lfs/usr/info/dir'</computeroutput></screen> 23 25 24 <para>This form of text (fixed-width text) shows screen output, 25 probably as the result of commands issued. This format is also used 26 to show filenames, such as 27 <filename>/etc/ld.so.conf</filename>.</para> 26 <para>This form of text (fixed-width text) shows screen output, probably 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> 28 29 29 <para><emphasis>Emphasis</emphasis></para>30 <para><emphasis>Emphasis</emphasis></para> 30 31 31 <para>This form of text is used for several purposes in the book.Its main32 purpose is to emphasize important points or items.</para>32 <para>This form of text is used for several purposes in the book. Its main 33 purpose is to emphasize important points or items.</para> 33 34 34 <para><ulink url="&lfs-root;"/></para>35 <para><ulink url="&lfs-root;"/></para> 35 36 36 <para>This format is used for hyperlinks both within the LFS 37 community and to external pages. It includes HOWTOs, download locations, 38 and websites.</para> 37 <para>This format is used for hyperlinks both within the LFS community and to 38 external pages. It includes HOWTOs, download locations, and websites.</para> 39 39 40 40 <screen role="nodump"><userinput>cat > $LFS/etc/group << "EOF" … … 44 44 EOF</userinput></screen> 45 45 46 <para>This format is used when creating configuration files. The first 47 command tells the system to create the file 48 <filename>$LFS/etc/group</filename> from whatever is typed on the 49 following lines until the sequence end of file (EOF) is encountered. 50 Therefore, this entire section is generally typed asseen.</para>46 <para>This format is used when creating configuration files. The first command 47 tells the system to create the file <filename>$LFS/etc/group</filename> from 48 whatever is typed on the following lines until the sequence end of file (EOF) 49 is encountered. Therefore, this entire section is generally typed as 50 seen.</para> 51 51 52 <para><replaceable>[REPLACED TEXT]</replaceable></para>52 <para><replaceable>[REPLACED TEXT]</replaceable></para> 53 53 54 <para>This format is used to encapsulate text that is not to be typed55 as seen or copied-and-pasted.</para>54 <para>This format is used to encapsulate text that is not to be typed 55 as seen or copied-and-pasted.</para> 56 56 57 <para><filename>passwd(5)</filename></para>57 <para><filename>passwd(5)</filename></para> 58 58 59 <para>This format is used to refer to a specific manual page (hereinafter60 referred to simply as a <quote>man</quote> page). The number inside parentheses61 indicates a specific section inside of <command>man</command>. For example,62 <command>passwd</command> has two man pages. Per LFS installation instructions,63 those two man pages will be located at64 <filename>/usr/share/man/man1/passwd.1</filename> and65 <filename>/usr/share/man/man5/passwd.5</filename>. Both man pages have different66 information in them. When the book uses <filename>passwd(5)</filename> it is67 specifically referring to <filename>/usr/share/man/man5/passwd.5</filename>.68 <command>man passwd</command> will print the first man page it finds that69 matches <quote>passwd</quote>, which will be70 <filename>/usr/share/man/man1/passwd.1</filename>. For this example, you will71 need to run <command>man 5 passwd</command> in order to read the specific page72 being referred to. It should be noted that most man pages do not have duplicate73 page names in different sections. Therefore, <command>man <replaceable>[program74 name]</replaceable></command> is generally sufficient.</para>59 <para>This format is used to refer to a specific manual page (hereinafter 60 referred to simply as a <quote>man</quote> page). The number inside parentheses 61 indicates a specific section inside of <command>man</command>. For example, 62 <command>passwd</command> has two man pages. Per LFS installation instructions, 63 those two man pages will be located at 64 <filename>/usr/share/man/man1/passwd.1</filename> and 65 <filename>/usr/share/man/man5/passwd.5</filename>. Both man pages have different 66 information in them. When the book uses <filename>passwd(5)</filename> it is 67 specifically referring to <filename>/usr/share/man/man5/passwd.5</filename>. 68 <command>man passwd</command> will print the first man page it finds that 69 matches <quote>passwd</quote>, which will be 70 <filename>/usr/share/man/man1/passwd.1</filename>. For this example, you will 71 need to run <command>man 5 passwd</command> in order to read the specific page 72 being referred to. It should be noted that most man pages do not have duplicate 73 page names in different sections. Therefore, <command>man <replaceable>[program 74 name]</replaceable></command> is generally sufficient.</para> 75 75 76 76 </sect1>
Note:
See TracChangeset
for help on using the changeset viewer.