Fix documentation syntaxes for RST option-list

http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#option-lists

RST only accepts two forms for option argument:
- Begins with a letter and consists of [a-zA-Z0-9_].
- Begins with "<" and ends with ">"; any characters except angle
  brackets are allowed internally.

Updated documents to obey the above rule.

Also cleaned up the documents to follow the syntaxes defined in
http://docopt.org/.

Change-Id: I06c6fa6db524325373053b26fc99169469664f01
This commit is contained in:
KongQun Yang 2018-05-02 10:55:51 -07:00
parent 2d919b5a31
commit 764c7077a2
9 changed files with 38 additions and 34 deletions

View File

@ -34,7 +34,7 @@ Synopsis
::
$ packager {stream_descriptor} [{stream_descriptor}] ... \
$ packager <stream_descriptor> ... \
[--dump_stream_info] \
[Chunking Options] \
[MP4 Output Options] \
@ -65,11 +65,11 @@ Different key providers cannot be specified at the same time.
::
[--enable_widevine_encryption {Widevine Encryption Options}] \
[--enable_widevine_decryption {Widevine Decryption Options}] \
[--enable_raw_key_encryption {Raw Key Encryption Options}] \
[--enable_raw_key_decryption {Raw Key Decryption Options}] \
[--enable_playready_encryption {PlayReady Encryption Options}]
[--enable_widevine_encryption <Widevine Encryption Options>] \
[--enable_widevine_decryption <Widevine Decryption Options>] \
[--enable_raw_key_encryption <Raw Key Encryption Options>] \
[--enable_raw_key_decryption <Raw Key Decryption Options>] \
[--enable_playready_encryption <PlayReady Encryption Options>]
.. include:: /options/general_encryption_options.rst

View File

@ -9,31 +9,34 @@ DASH options
that if segment_template is not specified, shaka-packager always generates
static mpd regardless of the value of this flag.
--mpd_output {file_path}
--mpd_output <file_path>
MPD output file name.
--base_urls {url}[,{url}]...
--base_urls <comma_separated_urls>
Comma separated BaseURLs for the MPD. The values will be added as <BaseURL>
element(s) immediately under the <MPD> element.
Comma separated BaseURLs for the MPD:
**<url>[,<url>]...**.
--min_buffer_time {seconds}
The values will be added as <BaseURL> element(s) immediately under the <MPD>
element.
--min_buffer_time <seconds>
Specifies, in seconds, a common duration used in the definition of the MPD
Representation data rate.
--minimum_update_period {seconds}
--minimum_update_period <seconds>
Indicates to the player how often to refresh the media presentation
description in seconds. This value is used for dynamic MPD only.
--suggested_presentation_delay {seconds}
--suggested_presentation_delay <seconds>
Specifies a delay, in seconds, to be added to the media presentation time.
This value is used for dynamic MPD only.
--time_shift_buffer_depth {seconds}
--time_shift_buffer_depth <seconds>
Guaranteed duration of the time shifting buffer for dynamic media
presentations, in seconds.
@ -48,12 +51,14 @@ DASH options
The segments are not removed if the value is zero.
--utc_timing {scheme_id_uri}={value}[,{scheme_id_uri}={value}]...
--utc_timing <scheme_id_uri_value_pairs>
Comma separated UTCTiming schemeIdUri and value pairs for the MPD:
**<scheme_id_uri>=<value>[,<scheme_id_uri>=<value>]...**
Comma separated UTCTiming schemeIdUri and value pairs for the MPD.
This value is used for dynamic MPD only.
--default_language {language}
--default_language <language>
Any audio/text tracks tagged with this language will have
<Role ... value=\"main\" /> in the manifest. This allows the player to

View File

@ -13,7 +13,7 @@ Raw key encryption options
**key_info_string** is of the form::
label={label}:key_id={key_id}:key={key}
label=<label>:key_id=<key_id>:key=<key>
*label* can be an arbitrary string or a predefined DRM label like AUDIO,
SD, HD, etc. Label with an empty string indicates the default key and

View File

@ -6,7 +6,7 @@ multiple different "files".
Stream descriptor is of the form::
{field}={value}[,{field}={value}]...
<field>=<value>[,<field>=<value>]...
These are the available fields:

View File

@ -3,7 +3,7 @@ UDP file options
UDP file is of the form::
udp://{ip}:{port}[?{option}[&{option}]...]
udp://<ip>:<port>[?<option>[&<option>]...]
Here is the list of supported options:
@ -11,17 +11,17 @@ Here is the list of supported options:
Allow or disallow reusing UDP sockets.
:interface={addr}:
:interface=<addr>:
Multicast group interface address. Only the packets sent to this address are
received. Default to "0.0.0.0" if not specified.
:source={addr}:
:source=<addr>:
Multicast source ip address. Only the packets sent from this source address
are received. Enables Source Specific Multicast (SSM) if set.
:timeout={microseconds}:
:timeout=<microseconds>:
UDP timeout in microseconds.

View File

@ -14,8 +14,8 @@ Synopsis
::
$ packager {stream_descriptor} [stream_descriptor] ... \
--mpd_output {manifest output path} \
$ packager <stream_descriptor> ... \
--mpd_output <manifest_output_path> \
[Other DASH options] \
[Other options, e.g. DRM options, HLS options]

View File

@ -23,9 +23,8 @@ Synopsis
::
$ packager {stream_descriptor with HLS specific descriptors} \
[stream_descriptor with HLS specific descriptors] ... \
--hls_master_playlist_output {master playlist output path} \
$ packager <stream_descriptor> ... \
--hls_master_playlist_output <master_playlist_output_path> \
[Other HLS options] \
[Other options, e.g. DRM options, DASH options]

View File

@ -8,15 +8,15 @@ Synopsis
::
$ packager {stream_descriptor} [stream_descriptor] ... \
$ packager <stream_descriptor> ... \
--enable_raw_key_encryption \
--keys <key_info_string[,key_info_string][,key_info_string]...> \
[--pssh <concatenated PSSHs>] \
--keys <key_info_string>[,<key_info_string>]... \
[--pssh <concatenated_PSSHs>] \
[Other options, e.g. DASH options, HLS options]
**key_info_string** is of the form::
label={label}:key_id={key_id}:key={key}
label=<label>:key_id=<key_id>:key=<key>
Custom PSSH(s) can be provided in *--pssh*. If absent,
`v1 common PSSH box <https://goo.gl/s8RIhr>`_ is generated.

View File

@ -15,7 +15,7 @@ Synopsis
AES signing::
$ packager {stream_descriptor} [stream_descriptor] ... \
$ packager <stream_descriptor> ... \
--enable_widevine_encryption \
--key_server_url <key_server_url> \
--content_id <content_id> \
@ -25,7 +25,7 @@ AES signing::
RSA signing::
$ packager {stream_descriptor} [stream_descriptor] ... \
$ packager <stream_descriptor> ... \
--enable_widevine_encryption \
--key_server_url <key_server_url> \
--content_id <content_id> \