Changed typography convections.

git-svn-id: http://svn.linuxfromscratch.org/LFS/trunk/BOOK@7516 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689
This commit is contained in:
Manuel Canales Esparcia 2006-04-14 09:37:17 +00:00
parent b55b3c4ff2
commit 0090db5c7b
27 changed files with 94 additions and 77 deletions

View File

@ -36,6 +36,18 @@
</listitem>
-->
<listitem>
<para>April 14, 2006</para>
<itemizedlist>
<listitem>
<para>[manuel] - Changed typography convections. From now,
eplaceable text is encamsulated inside &lt; $gt:, optional text
inside [ ], and libraries extensions inside { }. Thanks to
Bruce Dubbs for submint the patch.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>April 13, 2006</para>
<itemizedlist>

View File

@ -21,9 +21,9 @@
<para>To create an <systemitem class="filesystem">ext2</systemitem> file
system on the LFS partition, run the following:</para>
<screen role="nodump"><userinput>mke2fs -v /dev/<replaceable>[xxx]</replaceable></userinput></screen>
<screen role="nodump"><userinput>mke2fs -v /dev/<replaceable>&lt;xxx&gt;</replaceable></userinput></screen>
<para>Replace <replaceable>[xxx]</replaceable> with the name of the LFS
<para>Replace <replaceable>&lt;xxx&gt;</replaceable> with the name of the LFS
partition (<filename class="devicefile">hda5</filename> in our previous
example).</para>
@ -35,7 +35,7 @@
features, upgrade your e2fsprogs</quote>. To check if your host system
uses custom enhancements, run the following command:</para>
<screen role="nodump"><userinput>debugfs -R feature /dev/<replaceable>[xxx]</replaceable></userinput></screen>
<screen role="nodump"><userinput>debugfs -R feature /dev/<replaceable>&lt;xxx&gt;</replaceable></userinput></screen>
<para>If the output contains features other than: <option>dir_index</option>;
<option>filetype</option>; <option>large_file</option>;
@ -51,7 +51,7 @@ mkdir -v build
cd build
../configure
make #note that we intentionally don't 'make install' here!
./misc/mke2fs -v /dev/<replaceable>[xxx]</replaceable>
./misc/mke2fs -v /dev/<replaceable>&lt;xxx&gt;</replaceable>
cd /tmp
rm -rfv e2fsprogs-&e2fsprogs-version;</userinput></screen>
</note>
@ -61,9 +61,9 @@ rm -rfv e2fsprogs-&e2fsprogs-version;</userinput></screen>
If you are using an existing <systemitem class="filesystem">swap</systemitem>
partition, there is no need to format it.</para>
<screen role="nodump"><userinput>mkswap /dev/<replaceable>[yyy]</replaceable></userinput></screen>
<screen role="nodump"><userinput>mkswap /dev/<replaceable>&lt;yyy&gt;</replaceable></userinput></screen>
<para>Replace <replaceable>[yyy]</replaceable> with the name of the
<para>Replace <replaceable>&lt;yyy&gt;</replaceable> with the name of the
<systemitem class="filesystem">swap</systemitem> partition.</para>
</sect1>

View File

@ -26,9 +26,9 @@
running:</para>
<screen role="nodump"><userinput>mkdir -pv $LFS
mount -v /dev/<replaceable>[xxx]</replaceable> $LFS</userinput></screen>
mount -v /dev/<replaceable>&lt;xxx&gt;</replaceable> $LFS</userinput></screen>
<para>Replace <replaceable>[xxx]</replaceable> with the designation of the LFS
<para>Replace <replaceable>&lt;xxx&gt;</replaceable> with the designation of the LFS
partition.</para>
<para>If using multiple partitions for LFS (e.g., one for <filename
@ -36,12 +36,12 @@ mount -v /dev/<replaceable>[xxx]</replaceable> $LFS</userinput></screen>
class="directory">/usr</filename>), mount them using:</para>
<screen role="nodump"><userinput>mkdir -pv $LFS
mount -v /dev/<replaceable>[xxx]</replaceable> $LFS
mount -v /dev/<replaceable>&lt;xxx&gt;</replaceable> $LFS
mkdir -v $LFS/usr
mount -v /dev/<replaceable>[yyy]</replaceable> $LFS/usr</userinput></screen>
mount -v /dev/<replaceable>&lt;yyy&gt;</replaceable> $LFS/usr</userinput></screen>
<para>Replace <replaceable>[xxx]</replaceable> and
<replaceable>[yyy]</replaceable> with the appropriate partition
<para>Replace <replaceable>&lt;xxx&gt;</replaceable> and
<replaceable>&lt;yyy&gt;</replaceable> with the appropriate partition
names.</para>
<para>Ensure that this new partition is not mounted with permissions that

