diff --git a/config_help.md b/config_help.md index a36eeb9..0ed201e 100644 --- a/config_help.md +++ b/config_help.md @@ -3,9 +3,9 @@ If you’re in a hurry, see the examples below :). They should be reasonably self-explanatory. -The configuration file comprises one or more *stream specifications* that tell the script how to chop up and combine the various podcast input sources. Timestamps are whitespace-delimited (space or newline), but whitespace is otherwise insignificant. Use # for comments. +The configuration file comprises one or more *segment specifications* that tell the script how to chop up and combine the various podcast input sources. Timestamps are whitespace-delimited (space or newline), but whitespace is otherwise insignificant. Use # for comments. -Stream specifications can appear in any order (except for `^` frame inputs, see below), but this will make the file harder to understand. We recommended grouping all stream specifications of the same type in chronological order. Each stream specification starts with an *input specification*, followed by zero or more *segment specifications*. +Segment specifications can appear in any order (except for `^` frame inputs, see below), but this will make the file harder to understand. We recommended grouping all segment specifications of the same type in chronological order. Each segment specification starts with an *input specification*, followed by zero or more *time specifications*. Input specifications @@ -20,8 +20,8 @@ `num` is optional and represents either the `ffmpeg` stream number for audio and video inputs, or the frame/page number for frame inputs. It is zero-indexed (so page 1 of a PDF input is specified as 0). It defaults to 0 if omitted. For frame inputs, you can also specify `-1` or `last` to indicate that it should use the last frame of the input file (negative values other than -1 are currently not supported). -Segment specifications ----------------------- +Time specifications +------------------- These are normally just a sequence of timestamps, representing punch in and punch out times. Timestamps are in `HH:MM:SS[.ccc]` format. `HH` and `MM` are currently mandatory, but this will change soon to allow more flexibility. The punch out time for a segment *must* be later than the punch in time, but otherwise you can list timestamps in any order. However, we recommend listing them chronologically for the sake of sanity! @@ -54,9 +54,10 @@ ``` ``` -# Split into two segments, separated by filler audio (filler.wav), and a -# filler frame generated by repeating the last frame of the first video -# segment to the same duration as the filler audio. +# Split audio into two segments separated by an audio segment from +# filler.wav. Split video into two corresponding segments, separated +# by a filler frame generated by repeating the last frame of the first +# video segment for the same duration as filler.wav. [a] 00:01:53.000 00:23:15.000 [a:filler.wav] [a] 00:49:42.000 00:50:25.000