add shorthand option --remove-replay-gain to metaflac
[platform/upstream/flac.git] / src / metaflac / usage.c
index eb23954..aa9ff42 100644 (file)
@@ -1,5 +1,5 @@
 /* metaflac - Command-line FLAC metadata editor
- * Copyright (C) 2001,2002  Josh Coalson
+ * Copyright (C) 2001,2002,2003,2004,2005  Josh Coalson
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
@@ -25,7 +25,7 @@ static void usage_header(FILE *out)
 {
        fprintf(out, "==============================================================================\n");
        fprintf(out, "metaflac - Command-line FLAC metadata editor version %s\n", FLAC__VERSION_STRING);
-       fprintf(out, "Copyright (C) 2001,2002  Josh Coalson\n");
+       fprintf(out, "Copyright (C) 2001,2002,2003,2004,2005  Josh Coalson\n");
        fprintf(out, "\n");
        fprintf(out, "This program is free software; you can redistribute it and/or\n");
        fprintf(out, "modify it under the terms of the GNU General Public License\n");
@@ -57,7 +57,7 @@ static void usage_summary(FILE *out)
        fprintf(out, "                      (the default if more than one FLAC file is specified)\n");
        fprintf(out, "--no-filename         Do not prefix each output line with the FLAC file name\n");
        fprintf(out, "                      (the default if only one FLAC file is specified)\n");
-       fprintf(out, "--no-utf8-convert     Do not convert Vorbis comments from UTF-8 to local charset,\n");
+       fprintf(out, "--no-utf8-convert     Do not convert tags from UTF-8 to local charset,\n");
        fprintf(out, "                      or vice versa.  This is useful for scripts.\n");
        fprintf(out, "--dont-use-padding    By default metaflac tries to use padding where possible\n");
        fprintf(out, "                      to avoid rewriting the entire file if the metadata size\n");
@@ -114,29 +114,29 @@ int long_usage(const char *message, ...)
        fprintf(out, "--show-bps            Show the # of bits per sample from the STREAMINFO block.\n");
        fprintf(out, "--show-total-samples  Show the total # of samples from the STREAMINFO block.\n");
        fprintf(out, "\n");
-       fprintf(out, "--show-vc-vendor      Show the vendor string from the VORBIS_COMMENT block.\n");
-       fprintf(out, "--show-vc-field=name  Show all Vorbis comment fields where the the field name\n");
-       fprintf(out, "                      matches 'name'.\n");
-       fprintf(out, "--remove-vc-field=name\n");
-       fprintf(out, "                      Remove all Vorbis comment fields whose field name is\n");
-       fprintf(out, "                      'name'.\n");
-       fprintf(out, "--remove-vc-firstfield=name\n");
-       fprintf(out, "                      Remove first Vorbis comment field whose field name is\n");
-       fprintf(out, "                      'name'.\n");
-       fprintf(out, "--remove-vc-all       Remove all Vorbis comment fields, leaving only the\n");
-       fprintf(out, "                      vendor string in the VORBIS_COMMENT block.\n");
-       fprintf(out, "--set-vc-field=field  Add a Vorbis comment field.  The field must comply with\n");
-       fprintf(out, "                      the Vorbis comment spec, of the form \"NAME=VALUE\".  If\n");
-       fprintf(out, "                      there is currently no VORBIS_COMMENT block, one will be\n");
-       fprintf(out, "                      created.\n");
-       fprintf(out, "--import-vc-from=file Import Vorbis comments from a file.  Use '-' for stdin.\n");
-       fprintf(out, "                      Each line should be of the form NAME=VALUE.  Multi-\n");
-       fprintf(out, "                      line comments are currently not supported.  Specify\n");
-       fprintf(out, "                      --remove-vc-all and/or --no-utf8-convert before\n");
-       fprintf(out, "                      --import-vc-from if necessary.\n");
-       fprintf(out, "--export-vc-to=file   Export Vorbis comments to a file.  Use '-' for stdin.\n");
-       fprintf(out, "                      Each line will be of the form NAME=VALUE.  Specify\n");
+       fprintf(out, "--show-vendor-tag     Show the vendor string from the VORBIS_COMMENT block.\n");
+       fprintf(out, "--show-tag=NAME       Show all tags where the the field name matches 'NAME'.\n");
+       fprintf(out, "--remove-tag=NAME     Remove all tags whose field name is 'NAME'.\n");
+       fprintf(out, "--remove-first-tag=NAME  Remove first tag whose field name is 'NAME'.\n");
+       fprintf(out, "--remove-all-tags     Remove all tags, leaving only the vendor string.\n");
+       fprintf(out, "--set-tag=FIELD       Add a tag.  The FIELD must comply with the Vorbis comment\n");
+       fprintf(out, "                      spec, of the form \"NAME=VALUE\".  If there is currently\n");
+       fprintf(out, "                      no tag block, one will be created.\n");
+       fprintf(out, "--import-tags-from=FILE Import tags from a file.  Use '-' for stdin.  Each line\n");
+       fprintf(out, "                      should be of the form NAME=VALUE.  Multi-line comments\n");
+       fprintf(out, "                      are currently not supported.  Specify --remove-all-tags\n");
+       fprintf(out, "                      and/or --no-utf8-convert before --import-tags-from if\n");
+       fprintf(out, "                      necessary.\n");
+       fprintf(out, "--export-tags-to=FILE Export tags to a file.  Use '-' for stdin.  Each line\n");
+       fprintf(out, "                      will be of the form NAME=VALUE.  Specify\n");
        fprintf(out, "                      --no-utf8-convert if necessary.\n");
+       fprintf(out, "--import-cuesheet-from=FILE  Import a cuesheet from a file.  Use '-' for stdin.\n");
+       fprintf(out, "                      Only one FLAC file may be specified.  A seekpoint will be\n");
+       fprintf(out, "                      added for each index point in the cuesheet to the SEEKTABLE\n");
+       fprintf(out, "                      unless --no-cued-seekpoints is specified.\n");
+       fprintf(out, "--export-cuesheet-to=FILE  Export CUESHEET block to a cuesheet file, suitable\n");
+       fprintf(out, "                      for use by CD authoring software.  Use '-' for stdout.\n");
+       fprintf(out, "                      Only one FLAC file may be specified on the command line.\n");
        fprintf(out, "--add-replay-gain     Calculates the title and album gains/peaks of the given\n");
        fprintf(out, "                      FLAC files as if all the files were part of one album,\n");
        fprintf(out, "                      then stores them in the VORBIS_COMMENT block.  The tags\n");
@@ -149,6 +149,7 @@ int long_usage(const char *message, ...)
        fprintf(out, "                      must have the same resolution, sample rate, and number\n");
        fprintf(out, "                      of channels.  The sample rate must be one of 8, 11.025,\n");
        fprintf(out, "                      12, 16, 22.05, 24, 32, 44.1, or 48 kHz.\n");
+       fprintf(out, "--remove-replay-gain  Removes the ReplayGain tags.\n");
        fprintf(out, "--add-seekpoint={#|X|#x|#s}  Add seek points to a SEEKTABLE block\n");
        fprintf(out, "       #  : a specific sample number for a seek point\n");
        fprintf(out, "       X  : a placeholder point (always goes at the end of the SEEKTABLE)\n");
@@ -156,7 +157,7 @@ int long_usage(const char *message, ...)
        fprintf(out, "       #s : a seekpoint every # seconds; # does not have to be a whole number\n");
        fprintf(out, "                      If no SEEKTABLE block exists, one will be created.  If\n");
        fprintf(out, "                      one already exists, points will be added to the existing\n");
-       fprintf(out, "                      table, and duplicates will be turned into placeholder\n");
+       fprintf(out, "                      table, and any duplicates will be turned into placeholder\n");
        fprintf(out, "                      points.  You may use many --add-seekpoint options; the\n");
        fprintf(out, "                      resulting SEEKTABLE will be the unique-ified union of\n");
        fprintf(out, "                      all such values.  Example: --add-seekpoint=100x\n");
@@ -180,7 +181,7 @@ int long_usage(const char *message, ...)
        fprintf(out, "\n");
        fprintf(out, "    --block-type=type[,type[...]]\n");
        fprintf(out, "    --except-block-type=type[,type[...]]\n");
-       fprintf(out, "    An optional comma-separated list of block types to included or ignored\n");
+       fprintf(out, "    An optional comma-separated list of block types to be included or ignored\n");
        fprintf(out, "    with this option.  Use only one of --block-type or --except-block-type.\n");
        fprintf(out, "    The valid block types are: STREAMINFO, PADDING, APPLICATION, SEEKTABLE,\n");
        fprintf(out, "    VORBIS_COMMENT.  You may narrow down the types of APPLICATION blocks\n");