docs: reformat man pages to improve consistency and readability
Change-Id: I4f9afbc73c365dfa31eb6cd1e4a48368b6a9064f
diff --git a/docs/manpages/nfd-autoreg.rst b/docs/manpages/nfd-autoreg.rst
index 3ce898a..58390d6 100644
--- a/docs/manpages/nfd-autoreg.rst
+++ b/docs/manpages/nfd-autoreg.rst
@@ -4,12 +4,16 @@
Synopsis
--------
-**nfd-autoreg** --prefix=</autoreg/prefix> [--prefix=</another/prefix>]...
+| **nfd-autoreg** [**-i**\|\ **\--prefix** *prefix*]... [**-a**\|\ **\--all-faces-prefix** *prefix*]...
+| [**-b**\|\ **\--blacklist** *network*]... [**-w**\|\ **\--whitelist** *network*]... \
+ [**-c**\|\ **\--cost** *cost*]
+| **nfd-autoreg** **-h**\|\ **\--help**
+| **nfd-autoreg** **-V**\|\ **\--version**
Description
-----------
-``nfd-autoreg`` is a daemon application that automatically registers the specified
+:program:`nfd-autoreg` is a daemon application that automatically registers the specified
prefix(es) when new on-demand faces are created (i.e., when a new UDP face is created as
the result of an incoming packet or when a new TCP face is created as the result of an
incoming connection).
@@ -17,53 +21,61 @@
Options
-------
-``-i`` or ``--prefix``
- Prefix that should be automatically registered when a new remote face is created.
- Can be repeated multiple times to specify additional prefixes.
+.. option:: -i <prefix>, --prefix <prefix>
-``-c`` or ``--cost``
- RIB cost to be assigned to auto-registered prefixes. If not specified, default cost
- is set to 255.
+ Prefix that should be automatically registered when a new remote face is created.
+ Can be repeated multiple times to specify additional prefixes.
-``-w`` or ``--whitelist``
- Whitelisted network, e.g., 192.168.2.0/24 or ::1/128. Can be repeated multiple times
- to specify multiple whitelisted networks.
+.. option:: -b <network>, --blacklist <network>
- Prefix(es) will be auto-registered only when remote IP address is within the specified
- range(s), except blacklist ranges.
+ Blacklisted network, e.g., 192.168.2.32/30 or ::1/128. Can be repeated multiple times
+ to specify multiple blacklisted networks.
- Default: 0.0.0.0/0 and ::/0
+ The prefixes will be auto-registered only when the remote IP address is NOT inside the
+ specified range(s), but is inside the range defined by the whitelist(s), if any.
-``-b`` or ``--blacklist``
- Blacklisted network, e.g., 192.168.2.32/30 or ::1/128. Can be repeated multiple times
- to specify multiple blacklisted networks.
+ Default: none.
- Prefix(es) will be auto-registered only when remote IP address in **NOT** within the
- specified range(s), but is within the range define by the whitelist(s).
+.. option:: -w <network>, --whitelist <network>
- Default: none
+ Whitelisted network, e.g., 192.168.2.0/24 or ::1/128. Can be repeated multiple times
+ to specify multiple whitelisted networks.
-``-h`` or ``--help``
- Print help message and exit.
+ The prefixes will be auto-registered only when the remote IP address is inside the
+ specified range(s), excluding any blacklisted range(s).
-``-V`` or ``--version``
- Show version information and exit.
+ Default: 0.0.0.0/0 and ::/0.
-Exit status
+.. option:: -c <cost>, --cost <cost>
+
+ RIB cost to assign to auto-registered prefixes. If not specified, the cost is set to 255.
+
+.. option:: -h, --help
+
+ Print help message and exit.
+
+.. option:: -V, --version
+
+ Show version information and exit.
+
+Exit Status
-----------
-0: No error.
+0
+ No error.
-1: An unspecified error occurred.
+1
+ An unspecified error occurred.
-2: Malformed command line, e.g., invalid, missing, or unknown argument.
+2
+ Malformed command line, e.g., invalid, missing, or unknown argument.
-4: Insufficient privileges.
+4
+ Insufficient privileges.
Examples
--------
-Auto-register two prefixes for any newly created on-demand face, except those that has
-source IP address in ``10.0.0.0/8`` network::
-
- nfd-autoreg --prefix=/app1/video --prefix=/app2/pictures -b 10.0.0.0/8
+``nfd-autoreg -i /app1/video -i /app2/pictures -b 10.0.0.0/8``
+ Auto-register two prefixes for any newly created on-demand faces, except those that
+ have their remote IP address in the 10.0.0.0/8 network.