diff options
Diffstat (limited to 'subprojects/shared-modules/vorbisgain/0003-manpage.patch')
| -rw-r--r-- | subprojects/shared-modules/vorbisgain/0003-manpage.patch | 248 |
1 files changed, 248 insertions, 0 deletions
diff --git a/subprojects/shared-modules/vorbisgain/0003-manpage.patch b/subprojects/shared-modules/vorbisgain/0003-manpage.patch new file mode 100644 index 00000000..8aaeaf1c --- /dev/null +++ b/subprojects/shared-modules/vorbisgain/0003-manpage.patch @@ -0,0 +1,248 @@ +Description: Man page says --silent, should be --skip +From: http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=355783 +Forwarded: no +--- + vorbisgain.1 | 60 ++++++++++++----------------------------------------------- + 1 file changed, 13 insertions(+), 47 deletions(-) + +--- a/vorbisgain.1 ++++ b/vorbisgain.1 +@@ -2,10 +2,8 @@ + .\" groff -man -Tascii vorbisgain.1 + .\" + .TH vorbisgain 1 "2004 Jan 3" "" "VorbisGain" +- + .SH NAME + vorbisgain \- calculate the replay gain for Ogg Vorbis files +- + .SH SYNOPSIS + .B vorbisgain + [ +@@ -16,7 +14,6 @@ + .I album gain + ] + .I input_files \fR... +- + .SH DESCRIPTION + .B vorbisgain + calculates the ReplayGain values for the named Ogg Vorbis input files and +@@ -27,7 +24,6 @@ + uses a default target level of 89 dB, rather than the 83 dB recommended by the + ReplayGain standard, when calculating the gain to apply. (Some players include + a pre-amplification setting with which the target level can be changed.) +- + .PP + .B vorbisgain + input files must be Ogg Vorbis I files with 1 or 2 channels and a sample rate +@@ -35,21 +31,16 @@ + kHz. If an input file contains multiple streams (i.e., it is chained), the + streams must all have the same format, in terms of sampling frequency and + number of channels. +- + .PP + All streams in a chained file are processed, but the ReplayGain tags are + only written to (or removed from) the first stream. +- + .SH OPTIONS +- + .IP "-h, --help" + Show command help. +- + .IP "-a, --album" + Activates album mode, in which the album gain (sometimes called the audiophile + gain) is calculated in addition to the track gain (sometimes called the radio + gain). +- + .IP "-g n, --album-gain=n" + Sets the album gain value to use. Default is to calculate it, if + .I -a +@@ -59,38 +50,31 @@ + dB, specifying the + .B change + in volume that should be applied. +- + .IP "-c, --clean" + Remove any ReplayGain tags from the specified files. If a file does not + contain any ReplayGain tags, the file is not modified. +- + .IP "-C, --convert" + Convert old format ReplayGain tags to a new format (see section TAG FORMAT + below for details). If a file does not contain all ReplayGain tags that are + needed for a conversion, the file is not modified. The album peak tag is + only created if + .I -a +-is specified, and the album gain value is then checked for concistency. ++is specified, and the album gain value is then checked for consistency. + Otherwise any album gain is converted without any checks. +- + .IP "-d, --display-only" + Display the result only; do not write anything to disk. This applies to all + options. +- + .IP "-f, --fast" + Only calculate the gain for files that do not contain all replay gain tags + needed (the album gain and peak tags are only considered if + .I -a + has been specified). +- + .IP "-n, --no-progress" + Only display results, but don't show progress in percentages and times. This + can be useful if the output is piped into other programs. +- + .IP "-q, --quiet" + Do not display any output while processing. Only error and warning messages will + be printed. +- + .IP "-r, --recursive" + Enter directories (recursively) and search for files, if directories or file + patterns are specified. +@@ -98,65 +82,51 @@ + Only available if + .B vorbisgain + was configured with --enable-recursive. +- +-.IP "-s, --silent" +-Sliently skip any non-Vorbis files found. Vorbis files that can't be processed ++.IP "-s, --skip" ++Silently skip any non-Vorbis files found. Vorbis files that can't be processed + for some reason are skipped as well, though not silently. Default is to stop + when such files are encountered. +- + .IP "-v, --version" + Display the version of the program. +- + .SH EXAMPLES +- + Simplest version. Calculate the track gain and peak only. + .PP + .RS + vorbisgain somefile.ogg + .RE +- + .PP + Note that the following examples are only possible if + .B vorbisgain + was configured with --enable-recursive. +- + .PP + Calculate the album gain and peak, in addition to the track gain and peak, for + all .ogg files in the directory "music" (and all subdirectories). All files in + one directory are treated as belonging to the same album. Files that already + have ReplayGain tags are not re-calculated. Note the quotes, as they cause the + shell to not do any filename globbing: +- + .PP + .RS + vorbisgain -a -f -r "music/*.ogg" + .RE +- + .PP + Calculate the album gain. The files specified before the directory "album" + are treated as one album, the files in the directory "album" as another + album and the remaining files as a third album: +- + .PP + .RS + vorbisgain -a -r a.ogg b.ogg c.ogg album d.ogg e.ogg f.ogg + .RE +- + .PP + Remove all replaygain tags from a collection of oggs: +- + .PP + .RS + vorbisgain -c -r "music/*.ogg" + .RE +- + .SH TAG FORMAT +- + .B vorbisgain + creates tags like these (when in + .I -a + mode): +- + .PP + .RS + REPLAYGAIN_TRACK_GAIN=-7.03 dB +@@ -170,18 +140,15 @@ + .RS + REPLAYGAIN_ALBUM_PEAK=1.21822226 + .RE +- + .PP + Gain specifies how much the volume should be changed before playback, in dB. + Peak is the maximum sample value of the file before any gain has been + applied, where 1.0 means "full sample value" (32,767 when decoding to signed + 16 bit samples). +- + .PP + Earlier versions of + .B vorbisgain + (before 0.30) created the following tags: +- + .PP + .RS + RG_RADIO +@@ -192,7 +159,6 @@ + .RS + RG_AUDIOPHILE + .RE +- + .PP + When + .I -c +@@ -200,44 +166,44 @@ + REPLAYGAIN_TRACK_PEAK, RG_AUDIOPHILE to REPLAYGAIN_ALBUM_GAIN and + REPLAYGAIN_ALBUM_PEAK is calculated as the maximum of all RG_PEAK tags in + the album. +- + .SH AUTHORS +- + .TP + Program Code: + .br + Gian-Carlo Pascutto <gcp@sjeng.org> + .br + Magnus Holmgren <lear@algonet.se> +- + .TP + ReplayGain Analysis Code: + .br + Glen Sawyer <glensawyer@hotmail.com> + .br + Frank Klemm (http://www.uni-jena.de/~pfk/) +- + .TP + Man Page: + .br + Magnus Holmgren <lear@algonet.se> +- + .SH BUGS +- + None known. +- + .SH SEE ALSO +- + .TP + http://sjeng.org/vorbisgain.html + Home page for VorbisGain. The latest version, and a Windows executable, + can be found here. +- + .TP + http://www.replaygain.org/ + Contains detailed information about ReplayGain and how it is calculated. +- + .TP + http://www.hydrogenaudio.org/ + Discussion forum for audio compression and related issues, including Ogg + Vorbis and VorbisGain. ++.SH NOTE ++The version of vorbisgain packaged for Debian differs in two ways from ++the upstream version. First, it does not retain the modification time ++of the input file: if tags are changed in a file, the mtime will change. ++Second, it does not try to process wildcards in filenames. This makes ++it impossible to say "process all foo*.ogg in all subdirectories", but ++also avoids problems with filenames that actually contain wildcards. ++Without this change, "vorbisgain *.ogg" in a directory with a file that ++contains a question mark would result in that file being treated as ++being in a different album. |