2004-11-06 Paul Jakma <[email protected]>

	* 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.

doc/.cvsignore

@@ -1,13 +1,17 @@
 Makefile
 Makefile.in
+mdate-sh
 draft-zebra-00.txt
 zebra.info-*
 zebra.html
+defines.texi
+version.texi
 quagga.info*
 quagga.html
 quagga.pdf
 quagga.ps
 quagga.dvi
+stamp-vti
 .nfs*
 *.aux
 *.cp

doc/ChangeLog

@@ -1,3 +1,35 @@
+2004-11-06 Paul Jakma <[email protected]>
+
+	* 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.
+
 2004-10-12 Hasso Tepper <hasso at quagga.net>
 
 	* snmp.texi: ospf6d supports SNMP as well now.

doc/Makefile.am

@@ -2,9 +2,12 @@
 
 info_TEXINFOS = quagga.texi
 
+BUILT_SOURCES = defines.texi
+
 quagga_TEXINFOS = appendix.texi basic.texi bgpd.texi filter.texi install.texi \
 	ipv6.texi kernel.texi main.texi ospf6d.texi ospfd.texi overview.texi \
-	protocol.texi ripd.texi ripngd.texi routemap.texi snmp.texi vtysh.texi
+	protocol.texi ripd.texi ripngd.texi routemap.texi snmp.texi vtysh.texi \
+	defines.texi
 
 man_MANS = vtysh.1 bgpd.8 ospf6d.8 ospfd.8 ripd.8 ripngd.8 zebra.8
 

doc/appendix.texi

@@ -1,5 +1,4 @@
-@node  Packet Binary Dump Format, , Zebra Protocol, Top
-@comment  node-name,  next,  previous,  up
+@node  Packet Binary Dump Format
 @appendix Packet Binary Dump Format
 
   Quagga can dump routing protocol packet into file with a binary format

doc/basic.texi

@@ -1,5 +1,4 @@
 @node Basic commands
-@comment  node-name,  next,  previous,  up
 @chapter Basic commands
 
 There are five routing daemons in use, and there is one manager daemon.
@@ -23,8 +22,7 @@ daemons.
 
 
 
-@node Config Commands, Common Invocation Options, Basic commands, Basic commands
-@comment  node-name,  next,  previous,  up
+@node Config Commands
 @section Config Commands
 
 @cindex Configuration files for running the software
@@ -64,8 +62,7 @@ options when starting the daemon.
 
 
 
-@node Basic Config Commands, Sample Config File, Config Commands, Config Commands
-@comment  node-name,  next,  previous,  up
+@node Basic Config Commands
 @subsection Basic Config Commands
 
 @deffn Command {hostname @var{hostname}} {}
@@ -138,7 +135,7 @@ to all VTY interfaces.
 @end deffn
 
 @deffn Command {show version} {}
-Show the current version of the Quagga and its build host information.
+Show the current version of @value{PACKAGE_NAME} and its build host information.
 @end deffn
 
 @deffn Command {line vty} {}
@@ -172,8 +169,7 @@ Restrict vty connections with an access list.
 
 
 
-@node   Sample Config File,  , Basic Config Commands, Config Commands
-@comment  node-name,  next,  previous,  up
+@node Sample Config File
 @subsection Sample Config File
 
 
@@ -208,13 +204,12 @@ comment and the password is set to 'zebra!password'.
 
 
 
-@node Common Invocation Options, Virtual Terminal Interfaces, Config Commands, Basic commands
-@comment  node-name,  next,  previous,  up
+@node Common Invocation Options
 @section Common Invocation Options
 @c COMMON_OPTIONS
 @c OPTIONS section of the man page
 
-These options apply to all Quagga daemons.
+These options apply to all @value{PACKAGE_NAME} daemons.
 
 @table @samp
 
@@ -241,7 +236,7 @@ stop}.
 
 The file name is an run-time option rather than a configure-time option
 so that multiple routing daemons can be run simultaneously.  This is
-useful when using Quagga to implement a routing looking glass.  One
+useful when using @value{PACKAGE_NAME} to implement a routing looking glass.  One
 machine can be used to collect differing routing views from differing
 points in the network.
 
@@ -267,8 +262,7 @@ Print program version.
 
 
 
