view man/routeflapper.conf.5 @ 1:47f787af96c1

update documentation to match code
author Carl Byington <carl@five-ten-sg.com>
date Tue, 13 May 2008 15:46:53 -0700
parents 48d06780cf77
children
line wrap: on
line source

.\"Generated by db2man.xsl. Don't modify this, modify the source.
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH "ROUTEFLAPPER.CONF" 5 "2008-04-12" "" ""
.SH NAME
routeflapper.conf \- configuration file for routeflapper
.SH "SYNOPSIS"
.ad l
.hy 0
.HP 18
\fBrouteflapper\&.conf\fR
.ad
.hy

.SH "DESCRIPTION"

.PP
The \fBrouteflapper\&.conf\fR configuration file is specified by this partial bnf description\&. The entire config file is case sensitive\&. All the keywords are lower case\&.

.nf

CONFIG    := {FILE}+
FILE      := "file" FILENAME "{" PATTERN+ "};"
PATTERN   := PATH | ANNOUNCE | WITHDRAW | IP
PATH      := "path" REGEX "{" INDEXPATH         '}' ";"
ANNOUNCE  := "path" REGEX "{" INDEXVAL INDEXLEN '}' ";"
WITHDRAW  := "path" REGEX "{" INDEXVAL INDEXLEN '}' ";"
IP        := "path" REGEX "{" INDEXIP           '}' ";"
INDEXPATH := "index_path"   REGEX\-INTEGER\-VALUE ";"
INDEXVAL  := "index_value"  REGEX\-INTEGER\-VALUE ";"
INDEXLEN  := "index_length" REGEX\-INTEGER\-VALUE ";"
INDEXIP   := "index_ip"     REGEX\-INTEGER\-VALUE ";"
.fi

.SH "SAMPLE"

.nf

file "/var/log/bgp" {
    path " rcvd UPDATE w\&.* path (([0\-9]| )*[0\-9])" {
        index_path 1;
    };
    announce " rcvd (([0\-9]|\\\&.)*)/([0\-9]*)$" {
        index_value  1;
        index_length 3;
    };
    withdraw " rcvd UPDATE about (([0\-9]|\\\&.)*)/([0\-9]*) \-\- withdrawn" {
        index_value  1;
        index_length 3;
    };
};

file "/var/log/maillog" {
    ip "NOQUEUE: connect from\&.* \\[(\&.*)\\]" {
        index_ip 1;
    };
};
.fi

.SH "VERSION"

.PP
1\&.0\&.1