doc: Update man page for Quagga systemctl script

Create the man page for the quagga systemctl script.

Ticket: CM-9748
Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
Reviewed-by: Don Slice <dslice@cumulusnetworks.com>

diff --git a/debian/quagga.install b/debian/quagga.install
index 135ce53fa585e747bb77e789aedfc22fd64c16d9..38f6a770f51578570724fa1c59f4edb09d04d6dd 100644 (file)
--- a/debian/quagga.install
+++ b/debian/quagga.install
@@ -6,6 +6,7 @@ tools/quagga-reload.py usr/lib/quagga/
 tools/quagga usr/bin
 usr/share/doc/quagga/
 usr/share/man/man1/vtysh.1
+usr/share/man/man1/quagga.1
 usr/share/man/man8
 usr/share/man/man8/bgpd.8
 usr/share/man/man8/ospf6d.8

diff --git a/doc/Makefile.am b/doc/Makefile.am
index f313c6c7e1b7bf5dfe10d27dddf2bfe12c02b8b3..96aee59d5cede7db202bee70e4ee575788a39517 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -61,7 +61,7 @@ quagga_TEXINFOS = appendix.texi basic.texi bgpd.texi filter.texi \
 .dia.png:
        $(DIATOPNG) "$@" $<
 
-man_MANS = 
+man_MANS = quagga.1
 
 if BGPD
 man_MANS += bgpd.8

diff --git a/doc/quagga.1 b/doc/quagga.1
new file mode 100644 (file)
index 0000000..35e8b30
--- /dev/null
+++ b/doc/quagga.1
@@ -0,0 +1,65 @@
+.TH Quagga 1 "27 July 2006" "Quagga Systemd Script" "Version 0.99.23.1"
+.SH NAME
+quagga \- a systemd interaction script
+.SH SYNOPSIS
+.B quagga
+[
+.B start
+]
+.br
+.B quagga
+[
+.B stop
+]
+.br
+.B quagga
+[
+.B reload
+]
+.br
+.B quagga
+[
+.B restart
+]
+.br
+.B quagga
+[
+.B status
+]
+.br
+.SH DESCRIPTION
+.B Quagga
+is a systemd interaction script for the
+.B Quagga
+routing engine.
+.SH OPTIONS
+Options available for the
+.B quagga
+command:
+.IP start
+Start enabled Quagga daemons
+.IP stop
+Stop enabled Quagga daemons
+.IP reload
+Reload modified configuration files
+.IP restart
+Stop all running daemons and then restart them
+.IP status
+Status of all the daemons
+.SH "SEE ALSO"
+.BR bgpd (8),
+.BR ripd (8),
+.BR ripngd (8),
+.BR ospfd (8),
+.BR ospf6d (8),
+.BR isisd (8),
+.BR zebra (8)
+.SH BUGS
+.B quagga
+eats bugs for breakfast. If you have food for the maintainers try 
+.BI http://bugzilla.quagga.net
+.SH AUTHORS
+See
+.BI http://www.quagga.net
+or the Info file for an accurate list of authors.
+

diff --git a/tools/quagga b/tools/quagga
index a43335ecf63adfc72ad92bb86a18c6a05d5c63f5..033db66e3fdb547d6c3dfdcca2ea075ad891b96b 100755 (executable)
--- a/tools/quagga
+++ b/tools/quagga
@@ -71,6 +71,8 @@ case "$1" in
         systemctl -l -o cat -n0 status zebra bgpd ospfd ospf6d ripd ripngd isisd
         exit $?
          ;;
+     help)
+        man -s 1 quagga
      *)
         echo "Unknown option entered"
         exit -1