mirrors/flac
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Remove really old --explain text and reflow to fit 80 chars

Browse Source 
There was some help text in `flac --explain` which hasn't been
correct for about 20 years already. This is removed, the rest of
the text is reflowed to fit 80 chars standard terminal width
This commit is contained in:
Martijn van Beurden 2022-08-10 19:12:00 +02:00 committed by GitHub
parent 80d064e15d
commit 9bc2cc4c3b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
src/flac/main.c
View File

@ -1210,10 +1210,10 @@ static void usage_summary(void)
{
printf("Usage:\n");
printf("\n");
printf(" Encoding: flac [<general-options>] [<encoding/format-options>] [INPUTFILE [...]]\n");
printf(" Decoding: flac -d [<general-options>] [<format-options>] [FLACFILE [...]]\n");
printf(" Testing: flac -t [<general-options>] [FLACFILE [...]]\n");
printf("Analyzing: flac -a [<general-options>] [<analysis-options>] [FLACFILE [...]]\n");
printf(" Encoding: flac [<general/encoding/format options>] [INPUTFILE [...]]\n");
printf(" Decoding: flac -d [<general/decoding/format options>] [FLACFILE [...]]\n");
printf(" Testing: flac -t [<general options>] [FLACFILE [...]]\n");
printf("Analyzing: flac -a [<general/analysis options>] [FLACFILE [...]]\n");
printf("\n");
printf("Be sure to read the list of known bugs at:\n");
printf("http://xiph.org/flac/documentation_bugs.html\n");
@ -1322,7 +1322,7 @@ void show_help(void)
printf(" --channels=# Number of channels\n");
printf(" --bps=# Number of bits per sample\n");
printf(" --sample-rate=# Sample rate in Hz\n");
printf(" --sign={signed|uint32_t} Sign of samples\n");
printf(" --sign={signed|unsigned} Sign of samples\n");
printf(" --input-size=# Size of the raw input in bytes\n");
printf("negative options:\n");
printf(" --no-adaptive-mid-side\n");
@ -1357,9 +1357,9 @@ void show_explain(void)
usage_header();
usage_summary();
printf("For encoding:\n");
printf(" The input file(s) may be a PCM WAVE or RF64 file, AIFF (or uncompressed\n");
printf(" AIFF-C) file, or raw samples.\n");
printf(" The output file(s) will be in native FLAC or Ogg FLAC format\n");
printf(" The input file(s) may be a PCM WAVE, Wave64, RF64 file, AIFF (or uncompressed\n");
printf(" AIFF-C) file, or raw samples. The output file(s) will be in native FLAC\n");
printf(" or Ogg FLAC format\n");
printf("For decoding, the reverse is true.\n");
printf("\n");
printf("A single INPUTFILE may be - for stdin. No INPUTFILE implies stdin. Use of\n");
@ -1370,12 +1370,6 @@ void show_explain(void)
printf("since the former allows flac to seek backwards to write the STREAMINFO or\n");
printf("WAVE/AIFF header contents when necessary.\n");
printf("\n");
printf("flac checks for the presence of a AIFF/WAVE header to decide whether or not to\n");
printf("treat an input file as AIFF/WAVE format or raw samples. If any input file is\n");
printf("raw you must specify the format options {-fb|fl} -fc -fp and -fs, which will\n");
printf("apply to all raw files. You can force AIFF/WAVE files to be treated as raw\n");
printf("files using -fr.\n");
printf("\n");
printf("general options:\n");
printf(" -v, --version Show the flac version number\n");
printf(" -h, --help Show basic usage a list of all options\n");
@ -1627,12 +1621,13 @@ void show_explain(void)
printf(" blackman, blackman_harris_4term_92db,\n");
printf(" connes, flattop, gauss(STDDEV), hamming,\n");
printf(" hann, kaiser_bessel, nuttall, rectangle,\n");
printf(" triangle, tukey(P), welch, partial_tukey(n),\n");
printf(" triangle, tukey(P), welch, partial_tukey(n)\n");
printf(" punchout_tukey(n). More than one may be\n");
printf(" specified but encoding time is a multiple of\n");
printf(" the number of functions since they are each\n");
printf(" tried in turn. The encoder chooses suitable\n");
printf(" defaults in the absence of any -A options.\n");
printf(" specified but encoding time is a multiple\n");
printf(" of the number of functions since they are\n");
printf(" each tried in turn. The encoder chooses\n");
printf(" suitable defaults in the absence of any -A\n");
printf(" options.\n");
printf(" -l, --max-lpc-order=# Max LPC order; 0 => only fixed predictors.\n");
printf(" Must be <= 12 for Subset streams if sample\n");
printf(" rate is <=48kHz.\n");
@ -1647,11 +1642,12 @@ void show_explain(void)
printf(" (# is 0 to 15 inclusive; min defaults to 0;\n");
printf(" the default is -r 0; above 4 does not\n");
printf(" usually help much)\n");
printf(" --limit-min-bitrate Limit minimum bitrate by not allowing frames\n");
printf(" consisting of only constant subframes. This\n");
printf(" ensures a bitrate of at least 1 bit/sample,\n");
printf(" for example 48kbit/s for 48kHz input. This is\n");
printf(" mostly beneficial for internet streaming.\n");
printf(" --limit-min-bitrate Limit minimum bitrate by not allowing\n");
printf(" frames consisting of only constant\n");
printf(" subframes. This ensures a bitrate of at\n");
printf(" least 1 bit/sample, for example 48kbit/s\n");
printf(" for 48kHz input. This is mostly beneficial\n");
printf(" for internet streaming.\n");
printf("format options:\n");
printf(" --force-raw-format Force input (when encoding) or output (when\n");
printf(" decoding) to be treated as raw samples\n");
@ -1675,7 +1671,7 @@ void show_explain(void)
printf(" --channels=# Number of channels\n");
printf(" --bps=# Number of bits per sample\n");
printf(" --sample-rate=# Sample rate in Hz\n");
printf(" --sign={signed|uint32_t} Sign of samples (the default is signed)\n");
printf(" --sign={signed|unsigned} Sign of samples (the default is signed)\n");
printf(" --input-size=# Size of the raw input in bytes. If you are\n");
printf(" encoding raw samples from stdin, you must set\n");
printf(" this option in order to be able to use --skip,\n");