source: prologue/typography.xml@ dbc195c

6.0
Last change on this file since dbc195c was fbe4cf1, checked in by Manuel Canales Esparcia <manuel@…>, 20 years ago

Added a para about replaceable text.

git-svn-id: http://svn.linuxfromscratch.org/LFS/branches/testing/BOOK@3958 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689

  • Property mode set to 100644
File size: 2.2 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
3 <!ENTITY % general-entities SYSTEM "../general.ent">
4 %general-entities;
5]>
6<sect1 id="pre-typography">
7<title>Typography</title>
8<?dbhtml filename="typography.html"?>
9
10<para>To make things easier to follow, there are a few typographical
11conventions used throughout the book. Following are some examples:</para>
12
13<screen><userinput>./configure --prefix=/usr</userinput></screen>
14
15<blockquote><para>This form of text is designed to be typed exactly
16as seen unless otherwise noted in the surrounding text. It is also used
17in the explanation sections to identify which of the commands is being
18referenced.</para></blockquote>
19
20<screen><computeroutput>install-info: unknown option `--dir-file=/mnt/lfs/usr/info/dir'</computeroutput></screen>
21
22<blockquote><para>This form of text (fixed width text) is showing screen
23output, probably as the result of commands issued, and is also used to
24show filenames, such as <filename>/etc/ld.so.conf</filename>.</para></blockquote>
25
26<para><emphasis>Emphasis</emphasis></para>
27
28<blockquote><para>This form of text is used for several purposes in the
29book, mainly to emphasize important points or items.</para></blockquote>
30
31<para><ulink url="&lfs-root;"/></para>
32
33<blockquote><para>This form of text is used for hyperlinks, both within the
34book and to external pages such as HOWTOs, download locations and
35websites.</para></blockquote>
36
37<screen><userinput>cat &gt; $LFS/etc/group &lt;&lt; "EOF"
38root:x:0:
39bin:x:1:
40......
41EOF</userinput></screen>
42
43<blockquote><para>This type of section is used mainly when creating
44configuration files. The first command tells the system to create
45the file <filename>$LFS/etc/group</filename> from whatever is typed on the following lines until
46the sequence EOF is encountered. Therefore, this whole section is generally
47typed as seen.</para></blockquote>
48
49<para><replaceable>[REPLACED TEXT]</replaceable></para>
50
51<blockquote><para>This form of text is used to encapsulate text that is
52not to be typed as seen or copy and pasted.</para></blockquote>
53
54</sect1>
Note: See TracBrowser for help on using the repository browser.