From b4da1fa550db697a5d409dfde38457dd1ebb3ec1 Mon Sep 17 00:00:00 2001 From: Timothy Gu Date: Tue, 3 Sep 2013 17:19:26 -0700 Subject: [PATCH] doc/utils: rewrite doc for time duration syntax Extend description and clarify syntax. Signed-off-by: Timothy Gu Signed-off-by: Stefano Sabatini --- doc/utils.texi | 38 +++++++++++++++++++++++++++++++++----- 1 file changed, 33 insertions(+), 5 deletions(-) diff --git a/doc/utils.texi b/doc/utils.texi index 243973d419..484da5f507 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. + @example -[-][HH:]MM:SS[.m...] -[-]S+[.m...] +[-][@var{HH}:]@var{MM}:@var{SS}[.@var{m}...] @end example -@var{HH} expresses the number of hours, @var{MM} the number a of minutes -and @var{SS} the number of seconds. +@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 +@var{SS}. + +@emph{or} + +@example +[-]@var{S}+[.@var{m}...] +@end example + +@var{S} expresses the number of seconds, with the optional decimal part +@var{m}. + +In both expressions, the optional @samp{-} indicates negative duration. + +@subsection Examples + +The following examples are all valid time duration: + +@table @samp +@item 55 +55 seconds + +@item 12:03:45 +12 hours, 03 minutes and 45 seconds + +@item 23.189 +23.189 seconds +@end table @anchor{video size syntax} @section Video size