[FFmpeg-cvslog] doc/utils: rewrite doc for time duration syntax
Timothy Gu
git at videolan.org
Wed Oct 16 18:33:18 CEST 2013
ffmpeg | branch: master | Timothy Gu <timothygu99 at gmail.com> | Tue Sep 3 17:19:26 2013 -0700| [b4da1fa550db697a5d409dfde38457dd1ebb3ec1] | committer: Stefano Sabatini
doc/utils: rewrite doc for time duration syntax
Extend description and clarify syntax.
Signed-off-by: Timothy Gu <timothygu99 at gmail.com>
Signed-off-by: Stefano Sabatini <stefasab at gmail.com>
> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=b4da1fa550db697a5d409dfde38457dd1ebb3ec1
---
doc/utils.texi | 38 +++++++++++++++++++++++++++++++++-----
1 file changed, 33 insertions(+), 5 deletions(-)
diff --git a/doc/utils.texi b/doc/utils.texi
index 243973d..484da5f 100644
--- a/doc/utils.texi
+++ b/doc/utils.texi
@@ -96,14 +96,42 @@ year-month-day.
@anchor{time duration syntax}
@section Time duration
-The accepted syntax is:
+There are two accepted syntaxes for expressing time duration.
+
+ at example
+[-][@var{HH}:]@var{MM}:@var{SS}[. at var{m}...]
+ at end example
+
+ at var{HH} expresses the number of hours, @var{MM} the number of minutes
+for a maximum of 2 digits, and @var{SS} the number of seconds for a
+maximum of 2 digits. The @var{m} at the end expresses decimal value for
+ at var{SS}.
+
+ at emph{or}
+
@example
-[-][HH:]MM:SS[.m...]
-[-]S+[.m...]
+[-]@var{S}+[. at var{m}...]
@end example
- at var{HH} expresses the number of hours, @var{MM} the number a of minutes
-and @var{SS} the number of seconds.
+ at var{S} expresses the number of seconds, with the optional decimal part
+ at var{m}.
+
+In both expressions, the optional @samp{-} indicates negative duration.
+
+ at subsection Examples
+
+The following examples are all valid time duration:
+
+ at table @samp
+ at item 55
+55 seconds
+
+ at item 12:03:45
+12 hours, 03 minutes and 45 seconds
+
+ at item 23.189
+23.189 seconds
+ at end table
@anchor{video size syntax}
@section Video size
More information about the ffmpeg-cvslog
mailing list