summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorOndrej Filip <feela@network.cz>2013-11-23 13:26:52 +0100
committerOndrej Filip <feela@network.cz>2013-11-23 13:26:52 +0100
commitd940a2c4d4096f761a750e2df42ab55fd27a7e80 (patch)
tree74b28e655c97297791b864289f932e61f0075971 /doc
parent2b3d52aa421ae1c31e30107beefd82fddbb42854 (diff)
Added a few sentences about symbol names.
Diffstat (limited to 'doc')
-rw-r--r--doc/bird.sgml5
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/bird.sgml b/doc/bird.sgml
index 46d2e026..e208f1e2 100644
--- a/doc/bird.sgml
+++ b/doc/bird.sgml
@@ -256,7 +256,10 @@ which allows you to talk with BIRD in an extensive way.
<p>In the config, everything on a line after <cf/#/ or inside <cf>/*
*/</cf> is a comment, whitespace characters are treated as a single space. If there's a variable number of options, they are grouped using
the <cf/{ }/ brackets. Each option is terminated by a <cf/;/. Configuration
-is case sensitive.
+is case sensitive. There are two ways how to name symbols (like protocol names, filter names, constats etc.). You can either use
+a simple string starting with a letter followed by any combination of letters and numbers (e.g. "R123", "myfilter", "bgp5") or you
+can enclose the name into apostrophes (<cf/'/) and than you can use any combination of numbers, letters. hyphens, dots and colons
+(e.g. "'1:strange-name'", "'-NAME-'", "'cool::name'").
<p>Here is an example of a simple config file. It enables
synchronization of routing tables with OS kernel, scans for