View File

@ -127,7 +127,7 @@ cd ../binutils-build</userinput></screen>
<seglistitem>
<seg>addr2line, ar, as, c++filt, gprof, ld, nm, objcopy, objdump,
ranlib, readelf, size, strings, and strip</seg>
<seg>libiberty.a, libbfd.[a,so], and libopcodes.[a,so]</seg>
<seg>libiberty.a, libbfd.{a,so}, and libopcodes.{a,so}</seg>
</seglistitem>
</segmentedlist>

View File

@ -119,7 +119,7 @@ ln -sv bzip2 /bin/bzcat</userinput></screen>
<seglistitem>
<seg>bunzip2 (link to bzip2), bzcat (link to bzip2), bzcmp, bzdiff,
bzegrep, bzfgrep, bzgrep, bzip2, bzip2recover, bzless, and bzmore</seg>
<seg>libbz2.[a,so]</seg>
<seg>libbz2.{a,so}</seg>
</seglistitem>
</segmentedlist>

View File

@ -133,7 +133,7 @@ chown -Rv root:root /usr/share/doc/db-&db-version;</userinput></screen>
<seglistitem>
<seg>db_archive, db_checkpoint, db_deadlock, db_dump, db_hotbackup,
db_load, db_printlog, db_recover, db_stat, db_upgrade, and db_verify</seg>
<seg>libdb.[so,a] and libdb_cxx.[so,a]</seg>
<seg>libdb.{so,ar}and libdb_cxx.r{o,ar}</seg>
</seglistitem>
</segmentedlist>
@ -259,7 +259,7 @@ chown -Rv root:root /usr/share/doc/db-&db-version;</userinput></screen>
<varlistentry id="libdb">
<term><filename class="libraryfile">libdb.[so,a]</filename></term>
<term><filename class="libraryfile">libdb.{so,a}</filename></term>
<listitem>
<para>Contains functions to manipulate database files from C
programs</para>
@ -270,7 +270,7 @@ chown -Rv root:root /usr/share/doc/db-&db-version;</userinput></screen>
</varlistentry>
<varlistentry id="libdb_cxx">
<term><filename class="libraryfile">libdb_cxx.[so,a]</filename></term>
<term><filename class="libraryfile">libdb_cxx.{so,a}</filename></term>
<listitem>
<para>Contains functions to manipulate database files from C++
programs</para>

View File

@ -125,8 +125,8 @@ cd build</userinput></screen>
e2image, e2label, findfs, fsck, fsck.ext2, fsck.ext3, logsave, lsattr,
mk_cmds, mke2fs, mkfs.ext2, mkfs.ext3, mklost+found, resize2fs,
tune2fs, and uuidgen.</seg>
<seg>libblkid.[a,so], libcom_err.[a,so], libe2p.[a,so],
libext2fs.[a,so], libss.[a,so], and libuuid.[a,so]</seg>
<seg>libblkid.{a,so}, libcom_err.{a,so}, libe2p.{a,so},
libext2fs.{a,so}, libss.{a,so}, and libuuid.{a,so}</seg>
</seglistitem>
</segmentedlist>

View File

@ -70,7 +70,7 @@
<seglistitem>
<seg>file</seg>
<seg>libmagic.[a,so]</seg>
<seg>libmagic.{a,so}</seg>
</seglistitem>
</segmentedlist>

View File

@ -141,7 +141,7 @@ cd ../gcc-build</userinput></screen>
<seglistitem>
<seg>c++, cc (link to gcc), cpp, g++, gcc, gccbug, and gcov</seg>
<seg>libgcc.a, libgcc_eh.a, libgcc_s.so, libstdc++.[a,so], and
<seg>libgcc.a, libgcc_eh.a, libgcc_s.so, libstdc++.{a,so}, and
libsupc++.a</seg>
</seglistitem>
</segmentedlist>

View File

