docs: write arguments as upper case in manpages
refs #3780, #3864
Change-Id: Iff0534dbd0119734fdb567500fe2e1842c7805f5
diff --git a/docs/manpages/ndn-autoconfig-server.rst b/docs/manpages/ndn-autoconfig-server.rst
index 553635e..14525e3 100644
--- a/docs/manpages/ndn-autoconfig-server.rst
+++ b/docs/manpages/ndn-autoconfig-server.rst
@@ -8,7 +8,7 @@
::
- ndn-autoconfig-server [-h] [-p prefix] [-p prefix] ... FaceUri
+ ndn-autoconfig-server [-h] [-p <PREFIX>] [-p <PREFIX>] ... <FACEURI>
Description
@@ -24,10 +24,10 @@
``-h``
print usage and exit.
-``FaceUri``
+``<FACEURI>``
FaceUri for this NDN hub.
-``-p prefix``
+``-p <PREFIX>``
A local prefix for which the local hub allows end applications to register prefixes
(See more details in :ref:`local-prefix-discovery`). One can supply more than one
prefixes. All supplied prefixes will be put into the local prefix discovery data
diff --git a/docs/manpages/nfd-status-http-server.rst b/docs/manpages/nfd-status-http-server.rst
index a6aa0eb..e4e39eb 100644
--- a/docs/manpages/nfd-status-http-server.rst
+++ b/docs/manpages/nfd-status-http-server.rst
@@ -6,7 +6,7 @@
::
- nfd-status-http-server [-h] [-p port number] [-a IP address] [-r] [-v]
+ nfd-status-http-server [-h] [-p <PORT>] [-a <IPADDR>] [-r] [-v]
Description
-----------
@@ -19,10 +19,10 @@
``-h``
Show this help message and exit.
-``-p``
+``-p <PORT>``
HTTP server port number (default is 8080).
-``-a``
+``-a <IPADDR>``
HTTP server IP address (default is 127.0.0.1).
``-r``
diff --git a/docs/manpages/nfdc-face.rst b/docs/manpages/nfdc-face.rst
index f015daa..2d97407 100644
--- a/docs/manpages/nfdc-face.rst
+++ b/docs/manpages/nfdc-face.rst
@@ -4,10 +4,10 @@
SYNOPSIS
--------
| nfdc face [list]
-| nfdc face show <faceId>
+| nfdc face show <FACEID>
| nfdc channel [list]
-| nfdc create [-P] <faceUri>
-| nfdc destroy <faceId|faceUri>
+| nfdc create [-P] <FACEURI>
+| nfdc destroy <FACEID|FACEURI>
DESCRIPTION
-----------
@@ -36,11 +36,11 @@
A permanent face is kept alive upon socket errors,
and is closed only upon **nfdc destroy** command.
-<faceId>
+<FACEID>
Numerical identifier of the face.
It is displayed in the output of **nfdc face list** and **nfdc create** commands.
-<faceUri>
+<FACEURI>
An URI representing the remote endpoint of a face.
Its syntax is:
diff --git a/docs/manpages/nfdc-route.rst b/docs/manpages/nfdc-route.rst
index b654f8f..1cfef1d 100644
--- a/docs/manpages/nfdc-route.rst
+++ b/docs/manpages/nfdc-route.rst
@@ -5,8 +5,8 @@
--------
| nfdc route [list]
| nfdc fib [list]
-| nfdc register [-I] [-C] [-c <cost>] [-e <expiration>] [-o <origin>] <prefix> <faceId|faceUri>
-| nfdc unregister [-o <origin>] <prefix> <faceId>
+| nfdc register [-I] [-C] [-c <COST>] [-e <EXPIRATION>] [-o <ORIGIN>] <PREFIX> <FACEID|FACEURI>
+| nfdc unregister [-o <ORIGIN>] <PREFIX> <FACEID>
DESCRIPTION
-----------
@@ -35,27 +35,27 @@
-C
Set CAPTURE flag in the route.
--c <cost>
+-c <COST>
The administrative cost of the route.
The default is 0.
--e <expiration>
+-e <EXPIRATION>
Expiration time of the route, in milliseconds.
When the route expires, NFD removes it from the RIB.
The default is infinite, which keeps the route active until the nexthop face is destroyed.
--o <origin>
+-o <ORIGIN>
Origin of the route, i.e. who is announcing the route.
The default is 255, indicating a static route.
-<prefix>
+<PREFIX>
Name prefix of the route.
-<faceUri>
+<FACEURI>
An URI representing the remote endpoint of a face.
It can be used in **nfdc register** to create a new UDP or TCP face.
-<faceId>
+<FACEID>
A numerical identifier of the face.
It is displayed in the output of **nfdc face list** and **nfdc create** commands.
diff --git a/docs/manpages/nfdc-status.rst b/docs/manpages/nfdc-status.rst
index 10d1078..c5bdede 100644
--- a/docs/manpages/nfdc-status.rst
+++ b/docs/manpages/nfdc-status.rst
@@ -4,7 +4,7 @@
SYNOPSIS
--------
| nfdc status [show]
-| nfdc status report [<format>]
+| nfdc status report [<FORMAT>]
DESCRIPTION
-----------
@@ -22,7 +22,7 @@
OPTIONS
-------
-<format>
+<FORMAT>
The format of NFD status report, either ``text`` or ``xml``.
The default is ``text``.
diff --git a/docs/manpages/nfdc-strategy.rst b/docs/manpages/nfdc-strategy.rst
index 1f1c292..f89ee2b 100644
--- a/docs/manpages/nfdc-strategy.rst
+++ b/docs/manpages/nfdc-strategy.rst
@@ -4,8 +4,8 @@
SYNOPSIS
--------
| nfdc strategy [list]
-| nfdc set-strategy <prefix> <strategy>
-| nfdc unset-strategy <prefix>
+| nfdc set-strategy <PREFIX> <STRATEGY>
+| nfdc unset-strategy <PREFIX>
DESCRIPTION
-----------
@@ -27,7 +27,7 @@
OPTIONS
-------
-<prefix>
+<PREFIX>
The name prefix of a strategy choice.
The strategy choice is effective for all Interests under the name prefix,
unless overridden by another strategy choice.
@@ -35,7 +35,7 @@
Specifying ``ndn:/`` as the prefix in **nfdc unset-strategy** is disallowed,
because NFD must always have a default strategy.
-<strategy>
+<STRATEGY>
A name that identifies the forwarding strategy.
Consult NFD Developer's Guide for a complete list of all implemented strategies.