[xiph-commits] r9022 - in trunk/vorbis-tools/oggenc: . man

[msmith at motherfish-iii.xiph.org]

Author: msmith
Date: 2005-03-02 22:49:19 -0800 (Wed, 02 Mar 2005)
New Revision: 9022

Modified:
   trunk/vorbis-tools/oggenc/man/oggenc.1
   trunk/vorbis-tools/oggenc/oggenc.c
Log:
Update some point in the manpage.
Briefly document --advanced-encode-option in the --help text.


Modified: trunk/vorbis-tools/oggenc/man/oggenc.1
===================================================================
--- trunk/vorbis-tools/oggenc/man/oggenc.1	2005-03-03 06:32:04 UTC (rev 9021)
+++ trunk/vorbis-tools/oggenc/man/oggenc.1	2005-03-03 06:49:19 UTC (rev 9022)
@@ -1,7 +1,7 @@
 .\" Process this file with
 .\" groff -man -Tascii oggenc.1
 .\"
-.TH oggenc 1 "2003 December 30" "Xiph.org Foundation" "Vorbis Tools"
+.TH oggenc 1 "2005 March 3" "Xiph.org Foundation" "Vorbis Tools"
 
 .SH NAME
 oggenc \- encode audio into the Ogg Vorbis format
@@ -106,6 +106,8 @@
 .SH OPTIONS
 .IP "-h, --help"
 Show command help.
+.IP "-v, --version"
+Show the version number.
 .IP "-r, --raw"
 Assume input data is raw little-endian audio data with no
 header information. If other options are not specified, defaults to 44.1kHz
@@ -122,11 +124,11 @@
 .IP "-Q, --quiet"
 Quiet mode.  No messages are displayed.
 .IP "-b n, --bitrate=n"
-Sets encoding to the bitrate closest to n (in kb/s).
+Sets target bitrate to n (in kb/s). The encoder will attempt to encode at approximately this bitrate. By default, this remains a VBR encoding. See the --managed option to force a managed bitrate encoding at the selected bitrate.
 .IP "-m n, --min-bitrate=n"
-Sets minimum bitrate to n (in kb/s).
+Sets minimum bitrate to n (in kb/s). Enables bitrate management mode (see --managed).
 .IP "-M n, --max-bitrate=n"
-Sets maximum bitrate to n (in kb/s).
+Sets maximum bitrate to n (in kb/s). Enables bitrate management mode (see --managed).
 .IP "--managed"
 Set bitrate management mode. This turns off the normal VBR encoding, but allows
 hard or soft bitrate constraints to be enforced by the encoder. This mode is
@@ -156,6 +158,10 @@
 Produce filenames as this string, with %g, %a, %l, %n, %t, %d replaced by
 genre, artist, album, track number, title, and date, respectively (see below
 for specifying these). Also, %% gives a literal %.
+.IP "-X, --name-remove=s"
+Remove the specified characters from parameters to the -n format string. This is useful to ensure legal filenames are generated.
+.IP "-P, --name-replace=s"
+Replace characters removed by --name-remove with the characters specified. If this string is shorter than the --name-remove list, or is not specified, the extra characters are just removed. The default settings for this option, and the -X option above, are platform specific (and chosen to ensure legal filenames are generated for each platform).
 
 .IP "-c comment, --comment comment"
 Add the string

Modified: trunk/vorbis-tools/oggenc/oggenc.c
===================================================================
--- trunk/vorbis-tools/oggenc/oggenc.c	2005-03-03 06:32:04 UTC (rev 9021)
+++ trunk/vorbis-tools/oggenc/oggenc.c	2005-03-03 06:49:19 UTC (rev 9022)
@@ -409,6 +409,12 @@
 		" -M, --max-bitrate    Specify a maximum bitrate in kbps. Useful for\n"
 		"                      streaming applications. Using this will automatically\n"
         "                      enable managed bitrate mode (see --managed).\n"
+        " --advanced-encode-option option=value\n"
+        "                      Sets an advanced encoder option to the given value.\n"
+        "                      The valid options (and their values) are documented\n"
+        "                      in the man page supplied with this program. They are\n"
+        "                      for advanced users only, and should be used with\n"
+        "                      caution.\n"
 		" -q, --quality        Specify quality between 0 (low) and 10 (high),\n"
 		"                      instead of specifying a particular bitrate.\n"
 		"                      This is the normal mode of operation.\n"