@ -76,7 +76,7 @@
gettextize, hostname, msgattrib, msgcat, msgcmp, msgcomm, msgconv, msgen,
msgexec, msgfilter, msgfmt, msggrep, msginit, msgmerge, msgunfmt, msguniq,
ngettext, and xgettext</seg>
<seg>libasprintf.[a,so], libgettextlib.so, libgettextpo.[a,so], and
<seg>libasprintf.{a,so}, libgettextlib.so, libgettextpo.{a,so}, and
libgettextsrc.so</seg>
</seglistitem>
</segmentedlist>

View File

@ -271,10 +271,10 @@ EOF</userinput></screen>
<emphasis>Canada/Eastern</emphasis>). Then create the
<filename>/etc/localtime</filename> file by running:</para>
<screen><userinput>cp -v --remove-destination /usr/share/zoneinfo/<replaceable>[xxx]</replaceable> \
<screen><userinput>cp -v --remove-destination /usr/share/zoneinfo/<replaceable>$lt;xxx&gt;</replaceable> \
/etc/localtime</userinput></screen>
<para>Replace <replaceable>[xxx]</replaceable> with the name of the time zone
<para>Replace <replaceable>&lt;xxx&gt;</replaceable> with the name of the time zone
that <command>tzselect</command> provided (e.g., Canada/Eastern).</para>
<variablelist>
@ -342,13 +342,13 @@ EOF</userinput></screen>
ldd, lddlibc4, locale, localedef, mtrace, nscd, nscd_nischeck,
pcprofiledump, pt_chown, rpcgen, rpcinfo, sln, sprof, tzselect, xtrace,
zdump, and zic</seg>
<seg>ld.so, libBrokenLocale.[a,so], libSegFault.so, libanl.[a,so],
libbsd-compat.a, libc.[a,so], libcidn.so, libcrypt.[a,so], libdl.[a,so],
libg.a, libieee.a, libm.[a,so], libmcheck.a, libmemusage.so, libnsl.a,
<seg>ld.so, libBrokenLocale.{a,so}, libSegFault.so, libanl.{a,so},
libbsd-compat.a, libc.{a,so}, libcidn.so, libcrypt.{a,so}, libdl.{a,so},
libg.a, libieee.a, libm.{a,so}, libmcheck.a, libmemusage.so, libnsl.a,
libnss_compat.so, libnss_dns.so, libnss_files.so, libnss_hesiod.so,
libnss_nis.so, libnss_nisplus.so, libpcprofile.so, libpthread.[a,so],
libresolv.[a,so], librpcsvc.a, librt.[a,so], libthread_db.so, and
libutil.[a,so]</seg>
libnss_nis.so, libnss_nisplus.so, libpcprofile.so, libpthread.{a,so},
libresolv.{a,so}, librpcsvc.a, librt.{a,so}, libthread_db.so, and
libutil.{a,so}</seg>
</seglistitem>
</segmentedlist>

View File

@ -72,7 +72,7 @@
<para>Prepare Groff for compilation:</para>
<screen><userinput>PAGE=<replaceable>[paper_size]</replaceable> ./configure --prefix=/usr --enable-multibyte</userinput></screen>
<screen><userinput>PAGE=<replaceable>&lt;paper_size&gt;</replaceable> ./configure --prefix=/usr --enable-multibyte</userinput></screen>
<para>Compile the package:</para>

View File

@ -144,7 +144,7 @@
<listitem>
<para>The main executable. It has several different functions:</para>
<para><command>ip link <replaceable>[device]</replaceable></command>
<para><command>ip link <replaceable>&lt;device&gt;</replaceable></command>
allows users to look at the state of devices and to make changes</para>
<para><command>ip addr</command> allows users to look at addresses and

View File

@ -72,7 +72,7 @@
<seglistitem>
<seg>libtool and libtoolize</seg>
<seg>libltdl.[a,so]</seg>
<seg>libltdl.{a,so}</seg>
</seglistitem>
</segmentedlist>

View File

@ -296,8 +296,8 @@ install -m755 convert-mans /usr/bin</userinput></screen>
<para>If upstream distributes the manual pages in the same encoding
as Man-DB expects, the manual pages can be copied to
<filename class="directory">/usr/share/man/<replaceable>[language
code]</replaceable></filename>. E.g., French manual pages
<filename class="directory">/usr/share/man/<replaceable>&lt;language
code&gt;</replaceable></filename>. E.g., French manual pages
(<ulink url="http://ccb.club.fr/man/man-fr-1.58.0.tar.bz2"/>) can be
installed with the following command:</para>