-@node  Virtual Terminal Interfaces,  , Common Invocation Options, Basic commands
-@comment  node-name,  next,  previous,  up
+@node Virtual Terminal Interfaces
 @section Virtual Terminal Interfaces
 
 VTY -- Virtual Terminal [aka TeletYpe] Interface is a command line
@@ -282,8 +276,7 @@ interface (CLI) for user interaction with the routing daemon.
 
 
 
-@node  VTY Overview, VTY Modes, Virtual Terminal Interfaces, Virtual Terminal Interfaces
-@comment  node-name,  next,  previous,  up
+@node VTY Overview
 @subsection VTY Overview
 
 
@@ -300,9 +293,8 @@ Trying 127.0.0.1...
 Connected to localhost.
 Escape character is '^]'.
 
-Hello, this is zebra (version @value{VERSION})
-Copyright 1997-2000 Kunihiro Ishiguro
-
+Hello, this is @value{PACKAGE_NAME} (version @value{VERSION})
+@value{COPYRIGHT_STR}
 
 User Access Verification
 
@@ -326,13 +318,9 @@ Router#
 
 '?' is very useful for looking up commands.
 
-
-
-@node  VTY Modes, VTY CLI Commands, VTY Overview, Virtual Terminal Interfaces
-@comment  node-name,  next,  previous,  up
+@node VTY Modes
 @subsection VTY Modes
 
-
 There are three basic VTY modes:
 
 @menu
@@ -343,58 +331,43 @@ There are three basic VTY modes:
 
 There are commands that may be restricted to specific VTY modes. 
 
-
-
-@node VTY View Mode, VTY Enable Mode, VTY Modes, VTY Modes
-@comment  node-name,  next,  previous,  up
+@node VTY View Mode
 @subsubsection VTY View Mode
 @c to be written (gpoul)
 
 
 This mode is for read-only access to the CLI. One may exit the mode by
 leaving the system, or by entering @code{enable} mode.
 
-
-
-@node VTY Enable Mode, VTY Other Modes, VTY View Mode, VTY Modes
-@comment  node-name,  next,  previous,  up
+@node VTY Enable Mode
 @subsubsection VTY Enable Mode
 
-
 @c to be written (gpoul)
 This mode is for read-write access to the CLI. One may exit the mode by
 leaving the system, or by escaping to view mode.
 
-
-
-@node VTY Other Modes,  , VTY Enable Mode, VTY Modes
-@comment  node-name,  next,  previous,  up
+@node VTY Other Modes
 @subsubsection VTY Other Modes
 
 
 @c to be written (gpoul)
 This page is for describing other modes.
 
-@node VTY CLI Commands,  , VTY Modes, Virtual Terminal Interfaces
-@comment  node-name,  next,  previous,  up
+@node VTY CLI Commands
 @subsection VTY CLI Commands
 
-
-Commands that you may use at the command-line are described in the following three subsubsections.
+Commands that you may use at the command-line are described in the following
+three subsubsections.
 
 @menu
 * CLI Movement Commands::       Commands for moving the cursor about
 * CLI Editing Commands::        Commands for changing text
 * CLI Advanced Commands::       Other commands, session management and so on
 @end menu
 
-
-
-@node CLI Movement Commands, CLI Editing Commands, VTY CLI Commands, VTY CLI Commands
-@comment  node-name,  next,  previous,  up
+@node CLI Movement Commands
 @subsubsection CLI Movement Commands
 
-
 These commands are used for moving the CLI cursor. The @key{C} character
 means press the Control Key.
 
@@ -430,13 +403,9 @@ Move to the end of the line.
 
 @end table
 
-
-
-@node CLI Editing Commands, CLI Advanced Commands, CLI Movement Commands, VTY CLI Commands
-@comment  node-name,  next,  previous,  up
+@node CLI Editing Commands
 @subsubsection CLI Editing Commands
 
-
 These commands are used for editing text on a line. The @key{C}
 character means press the Control Key.
 
@@ -474,13 +443,9 @@ Transpose character.
 
 @end table
 
-
-
-@node CLI Advanced Commands,  , CLI Editing Commands, VTY CLI Commands
-@comment  node-name,  next,  previous,  up
+@node CLI Advanced Commands
 @subsubsection CLI Advanced Commands
 
-
 There are several additional CLI commands for command line completions,
 insta-help, and VTY session management.