Date: Sun, 27 Apr 2008 08:55:01 +0200 From: "Gabor PALI" <pgj@FreeBSD.org> To: FreeBSD-gnats-submit@FreeBSD.org Subject: docs/123132: [patch] Fix <replaceable> tags in Handbook Chapter 7 (Multimedia) Message-ID: <48142348.09b6660a.4af1.03e1@mx.google.com> Resent-Message-ID: <200804270700.m3R701WM080429@freefall.freebsd.org>
next in thread | raw e-mail | index | archive | help
>Number: 123132
>Category: docs
>Synopsis: [patch] Fix <replaceable> tags in Handbook Chapter 7 (Multimedia)
>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 07:00:01 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@disznohal:/usr/obj/usr/src/sys/GENERIC_ i386
>Description:
I found the <replaceable> tags in Chapter 7 (``Multimedia'') of the
FreeBSD Handbook are used in an unconsistent manner, so I created a
patch for this.
>How-To-Repeat:
>Fix:
Here it goes:
--- multimedia.patch.diff begins here ---
Index: chapter.sgml
===================================================================
RCS file: /doc/en_US.ISO8859-1/books/handbook/multimedia/chapter.sgml,v
retrieving revision 1.128
diff -u -r1.128 chapter.sgml
--- chapter.sgml 9 Aug 2007 09:09:26 -0000 1.128
+++ chapter.sgml 27 Apr 2008 06:40:23 -0000
@@ -293,7 +293,7 @@
<screen>&prompt.user; <userinput>cat <replaceable>filename</replaceable> > /dev/dsp</userinput></screen>
- <para>where <replaceable>filename</replaceable> can be any file.
+ <para>where <filename><replaceable>filename</replaceable></filename> can be any file.
This command line should produce some noise, confirming the
sound card is actually working.</para>
@@ -494,7 +494,7 @@
MPEG 1.0 layer III, 128 kbit/s, 44100 Hz joint-stereo
</screen>
- <para><literal>/dev/dsp1.0</literal> should be replaced with the
+ <para><devicename><replaceable>/dev/dsp1.0</replaceable></devicename> should be replaced with the
<devicename>dsp</devicename> device entry on your system.</para>
</sect2>
@@ -556,8 +556,8 @@
<filename role="package">audio/lame</filename> in the ports tree.</para>
<para>Using the ripped WAV files, the following command will
- convert <filename>audio01.wav</filename> to
- <filename>audio01.mp3</filename>:</para>
+ convert <filename><replaceable>audio01.wav</replaceable></filename> to
+ <filename><replaceable>audio01.mp3</replaceable></filename>:</para>
<screen>&prompt.root; <userinput>lame -h -b <replaceable>128</replaceable> \
--tt "<replaceable>Foo Song Title</replaceable>" \
@@ -644,7 +644,7 @@
<procedure>
<step>
<para>Run <command>mpg123 -s <replaceable>audio01.mp3</replaceable>
- > audio01.pcm</command></para>
+ > <replaceable>audio01.pcm</replaceable></command></para>
</step>
</procedure>
@@ -1069,18 +1069,18 @@
through one of the various video interfaces set the
<option>-vo</option> option:</para>
- <screen>&prompt.user; <userinput>mplayer -vo xv testfile.avi</userinput></screen>
- <screen>&prompt.user; <userinput>mplayer -vo sdl testfile.avi</userinput></screen>
- <screen>&prompt.user; <userinput>mplayer -vo x11 testfile.avi</userinput></screen>
- <screen>&prompt.root; <userinput>mplayer -vo dga testfile.avi</userinput></screen>
- <screen>&prompt.root; <userinput>mplayer -vo 'sdl:dga' testfile.avi</userinput></screen>
+ <screen>&prompt.user; <userinput>mplayer -vo xv <replaceable>testfile.avi</replaceable></userinput></screen>
+ <screen>&prompt.user; <userinput>mplayer -vo sdl <replaceable>testfile.avi</replaceable></userinput></screen>
+ <screen>&prompt.user; <userinput>mplayer -vo x11 <replaceable>testfile.avi</replaceable></userinput></screen>
+ <screen>&prompt.root; <userinput>mplayer -vo dga <replaceable>testfile.avi</replaceable></userinput></screen>
+ <screen>&prompt.root; <userinput>mplayer -vo 'sdl:dga' <replaceable>testfile.avi</replaceable></userinput></screen>
<para>It is worth trying all of these options, as their relative
performance depends on many factors and will vary significantly
with hardware.</para>
<para>To play from a DVD, replace the
- <filename>testfile.avi</filename> with <option>dvd://<replaceable>N</replaceable> -dvd-device
+ <filename><replaceable>testfile.avi</replaceable></filename> with <option>dvd://<replaceable>N</replaceable> -dvd-device
<replaceable>DEVICE</replaceable></option> where <replaceable>N</replaceable> is
the title number to play and
<filename><replaceable>DEVICE</replaceable></filename> is the
@@ -1141,7 +1141,7 @@
or bad performance. Here are a couple of examples to get
you going. First a simple copy:</para>
- <screen>&prompt.user; <userinput>mencoder input.avi -oac copy -ovc copy -o output.avi</userinput></screen>
+ <screen>&prompt.user; <userinput>mencoder <replaceable>input.avi</replaceable> -oac copy -ovc copy -o <replaceable>output.avi</replaceable></userinput></screen>
<para>Improper combinations of command line options can yield
output files that are
@@ -1149,16 +1149,16 @@
just want to rip to a file, stick to the <option>-dumpfile</option>
in <command>mplayer</command>.</para>
- <para>To convert <filename>input.avi</filename> to the MPEG4
+ <para>To convert <filename><replaceable>input.avi</replaceable></filename> to the MPEG4
codec with MPEG3 audio encoding (<filename role="package">audio/lame</filename> is required):</para>
- <screen>&prompt.user; <userinput>mencoder input.avi -oac mp3lame -lameopts br=192 \
- -ovc lavc -lavcopts vcodec=mpeg4:vhq -o output.avi</userinput></screen>
+ <screen>&prompt.user; <userinput>mencoder <replaceable>input.avi</replaceable> -oac mp3lame -lameopts br=192 \
+ -ovc lavc -lavcopts vcodec=mpeg4:vhq -o <replaceable>output.avi</replaceable></userinput></screen>
<para>This has produced output playable by <command>mplayer</command>
and <command>xine</command>.</para>
- <para><filename>input.avi</filename> can be replaced with
+ <para><filename><replaceable>input.avi</replaceable></filename> can be replaced with
<option>dvd://1 -dvd-device /dev/dvd</option> and run as
<username>root</username> to re-encode a DVD title
directly. Since you are likely to be dissatisfied with
@@ -1202,7 +1202,7 @@
<para>Alternatively, it may be invoked to play a file immediately
without the GUI with the command:</para>
- <screen>&prompt.user; <userinput>xine -g -p mymovie.avi</userinput></screen>
+ <screen>&prompt.user; <userinput>xine -g -p <replaceable>mymovie.avi</replaceable></userinput></screen>
</sect3>
@@ -1230,11 +1230,11 @@
example to show how to convert a DivX file into a PAL MPEG-1
file (PAL VCD):</para>
- <screen>&prompt.user; <userinput>transcode -i input.avi -V --export_prof vcd-pal -o output_vcd</userinput>
-&prompt.user; <userinput>mplex -f 1 -o output_vcd.mpg output_vcd.m1v output_vcd.mpa</userinput></screen>
+ <screen>&prompt.user; <userinput>transcode -i <replaceable>input.avi</replaceable> -V --export_prof vcd-pal -o output_vcd</userinput>
+&prompt.user; <userinput>mplex -f 1 -o <replaceable>output_vcd.mpg output_vcd.m1v output_vcd.mpa</replaceable></userinput></screen>
<para>The resulting MPEG file,
- <filename>output_vcd.mpg</filename>, is ready to be played with
+ <filename><replaceable>output_vcd.mpg</replaceable></filename>, is ready to be played with
<application>MPlayer</application>. You could even burn the
file on a CD-R media to create a Video CD, in this case you will
need to install and use both <filename
@@ -1728,7 +1728,7 @@
example, our USB scanner uses the device node
<filename>/dev/uscanner0</filename> which is owned by the
<groupname>operator</groupname> group. Adding the user
- <username>joe</username> to the
+ <username><replaceable>joe</replaceable></username> to the
<groupname>operator</groupname> group will allow him to use
the scanner:</para>
--- multimedia.patch.diff ends here ---
>Release-Note:
>Audit-Trail:
>Unformatted:
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?48142348.09b6660a.4af1.03e1>