shithub: sox

Info  •  Files  •  Log  •  Branches

repeat effect: document behaviour if no argument is given

The argument to repeat is optional, and not giving it means repeating
once. Document this (unchanged) behaviour in the man page and in the
usage message.

--- a/sox.1

+++ b/sox.1

@@ -2960,8 +2960,8 @@

 .B swap

 for similar effects.

 .TP

-\fBrepeat \fIcount\fR

-Repeat the entire audio \fIcount\fR times.

+\fBrepeat\fR [\fIcount\fR (1)]

+Repeat the entire audio \fIcount\fR times, or once if \fIcount\fR is not given.

 Requires temporary file space to store the audio to be repeated.

 Note that repeating once yields two copies: the original audio and the

 repeated audio.

--- a/src/repeat.c

+++ b/src/repeat.c

@@ -93,7 +93,7 @@

 sox_effect_handler_t const * lsx_repeat_effect_fn(void)

 {

-  static sox_effect_handler_t effect = {"repeat", "[count]",

+  static sox_effect_handler_t effect = {"repeat", "[count (1)]",

     SOX_EFF_MCHAN | SOX_EFF_LENGTH | SOX_EFF_MODIFY,

     create, start, flow, drain, stop, NULL, sizeof(priv_t)};

   return &effect;