source: clfs-sysroot/BOOK/prologue/common/typography.xml@ 12e747fb

Last change on this file since 12e747fb was c439b8a, checked in by Manuel Canales Esparcia <manuel@…>, 18 years ago

Updated CLFS-Sysroot book sources to use DocBook-XML DTD 4.5.

  • Property mode set to 100644
File size: 3.4 KB
RevLine 
[02095ae]1<?xml version="1.0" encoding="ISO-8859-1"?>
[c439b8a]2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
[02095ae]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
22 explanation sections to identify which of the commands is being
23 referenced.</para>
24
[586feb7]25<screen><computeroutput>install-info: unknown option '--dir-file=/mnt/clfs/usr/info/dir'</computeroutput></screen>
[02095ae]26
27 <para>This form of text (fixed-width text) shows screen output,
28 probably as the result of commands issued. This format is also used
29 to show filenames, such as <filename>/etc/ld.so.conf</filename>.</para>
30
31 <para><emphasis>Emphasis</emphasis></para>
32
33 <para>This form of text is used for several purposes in the book.
34 Its main purpose is to emphasize important points or items.</para>
35
[586feb7]36 <para><ulink url="&clfs-root;"/></para>
[02095ae]37
[1a09536]38 <para>This format is used for hyperlinks, both within the CLFS
[02095ae]39 community and to external pages. It includes HOWTOs, download locations,
40 and websites.</para>
41
[65df7b1]42<screen role="nodump"><userinput>cat &gt; ${CLFS}/etc/group &lt;&lt; "EOF"
[02095ae]43<literal>root:x:0:
44bin:x:1:
45......</literal>
46EOF</userinput></screen>
47
48 <para>This format is used when creating configuration files. The first
49 command tells the system to create the file
[65df7b1]50 <filename>${CLFS}/etc/group</filename> from whatever is typed on the
[02095ae]51 following lines until the sequence end of file (EOF) is encountered.
52 Therefore, this entire section is generally typed as seen.</para>
53
54 <para><replaceable>[REPLACED TEXT]</replaceable></para>
55
56 <para>This format is used to encapsulate text that is not to be typed
57 as seen or copied-and-pasted.</para>
58
59 <para><filename>passwd(5)</filename></para>
60
61 <para>This format is used to refer to a specific manual page (hereinafter
62 referred to simply as a <quote>man</quote> page). The number inside
63 parentheses indicates a specific section inside of <command>man</command>.
[1a09536]64 For example, <command>passwd</command> has two man pages. Per CLFS
[02095ae]65 installation instructions, those two man pages will be located at
66 <filename>/usr/share/man/man1/passwd.1</filename> and
67 <filename>/usr/share/man/man5/passwd.5</filename>. Both man pages have
68 different information in them. When the book uses
69 <filename>passwd(5)</filename> it is specifically referring to
70 <filename>/usr/share/man/man5/passwd.5</filename>.
71 <command>man passwd</command> will print the first man page it finds
72 that matches <quote>passwd</quote>, which will be
73 <filename>/usr/share/man/man1/passwd.1</filename>. For this example,
74 you will need to run <command>man 5 passwd</command> in order to read
75 the specific page being referred to. It should be noted that most man
76 pages do not have duplicate page names in different sections. Therefore,
77 <command>man <replaceable>[program name]</replaceable></command> is
78 generally sufficient.</para>
79
80</sect1>
Note: See TracBrowser for help on using the repository browser.