docs/134763: [Handbook] Varying filename example is not included in <replaceable> element

Benedict Reuschling bcr at doc.bsdgroup.de
Wed May 20 20:00:07 UTC 2009


>Number:         134763
>Category:       docs
>Synopsis:       [Handbook] Varying filename example is not included in <replaceable> element
>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:   Wed May 20 20:00:07 UTC 2009
>Closed-Date:
>Last-Modified:
>Originator:     Benedict Reuschling
>Release:        FreeBSD 7.2-STABLE
>Organization:
The FreeBSD German Documentation Project
>Environment:
FreeBSD atlantis.reuschling.org 7.2-STABLE FreeBSD 7.2-STABLE #19: Mon May  4 20:19:52 CEST 2009     root at atlantis.reuschling.org:/tank/obj/usr/src/sys/ATLANTIS  i386
>Description:
The multimedia-section in the FreeBSD handbook about MP3 Audio lists the following example:

<screen>&prompt.root; <userinput>mpg123 -a <replaceable>/dev/dsp1.0</replaceable> Foobar-GreatestHits.mp3</userinput> ...

Since "Foobar-GreatestHits.mp3" can be replaced by other filenames, it should be included in the preceding <replaceable> element.
>How-To-Repeat:
Look at the handbook section "7.3.1 MP3 Players" of doc/en_US.ISO8859-1/books/handbook/sound-mp3.html and guess what other .mp3 files you could use instead of Foobar-GreatestHits.mp3 :-) 
Therefore, it is a <replaceable> filename and should be typeset accordingly. 
>Fix:
Apply the attached patch that moves the "Foobar-GreatestHits.mp3" within the <replaceable> element.

Patch attached with submission follows:

--- chapter1.131.sgml	2009-05-20 21:37:07.628706721 +0200
+++ chapter.sgml	2009-05-20 21:40:03.750229988 +0200
@@ -483,7 +483,7 @@
 	the sound device and the MP3 file on the command line, as
 	shown below:</para>
 
-      <screen>&prompt.root; <userinput>mpg123 -a <replaceable>/dev/dsp1.0</replaceable> Foobar-GreatestHits.mp3</userinput>
+      <screen>&prompt.root; <userinput>mpg123 -a <replaceable>/dev/dsp1.0 Foobar-GreatestHits.mp3</replaceable></userinput>
 High Performance MPEG 1.0/2.0/2.5 Audio Player for Layer 1, 2 and 3.
 Version 0.59r (1999/Jun/15). Written and copyrights by Michael Hipp.
 Uses code from various people. See 'README' for more!


>Release-Note:
>Audit-Trail:
>Unformatted:



More information about the freebsd-doc mailing list