summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/ChangeLog5
-rw-r--r--doc/bgpd.816
-rw-r--r--doc/isisd.811
-rw-r--r--doc/ospf6d.811
-rw-r--r--doc/ospfd.811
-rw-r--r--doc/ripd.814
-rw-r--r--doc/ripngd.811
-rw-r--r--doc/zebra.814
8 files changed, 66 insertions, 27 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog
index 48f78c17..6afe5a3d 100644
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,3 +1,8 @@
+2004-11-25 Hasso Tepper <hasso at quagga.net>
+
+ * *.8: Document -g/--group command line switch and some small
+ cosmetical changes.
+
2004-11-22 Paul Jakma <paul@dishone.st>
* bgpd.8: escape -/+ signs, reported by ESR to bug-zebra.
diff --git a/doc/bgpd.8 b/doc/bgpd.8
index 736250e1..e6f5bc65 100644
--- a/doc/bgpd.8
+++ b/doc/bgpd.8
@@ -1,4 +1,4 @@
-.TH BGPD 8 "10 August 2004" "Quagga BGPD daemon" "Version 0.96.5"
+.TH BGPD 8 "25 November 2004" "Quagga BGPD daemon" "Version 0.97.3"
.SH NAME
bgpd \- a BGPv4, BGPv4\+, BGPv4\- routing engine for use with Quagga routing
software
@@ -17,9 +17,6 @@ software
.B \-p
.I bgp-port-number
] [
-.B \--bgp_port=
-.I port-number
-] [
.B \-P
.I port-number
] [
@@ -28,6 +25,9 @@ software
] [
.B \-u
.I user
+] [
+.B \-g
+.I group
]
.SH DESCRIPTION
.B bgpd
@@ -46,6 +46,9 @@ Runs in daemon mode, forking and exiting from tty.
Specifies the config file to use for startup. If not specified this
option will likely default to \fB\fI/usr/local/etc/bgpd.conf\fR.
.TP
+\fB\-g\fR, \fB\-\-group \fR\fIgroup\fR
+Specify the group to run as. Default is \fIquagga\fR.
+.TP
\fB\-h\fR, \fB\-\-help\fR
A brief message.
.TP
@@ -54,7 +57,7 @@ When bgpd starts its process idenifier is written to
\fB\fIpid-file\fR. The init system uses the recorded PID to stop or
restart bgpd. The likely default is \fB\fI/var/run/bgpd.pid\fR.
.TP
-\fB\-p\fR, \fB\-\-bgp_port=\fR\fIport\fR
+\fB\-p\fR, \fB\-\-bgp_port \fR\fIbgp-port-number\fR
Set the port that bgpd will listen to for bgp data.
.TP
\fB\-P\fR, \fB\-\-vty_port \fR\fIport-number\fR
@@ -66,8 +69,7 @@ Specify the address that the bgpd VTY will listen on. Default is all
intrefaces.
.TP
\fB\-u\fR, \fB\-\-user \fR\fIuser\fR
-Specify the user and group to run as. User and group have to have same
-name at the moment. Default is \fIquagga\fR.
+Specify the user to run as. Default is \fIquagga\fR.
.TP
\fB\-r\fR, \fB\-\-retain\fR
When the program terminates, retain routes added by \fBbgpd\fR.
diff --git a/doc/isisd.8 b/doc/isisd.8
index 9e33f7c9..7ae7dbaf 100644
--- a/doc/isisd.8
+++ b/doc/isisd.8
@@ -1,4 +1,4 @@
-.TH IS-IS 8 "10 August 2004" "Quagga IS-IS daemon" "Version 0.96.5"
+.TH IS-IS 8 "25 November 2004" "Quagga IS-IS daemon" "Version 0.97.3"
.SH NAME
isisd \- an IS-IS routing engine for use with Quagga routing software.
.SH SYNOPSIS
@@ -20,6 +20,9 @@ isisd \- an IS-IS routing engine for use with Quagga routing software.
] [
.B \-u
.I user
+] [
+.B \-g
+.I group
]
.SH DESCRIPTION
.B isisd
@@ -38,6 +41,9 @@ Runs in daemon mode, forking and exiting from tty.
Specifies the config file to use for startup. If not specified this
option will likely default to \fB\fI/usr/local/etc/isisd.conf\fR.
.TP
+\fB\-g\fR, \fB\-\-group \fR\fIgroup\fR
+Specify the group to run as. Default is \fIquagga\fR.
+.TP
\fB\-h\fR, \fB\-\-help\fR
A brief message.
.TP
@@ -55,8 +61,7 @@ Specify the address that the isisd VTY will listen on. Default is all
intrefaces.
.TP
\fB\-u\fR, \fB\-\-user \fR\fIuser\fR
-Specify the user and group to run as. User and group have to have same
-name at the moment. Default is \fIquagga\fR.
+Specify the user to run as. Default is \fIquagga\fR.
.TP
\fB\-v\fR, \fB\-\-version\fR
Print the version and exit.
diff --git a/doc/ospf6d.8 b/doc/ospf6d.8
index 275844b8..2266fffe 100644
--- a/doc/ospf6d.8
+++ b/doc/ospf6d.8
@@ -1,4 +1,4 @@
-.TH OSPF6D 8 "10 August 2004" "Quagga OSPFv3 daemon" "Version 0.96.5"
+.TH OSPF6D 8 "25 November 2004" "Quagga OSPFv3 daemon" "Version 0.97.3"
.SH NAME
ospf6d \- an OSPFv3 routing engine for use with Quagga routing software.
.SH SYNOPSIS
@@ -20,6 +20,9 @@ ospf6d \- an OSPFv3 routing engine for use with Quagga routing software.
] [
.B \-u
.I user
+] [
+.B \-g
+.I group
]
.SH DESCRIPTION
.B ospf6d
@@ -39,6 +42,9 @@ Runs in daemon mode, forking and exiting from tty.
Specifies the config file to use for startup. If not specified this
option will likely default to \fB\fI/usr/local/etc/ospf6d.conf\fR.
.TP
+\fB\-g\fR, \fB\-\-group \fR\fIgroup\fR
+Specify the group to run as. Default is \fIquagga\fR.
+.TP
\fB\-h\fR, \fB\-\-help\fR
A brief message.
.TP
@@ -56,8 +62,7 @@ Specify the address that the ospf6d VTY will listen on. Default is all
intrefaces.
.TP
\fB\-u\fR, \fB\-\-user \fR\fIuser\fR
-Specify the user and group to run as. User and group have to have same
-name at the moment. Default is \fIquagga\fR.
+Specify the user to run as. Default is \fIquagga\fR.
.TP
\fB\-v\fR, \fB\-\-version\fR
Print the version and exit.
diff --git a/doc/ospfd.8 b/doc/ospfd.8
index af5a83ab..c6c1857f 100644
--- a/doc/ospfd.8
+++ b/doc/ospfd.8
@@ -1,4 +1,4 @@
-.TH OSPFD 8 "10 August 2004" "Quagga OSPFv2 daemon" "Version 0.96.5"
+.TH OSPFD 8 "25 November 2004" "Quagga OSPFv2 daemon" "Version 0.97.3"
.SH NAME
ospfd \- an OSPFv2 routing engine for use with Quagga routing software.
.SH SYNOPSIS
@@ -20,6 +20,9 @@ ospfd \- an OSPFv2 routing engine for use with Quagga routing software.
] [
.B \-u
.I user
+] [
+.B \-g
+.I group
]
.SH DESCRIPTION
.B ospfd
@@ -38,6 +41,9 @@ Runs in daemon mode, forking and exiting from tty.
Specifies the config file to use for startup. If not specified this
option will likely default to \fB\fI/usr/local/etc/ospfd.conf\fR.
.TP
+\fB\-g\fR, \fB\-\-group \fR\fIgroup\fR
+Specify the group to run as. Default is \fIquagga\fR.
+.TP
\fB\-h\fR, \fB\-\-help\fR
A brief message.
.TP
@@ -58,8 +64,7 @@ Specify the address that the ospfd VTY will listen on. Default is all
intrefaces.
.TP
\fB\-u\fR, \fB\-\-user \fR\fIuser\fR
-Specify the user and group to run as. User and group have to have same
-name at the moment. Default is \fIquagga\fR.
+Specify the user to run as. Default is \fIquagga\fR.
.TP
\fB\-a\fR, \fB\-\-apiserver \fR
Enable OSPF apiserver. Default is disabled.
diff --git a/doc/ripd.8 b/doc/ripd.8
index 2f386827..5a9f5fa8 100644
--- a/doc/ripd.8
+++ b/doc/ripd.8
@@ -1,4 +1,4 @@
-.TH RIPD 8 "10 August 2004" "Quagga RIP daemon" "Version 0.96.5"
+.TH RIPD 8 "25 November 2004" "Quagga RIP daemon" "Version 0.97.3"
.SH NAME
ripd \- a RIP routing engine for use with Quagga routing software.
.SH SYNOPSIS
@@ -20,6 +20,9 @@ ripd \- a RIP routing engine for use with Quagga routing software.
] [
.B \-u
.I user
+] [
+.B \-g
+.I group
]
.SH DESCRIPTION
.B ripd
@@ -36,7 +39,11 @@ command:
Runs in daemon mode, forking and exiting from tty.
.TP
\fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR
-Specifies the config file to use for startup. If not specified this option will likely default to \fB\fI/usr/local/etc/ripd.conf\fR.
+Specifies the config file to use for startup. If not specified this
+option will likely default to \fB\fI/usr/local/etc/ripd.conf\fR.
+.TP
+\fB\-g\fR, \fB\-\-group \fR\fIgroup\fR
+Specify the group to run as. Default is \fIquagga\fR.
.TP
\fB\-h\fR, \fB\-\-help\fR
A brief message.
@@ -55,8 +62,7 @@ Specify the address that the ripd VTY will listen on. Default is all
intrefaces.
.TP
\fB\-u\fR, \fB\-\-user \fR\fIuser\fR
-Specify the user and group to run as. User and group have to have same
-name at the moment. Default is \fIquagga\fR.
+Specify the user to run as. Default is \fIquagga\fR.
.TP
\fB\-r\fR, \fB\-\-retain\fR
When the program terminates, retain routes added by \fBripd\fR.
diff --git a/doc/ripngd.8 b/doc/ripngd.8
index 1dee0bbc..c45fc307 100644
--- a/doc/ripngd.8
+++ b/doc/ripngd.8
@@ -1,4 +1,4 @@
-.TH RIPNGD 8 "10 August 2004" "Quagga RIPNG daemon" "Version 0.96.5"
+.TH RIPNGD 8 "25 November 2004" "Quagga RIPNG daemon" "Version 0.97.3"
.SH NAME
ripngd \- a RIPNG routing engine for use with Quagga routing software.
.SH SYNOPSIS
@@ -20,6 +20,9 @@ ripngd \- a RIPNG routing engine for use with Quagga routing software.
] [
.B \-u
.I user
+] [
+.B \-g
+.I group
]
.SH DESCRIPTION
.B ripngd
@@ -39,6 +42,9 @@ Runs in daemon mode, forking and exiting from tty.
Specifies the config file to use for startup. If not specified this
option will likely default to \fB\fI/usr/local/etc/ripngd.conf\fR.
.TP
+\fB\-g\fR, \fB\-\-group \fR\fIgroup\fR
+Specify the group to run as. Default is \fIquagga\fR.
+.TP
\fB\-h\fR, \fB\-\-help\fR
A brief message.
.TP
@@ -59,8 +65,7 @@ Specify the address that the ripngd VTY will listen on. Default is all
intrefaces.
.TP
\fB\-u\fR, \fB\-\-user \fR\fIuser\fR
-Specify the user and group to run as. User and group have to have same
-name at the moment. Default is \fIquagga\fR.
+Specify the user to run as. Default is \fIquagga\fR.
.TP
\fB\-r\fR, \fB\-\-retain\fR
When the program terminates, retain routes added by \fBripd\fR.
diff --git a/doc/zebra.8 b/doc/zebra.8
index 25cbb363..a3f4b1ac 100644
--- a/doc/zebra.8
+++ b/doc/zebra.8
@@ -1,4 +1,4 @@
-.TH ZEBRA 8 "10 August 2004" "Zebra daemon" "Version 0.96.5"
+.TH ZEBRA 8 "25 November 2004" "Zebra daemon" "Version 0.97.3"
.SH NAME
zebra \- a routing manager for use with associated Quagga components.
.SH SYNOPSIS
@@ -20,6 +20,9 @@ zebra \- a routing manager for use with associated Quagga components.
] [
.B \-u
.I user
+] [
+.B \-g
+.I group
]
.SH DESCRIPTION
.B zebra
@@ -40,7 +43,11 @@ Runs in batch mode, \fBzebra\fR parses its config and exits.
Runs in daemon mode, forking and exiting from tty.
.TP
\fB\-f\fR, \fB\-\-config-file \fR\fIconfig-file\fR
-Specifies the config file to use for startup. If not specified this option will likely default to \fB\fI/usr/local/etc/zebra.conf\fR.
+Specifies the config file to use for startup. If not specified this
+option will likely default to \fB\fI/usr/local/etc/zebra.conf\fR.
+.TP
+\fB\-g\fR, \fB\-\-group \fR\fIgroup\fR
+Specify the group to run as. Default is \fIquagga\fR.
.TP
\fB\-h\fR, \fB\-\-help\fR
A brief message.
@@ -65,8 +72,7 @@ Specify the address that the zebra VTY will listen on. Default is all
intrefaces.
.TP
\fB\-u\fR, \fB\-\-user \fR\fIuser\fR
-Specify the user and group to run as. User and group have to have same
-name at the moment. Default is \fIquagga\fR.
+Specify the user to run as. Default is \fIquagga\fR.
.TP
\fB\-r\fR, \fB\-\-retain\fR
When the program terminates, retain routes added by \fBzebra\fR.