View File

@ -165,9 +165,9 @@ cp -av lib/lib*.so.5* /usr/lib</userinput></screen>
<seglistitem>
<seg>captoinfo (link to tic), clear, infocmp, infotocap (link to tic),
reset (link to tset), tack, tic, toe, tput, and tset</seg>
<seg>libcursesw.[a,so] (symlink and linker script to libncursesw.[a,so]),
libformw.[a,so], libmenuw.[a,so], libncurses++w.a, libncursesw.[a,so],
libpanelw.[a,so] and their non-wide-character counterparts without "w"
<seg>libcursesw.{a,so} (symlink and linker script to libncursesw.{a,so}),
libformw.{a,so}, libmenuw.{a,so}, libncurses++w.a, libncursesw.{a,so},
libpanelw.{a,so} and their non-wide-character counterparts without "w"
in the library names.</seg>
</seglistitem>
</segmentedlist>

View File

@ -102,7 +102,7 @@ ln -sfv ../../lib/libhistory.so.5 /usr/lib/libhistory.so</userinput></screen>
<segtitle>Installed libraries</segtitle>
<seglistitem>
<seg>libhistory.[a,so], and libreadline.[a,so]</seg>
<seg>libhistory.{a,so}, and libreadline.{a,so}</seg>
</seglistitem>
</segmentedlist>

View File

@ -221,7 +221,7 @@ ln -sfv ../../lib/libshadow.so.0 /usr/lib/libshadow.so</userinput></screen>
logoutd, newgrp, newusers, passwd, pwck, pwconv, pwunconv, sg (link to
newgrp), su, useradd, userdel, usermod, vigr (link to vipw), and
vipw</seg>
<seg>libshadow.[a,so]</seg>
<seg>libshadow.{a,so}</seg>
</seglistitem>
</segmentedlist>

View File

@ -101,7 +101,7 @@ make</userinput></screen>
<segtitle>Installed libraries</segtitle>
<seglistitem>
<seg>libz.[a,so]</seg>
<seg>libz.{a,so}</seg>
</seglistitem>
</segmentedlist>

View File

@ -22,9 +22,9 @@
<para>Create the <filename>/etc/sysconfig/network</filename> file and enter a
hostname by running:</para>
<screen><userinput>echo "HOSTNAME=<replaceable>[lfs]</replaceable>" &gt; /etc/sysconfig/network</userinput></screen>
<screen><userinput>echo "HOSTNAME=<replaceable>&lt;lfs&gt;</replaceable>" &gt; /etc/sysconfig/network</userinput></screen>
<para><replaceable>[lfs]</replaceable> needs to be replaced with the name given
<para><replaceable>&lt;lfs&gt;</replaceable> needs to be replaced with the name given
to the computer. Do not enter the Fully Qualified Domain Name (FQDN) here. That
information will be put in the <filename>/etc/hosts</filename> file in the next
section.</para>

View File

@ -26,7 +26,7 @@
fully-qualified domain name (FQDN), and possible aliases for use in the
<filename>/etc/hosts</filename> file. The syntax is:</para>
<screen><literal>&lt;IP address&gt; myhost.example.org aliases</literal></screen>
<screen><literal>IP_address myhost.example.org aliases</literal></screen>
<para>Unless the computer is to be visible to the Internet (i.e.,
there is a registered domain and a valid block of assigned IP
@ -54,16 +54,17 @@
<literal># Begin /etc/hosts (network card version)
127.0.0.1 localhost
<replaceable>[192.168.1.1]</replaceable> <replaceable>[&lt;HOSTNAME&gt;.example.org]</replaceable> <replaceable>[HOSTNAME]</replaceable>
<replaceable>&lt;192.168.1.1&gt;</replaceable> <replaceable>&lt;HOSTNAME.example.org&gt;</replaceable> <replaceable>[alias1] [alias2 ...]</replaceable>
# End /etc/hosts (network card version)</literal>
EOF</userinput></screen>
<para>The <replaceable>[192.168.1.1]</replaceable> and
<replaceable>[&lt;HOSTNAME&gt;.example.org]</replaceable>
<para>The <replaceable>&lt;192.168.1.1&gt;</replaceable> and
<replaceable>&lt;HOSTNAME.example.org&gt;</replaceable>
values need to be changed for specific users or requirements (if
assigned an IP address by a network/system administrator and the
machine will be connected to an existing network).</para>
machine will be connected to an existing network). The optional alias
name(s) can be omitted.</para>
<para>If a network card is not going to be configured, create the
<filename>/etc/hosts</filename> file by running:</para>
@ -71,7 +72,7 @@ EOF</userinput></screen>
<screen role="nodump"><userinput>cat &gt; /etc/hosts &lt;&lt; "EOF"
<literal># Begin /etc/hosts (no network card version)
127.0.0.1 <replaceable>[&lt;HOSTNAME&gt;.example.org]</replaceable> <replaceable>[HOSTNAME]</replaceable> localhost
127.0.0.1 <replaceable>&lt;HOSTNAME.example.org&gt;</replaceable> <replaceable>&lt;HOSTNAME&gt;</replaceable> localhost
# End /etc/hosts (no network card version)</literal>
EOF</userinput></screen>

