summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--doc/.cvsignore2
-rw-r--r--doc/ChangeLog9
-rw-r--r--doc/Makefile.am32
-rw-r--r--doc/bgpd.texi5
-rw-r--r--doc/overview.texi8
-rw-r--r--doc/quagga.texi96
-rw-r--r--doc/ripd.texi7
-rw-r--r--doc/ripngd.texi4
8 files changed, 95 insertions, 68 deletions
diff --git a/doc/.cvsignore b/doc/.cvsignore
index 1b6e6bc4..449c7ae9 100644
--- a/doc/.cvsignore
+++ b/doc/.cvsignore
@@ -8,7 +8,7 @@ defines.texi
version.texi
quagga.info*
quagga.html
-quagga.pdf
+*.pdf
quagga.ps
quagga.dvi
stamp-vti
diff --git a/doc/ChangeLog b/doc/ChangeLog
index 7175a09e..5d8a570b 100644
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,6 +1,15 @@
2004-11-07 Paul Jakma <paul@dishone.st>
+ * Makefile.am: Add automatic rule to build pdf's from eps figures.
+ Clean *.pdf. Add rule for quagga.pdf (as the eps.pdf pattern
+ probably otherwise will override automake's rule for quagga.pdf)
+ * overview.texi: URL was causing TeX overfull, put on newline.
+ * quagga.texi: Put the copyright notice into @copying section, as
+ is proper. Strip trailling space from the main menu lines.
+ * rip(ng)?d.texi: Minor reformatting.
* Add the route server docs.
+ * bgpd.texi: remove unneeded page breaks. The 6Bone example
+ overflows though.
* routeserver.texi: new file, texinfo'fied and slightly modified
version of the original TeX from James Luis Rubio.
* fig-*.eps: new files, diagrammes.
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 916450f3..bcf55e24 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,13 +1,41 @@
## Process this file with automake to produce Makefile.in.
-info_TEXINFOS = quagga.texi
+EPSTOPDF = epstopdf
+
+# rather twisted logic because we have to build PDFs of the EPS figures
+# and yet build one PDF, quagga.pdf, from texi source. Which means we cant
+# rely on a single automatic rule for *.pdf.
+# If you are an automake wizard, please feel free to compact it somehow.
+#figures_pdfs = Normal-Announcement-processing.eps \
+# RS-Announcement-processing.eps \
+# topologias_full.eps topologias_rs.eps
+# Built from defines.texi.in
BUILT_SOURCES = defines.texi
+info_TEXINFOS = quagga.texi
+
+CLEANFILES = *.pdf
+
+# The figure sources
+figures_SOURCES = fig-normal-processing.eps \
+ fig_topologies_full.eps \
+ fig-rs-processing.eps \
+ fig_topologies_rs.eps
+
+# Have to manually
+quagga.pdf: quagga.texi \
+ fig-normal-processing.pdf fig_topologies_full.pdf \
+ fig-rs-processing.pdf fig_topologies_rs.pdf
+ $(TEXI2PDF) -o "$@" $(info_TEXINFOS)
+
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 \
- defines.texi
+ defines.texi $(figures_SOURCES)
+
+%.pdf: %.eps
+ $(EPSTOPDF) --outfile="$@" $<
man_MANS = vtysh.1 bgpd.8 ospf6d.8 ospfd.8 ripd.8 ripngd.8 zebra.8
diff --git a/doc/bgpd.texi b/doc/bgpd.texi
index dab367c0..0e0a2708 100644
--- a/doc/bgpd.texi
+++ b/doc/bgpd.texi
@@ -328,9 +328,6 @@ This command bind specific peer to peer group @var{word}.
@node BGP Address Family
@section BGP Address Family
-
-
-@page
@c -----------------------------------------------------------------------
@node Autonomous System
@section Autonomous System
@@ -422,7 +419,6 @@ This command defines a new AS path access list.
@node Private AS Numbers
@subsection Private AS Numbers
-@page
@c -----------------------------------------------------------------------
@node BGP Communities Attribute
@section BGP Communities Attribute
@@ -1182,6 +1178,7 @@ Display routing table of BGP view @var{name}.
@node How to set up a 6-Bone connection
@section How to set up a 6-Bone connection
+
@example
@group
zebra configuration
diff --git a/doc/overview.texi b/doc/overview.texi
index 12980379..911553f9 100644
--- a/doc/overview.texi
+++ b/doc/overview.texi
@@ -304,9 +304,11 @@ the available mailing lists, see:
@cindex Reporting software errors
@cindex Errors in the software
- If you think you have found a bug, please send a bug report to
-@uref{http://bugzilla.quagga.net}. When you send a bug report, please be
-careful about the points below.
+If you think you have found a bug, please send a bug report to:
+
+@uref{http://bugzilla.quagga.net}
+
+When you send a bug report, please be careful about the points below.
@itemize @bullet
@item
diff --git a/doc/quagga.texi b/doc/quagga.texi
index 18d52d5f..cd3b5f2f 100644
--- a/doc/quagga.texi
+++ b/doc/quagga.texi
@@ -14,16 +14,34 @@
@c and set EDITION, VERSION, UPDATED and UPDATED-MONTH
@include version.texi
+@copying
+@quotation
+Permission is granted to make and distribute verbatim copies of this
+manual provided the copyright notice and this permission notice are
+preserved on all copies.
+
+Permission is granted to copy and distribute modified versions of this
+manual under the conditions for verbatim copying, provided that the
+entire resulting derived work is distributed under the terms of a
+permission notice identical to this one.
+
+Permission is granted to copy and distribute translations of this manual
+into another language, under the above conditions for modified versions,
+except that this permission notice may be stated in a translation
+approved by Kunihiro Ishiguro.
+@end quotation
+@end copying
+
@c Info entry
@dircategory Routing Software:
@direntry
-* Quagga: (quagga). The Quagga routing software
+* Quagga: (quagga). The Quagga Software Routing Suite
@end direntry
@c @smallbook
@ifinfo
-This file documents the @sc{gnu} Quagga software which manages common
+This file documents the Quagga Software Routing Suite which manages common
TCP/IP routing protocols.
This is Edition @value{EDITION}, last updated @value{UPDATED} of
@@ -32,26 +50,7 @@ Version @value{VERSION}.
@value{COPYRIGHT_STR}
-Permission is granted to make and distribute verbatim copies of this
-manual provided the copyright notice and this permission notice are
-preserved on all copies.
-
-@ignore
-Permission is granted to process this file through TeX and print the
-results, provided the printed document carries a copyright permission
-notice identical to this one except for the removal of this paragraph
-(this paragraph not being relevant to the printed manual).
-
-@end ignore
-Permission is granted to copy and distribute modified versions of this
-manual under the conditions for verbatim copying, provided that the
-entire resulting derived work is distributed under the terms of a
-permission notice identical to this one.
-
-Permission is granted to copy and distribute translations of this manual
-into another language, under the above conditions for modified versions,
-except that this permission notice may be stated in a translation
-approved by Kunihiro Ishiguro.
+@insertcopying
@end ifinfo
@titlepage
@@ -65,19 +64,7 @@ approved by Kunihiro Ishiguro.
@vskip 0pt plus 1filll
@value{COPYRIGHT_STR}
-Permission is granted to make and distribute verbatim copies of
-this manual provided the copyright notice and this permission notice
-are preserved on all copies.
-
-Permission is granted to copy and distribute modified versions of this
-manual under the conditions for verbatim copying, provided that the entire
-resulting derived work is distributed under the terms of a permission
-notice identical to this one.
-
-Permission is granted to copy and distribute translations of this manual
-into another language, under the above conditions for modified versions,
-except that this permission notice may be stated in a translation approved
-by Kunihiro Ishiguro.
+@insertcopying
@end titlepage
@page
@@ -92,25 +79,26 @@ for quagga-@value{VERSION}. @uref{http://www.quagga.net,,Quagga} is a fork of
@end ifnottex
@menu
-* Overview::
-* Installation::
-* Basic commands::
-* Zebra::
-* RIP::
-* RIPng::
-* OSPFv2::
-* OSPFv3::
-* BGP::
-* VTY shell::
-* Filtering::
-* Route Map::
-* IPv6 Support::
-* Kernel Interface::
-* SNMP Support::
-* Zebra Protocol::
-* Packet Binary Dump Format::
-* Command Index::
-* VTY Key Index::
+* Overview::
+* Installation::
+* Basic commands::
+* Zebra::
+* RIP::
+* RIPng::
+* OSPFv2::
+* OSPFv3::
+* BGP::
+* Configuring Quagga as a Route Server::
+* VTY shell::
+* Filtering::
+* Route Map::
+* IPv6 Support::
+* Kernel Interface::
+* SNMP Support::
+* Zebra Protocol::
+* Packet Binary Dump Format::
+* Command Index::
+* VTY Key Index::
@end menu
@contents
diff --git a/doc/ripd.texi b/doc/ripd.texi
index 8874bc43..c1ddfd1b 100644
--- a/doc/ripd.texi
+++ b/doc/ripd.texi
@@ -3,7 +3,6 @@
@c @value{COPYRIGHT_STR}
@c See file quagga.texi for copying conditions.
@node RIP
-@comment node-name, next, previous, up
@chapter RIP
RIP -- Routing Information Protocol is widely deployed interior gateway
@@ -567,9 +566,9 @@ dump is shown.
Debug rip between zebra communication.
@end deffn
-This command will show the communication between @command{ripd} and @command{zebra}. The
-main information will include addition and deletion of paths to the
-kernel and the sending and receiving of interface information.
+This command will show the communication between @command{ripd} and
+@command{zebra}. The main information will include addition and deletion of
+paths to the kernel and the sending and receiving of interface information.
@deffn Command {show debugging rip} {}
Display @command{ripd}'s debugging option.
diff --git a/doc/ripngd.texi b/doc/ripngd.texi
index 433f1ab4..0e58de6d 100644
--- a/doc/ripngd.texi
+++ b/doc/ripngd.texi
@@ -1,3 +1,7 @@
+@c -*-texinfo-*-
+@c This is part of the Quagga Manual.
+@c @value{COPYRIGHT_STR}
+@c See file quagga.texi for copying conditions.
@node RIPng
@chapter RIPng
generated by cgit v1.2.1 (git 2.18.0) at 2024-12-26 04:43:41 +0000