From a0dd1c74334fa22588f9d1c8cb73013f1940b974 Mon Sep 17 00:00:00 2001 From: Pavel Machek Date: Fri, 19 May 2000 13:58:39 +0000 Subject: [PATCH] Some spellchecking, and use right tags for right things. --- doc/bird.sgml | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/doc/bird.sgml b/doc/bird.sgml index 4bda16dd..d923e5de 100644 --- a/doc/bird.sgml +++ b/doc/bird.sgml @@ -41,7 +41,7 @@ License. Bird is designed to run on Unix and unix-like systems, it is primarily About this documentation -

This documentation can have 4 forms: sgml (this is master copy), html, ascii text (generated from +

This documentation can have 4 forms: sgml (this is master copy), html, ASCII text (generated from html) and dvi/postscript (generated from sgml using sgmltools). You should always edit master copy, it is slightly modified linuxdoc dtd. Anything in <descrip> tags is considered definition of configuration primitives, <cf> is fragment of configuration within normal text, <m> is @@ -52,8 +52,7 @@ configuration primitives, <cf> is fragment of configuration within normal

Bird is configured using text configuration file. At startup, bird reads - + protocol kernel { persist; # Don't remove routes on bird shutdown scan time 20; # Scan kernel routing table every 20 seconds @@ -68,7 +67,7 @@ protocol rip { export all; import all; } - +

Everything on a line after # is a comment, whitespace is ignored. If there's variable number of options, it is grouped using { @@ -77,8 +76,8 @@ ignored. If there's variable number of options, it is grouped using {

You can find example of more complicated configuration file in doc/bird.conf.example. Global options - - + +

log " set logging of classes (either all or { error, trace } etc.) into selected destination. You may specify more than one Per-protocol options - +

preference sets preference of this protocol. disabled disables given protocol. @@ -153,12 +152,12 @@ no equivalent of while() or for() command, and recursive functions are not permi

You can find sources of filters language in filter/ directory. filter/config.Y contains filter grammar, and basically translates source from user into tree of f_inst structures. These trees are later interpreted using code in -filter/filter.c. Filters internally work with values/variables in struct -f_val, which contains type of value and value. +filter/filter.c. Filters internally work with values/variables in struct +f_val, which contains type of value and value.

Filter basically looks like this: - + filter not_too_far int var; { @@ -173,7 +172,7 @@ int var; else accept "ok"; } - +

As you can see, filter has a header, list of local variables, and body. Header consists of type name;, where each pair defines one local variable. Body consists of @@ -224,7 +223,7 @@ booleans (that is to prevent you from shooting in the foot). @@ -242,7 +241,7 @@ is true if element is in given set or if ip address is inside given prefix. over. Functions can have zero or more parameters, and can have local variables. Function basically looks like this: - + function name () int local_variable; { @@ -253,7 +252,7 @@ function with_parameters (int parameter) { print parameter; } - +

Unlike C, variables are declared after function line but before first {. You can not declare variables in nested blocks. Functions are called like in C: name(); @@ -317,7 +316,7 @@ through multicast mode is possible. quiet option means that rip will no periodic messages onto this interface and nolisten means that rip will talk to this interface but not listen on it. -

Following options generally override specified behaviour from rfc. If you use any of these +

Following options generally override specified behavior from rfc. If you use any of these options, bird will no longer be rfc-compatible, which means it will not be able to talk to anything other than equally (mis-)configured bird. I warned you. @@ -344,8 +343,7 @@ other than equally (mis-)configured bird. I warned you.

In addition, rip defines two filter variables, both of type it. rip_metric is rip metric of current route, rip_tag is tag of current route. - - + protocol rip MyRIP_test { debug all; port 1520; @@ -360,8 +358,10 @@ protocol rip MyRIP_test { import filter { print "importing"; accept; }; export filter { print "exporting"; accept; }; } - + -# LocalWords: IPv4 IPv6 doctype verb \ No newline at end of file + \ No newline at end of file