View File

@ -139,14 +139,14 @@ EOF</userinput></screen>
<screen><userinput>cat &gt; /etc/resolv.conf &lt;&lt; "EOF"
<literal># Begin /etc/resolv.conf
domain {<replaceable>[Your Domain Name]</replaceable>}
nameserver <replaceable>[IP address of your primary nameserver]</replaceable>
nameserver <replaceable>[IP address of your secondary nameserver]</replaceable>
domain {<replaceable>&lt;Your Domain Name&gt;</replaceable>}
nameserver <replaceable>&lt;IP address of your primary nameserver&gt;</replaceable>
nameserver <replaceable>&lt;IP address of your secondary nameserver&gt;</replaceable>
# End /etc/resolv.conf</literal>
EOF</userinput></screen>
<para>Replace <replaceable>[IP address of the nameserver]</replaceable>
<para>Replace <replaceable>&lt;IP address of the nameserver&gt;</replaceable>
with the IP address of the DNS most appropriate for the setup. There will
often be more than one entry (requirements demand secondary servers for
fallback capability). If you only need or want one DNS server, remove the

View File

@ -65,10 +65,10 @@
makes Bash and Readline use the <filename>/etc/inputrc</filename> file created
earlier.</para>
<para>Replace <replaceable>[ll]</replaceable> below with the two-letter code
<para>Replace <replaceable>&lt;ll&gt;</replaceable> below with the two-letter code
for the desired language (e.g., <quote>en</quote>) and
<replaceable>[CC]</replaceable> with the two-letter code for the appropriate
country (e.g., <quote>GB</quote>). <replaceable>[charmap]</replaceable> should
<replaceable>&lt;CC&gt;</replaceable> with the two-letter code for the appropriate
country (e.g., <quote>GB</quote>). <replaceable>&lt;charmap&gt;</replaceable> should
be replaced with the canonical charmap for your chosen locale. Optional
modifiers such as <quote>@euro</quote> may also be present.</para>
@ -83,11 +83,11 @@
that <quote>UTF-8</quote> is written as <quote>UTF-8</quote>, not
<quote>utf8</quote>), so it is safest in most
cases to choose the canonical name for a particular locale. To determine
the canonical name, run the following command, where <replaceable>[locale
name]</replaceable> is the output given by <command>locale -a</command> for
the canonical name, run the following command, where <replaceable>&lt;locale
name&gt;</replaceable> is the output given by <command>locale -a</command> for
your preferred locale (<quote>en_GB.iso88591</quote> in our example).</para>
<screen role="nodump"><userinput>LC_ALL=<replaceable>[locale name]</replaceable> locale charmap</userinput></screen>
<screen role="nodump"><userinput>LC_ALL=<replaceable>&lt;locale name&gt;</replaceable> locale charmap</userinput></screen>
<para>For the <quote>en_GB.iso88591</quote> locale, the above command
will print:</para>
@ -98,11 +98,11 @@
It is important that the locale found using the heuristic above is tested prior
to it being added to the Bash startup files:</para>
<screen role="nodump"><userinput>LC_ALL=[locale name] locale country
LC_ALL=[locale name] locale language
LC_ALL=[locale name] locale charmap
LC_ALL=[locale name] locale int_curr_symbol
LC_ALL=[locale name] locale int_prefix</userinput></screen>
<screen role="nodump"><userinput>LC_ALL=&lt;locale name&gt; locale country
LC_ALL=&lt;locale name&gt; locale language
LC_ALL=&lt;locale name&gt; locale charmap
LC_ALL=&lt;locale name&gt; locale int_curr_symbol
LC_ALL=&lt;locale name&gt; locale int_prefix</userinput></screen>
<para>The above commands should print the country and language names, the
character encoding used by the locale, the local currency and the prefix to dial
@ -143,7 +143,7 @@ LC_ALL=[locale name] locale int_prefix</userinput></screen>
<screen><userinput>cat &gt; /etc/profile &lt;&lt; "EOF"
<literal># Begin /etc/profile
export LANG=<replaceable>[ll]</replaceable>_<replaceable>[CC]</replaceable>.<replaceable>[charmap]</replaceable><replaceable>[@modifiers]</replaceable>
export LANG=<replaceable>&lt;ll&gt;</replaceable>_<replaceable>&lt;CC&gt;</replaceable>.<replaceable>&lt;charmap&gt;</replaceable><replaceable>&lt;@modifiers&gt;</replaceable>
export INPUTRC=/etc/inputrc
# End /etc/profile</literal>

