highperfocused/ffmpeg
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc/utils: rewrite doc for time duration syntax

Browse Source 
Extend description and clarify syntax.

Signed-off-by: Timothy Gu <timothygu99@gmail.com>
Signed-off-by: Stefano Sabatini <stefasab@gmail.com>
This commit is contained in:
Timothy Gu 2013-09-03 17:19:26 -07:00 committed by Stefano Sabatini
parent d0b7d24b80
commit b4da1fa550
1 changed files with 33 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
doc/utils.texi
View File

@ -96,14 +96,42 @@ year-month-day.
@anchor{time duration syntax} @anchor{time duration syntax}
@section Time duration @section Time duration
The accepted syntax is: There are two accepted syntaxes for expressing time duration.
@example @example
[-][HH:]MM:SS[.m...] [-][@var{HH}:]@var{MM}:@var{SS}[.@var{m}...]
[-]S+[.m...]
@end example @end example
@var{HH} expresses the number of hours, @var{MM} the number a of minutes @var{HH} expresses the number of hours, @var{MM} the number of minutes
and @var{SS} the number of seconds. 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} @anchor{video size syntax}
@section Video size @section Video size