summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorFelix Krull <f_krull@gmx.de>2012-06-30 13:56:20 +0200
committerFelix Krull <f_krull@gmx.de>2012-06-30 13:56:20 +0200
commit160ccd12f19f096db739316e1e73754b14a7d2ca (patch)
tree6ad39d1e98f0b7231d717da49d301d490be79311 /man
parent29d56d20bc9272e892b60ccc04e6d396727e8e36 (diff)
Added manpages.
These manpages were written by Simon Chopin for the Debian project and later added to the package.
Diffstat (limited to 'man')
-rw-r--r--man/collectiongain.rst63
-rw-r--r--man/replaygain.rst65
2 files changed, 128 insertions, 0 deletions
diff --git a/man/collectiongain.rst b/man/collectiongain.rst
new file mode 100644
index 0000000..7092009
--- /dev/null
+++ b/man/collectiongain.rst
@@ -0,0 +1,63 @@
+================
+ collectiongain
+================
+
+------------------------------------------
+ large scale Replay Gain calculating tool
+------------------------------------------
+
+:Date: 2011-11-26
+:Version: 1.0
+:Manual section: 1
+:Manual group: rgain
+
+SYNOPSIS
+========
+
+| **collectiongain** [*options*] *music_dir*
+| **collectiongain** --help
+| **collectiongain** --version
+
+DESCRIPTION
+===========
+
+**collectiongain** is a script calculating the Replay Gain values of a large set of
+music files inside *music_dir*. Each audio file will be rectified against the
+other files of the same album, which are identified using the file tags.
+
+OPTIONS
+=======
+
+--version
+ Display the version of the software.
+
+-h, --help
+ Display a short summary of the available options.
+
+-f, --force
+ Recalculate Replay Gain even if the file already contains gain information.
+
+-d, --dry-run
+ Don't actually modify any files.
+
+-r REF, --reference-loudness=REF
+ Set the reference loudness to REF dB (default: 89 dB)
+
+--mp3-format=MP3_FORMAT
+ Choose the Replay Gain data format for MP3 files. Since there is no
+ commonly accepted standard for Replay Gain in MP3 files, you need to choose.
+ Possible formats are :
+
+ - *ql* (used by **Quod Libet**). This is the default value.
+ - *fb2k* (read and written by **foobar2000**, also understood by **Quod Libet**)
+ - *mp3gain* (tags as written by the **mp3gain** program; this doesn't modify the
+ MP3 audio data as said program does).
+
+--ignore-cache
+ Don't trust implicit assumptions about what was already done, instead check
+ all files for Replay Gain data explicitly.
+
+SEE ALSO
+========
+
+**replaygain(1)**
diff --git a/man/replaygain.rst b/man/replaygain.rst
new file mode 100644
index 0000000..bbde157
--- /dev/null
+++ b/man/replaygain.rst
@@ -0,0 +1,65 @@
+============
+ replaygain
+============
+
+--------------------------------
+ single file Replay Gain editor
+--------------------------------
+
+:Date: 2011-11-26
+:Version: 1.0
+:Manual section: 1
+:Manual group: rgain
+
+SYNOPSIS
+========
+
+| **replaygain** [*options*] *AUDIO_FILE* [*AUDIO_FILE* ...]
+| **replaygain** --help
+| **replaygain** --version
+
+DESCRIPTION
+===========
+
+**replaygain** applies or displays Replay Gain information for audio files.
+
+OPTIONS
+=======
+
+--version
+ Display the version of the software.
+
+-h, --help
+ Display a short documentation.
+
+-f, --force
+ Recalculate Replay Gain even if the file already contains gain information.
+
+-d, --dry-run
+ Don't actually modify any files.
+
+-r REF, --reference-loudness=REF
+ Set the reference loudness to REF dB (default: 89 dB)
+
+--mp3-format=MP3_FORMAT
+ Choose the Replay Gain data format for MP3 files. Since there is no
+ commonly accepted standard for Replay Gain in MP3 files, you need to choose.
+ Possible formats are :
+
+ - *ql* (used by **Quod Libet**). This is the default value.
+ - *fb2k* (read and written by **foobar2000**, also understood by **Quod Libet**)
+ - *mp3gain* (tags as written by the **mp3gain** program; this doesn't modify the
+ MP3 audio data as said program does).
+
+--no-album
+ Don't write any album gain information.
+
+--show
+ Don't calculate anything, simply show Replay Gain information for the
+ specified files. In this mode, all options other than **--mp3-format**
+ are ignored.
+
+SEE ALSO
+========
+
+**collectiongain(1)**