Commit graph

106 commits

Author SHA1 Message Date
Martin Mares 371adba6de Use <chapt> for chapters, <sect> for sections and <sect1> for subsections. 2000-06-02 17:23:53 +00:00
Martin Mares 6cba2d5eeb Typographical enhancements. Now, the documentation is typeset using a modified
book style.

Please look at this version and tell me your opinion. Especially I don't feel
happy about the spacing and (not) indenting of paragraphs.

Also, I've removed things like "fax" and "letter" from the LaTeX mapping file.
2000-06-02 17:22:43 +00:00
Martin Mares 3c6269b8fe Added documentation on protocols.
Protocol hooks deserve an extra chapter (to come soon).
2000-06-02 13:42:36 +00:00
Martin Mares 75317ab8e5 Spelling fixes. 2000-06-02 09:51:26 +00:00
Martin Mares f8e2d916b6 Minor fixes. 2000-06-02 09:46:35 +00:00
Martin Mares cd4fecb66a Made it *compile* !!! 2000-06-02 09:35:17 +00:00
Pavel Machek 326e33f521 Results of complete reading of documentation. 2000-06-02 07:59:26 +00:00
Martin Mares 658d272bb6 Better handling of parameterless functions. 2000-06-01 17:11:10 +00:00
Ondrej Filip 7257749266 Some other reply codes allocated. 2000-06-01 16:45:10 +00:00
Ondrej Filip a783e259d8 Cisco-like "show ospf neighbors" implemented. 2000-06-01 15:53:06 +00:00
Martin Mares c23f40b145 Use <funcsect> instead of <sect3>. 2000-06-01 15:04:25 +00:00
Martin Mares 56ca7acd3a BGP: RFC 2842 has replaced the cap-draft. 2000-06-01 12:55:26 +00:00
Pavel Machek c184d9d0bd Documentation update 2000-05-31 21:51:04 +00:00
Martin Mares 1c1f1b6c0a This should be enough from the SGMLtools distribution to make the
SGMLtools happy.

The only symlink you need now is dist/birddoc -> dist/sgmltool. I'm
convinced it could be avoided by renaming the directory instead, but I'd
rather avoid it due to CVS pecularities.
2000-05-31 14:27:49 +00:00
Martin Mares 1885aa8ce3 Clean LaTeX .aux and .toc files as well. 2000-05-31 14:25:27 +00:00
Martin Mares fcdddff5f3 Formatting of progdoc works in both HTML and LaTeX. The LaTeX output
still has somewhat weird spacing, but it will be hopefully easy
to fix.
2000-05-31 14:24:21 +00:00
Martin Mares aa185265f1 Updated headings and copyrights. 2000-05-31 13:54:00 +00:00
Martin Mares 38cf78a97a Added the introduction chapter of progdoc. 2000-05-31 13:30:58 +00:00
Martin Mares 3caca73fd9 Spelling check and update of LocalWords. 2000-05-31 13:30:29 +00:00
Martin Mares 46527a939e Modified the Makefile to work in the source tree.
From now, you can just `make userdocs' in doc, no need to use ugly scripts.

Also, `make progdocs' builds the programmer's documentation in HTML,
LaTeX version to come later.
2000-05-31 11:35:47 +00:00
Martin Mares c9c3611734 Added new output format `bird' which creates birddoc SGML. 2000-05-31 11:29:22 +00:00
Martin Mares 3fc2595495 Added tags for markup of programmer's documentation. 2000-05-31 11:28:52 +00:00
Martin Mares c92795e934 Moved old TeX documents to old/ to make them not interfere with doc building. 2000-05-31 11:28:07 +00:00
Martin Mares a2a3ced83e Added Pipe documentation. 2000-05-31 10:07:27 +00:00
Pavel Machek 36032dedc6 Added section about client. 2000-05-30 19:20:02 +00:00
Pavel Machek 7b099bf9a7 Recovering after change linuxdoc->birddoc 2000-05-30 11:50:17 +00:00
Pavel Machek 068b41272e Don't say too bad things about our concurence. 2000-05-30 11:27:42 +00:00
Pavel Machek e9df1bb647 Small change in working to make it obvious we are free software. 2000-05-30 11:23:47 +00:00
Pavel Machek 1cb10462c3 Date removed. 2000-05-30 11:22:12 +00:00
Pavel Machek f3b33928ce Tried to change garbagetime -> garbage time to be more consistent. 2000-05-30 11:15:19 +00:00
Pavel Machek 2d6627a7a5 Fixed bug in RIP docs. 2000-05-30 10:42:00 +00:00
Pavel Machek 298f2530ec Moved description of filters to programmers docs. 2000-05-30 10:13:02 +00:00
Martin Mares 5459fac61f Added BGP documentation. 2000-05-29 21:03:27 +00:00
Martin Mares 56ab03c71f Added introduction to BGP. 2000-05-29 13:47:18 +00:00
Martin Mares 0e4789c2c3 Added Kernel protocol documentation. 2000-05-29 13:13:58 +00:00
Martin Mares d9d41c6042 Capitalize properly in Install section.
BTW, what about configure options and similar things?
2000-05-29 12:46:27 +00:00
Pavel Machek 4f88ac47c6 Reduce number of chapters -- having subchapter for 2 lines of code looks ugly in output. 2000-05-29 12:23:49 +00:00
Martin Mares 0e694e041a Minor fixes as requested by Pavel. 2000-05-29 12:18:30 +00:00
Pavel Machek 440439e3cc Really short installation section added. 2000-05-29 12:05:56 +00:00
Martin Mares 04a22949d7 Renamed the DTD from linuxdoc to birddoc.
Pavel, please check whether it builds in your environment as well.
2000-05-29 12:05:21 +00:00
Martin Mares 897cd7aa55 Tried to write a better introduction. 2000-05-29 12:03:28 +00:00
Pavel Machek 9d89348914 Docs updates. 2000-05-29 11:53:24 +00:00
Martin Mares 79a2b697e3 Added description of Static, Device and Direct protocols. 2000-05-29 11:30:25 +00:00
Pavel Machek 98627595fb Better description of how route is selected. 2000-05-29 11:22:43 +00:00
Pavel Machek 2f647f3f9f Added "what is router" to introduction. 2000-05-29 11:13:51 +00:00
Martin Mares 1b55b1a364 Spelling fixes.
Added skeleton for subchapters on all the protocols. Each subchapter should
contain:

	Introduction (brief intro to the protocol, where should it be used,
		references to the relevant standards)
	Configuration
	Attributes
	Example

Added a more detailed description of RIP attributes.
2000-05-29 10:32:37 +00:00
Pavel Machek d150c6379c Documentation update. 2000-05-28 19:11:08 +00:00
Pavel Machek 216fd83c4b Spell checking. 2000-05-25 16:28:08 +00:00
Pavel Machek 9b24a6fb94 Text version generated from lynx looks as ugly as hell, sgml is much better
at generating nice output. Unfortunately, sgml output contains a^ha highlight
some printers do not like.
2000-05-25 16:17:54 +00:00
Pavel Machek d26524fa0c Add section about routing tables. 2000-05-25 15:28:24 +00:00