diff options
| author | Quentin Young <qlyoung@cumulusnetworks.com> | 2018-01-31 15:59:26 -0500 |
|---|---|---|
| committer | Quentin Young <qlyoung@cumulusnetworks.com> | 2018-01-31 17:27:02 -0500 |
| commit | a1e276e1d328cf3cc871da409fa098ebc428a62a (patch) | |
| tree | 91bafedd55cb6005c9bdefce3c709101bb398672 /doc/manpages/ospfclient.rst | |
| parent | 05102ddc45c8f6ebdf93c9ade0ae2d77c5f2b520 (diff) | |
doc: overhaul manpages
* Remove groff manpages
* Rewrite manpages in RST
* Clean up and standardize manpage content
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
Diffstat (limited to 'doc/manpages/ospfclient.rst')
| -rw-r--r-- | doc/manpages/ospfclient.rst | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/doc/manpages/ospfclient.rst b/doc/manpages/ospfclient.rst new file mode 100644 index 0000000000..573a75f6a7 --- /dev/null +++ b/doc/manpages/ospfclient.rst @@ -0,0 +1,41 @@ +********** +OSPFCLIENT +********** + +SYNOPSIS +======== +ospfclient <ospfd> <lsatype> <opaquetype> <opaqueid> <ifaddr> <areaid> + +DESCRIPTION +=========== +ospfclient is an example ospf-api client to test the ospfd daemon. + +OPTIONS +======= + +.. option:: ospfd + + A router where the API-enabled OSPF daemon is running. + +.. option:: lsatype + + The value has to be either "9", "10", or "11", depending on the flooding scope. + +.. option:: opaquetype + + The value has to be in the range of 0-255 (for example, experimental applications might use opaquetype larger than 128). + +.. option:: opaqueid + + Arbitrary application instance (24 bits). + +.. option:: ifaddr + + Interface IP address for type 9, otherwise it will be ignored. + +.. option:: areaid + + Area in the IP address format for type 10, otherwise it will be ignored. + + +.. include:: epilogue.rst |