2004-11-06 Paul Jakma <paul@dishone.st>
* defines.texi.in: New file, texi variables should be set here,
autoconf substitution is available. Define common AUTHORS,
COPYRIGHT_YEAR and COPYRIGHT_STR vars.
* (global): Make use of makeinfo node pointer auto-creation
to avoid having to fully specify links for nodes, so we only have
to specify current node name - simplifies text slightly.
Remove extraneous newlines which appear to cause extra blank pages
to be added in output.
Update copyright strings which appear in various places to
use the new COPYRIGHT_STR texinfo variable.
Change url to uref, the former need not output an actual
hyperlink depending on version of texinfo, the latter should if
supported by the format (eg PDF).
* texinfo.tex: Update to a more recent version. previous file
was many many years old. This file should possibly be removed
altogether, and allowed to be installed by automake.
* quagga.texi: Make use of automake's version.texi feature to
have VERSION and some other vars auto-defined. include
defines.texi. Change copyright strings to use the COPYRIGHT_STR
variable.
* install.texi: Make the privs section an actual section. Ditto for
the Linux notes.
* overview.texi: Supply URL for Quagga, where format allows. Tidy up
one or two paragraphs slightly.
Update the section on supported platforms.
Remove the ZNOG list stuff, direct reader to the website for
further information on email lists.
* vtysh.texi: Update the integrated config file section. Make the
commands sections so correct PDF indexes are built.
diff --git a/doc/vtysh.texi b/doc/vtysh.texi
index de59f7f..b4c3fcb 100644
--- a/doc/vtysh.texi
+++ b/doc/vtysh.texi
@@ -1,5 +1,4 @@
@node VTY shell
-@comment node-name, next, previous, up
@chapter VTY shell
@command{vtysh} is integrated shell of Quagga software.
@@ -14,6 +13,14 @@
Currently, vtysh.conf has only two commands.
+@menu
+* VTY shell username::
+* VTY shell integrated configuration::
+@end menu
+
+@node VTY shell username
+@section VTY shell username
+
@deffn {Command} {username @var{username} nopassword} {}
With this set, user foo does not need password authentication for user vtysh.
@@ -26,28 +33,29 @@
@end deffn
-@deffn {Command} {write-conf daemon} {}
-Instruct daemons to write out their config files when 'write file'
-is issued.
-@end deffn
-@deffn {Command} {write-conf integrated} {}
-Write out integrated Quagga.conf file when 'write file' is issued.
-@end deffn
+@node VTY shell integrated configuration
+@section
-This command controls the behaviour of vtysh when it is told
-to write out the configuration. If @command{write-conf integrated} is
-set, the daemon will write out a Quagga.conf with all daemons' commands
-integrated into it. If @command{write-conf daemon} is set, vtysh
-will instruct each daemon to write out their config files.
+@deffn {Command} {service integrated-vtysh-config} {}
+Write out integrated Quagga.conf file when 'write file' is issued.
+
+This command controls the behaviour of vtysh when it is told to write out
+the configuration. Per default, vtysh will instruct each daemon to write
+out their own config files when @command{write file} is issued. However, if
+@command{service integrated-vtysh-config} is set, when @command{write file}
+is issued, vtysh will instruct the daemons will write out a Quagga.conf with
+all daemons' commands integrated into it.
Vtysh per default behaves as if @command{write-conf daemon} is set. Note
-that both may be set at same time if one wishes to have both
-Quagga.conf and daemon specific files written out. Further, note that the
-daemons are hard-coded to first look for the integrated Quagga.conf
-file before looking for their own file.
+that both may be set at same time if one wishes to have both Quagga.conf and
+daemon specific files written out. Further, note that the daemons are
+hard-coded to first look for the integrated Quagga.conf file before looking
+for their own file.
-We recommend you do not mix the use of the two types of files.
-Further, it is better not to use the integrated Quagga.conf file,
-as any syntax error in it can lead to /all/ of your daemons being unable
-to start up. Per daemon files are more robust as impact of errors in
-configuration are limited to the daemon in whose file the error is made.
+We recommend you do not mix the use of the two types of files. Further, it
+is better not to use the integrated Quagga.conf file, as any syntax error in
+it can lead to /all/ of your daemons being unable to start up. Per daemon
+files are more robust as impact of errors in configuration are limited to
+the daemon in whose file the error is made.
+
+@end deffn