Ondrej Zajicek
eb875dbbe1
Documentation fixes.
2009-03-14 22:18:49 +01:00
Ondrej Zajicek
ad586334d5
Path related documentation update
2009-03-14 14:01:39 +01:00
Ondrej Zajicek
e8ba557c7f
Update capability handshake options
...
Add 'capabilities' option, change default behavior to advertise ipv4,
add some checks and ignore incoming capabilities when capabilities
are disabled.
2009-03-13 12:49:44 +01:00
Ondrej Zajicek
e3299ab148
Added Cisco and Quagga capability workaround option.
2009-03-05 11:52:47 +01:00
Ondrej Zajicek
e312bb4014
Documentation update
2009-02-12 21:53:44 +01:00
Ondrej Zajicek
e29fa06ece
New read-only route attribute 'proto' added. It returns a string
...
representing a name of the protocol that originated the route.
Strings can be compared using = or matched using ~. Routes can
be filtered, for example:
show route where proto ~ "bgp1*"
2008-11-14 14:50:37 +01:00
Ondrej Zajicek
b21f68b4cd
Fix bugs in OSPF MD5 authentication. First bug is that default
...
values for MD5 password ID changed during reconfigure, Second
bug is that BIRD chooses password in first-fit manner, but RFC
says that it should use the one with the latest generate-from.
It also modifies the syntax for multiple passwords.
Now it is possible to just add more 'password' statements
to the interface section and it is not needed to use
'passwords' section. Old syntax can be used too.
2008-11-08 17:24:23 +01:00
Ondrej Zajicek
a92fe60717
Implementation of route server.
2008-11-01 12:55:43 +01:00
Ondrej Zajicek
b6bf284a90
Bugfixes in MULIT_EXIT_DISC attribute handling.
...
- Old MED handling was completely different from behavior
specified in RFCs - for example they havn't been propagated
to neighboring areas.
- Update tie-breaking according to RFC 4271.
- Change default value for 'default bgp_med' configuration
option according to RFC 4271.
2008-10-26 22:59:21 +01:00
Ondrej Zajicek
1adc17b4b5
Update of a documentation - new options for AS4, MD5 auth and route reflection.
2008-10-26 22:52:21 +01:00
Ondrej Filip
94c42054ea
Added new parametr 'rx buffer <num>'. BIRD is able to receive
...
very large packets (if configured).
2005-03-15 22:06:36 +00:00
Ondrej Filip
f735de0290
Small typos in documentation.
2005-02-21 14:06:22 +00:00
Ondrej Filip
d8c7d9e884
Since now I can also use 'dead interval', not just 'dead counter'.
2005-02-20 04:27:56 +00:00
Ondrej Filip
0d3effcf8c
Time added in password management.
2005-02-12 22:27:55 +00:00
Ondrej Filip
73089070e6
Typo.
2004-07-16 08:01:32 +00:00
Ondrej Filip
4e9742bb59
Added note about *BSD.
2004-07-15 19:46:52 +00:00
Ondrej Filip
3b16080c97
Multiple OSPF areas can be attached.
...
Origination of summary LSA works.
Routing table calculation works.
Virtual links works.
Well, I hope, OSPF is fully compatible with RFC2328!!!!
2004-07-14 21:46:20 +00:00
Ondrej Filip
62eee82321
Default tick = 1. The today's CPU is fast enough.
2004-07-13 21:27:33 +00:00
Ondrej Filip
ea357b8b6d
Update of the documentation. (passwords and md5).
...
Option for md5 auth in config.
2004-06-26 22:52:39 +00:00
Ondrej Filip
98ac61766d
A lot of changes:
...
- metric is 3 byte long now
- summary lsa originating
- more OSPF areas possible
- virtual links
- better E1/E2 routes handling
- some bug fixes..
I have to do:
- md5 auth (last mandatory item from rfc2328)
- !!!!DEBUG!!!!! (mainly virtual link system has probably a lot of bugs)
- 2328 appendig E
2004-06-25 16:39:53 +00:00
Ondrej Filip
9a4b87905d
Deleted RTS_OSPF_BOUNDARY
2004-06-11 09:06:08 +00:00
Ondrej Filip
c90ac711bc
Cleanup in show route import <p>.
2004-06-07 10:42:24 +00:00
Martin Mares
9c7631235a
Updated the documentation building tools to work with a recent linuxdoc-tools package.
...
Note that this is (and always was) a terrible hack and we really should
replace it with something reasonable which wouldn't need changing every
time linuxdoc-tools evolve.
I also needed to include a patched version of LinuxDocTools.pm, because the
original one explicitly refused to work with a non-linuxdoc DTD. The authors
of linuxdoc recommend to use sgmltools-lite in such cases, but it would mean
rewritting our formatting rules to the DSSSL language which I don't dare to
speak about here :)
2003-04-06 19:35:50 +00:00
Ondrej Filip
30c34a1079
Small bugfix in RIP documentation.
2001-12-07 17:10:49 +00:00
Ondrej Filip
16319aebd3
Dokumented switch network.
2001-08-12 00:09:47 +00:00
Ondrej Filip
b2bdb40656
Changed definition of stub area.
2001-08-11 16:22:29 +00:00
Martin Mares
4d04187465
Added paper for my talk about BIRD at SLT 2001.
2001-01-19 20:30:08 +00:00
Ondrej Filip
f02e4258b9
Some misspells.
2000-09-03 18:27:21 +00:00
Ondrej Filip
e3bc10fdc4
Added stub interface. (Interface which is propagated to OSPF but
...
it does not sends nor listens packets.)
I added some new options, please look at it and look into doc if it's OK.
2000-09-02 08:54:40 +00:00
Ondrej Filip
e7e2878b74
More examples.
2000-09-02 00:14:46 +00:00
Ondrej Filip
a190e7200b
Added hellos on NBMA networks. (I don't violate RFC now.)
2000-09-02 00:03:36 +00:00
Ondrej Filip
94e2bbcc72
Better ospf metric explanation.
2000-08-28 14:32:11 +00:00
Martin Mares
e7894ecede
Added slides for our presentation, but don't export them to the
...
distribution tarball -- they are in Czech and therefore of no use
to almost anybody :(
2000-06-26 20:02:30 +00:00
Martin Mares
99955b54be
Proper building and installation of documentation in the Makefiles.
2000-06-09 06:31:43 +00:00
Pavel Machek
96264d4d2f
Final version of documentation (famous last words)
2000-06-08 14:06:20 +00:00
Martin Mares
66701947c4
Fixes.
2000-06-08 12:56:59 +00:00
Pavel Machek
1632f1fe32
More spellchecking and typographic changes.
2000-06-08 12:38:16 +00:00
Martin Mares
725270cb1d
Fixes for the programmer's manual.
2000-06-08 12:37:21 +00:00
Martin Mares
2a56bb3bd6
Set margins.
2000-06-08 11:05:19 +00:00
Ondrej Filip
5a64ac7036
Introduction to configuration of OSPF.
2000-06-08 11:00:15 +00:00
Pavel Machek
a460184532
Tiny fixes.
2000-06-08 10:30:55 +00:00
Pavel Machek
5a203dac61
Docs updates.
2000-06-08 10:24:42 +00:00
Pavel Machek
64722c9852
Added brief description of client features. Grammar really is not good place to write help from, so please check this.
2000-06-07 15:27:16 +00:00
Pavel Machek
074a166d94
Better explanation for if/case, and RFC pointers for rip. Still searching for
...
RIPv2 rfc number!
2000-06-07 14:39:34 +00:00
Ondrej Filip
f06a219a24
Better explanation of OSPF attributes. But it's still not perfect.
2000-06-07 14:12:13 +00:00
Martin Mares
4e8ec66698
Spelling.
2000-06-07 14:08:14 +00:00
Ondrej Filip
76c7efec63
Better example for OSPF configuration.
2000-06-07 14:01:18 +00:00
Martin Mares
3ca3e999ec
Spelling and style corrections to the OSPF section.
2000-06-07 13:54:24 +00:00
Martin Mares
6316555eea
Minor tagging fixes in OSPF docs.
2000-06-07 13:32:10 +00:00
Pavel Machek
25696edb03
Full list of possible values in attributes, better operators description.
2000-06-07 13:30:02 +00:00
Ondrej Filip
088bc8add1
Bugfix in <>.
2000-06-07 13:28:54 +00:00
Martin Mares
58f7d004fd
Fixes to the progdoc.
2000-06-07 13:25:53 +00:00
Pavel Machek
0c69604c8d
SGML syntax fix.
2000-06-07 13:15:48 +00:00
Ondrej Filip
8fd12e6b27
OSPF user documentation added.
2000-06-07 12:35:43 +00:00
Martin Mares
cf0fca3035
Added `progspell' target which runs ispell on the progdoc SGML file with
...
all function, variable and structure names removed.
2000-06-07 12:27:18 +00:00
Pavel Machek
1532a244da
mj's fixes to rip documentation.
2000-06-06 20:54:05 +00:00
Pavel Machek
a7c9f7c065
Batch of mj's corrections (config + filters)
2000-06-06 20:35:59 +00:00
Martin Mares
a00c7a18f5
Typos in Static section.
2000-06-06 11:58:25 +00:00
Pavel Machek
02357f960e
Merged mj's changes, up-to "import filter".
2000-06-06 11:53:22 +00:00
Pavel Machek
a852c139dc
Don't let example overflow, and new chapter for "about routing tables".
2000-06-06 11:05:12 +00:00
Ondrej Filip
c1824c4d4c
Simple autentication added.
2000-06-06 01:23:03 +00:00
Ondrej Filip
7d68e18b41
Added NBMA into examples.
2000-06-06 00:21:06 +00:00
Ondrej Filip
ab698fc57c
Added example of OSPF configuration.
2000-06-05 21:09:03 +00:00
Martin Mares
a13eaf219a
Define element <progdoc> which initializes different formatting for the
...
programmer's guide (\raggedbottom etc.).
Also, omit "\usepackage{t1enc}", so that bullets work now.
2000-06-05 21:02:57 +00:00
Martin Mares
854128a5ed
Don't print empty synopses of functions.
2000-06-05 21:01:58 +00:00
Martin Mares
f1aa23d4b3
Minor tweaks of spacing.
2000-06-05 20:24:42 +00:00
Martin Mares
2debcb9eb0
Move TeX trickery for typesetting of function descriptions to where
...
it belongs.
2000-06-05 19:17:37 +00:00
Martin Mares
1605f043aa
Avoid using style combinations such as italic typewriter font.
2000-06-05 19:08:27 +00:00
Pavel Machek
22080a8640
Make rip example fit on page.
2000-06-05 16:42:54 +00:00
Pavel Machek
8798c81176
Docs updates:
...
make prog.dvi
do not overflow in .dvi
include filter documentation in the system
2000-06-05 16:36:16 +00:00
Martin Mares
b458ce83d7
Print out function synopsis as a part of the declaration.
...
Also, reverted my previous hack for `&' and replaced it by just disabling
the `& -> &' conversions.
2000-06-05 16:19:27 +00:00
Pavel Machek
b093c328f5
Updates to both programmers and users doc
2000-06-05 12:52:57 +00:00
Martin Mares
42b3daa09c
Description of protocol module moved to where it belongs. If documentation
...
of standard modules is stored in their source, such auxilliary files
should be as well.
2000-06-05 09:51:24 +00:00
Martin Mares
899fc0abfe
`|' now works as it should.
2000-06-03 18:22:43 +00:00
Martin Mares
2e130b5cad
Recognize `|xxxx|' as verbatim text and typeset it using <tt>.
2000-06-03 17:02:30 +00:00
Martin Mares
7e602d5ea7
Killed several bugs in kernel-doc. The most painful one was that it
...
was unable to recognize structure markers `&'.
2000-06-02 17:42:21 +00:00
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
Pavel Machek
69477cad70
Add section about utility functions in filters
2000-05-25 15:11:13 +00:00
Pavel Machek
4a5bb2bf1b
Description of types needed for BGP.
2000-05-25 15:01:08 +00:00
Pavel Machek
ba1dda495a
SGML correctness fix.
2000-05-25 14:50:46 +00:00
Pavel Machek
0e5373fd82
Some more documentation, plus minor fixes.
2000-05-25 12:33:42 +00:00
Pavel Machek
af0b25d20d
More updates.
2000-05-19 15:59:21 +00:00
Pavel Machek
242352b7a7
Improve docs of log statment, improve markup.
2000-05-19 14:13:49 +00:00
Pavel Machek
8af8a87375
Descriptive lists rendered better in TeX.
2000-05-19 14:05:55 +00:00
Pavel Machek
a0dd1c7433
Some spellchecking, and use right tags for right things.
2000-05-19 13:58:39 +00:00
Pavel Machek
7581b81bd7
More additions to documentation and spellchecking.
2000-05-16 18:47:06 +00:00
Pavel Machek
bfd7117846
Documentation fixes suggested by mj
2000-05-12 10:57:36 +00:00
Pavel Machek
6e06e6eef0
Critical files from linuxdoc1 distribution checked in.
2000-05-11 12:00:35 +00:00
Pavel Machek
0e7a720a1c
Use <m> instead of <i> in bird.sgml, fix url references.
2000-05-11 11:54:03 +00:00
Pavel Machek
7692aad10c
Don't include Rules: they are not needed and break stand-alone make of documentation.
2000-05-11 10:47:33 +00:00
Martin Mares
8aecbf160a
New example config.
2000-05-08 22:33:50 +00:00
Martin Mares
23693958aa
Implemented `show route <...> stats'.
2000-05-07 11:28:59 +00:00
Martin Mares
ce1da96ee7
Added commands show route protocol <p>' and
show route import <p>' which
...
show the routing table as exported to the protocol given resp. as returned
from its import control hook.
To get handling of filtered extended attributes right (even in the old
`show route where <filter>' command), the get_route_info hook gets an
attribute list and all protocol specific rte attributes are contained
there as temporary ones. Updated RIP to do that.
Added ea_append() which joins two ea_list's.
2000-05-06 22:57:39 +00:00
Martin Mares
b177724896
Connected the `doc' subtree to global makefiles.
...
All documentation is built in obj/doc (resp. doc/ if you do a stand-alone build).
Use `make docs' to make the whole documentation or `make userdocs' resp.
`make progdocs' for user manual resp. developer's guide.
2000-05-05 17:15:56 +00:00
Pavel Machek
249d238c14
First attempt at documenting configuration.
2000-05-05 09:39:08 +00:00
Pavel Machek
5dc4b0aae2
Display examples more nicely
2000-05-04 10:03:53 +00:00
Pavel Machek
2337ade754
Moved documentation to top of file, where it belongs.
2000-04-30 18:47:48 +00:00
Pavel Machek
e83b42deb4
Include proto/rip/rip.c in documentation system.
2000-04-28 09:55:36 +00:00
Pavel Machek
602b1445e3
Documentation-generating tool taken from linux-2.3.99-pre6, and
...
makefile to actually use it.
2000-04-28 09:48:01 +00:00
Pavel Machek
5227699606
Few bugs removed from sgml, makefile added.
2000-04-17 16:51:28 +00:00
Pavel Machek
f9b8bcca4e
Bird.html will now be autogenerated.
2000-04-17 16:49:05 +00:00