docs, tools: expand nfd-status manpage for -c -s -x
Refs: #1689
Change-Id: I5b04f8a89e2b267d07339237ec42dceda3724125
diff --git a/docs/manpages/nfd-status.rst b/docs/manpages/nfd-status.rst
index cf80991..5a52ae2 100644
--- a/docs/manpages/nfd-status.rst
+++ b/docs/manpages/nfd-status.rst
@@ -22,14 +22,28 @@
``-v``
Retrieve version information.
+``-c``
+ Retrieve channel status information.
+
``-f``
Retrieve face status information.
``-b``
Retrieve FIB information.
+``-s``
+ Retrieve configured strategy choice for NDN namespaces.
+
+``-x``
+ Output NFD status information in XML format.
+
+``-V``
+ Show version information of nfd-status and exit.
+
If no options are provided, all information is retrieved.
+If -x is provided, other options(-v, -c, etc.) are ignored, and all information is printed in XML format.
+
Examples
--------
@@ -38,27 +52,35 @@
$ nfd-status
General NFD status:
version=1000
- startTime=20140427T230936.006000
- currentTime=20140427T231055.924000
- uptime=79 seconds
- nNameTreeEntries=12
- nFibEntries=4
+ startTime=20140621T165241.938000
+ currentTime=20140621T170712.007000
+ uptime=870 seconds
+ nNameTreeEntries=8
+ nFibEntries=2
nPitEntries=2
nMeasurementsEntries=0
nCsEntries=24
- nInInterests=20
- nOutInterests=19
+ nInInterests=33
+ nOutInterests=31
nInDatas=24
- nOutDatas=19
+ nOutDatas=18
+ Channels:
+ unix:///private/var/run/nfd.sock
+ udp6://[::]:6363
+ udp4://0.0.0.0:6363
+ tcp6://[::]:6363
+ tcp4://0.0.0.0:6363
Faces:
- faceid=1 remote=internal:// local=internal:// counters={in={0i 24d} out={20i 0d}}
- faceid=2 remote=udp4://224.0.23.170:56363 local=udp4://192.168.0.106:56363 counters={in={0i 0d} out={0i 0d}}
+ faceid=1 remote=internal:// local=internal:// counters={in={0i 26d} out={34i 0d}}
+ faceid=2 remote=udp4://224.0.23.170:56363 local=udp4://192.168.1.103:56363 counters={in={0i 0d} out={0i 0d}}
faceid=3 remote=udp4://224.0.23.170:56363 local=udp4://127.0.0.1:56363 counters={in={0i 0d} out={0i 0d}}
- faceid=5 remote=fd://16 local=unix:///private/tmp/nfd.sock counters={in={12i 1d} out={1i 11d}}
- faceid=8 remote=tcp4://131.179.196.46:6363 local=tcp4://192.168.0.106:56118 counters={in={0i 0d} out={0i 0d}}
- faceid=9 remote=fd://17 local=unix:///private/tmp/nfd.sock counters={in={2i 0d} out={0i 1d}}
+ faceid=4 remote=ether://[01:00:5e:00:17:aa] local=dev://bridge0 counters={in={0i 0d} out={0i 0d}}
+ faceid=5 remote=ether://[01:00:5e:00:17:aa] local=dev://en0 counters={in={0i 0d} out={0i 0d}}
+ faceid=6 remote=ether://[01:00:5e:00:17:aa] local=dev://en1 counters={in={0i 0d} out={0i 0d}}
+ faceid=7 remote=fd://27 local=unix:///private/var/run/nfd.sock counters={in={23i 0d} out={0i 8d}}
+ faceid=10 remote=fd://28 local=unix:///private/var/run/nfd.sock counters={in={3i 0d} out={0i 2d}}
FIB:
/localhost/nfd nexthops={faceid=1 (cost=0)}
- /localhop/nfd/rib nexthops={faceid=5 (cost=0)}
- /ndn nexthops={faceid=8 (cost=0)}
- /localhost/nfd/rib nexthops={faceid=5 (cost=0)}
+ /localhost/nfd/rib nexthops={faceid=7 (cost=0)}
+ Strategy choices:
+ / strategy=/localhost/nfd/strategy/best-route
diff --git a/tools/nfd-status.cpp b/tools/nfd-status.cpp
index b69029c..7736fc8 100644
--- a/tools/nfd-status.cpp
+++ b/tools/nfd-status.cpp
@@ -70,12 +70,12 @@
" [-f] - retrieve face status information\n"
" [-b] - retrieve FIB information\n"
" [-s] - retrieve configured strategy choice for NDN namespaces\n"
- " [-x] - retrieve NFD status information in XML format\n"
+ " [-x] - output NFD status information in XML format\n"
"\n"
" [-V] - show version information of nfd-status and exit\n"
"\n"
"If no options are provided, all information is retrieved.\n"
- "If -x is provided, other options(v, f and b) are ignored, and all information is retrieved in XML format.\n"
+ "If -x is provided, other options(-v, -c, etc.) are ignored, and all information is printed in XML format.\n"
;
}