Skip to content

Commit 0453280

Browse files
authored
Escape double dashes, so they don't get converted to em dashes (#698)
Fixes #671
1 parent f5012d5 commit 0453280

File tree

2 files changed

+19
-16
lines changed

2 files changed

+19
-16
lines changed

man/flac.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ the convention is that FLAC files have the extension ".flac"
4242
Before going into the full command-line description, a few other things
4343
help to sort it out:
4444
1. flac encodes by default, so you must use -d to decode
45-
2. the options -0 .. -8 (or --fast and --best) that control the
45+
2. the options -0 .. -8 (or \--fast and \--best) that control the
4646
compression level actually are just synonyms for different groups of
4747
specific encoding options (described later) and you can get the same
4848
effect by using the same options. When specific options are specified
@@ -66,7 +66,7 @@ the desired operation on each input file to similarly named output files
6666
(meaning for encoding, the extension will be replaced with ".flac", or
6767
appended with ".flac" if the input file has no extension, and for
6868
decoding, the extension will be ".wav" for WAVE output and ".raw" for raw
69-
output). The original file is not deleted unless --delete-input-file is
69+
output). The original file is not deleted unless \--delete-input-file is
7070
specified.
7171

7272
If you are encoding/decoding from stdin to a file, you should use the -o
@@ -85,7 +85,7 @@ RIFF WAVE header contents when necessary.
8585

8686
Also, you can force output data to go to stdout using -c.
8787

88-
To encode or decode files that start with a dash, use -- to signal the
88+
To encode or decode files that start with a dash, use \-- to signal the
8989
end of options, to keep the filenames themselves from being treated as
9090
options:
9191

@@ -154,7 +154,7 @@ Some common **encoding** tasks using flac:
154154
`flac abc.flac --force`
155155
: This one's a little tricky: notice that flac is in encode mode by
156156
default (you have to specify -d to decode) so this command actually
157-
recompresses abc.flac back to abc.flac. --force is needed to make
157+
recompresses abc.flac back to abc.flac. \--force is needed to make
158158
sure you really want to overwrite abc.flac with a new version. Why
159159
would you want to do this? It allows you to recompress an existing
160160
FLAC file with (usually) higher compression options or a newer
@@ -167,16 +167,19 @@ Some common **decoding** tasks using flac:
167167
-d it means re-encode abc.flac to abc.flac (see above).
168168

169169
`flac -d --force-aiff-format abc.flac`
170+
170171
`flac -d -o abc.aiff abc.flac`
171172
: Two different ways of decoding abc.flac to abc.aiff (AIFF format).
172173
abc.flac is not deleted.
173174

174175
`flac -d --force-rf64-format abc.flac`
176+
175177
`flac -d -o abc.rf64 abc.flac`
176178
: Two different ways of decoding abc.flac to abc.rf64 (RF64 format).
177179
abc.flac is not deleted.
178180

179181
`flac -d --force-wave64-format abc.flac`
182+
180183
`flac -d -o abc.w64 abc.flac`
181184
: Two different ways of decoding abc.flac to abc.w64 (Wave64 format).
182185
abc.flac is not deleted.
@@ -559,14 +562,14 @@ the HTML documentation.
559562
ends with *.aif* or *.aiff*, *.rf64* and *.w64* respectively. Also,
560563
this option has no effect when encoding since input is
561564
auto-detected. When none of these options nor
562-
--keep-foreign-metadata are given and no output filename is set,
565+
\--keep-foreign-metadata are given and no output filename is set,
563566
the output format is WAV by default.
564567

565568
**\--force-legacy-wave-format**
566569
**\--force-extensible-wave-format**
567570
: Instruct the decoder to output a WAVE file with WAVE_FORMAT_PCM and
568571
WAVE_FORMAT_EXTENSIBLE respectively. If none of these options nor
569-
--keep-foreign-metadata are given, FLAC outputs WAVE_FORMAT_PCM
572+
\--keep-foreign-metadata are given, FLAC outputs WAVE_FORMAT_PCM
570573
for mono or stereo with a bit depth of 8 or 16 bits, and
571574
WAVE_FORMAT_EXTENSIBLE for all other audio formats.
572575

man/metaflac.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ set of FLAC files to operate on. There are three kinds of "options":
3030

3131
- Shorthand operations, which are convenient synonyms for major
3232
operations. For example, there is a shorthand operation
33-
--show-sample-rate that shows just the sample rate field from the
33+
\--show-sample-rate that shows just the sample rate field from the
3434
STREAMINFO metadata block.
3535

3636
- Global options, which affect all the operations.
@@ -45,7 +45,7 @@ files:
4545
`metaflac --show-md5sum file1.flac file2.flac file3.flac`
4646

4747
Another example; this removes all DESCRIPTION and COMMENT tags in a set
48-
of FLAC files, and uses the --preserve-modtime global option to keep the
48+
of FLAC files, and uses the \--preserve-modtime global option to keep the
4949
FLAC file modification times the same (usually when files are edited the
5050
modification time is set to the current time):
5151

@@ -59,7 +59,7 @@ modification time is set to the current time):
5959
**\--with-filename**
6060
: Prefix each output line with the FLAC file name (the default if more
6161
than one FLAC file is specified). This option has no effect for
62-
options exporting to a file, like --export-tags-to.
62+
options exporting to a file, like \--export-tags-to.
6363

6464
**\--no-filename**
6565
: Do not prefix each output line with the FLAC file name (the default
@@ -111,7 +111,7 @@ modification time is set to the current time):
111111
: Show all tags where the field name matches 'name'.
112112

113113
**\--show-all-tags**
114-
: Show all tags. This is an alias for --export-tags-to=-.
114+
: Show all tags. This is an alias for \--export-tags-to=-.
115115

116116
**\--remove-tag=name**
117117
: Remove all tags whose field name is 'name'.
@@ -263,19 +263,19 @@ modification time is set to the current time):
263263
\--application-data-format=hexdump.
264264

265265
**\--data-format=binary\|binary-headerless\|text**
266-
: For use with --list. By default a human-readable text
266+
: For use with \--list. By default a human-readable text
267267
representation of the data is isplayed. You may specify
268-
--data-format=binary to dump the raw binary form of each metadata
269-
block. Specify --data-format=binary-headerless to omit output of
268+
\--data-format=binary to dump the raw binary form of each metadata
269+
block. Specify \--data-format=binary-headerless to omit output of
270270
metadata block headers, including the id of APPLICATION metadata
271271
blocks.
272272

273273
**\--append**
274274
: Insert a metadata block from a file. This must be a binary block as
275-
exported with --list --data-format=binary. The insertion point is
276-
defined with --block-number=#. The new block will be added after the
275+
exported with \--list \--data-format=binary. The insertion point is
276+
defined with \--block-number=#. The new block will be added after the
277277
given block number. This prevents the illegal insertion of a block
278-
before the first STREAMINFO block. You may not --append another
278+
before the first STREAMINFO block. You may not \--append another
279279
STREAMINFO block. It is possible to copy a metadata block from one
280280
file to another with this option. For example use
281281
`metaflac --list --data-format=binary --block-number=6 file.flac > block`

0 commit comments

Comments
 (0)