test/*.sh : Fix MALLOC_PERTURB initialization.
[platform/upstream/flac.git] / man / metaflac.1
index 11bd6c6..d5a71fc 100644 (file)
@@ -3,7 +3,7 @@
 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
 .\" Please send any bug reports, improvements, comments, patches, 
 .\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "METAFLAC" "1" "09 October 2006" "" ""
+.TH "METAFLAC" "1" "2013/04/30" "" ""
 
 .SH NAME
 metaflac \- program to list, add, remove, or edit metadata in one or more FLAC files.
@@ -29,6 +29,10 @@ more than one FLAC file is specified).
 Do not prefix each output line with the FLAC file name (the default
 if only one FLAC file is specified).
 .TP
+\fB--no-utf8-convert\fR
+Do not convert tags from UTF-8 to local charset, or vice versa. This is
+useful for scripts, and setting tags in situations where the locale is wrong.
+.TP
 \fB--dont-use-padding\fR
 By default metaflac tries to use padding where possible to avoid
 rewriting the entire file if the metadata size changes.  Use this
@@ -96,10 +100,11 @@ that.
 Import tags from a file.  Use '-' for stdin.  Each
 line should be of the form NAME=VALUE.  Multi-line comments
 are currently not supported.  Specify --remove-all-tags and/or
---no-utf8-convert before --import-tags-from if necessary.
+--no-utf8-convert before --import-tags-from if necessary.  If
+FILE is '-' (stdin), only one FLAC file may be specified.
 .TP
 \fB--export-tags-to=file\fR
-Export tags to a file.  Use '-' for stdin.  Each
+Export tags to a file.  Use '-' for stdout.  Each
 line will be of the form NAME=VALUE.  Specify
 --no-utf8-convert if necessary.
 .TP
@@ -114,10 +119,10 @@ Export CUESHEET block to a cuesheet file, suitable for use by
 CD authoring software.  Use '-' for stdout.  Only one FLAC file
 may be specified on the command line.
 .TP
-\fB--import-picture=\fISPECIFICATION\fB\fR
-Import a picture and store it in a PICTURE metadata block.  More than one --import-picture command can be specified.  The SPECIFICATION is a string whose parts are separated by | (pipe) characters.  Some parts may be left empty to invoke default values.  The format of SPECIFICATION is
+\fB--import-picture-from={\fIFILENAME\fB|\fISPECIFICATION\fB}\fR
+Import a picture and store it in a PICTURE metadata block.  More than one --import-picture-from command can be specified.  Either a filename for the picture file or a more complete specification form can be used.  The SPECIFICATION is a string whose parts are separated by | (pipe) characters.  Some parts may be left empty to invoke default values.  FILENAME is just shorthand for "||||FILENAME".  The format of SPECIFICATION is
 
-[TYPE]|MIME-TYPE|[DESCRIPTION]|[WIDTHxHEIGHTxDEPTH[/COLORS]]|FILE
+[TYPE]|[MIME-TYPE]|[DESCRIPTION]|[WIDTHxHEIGHTxDEPTH[/COLORS]]|FILE
 
 TYPE is optional; it is a number from one of:
 
@@ -165,7 +170,7 @@ TYPE is optional; it is a number from one of:
 
 The default is 3 (front cover).  There may only be one picture each of type 1 and 2 in a file.
 
-MIME-TYPE is mandatory; for best compatibility with players, use pictures with MIME type image/jpeg or image/png.  The MIME type can also be --> to mean that FILE is actually a URL to an image, though this use is discouraged.
+MIME-TYPE is optional; if left blank, it will be detected from the file.  For best compatibility with players, use pictures with MIME type image/jpeg or image/png.  The MIME type can also be --> to mean that FILE is actually a URL to an image, though this use is discouraged.
 
 DESCRIPTION is optional; the default is an empty string.
 
@@ -177,10 +182,13 @@ For example, "|image/jpeg|||../cover.jpg" will embed the JPEG file at ../cover.j
 
 The specification "4|-->|CD|320x300x24/173|http://blah.blah/backcover.tiff" will embed the given URL, with type 4 (back cover), description "CD", and a manually specified resolution of 320x300, 24 bits-per-pixel, and 173 colors.  The file at the URL will not be fetched; the URL itself is stored in the PICTURE metadata block.
 .TP
+\fB--export-picture-to=file\fR
+Export PICTURE block to a file.  Use '-' for stdout.  Only one FLAC file may be specified on the command line.  The first PICTURE block will be exported unless --export-picture-to is preceded by a --block-number=# option to specify the exact metadata block to extract.  Note that the block number is the one shown by --list.
+.TP
 \fB--add-replay-gain\fR
 Calculates the title and album gains/peaks of the given FLAC
 files as if all the files were part of one album, then stores
-them in the VORBIS_COMMENT block.  The tags are the same as
+them as FLAC tags.  The tags are the same as
 those used by vorbisgain.  Existing ReplayGain tags will be
 replaced.  If only one FLAC file is given, the album and title
 gains will be the same.  Since this operation requires two
@@ -188,7 +196,8 @@ passes, it is always executed last, after all other operations
 have been completed and written to disk.  All FLAC files
 specified must have the same resolution, sample rate, and
 number of channels.  The sample rate must be one of 8, 11.025,
-12, 16, 22.05, 24, 32, 44.1, or 48 kHz.
+12, 16, 18.9, 22.05, 24, 28, 32, 37.8, 44.1, 48, 56, 64, 88.2,
+96, 112, 128, 144, 176.4, or 192kHz.
 .TP
 \fB--remove-replay-gain\fR
 Removes the ReplayGain tags.
@@ -230,8 +239,8 @@ The first block, the STREAMINFO block, is block 0.
 An optional comma-separated list of block types to be included
 or ignored with this option.  Use only one of --block-type or
 --except-block-type.  The valid block types are: STREAMINFO,
-PADDING, APPLICATION, SEEKTABLE, VORBIS_COMMENT.  You may
-narrow down the types of APPLICATION blocks displayed as
+PADDING, APPLICATION, SEEKTABLE, VORBIS_COMMENT, PICTURE.  You
+may narrow down the types of APPLICATION blocks displayed as
 follows:
 
 APPLICATION:abcd        The APPLICATION block(s) whose textual repre-