diff options
| author | Martin Winter <mwinter@opensourcerouting.org> | 2018-03-13 15:12:54 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-03-13 15:12:54 -0700 |
| commit | 2cdb3adfee540ff3367ef3206fe3807f38bc3b8b (patch) | |
| tree | fc92ed12fcbbf0a77d362939bddab9277dbee67d /doc/manpages/ospfclient.rst | |
| parent | 118c1156202f543dde9312fd5bc8ff609b8f7cf3 (diff) | |
| parent | 65230b542e66532ebd5c73a1996208f42e1a7eac (diff) | |
Merge pull request #1704 from qlyoung/docuser
Documentation update to ReST
Diffstat (limited to 'doc/manpages/ospfclient.rst')
| -rw-r--r-- | doc/manpages/ospfclient.rst | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/doc/manpages/ospfclient.rst b/doc/manpages/ospfclient.rst new file mode 100644 index 0000000000..c52b108767 --- /dev/null +++ b/doc/manpages/ospfclient.rst @@ -0,0 +1,43 @@ +********** +OSPFCLIENT +********** + +.. include:: defines.rst + +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 |