man/metaflac.1

   1 .\" This manpage has been automatically generated by docbook2man
   2 .\" from a DocBook document.  This tool can be found at:
   3 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
   4 .\" Please send any bug reports, improvements, comments, patches,
   5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
   6 .TH "METAFLAC" "1" "01 February 2005" "" ""
   7 .SH NAME
   8 metaflac \- program to list, add, remove, or edit metadata in one or more FLAC files.
   9 .SH SYNOPSIS
  10
  11 \fBmetaflac\fR [ \fB\fIoptions\fB\fR ] [ \fB\fIoperations\fB\fR ] \fB\fIFLACfile\fB\fR\fI ...\fR
  12
  13 .SH "DESCRIPTION"
  14 .PP
  15 Use \fBmetaflac\fR to list, add, remove, or edit
  16 metadata in one or more FLAC files.  You may perform one major operation,
  17 or many shorthand operations at a time.
  18 .SH "OPTIONS"
  19 .TP
  20 \fB--preserve-modtime\fR
  21 Preserve the original modification time in spite of edits.
  22 .TP
  23 \fB--with-filename\fR
  24 Prefix each output line with the FLAC file name (the default if
  25 more than one FLAC file is specified).
  26 .TP
  27 \fB--no-filename\fR
  28 Do not prefix each output line with the FLAC file name (the default
  29 if only one FLAC file is specified).
  30 .TP
  31 \fB--dont-use-padding\fR
  32 By default metaflac tries to use padding where possible to avoid
  33 rewriting the entire file if the metadata size changes.  Use this
  34 option to tell metaflac to not take advantage of padding this way.
  35 .SH "SHORTHAND OPERATIONS"
  36 .TP
  37 \fB--show-md5sum\fR
  38 Show the MD5 signature from the STREAMINFO block.
  39 .TP
  40 \fB--show-min-blocksize\fR
  41 Show the minimum block size from the STREAMINFO block.
  42 .TP
  43 \fB--show-max-blocksize\fR
  44 Show the maximum block size from the STREAMINFO block.
  45 .TP
  46 \fB--show-min-framesize\fR
  47 Show the minimum frame size from the STREAMINFO block.
  48 .TP
  49 \fB--show-max-framesize\fR
  50 Show the maximum frame size from the STREAMINFO block.
  51 .TP
  52 \fB--show-sample-rate\fR
  53 Show the sample rate from the STREAMINFO block.
  54 .TP
  55 \fB--show-channels\fR
  56 Show the number of channels from the STREAMINFO block.
  57 .TP
  58 \fB--show-bps\fR
  59 Show the # of bits per sample from the STREAMINFO block.
  60 .TP
  61 \fB--show-total-samples\fR
  62 Show the total # of samples from the STREAMINFO block.
  63 .TP
  64 \fB--show-vendor-tag\fR
  65 Show the vendor string from the VORBIS_COMMENT block.
  66 .TP
  67 \fB--show-tag=name\fR
  68 Show all tags where the the field name matches 'name'.
  69 .TP
  70 \fB--remove-tag=name\fR
  71 Remove all tags whose field name is 'name'.
  72 .TP
  73 \fB--remove-first-tag=name\fR
  74 Remove first tag whose field name is 'name'.
  75 .TP
  76 \fB--remove-all-tags\fR
  77 Remove all tags, leaving only the vendor string.
  78 .TP
  79 \fB--set-tag=field\fR
  80 Add a tag.  The field must comply with the
  81 Vorbis comment spec, of the form "NAME=VALUE".  If there is
  82 currently no tag block, one will be created.
  83 .TP
  84 \fB--import-tags-from=file\fR
  85 Import tags from a file.  Use '-' for stdin.  Each
  86 line should be of the form NAME=VALUE.  Multi-line comments
  87 are currently not supported.  Specify --remove-all-tags and/or
  88 --no-utf8-convert before --import-tags-from if necessary.
  89 .TP
  90 \fB--export-tags-to=file\fR
  91 Export tags to a file.  Use '-' for stdin.  Each
  92 line will be of the form NAME=VALUE.  Specify
  93 --no-utf8-convert if necessary.
  94 .TP
  95 \fB--import-cuesheet-from=file\fR
  96 Import a cuesheet from a file.  Use '-' for stdin.  Only one
  97 FLAC file may be specified.  A seekpoint will be added for each
  98 index point in the cuesheet to the SEEKTABLE unless
  99 --no-cued-seekpoints is specified.
 100 .TP
 101 \fB--export-cuesheet-to=file\fR
 102 Export CUESHEET block to a cuesheet file, suitable for use by
 103 CD authoring software.  Use '-' for stdout.  Only one FLAC file
 104 may be specified on the command line.
 105 .TP
 106 \fB--add-replay-gain\fR
 107 Calculates the title and album gains/peaks of the given FLAC
 108 files as if all the files were part of one album, then stores
 109 them in the VORBIS_COMMENT block.  The tags are the same as
 110 those used by vorbisgain.  Existing ReplayGain tags will be
 111 replaced.  If only one FLAC file is given, the album and title
 112 gains will be the same.  Since this operation requires two
 113 passes, it is always executed last, after all other operations
 114 have been completed and written to disk.  All FLAC files
 115 specified must have the same resolution, sample rate, and
 116 number of channels.  The sample rate must be one of 8, 11.025,
 117 12, 16, 22.05, 24, 32, 44.1, or 48 kHz.
 118 .TP
 119 \fB--add-seekpoint={\fI#\fB|\fIX\fB|\fI#x\fB|\fI#s\fB}\fR
 120 Add seek points to a SEEKTABLE block.  Using #, a seek point at
 121 that sample number is added.  Using X, a placeholder point is
 122 added at the end of a the table.  Using #x, # evenly spaced seek
 123 points will be added, the first being at sample 0.  Using #s, a
 124 seekpoint will be added every # seconds (# does not have to be a
 125 whole number; it can be, for example, 9.5, meaning a seekpoint
 126 every 9.5 seconds).  If no SEEKTABLE block exists, one will be
 127 created.  If one already exists, points will be added to the
 128 existing table, and any duplicates will be turned into placeholder
 129 points.  You may use many --add-seekpoint options; the resulting
 130 SEEKTABLE will be the unique-ified union of all such values.
 131 Example: --add-seekpoint=100x --add-seekpoint=3.5s will add 100
 132 evenly spaced seekpoints and a seekpoint every 3.5 seconds.
 133 .TP
 134 \fB--add-padding=length\fR
 135 Add a padding block of the given length (in bytes).  The overall
 136 length of the new block will be 4 + length; the extra 4 bytes is
 137 for the metadata block header.
 138 .SH "MAJOR OPERATIONS"
 139 .TP
 140 \fB--list\fR
 141 List the contents of one or more metadata blocks to stdout.  By
 142 default, all metadata blocks are listed in text format.  Use the
 143 following options to change this behavior:
 144 .RS
 145 .TP
 146 \fB--block-number=#[,#[...]]\fR
 147 An optional comma-separated list of block numbers to display.
 148 The first block, the STREAMINFO block, is block 0.
 149 .TP
 150 \fB--block-type=type[,type[...]]\fR
 151 .TP
 152 \fB--except-block-type=type[,type[...]]\fR
 153 An optional comma-separated list of block types to be included
 154 or ignored with this option.  Use only one of --block-type or
 155 --except-block-type.  The valid block types are: STREAMINFO,
 156 PADDING, APPLICATION, SEEKTABLE, VORBIS_COMMENT.  You may
 157 narrow down the types of APPLICATION blocks displayed as
 158 follows:
 159
 160 APPLICATION:abcd        The APPLICATION block(s) whose textual repre-
 161 sentation of the 4-byte ID is "abcd"
 162 APPLICATION:0xXXXXXXXX  The APPLICATION block(s) whose hexadecimal big-
 163 endian representation of the 4-byte ID is
 164 "0xXXXXXXXX".  For the example "abcd" above the
 165 hexadecimal equivalalent is 0x61626364
 166 .sp
 167 .RS
 168 .B "Note:"
 169 if both --block-number and --[except-]block-type are
 170 specified, the result is the logical AND of both
 171 arguments.
 172 .RE
 173 .TP
 174 \fB--application-data-format=hexdump|text\fR
 175 If the application block you are displaying contains binary
 176 data but your --data-format=text, you can display a hex dump
 177 of the application data contents instead using
 178 --application-data-format=hexdump.
 179 .RE
 180 .TP
 181 \fB--remove\fR
 182 Remove one or more metadata blocks from the metadata.  Unless
 183 --dont-use-padding is specified, the blocks will be replaced with
 184 padding.  You may not remove the STREAMINFO block.
 185 .RS
 186 .TP
 187 \fB--block-number=#[,#[...]]\fR
 188 .TP
 189 \fB--block-type=type[,type[...]]\fR
 190 .TP
 191 \fB--except-block-type=type[,type[...]]\fR
 192 See --list above for usage.
 193 .sp
 194 .RS
 195 .B "Note:"
 196 if both --block-number and --[except-]block-type are
 197 specified, the result is the logical AND of both arguments.
 198 .RE
 199 .RE
 200 .TP
 201 \fB--remove-all\fR
 202 Remove all metadata blocks (except the STREAMINFO block) from the
 203 metadata.  Unless --dont-use-padding is specified, the blocks will
 204 be replaced with padding.
 205 .TP
 206 \fB--merge-padding\fR
 207 Merge adjacent PADDING blocks into single blocks.
 208 .TP
 209 \fB--sort-padding\fR
 210 Move all PADDING blocks to the end of the metadata and merge them
 211 into a single block.
 212 .SH "SEE ALSO"
 213 .PP
 214 flac(1).