diff options
author | Timothy Gu <timothygu99@gmail.com> | 2015-03-23 06:47:18 +0300 |
---|---|---|
committer | Michael Niedermayer <michaelni@gmx.at> | 2015-03-23 19:08:08 +0300 |
commit | ecba41bfd3a1bb222db99bac10731a9e30c7e18c (patch) | |
tree | 97d1884c9b592b5d2dda00b3fb31d0b63a6ad84a /doc/ffprobe.texi | |
parent | aba3030a5593ceb0b9390cbc4c58642f372a17a3 (diff) |
doc: More semantic markup using @samp and @var where appropriate
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
Diffstat (limited to 'doc/ffprobe.texi')
-rw-r--r-- | doc/ffprobe.texi | 33 |
1 files changed, 17 insertions, 16 deletions
diff --git a/doc/ffprobe.texi b/doc/ffprobe.texi index 0fdf45e27b..2024eed4e5 100644 --- a/doc/ffprobe.texi +++ b/doc/ffprobe.texi @@ -447,17 +447,17 @@ writer). It can assume one of the following values: @table @option @item c -Perform C-like escaping. Strings containing a newline ('\n'), carriage -return ('\r'), a tab ('\t'), a form feed ('\f'), the escaping -character ('\') or the item separator character @var{SEP} are escaped using C-like fashioned -escaping, so that a newline is converted to the sequence "\n", a -carriage return to "\r", '\' to "\\" and the separator @var{SEP} is -converted to "\@var{SEP}". +Perform C-like escaping. Strings containing a newline (@samp{\n}), carriage +return (@samp{\r}), a tab (@samp{\t}), a form feed (@samp{\f}), the escaping +character (@samp{\}) or the item separator character @var{SEP} are escaped +using C-like fashioned escaping, so that a newline is converted to the +sequence @samp{\n}, a carriage return to @samp{\r}, @samp{\} to @samp{\\} and +the separator @var{SEP} is converted to @samp{\@var{SEP}}. @item csv Perform CSV-like escaping, as described in RFC4180. Strings -containing a newline ('\n'), a carriage return ('\r'), a double quote -('"'), or @var{SEP} are enclosed in double-quotes. +containing a newline (@samp{\n}), a carriage return (@samp{\r}), a double quote +(@samp{"}), or @var{SEP} are enclosed in double-quotes. @item none Perform no escaping. @@ -485,7 +485,7 @@ The description of the accepted options follows. Separator character used to separate the chapter, the section name, IDs and potential tags in the printed field key. -Default value is '.'. +Default value is @samp{.}. @item hierarchical, h Specify if the section name specification should be hierarchical. If @@ -507,21 +507,22 @@ The following conventions are adopted: @item all key and values are UTF-8 @item -'.' is the subgroup separator +@samp{.} is the subgroup separator @item -newline, '\t', '\f', '\b' and the following characters are escaped +newline, @samp{\t}, @samp{\f}, @samp{\b} and the following characters are +escaped @item -'\' is the escape character +@samp{\} is the escape character @item -'#' is the comment indicator +@samp{#} is the comment indicator @item -'=' is the key/value separator +@samp{=} is the key/value separator @item -':' is not used but usually parsed as key/value separator +@samp{:} is not used but usually parsed as key/value separator @end itemize This writer accepts options as a list of @var{key}=@var{value} pairs, -separated by ":". +separated by @samp{:}. The description of the accepted options follows. |