summaryrefslogtreecommitdiff
path: root/doc/manpages/ospfclient.8.in
diff options
context:
space:
mode:
authorQuentin Young <qlyoung@cumulusnetworks.com>2018-01-30 16:14:24 -0500
committerQuentin Young <qlyoung@cumulusnetworks.com>2018-01-30 16:14:24 -0500
commit3eb7a2f08bc8ee3b3f69ae0fda37a662fdb752a1 (patch)
tree079b667f24595d92c20deef4f107f6fd0b1c1bfa /doc/manpages/ospfclient.8.in
parentcb39e63e59ab338eb1edb40df4af6e55a5ecd9a9 (diff)
doc: reorganize
* Move all developer related docs into developer/ * Move all figures into their own directory * Move manpages to own directory Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
Diffstat (limited to 'doc/manpages/ospfclient.8.in')
-rw-r--r--doc/manpages/ospfclient.8.in42
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/manpages/ospfclient.8.in b/doc/manpages/ospfclient.8.in
new file mode 100644
index 0000000000..a304beffda
--- /dev/null
+++ b/doc/manpages/ospfclient.8.in
@@ -0,0 +1,42 @@
+.\" This file was originally generated by help2man 1.36.
+.TH OSPFCLIENT "8" "July 2010"
+.SH NAME
+ospfclient \- an example ospf-api client
+.SH SYNOPSIS
+.B ospfclient
+.I ospfd
+.I lsatype
+.I opaquetype
+.I opaqueid
+.I ifaddr
+.I areaid
+.SH DESCRIPTION
+.B ospfclient
+is a an example ospf-api client to test the ospfd daemon.
+.SH OPTIONS
+.TP
+.I ospfd
+A router where the API\-enabled OSPF daemon is running.
+.TP
+.I lsatype
+The value has to be either "9", "10", or "11", depending on the flooding
+scope.
+.TP
+.I opaquetype
+The value has to be in the range of 0\-255 (for example, experimental
+applications use
+.I opaquetype
+larger than 128).
+.TP
+.I opaqueid
+Arbitrary application instance (24 bits).
+.TP
+.I ifaddr
+Interface IP address for type 9, otherwise it will be ignored.
+.TP
+.I areaid
+Area in the IP address format for type 10, otherwise it will be ignored.
+.SH "SEE ALSO"
+.BR ospfd (8).
+.SH AUTHORS
+See the project homepage at <@PACKAGE_URL@>.