View File

@ -38,8 +38,8 @@
6: reboot the computer</literallayout>
<para>The command used to change run-levels is <command>init
<replaceable>[runlevel]</replaceable></command>, where
<replaceable>[runlevel]</replaceable> is the target run-level. For example, to
<replaceable>&lt;runlevel&gt;</replaceable></command>, where
<replaceable>&lt;runlevel&gt;</replaceable> is the target run-level. For example, to
reboot the computer, a user could issue the <command>init 6</command> command,
which is an alias for the <command>reboot</command> command. Likewise,
<command>init 0</command> is an alias for the <command>halt</command>

View File

@ -25,8 +25,8 @@
# file system mount-point type options dump fsck
# order
/dev/<replaceable>[xxx]</replaceable> / <replaceable>[fff]</replaceable> defaults 1 1
/dev/<replaceable>[yyy]</replaceable> swap swap pri=1 0 0
/dev/<replaceable>&lt;xxx&gt;</replaceable> / <replaceable>&lt;fff&gt;</replaceable> defaults 1 1
/dev/<replaceable>&lt;yyy&gt;</replaceable> swap swap pri=1 0 0
proc /proc proc defaults 0 0
sysfs /sys sysfs defaults 0 0
devpts /dev/pts devpts gid=4,mode=620 0 0
@ -34,8 +34,8 @@ shm /dev/shm tmpfs defaults 0 0
# End /etc/fstab</literal>
EOF</userinput></screen>
<para>Replace <replaceable>[xxx]</replaceable>,
<replaceable>[yyy]</replaceable>, and <replaceable>[fff]</replaceable>
<para>Replace <replaceable>&lt;xxx&gt;</replaceable>,
<replaceable>&lt;yyy&gt;</replaceable>, and <replaceable>&lt;fff&gt;</replaceable>
with the values appropriate for the system, for example, <filename
class="partition">hda2</filename>, <filename
class="partition">hda5</filename>, and <systemitem

View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<!ENTITY version "SVN-20060413">
<!ENTITY releasedate "April 13, 2006">
<!ENTITY version "SVN-20060414">
<!ENTITY releasedate "April 14, 2006">
<!ENTITY milestone "6.2">
<!ENTITY generic-version "development"> <!-- Use "development", "testing", or "x.y[-pre{x}]" -->

View File

@ -49,10 +49,14 @@ EOF</userinput></screen>
is encountered. Therefore, this entire section is generally typed as
seen.</para>
<para><replaceable>[REPLACED TEXT]</replaceable></para>
<para><replaceable>&lt;REPLACED TEXT&gt;</replaceable></para>
<para>This format is used to encapsulate text that is not to be typed
as seen or copied-and-pasted.</para>
as seen or for copy-and-paste operations.</para>
<para><replaceable>[OPTIONAL TEXT]</replaceable></para>
<para>This format is used to encapsulate text that is optional.</para>
<para><filename>passwd(5)</filename></para>
@ -70,8 +74,8 @@ EOF</userinput></screen>
<filename>/usr/share/man/man1/passwd.1</filename>. For this example, you will
need to run <command>man 5 passwd</command> in order to read the specific page
being referred to. It should be noted that most man pages do not have duplicate
page names in different sections. Therefore, <command>man <replaceable>[program
name]</replaceable></command> is generally sufficient.</para>
page names in different sections. Therefore, <command>man <replaceable>&lt;program
name&gt;</replaceable></command> is generally sufficient.</para>
</sect1>