docs/123150: [patch] Add missing <replaceable> tags to Handbook Chapter 9
Gabor PALI
pgj at FreeBSD.org
Sun Apr 27 21:30:03 UTC 2008
>Number: 123150
>Category: docs
>Synopsis: [patch] Add missing <replaceable> tags to Handbook Chapter 9
>Confidential: no
>Severity: non-critical
>Priority: low
>Responsible: freebsd-doc
>State: open
>Quarter:
>Keywords:
>Date-Required:
>Class: doc-bug
>Submitter-Id: current-users
>Arrival-Date: Sun Apr 27 21:30:03 UTC 2008
>Closed-Date:
>Last-Modified:
>Originator: Gabor PALI
>Release: FreeBSD 6.3-STABLE i386
>Organization:
>Environment:
System: FreeBSD disznohal 6.3-STABLE FreeBSD 6.3-STABLE #4: Fri Apr 4 23:29:43 CEST 2008 dezzy at disznohal:/usr/obj/usr/src/sys/GENERIC_ i386
>Description:
<replaceable> tags are missing from the FreeBSD Handbook, Chapter
9 (Printing) in some cases. I think file names corrected by this
patch are just examples, so they should be replaceable.
>How-To-Repeat:
>Fix:
Apply this patch:
--- printing.patch.2.diff begins here ---
Index: chapter.sgml
===================================================================
RCS file: /doc/en_US.ISO8859-1/books/handbook/printing/chapter.sgml,v
retrieving revision 1.112
diff -u -r1.112 chapter.sgml
--- chapter.sgml 13 Apr 2008 15:13:45 -0000 1.112
+++ chapter.sgml 27 Apr 2008 21:06:32 -0000
@@ -1913,8 +1913,8 @@
<programlisting>:if=/usr/local/libexec/ifhp:</programlisting>
- <para>That is it. You can type <command>lpr plain.text</command> and
- <filename>lpr whatever.ps</filename> and both should print
+ <para>That is it. You can type <command>lpr <replaceable>plain.text</replaceable></command> and
+ <filename>lpr <replaceable>whatever.ps</replaceable></filename> and both should print
successfully.</para>
</sect3>
@@ -1940,8 +1940,8 @@
we convert the DVI file into &postscript;. The command sequence
goes like this:</para>
- <screen>&prompt.user; <userinput>dvips seaweed-analysis.dvi</userinput>
-&prompt.user; <userinput>lpr seaweed-analysis.ps</userinput></screen>
+ <screen>&prompt.user; <userinput>dvips <replaceable>seaweed-analysis.dvi</replaceable></userinput>
+&prompt.user; <userinput>lpr <replaceable>seaweed-analysis.ps</replaceable></userinput></screen>
<para>By installing a conversion filter for DVI files, we can skip
the hand conversion step each time by having
@@ -1949,7 +1949,7 @@
Now, each time we get a DVI file, we are just one step away from
printing it:</para>
- <screen>&prompt.user; <userinput>lpr -d seaweed-analysis.dvi</userinput></screen>
+ <screen>&prompt.user; <userinput>lpr -d <replaceable>seaweed-analysis.dvi</replaceable></userinput></screen>
<para>We got <application>LPD</application> to do the DVI file
conversion for us by specifying
@@ -3076,7 +3076,7 @@
<literal>rattan</literal> and <literal>bamboo</literal>. If, for
example, a user on <hostid>orchid</hostid> typed:</para>
- <screen>&prompt.user; <userinput>lpr -P bamboo -d sushi-review.dvi</userinput></screen>
+ <screen>&prompt.user; <userinput>lpr -P bamboo -d <replaceable>sushi-review.dvi</replaceable></userinput></screen>
<para>the <application>LPD</application> system on <hostid>orchid</hostid>
would copy the job to the spooling
@@ -3248,7 +3248,7 @@
multiple times, or from submitting the same file multiple times in
one job like this:</para>
- <screen>&prompt.user; <userinput>lpr forsale.sign forsale.sign forsale.sign forsale.sign forsale.sign</userinput></screen>
+ <screen>&prompt.user; <userinput>lpr <replaceable>forsale.sign forsale.sign forsale.sign forsale.sign forsale.sign</replaceable></userinput></screen>
<para>There are many ways to prevent this abuse (including ignoring
it) which you are free to explore.</para>
@@ -4014,7 +4014,7 @@
available from other hosts. The following command sequence
demonstrates this:</para>
- <screen>&prompt.user; <userinput>lpr -P rattan myfile</userinput>
+ <screen>&prompt.user; <userinput>lpr -P rattan <replaceable>myfile</replaceable></userinput>
&prompt.user; <userinput>rlogin orchid</userinput>
&prompt.user; <userinput>lpq -P rattan</userinput>
Rank Owner Job Files Total Size
@@ -4048,10 +4048,10 @@
<indexterm><primary>&tex;</primary></indexterm>
<para>For example, the following command prints a DVI file (from the
- &tex; typesetting system) named <filename>fish-report.dvi</filename>
+ &tex; typesetting system) named <filename><replaceable>fish-report.dvi</replaceable></filename>
to the printer named <literal>bamboo</literal>:</para>
- <screen>&prompt.user; <userinput>lpr -P bamboo -d fish-report.dvi</userinput></screen>
+ <screen>&prompt.user; <userinput>lpr -P bamboo -d <replaceable>fish-report.dvi</replaceable></userinput></screen>
<para>These options apply to every file in the job, so you cannot mix
(say) DVI and ditroff files together in a job. Instead, submit the
--- printing.patch.2.diff ends here ---
>Release-Note:
>Audit-Trail:
>Unformatted:
More information about the freebsd-doc
mailing list