Jerry/bird
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Doc: Change debug to { flag1|flag2|flag3 [, ...] } style

Browse source 
Thanks to Micah Anderson for bug report and Ondrej Zajicek for the idea!
This commit is contained in:
Pavel Tvrdik 2016-09-05 11:20:28 +02:00 committed by Ondrej Zajicek (work)
parent 9fcb9637b5
commit 9df52a98e2
2 changed files with 19 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
doc/bird.sgml
View file

@ -344,7 +344,7 @@ protocol rip {
<tag><label id="opt-log">log "<m/filename/"|syslog [name <m/name/]|stderr all|{ <m/list of classes/ }</tag> <tag><label id="opt-log">log "<m/filename/"|syslog [name <m/name/]|stderr all|{ <m/list of classes/ }</tag>
Set logging of messages having the given class (either <cf/all/ or Set logging of messages having the given class (either <cf/all/ or
<cf/{ error, trace }/ etc.) into selected destination (a file specified <cf/{ error|trace [, <m/.../] }/ etc.) into selected destination (a file specified
as a filename string, syslog with optional name argument, or the stderr as a filename string, syslog with optional name argument, or the stderr
output). Classes are: output). Classes are:
<cf/info/, <cf/warning/, <cf/error/ and <cf/fatal/ for messages about local problems, <cf/info/, <cf/warning/, <cf/error/ and <cf/fatal/ for messages about local problems,
@ -356,7 +356,7 @@ protocol rip {
You may specify more than one <cf/log/ line to establish logging to You may specify more than one <cf/log/ line to establish logging to
multiple destinations. Default: log everything to the system log. multiple destinations. Default: log everything to the system log.
<tag><label id="opt-debug-protocols">debug protocols all|off|{ states, routes, filters, interfaces, events, packets }</tag> <tag><label id="opt-debug-protocols">debug protocols all|off|{ states|routes|filters|interfaces|events|packets [, <m/.../] }</tag>
Set global defaults of protocol debugging options. See <cf/debug/ in the Set global defaults of protocol debugging options. See <cf/debug/ in the
following section. Default: off. following section. Default: off.
@ -386,7 +386,7 @@ protocol rip {
Set MRTdump file name. This option must be specified to allow MRTdump Set MRTdump file name. This option must be specified to allow MRTdump
feature. Default: no dump file. feature. Default: no dump file.
<tag><label id="opt-mrtdump-protocols">mrtdump protocols all|off|{ states, messages }</tag> <tag><label id="opt-mrtdump-protocols">mrtdump protocols all|off|{ states|messages [, <m/.../] }</tag>
Set global defaults of MRTdump options. See <cf/mrtdump/ in the Set global defaults of MRTdump options. See <cf/mrtdump/ in the
following section. Default: off. following section. Default: off.
@ -397,7 +397,7 @@ protocol rip {
<tag><label id="opt-function">function <m/name/ (<m/parameters/) <m/local variables/ { <m/commands/ }</tag> <tag><label id="opt-function">function <m/name/ (<m/parameters/) <m/local variables/ { <m/commands/ }</tag>
Define a function. You can learn more about functions in the following chapter. Define a function. You can learn more about functions in the following chapter.
<tag><label id="opt-protocol">protocol rip|ospf|bgp|... [<m/name/ [from <m/name2/]] { <m>protocol options</m> }</tag> <tag><label id="opt-protocol">protocol rip|ospf|bgp|<m/.../ [<m/name/ [from <m/name2/]] { <m>protocol options</m> }</tag>
Define a protocol instance called <cf><m/name/</cf> (or with a name like Define a protocol instance called <cf><m/name/</cf> (or with a name like
"rip5" generated automatically if you don't specify any "rip5" generated automatically if you don't specify any
<cf><m/name/</cf>). You can learn more about configuring protocols in <cf><m/name/</cf>). You can learn more about configuring protocols in
@ -406,7 +406,7 @@ protocol rip {
<cf><m/name2/</cf> You can run more than one instance of most protocols <cf><m/name2/</cf> You can run more than one instance of most protocols
(like RIP or BGP). By default, no instances are configured. (like RIP or BGP). By default, no instances are configured.
<tag><label id="opt-template">template rip|bgp|... [<m/name/ [from <m/name2/]] { <m>protocol options</m> }</tag> <tag><label id="opt-template">template rip|bgp|<m/.../ [<m/name/ [from <m/name2/]] { <m>protocol options</m> }</tag>
Define a protocol template instance called <m/name/ (or with a name like Define a protocol template instance called <m/name/ (or with a name like
"bgp1" generated automatically if you don't specify any <m/name/). "bgp1" generated automatically if you don't specify any <m/name/).
Protocol templates can be used to group common options when many Protocol templates can be used to group common options when many
@ -427,7 +427,7 @@ protocol rip {
version, the lowest IP address of a non-loopback interface. In IPv6 version, the lowest IP address of a non-loopback interface. In IPv6
version, this option is mandatory. version, this option is mandatory.
<tag><label id="opt-router-id-from">router id from [-] [ "<m/mask/" ] [ <m/prefix/ ] [, ...]</tag> <tag><label id="opt-router-id-from">router id from [-] [ "<m/mask/" ] [ <m/prefix/ ] [, <m/.../]</tag>
Set BIRD's router ID based on an IP address of an interface specified by Set BIRD's router ID based on an IP address of an interface specified by
an interface pattern. The option is applicable for IPv4 version only. an interface pattern. The option is applicable for IPv4 version only.
See <ref id="proto-iface" name="interface"> section for detailed See <ref id="proto-iface" name="interface"> section for detailed
@ -480,7 +480,7 @@ protocol rip {
Option <cf/sorted/ can be used to enable sorting of routes, see Option <cf/sorted/ can be used to enable sorting of routes, see
<ref id="dsc-table-sorted" name="sorted table"> description for details. <ref id="dsc-table-sorted" name="sorted table"> description for details.
<tag><label id="opt-roa-table">roa table <m/name/ [ { roa table options ... } ]</tag> <tag><label id="opt-roa-table">roa table <m/name/ [ { <m/roa table options .../ } ]</tag>
Create a new ROA (Route Origin Authorization) table. ROA tables can be Create a new ROA (Route Origin Authorization) table. ROA tables can be
used to validate route origination of BGP routes. A ROA table contains used to validate route origination of BGP routes. A ROA table contains
ROA entries, each consist of a network prefix, a max prefix length and ROA entries, each consist of a network prefix, a max prefix length and
@ -522,7 +522,7 @@ agreement").
command line interface without needing to touch the configuration. command line interface without needing to touch the configuration.
Disabled protocols are not activated. Default: protocol is enabled. Disabled protocols are not activated. Default: protocol is enabled.
<tag><label id="proto-debug">debug all|off|{ states, routes, filters, interfaces, events, packets }</tag> <tag><label id="proto-debug">debug all|off|{ states|routes|filters|interfaces|events|packets [, <m/.../] }</tag>
Set protocol debugging options. If asked, each protocol is capable of Set protocol debugging options. If asked, each protocol is capable of
writing trace messages about its work to the log (with category writing trace messages about its work to the log (with category
<cf/trace/). You can either request printing of <cf/all/ trace messages <cf/trace/). You can either request printing of <cf/all/ trace messages
@ -533,7 +533,7 @@ agreement").
protocol, <cf/events/ for events internal to the protocol and <cf/packets/ protocol, <cf/events/ for events internal to the protocol and <cf/packets/
for packets sent and received by the protocol. Default: off. for packets sent and received by the protocol. Default: off.
<tag><label id="proto-mrtdump">mrtdump all|off|{ states, messages }</tag> <tag><label id="proto-mrtdump">mrtdump all|off|{ states|messages [, <m/.../] }</tag>
Set protocol MRTdump flags. MRTdump is a standard binary format for Set protocol MRTdump flags. MRTdump is a standard binary format for
logging information from routing protocols and daemons. These flags logging information from routing protocols and daemons. These flags
control what kind of information is logged from the protocol to the control what kind of information is logged from the protocol to the
@ -603,7 +603,7 @@ agreement").
<p>There are several options that give sense only with certain protocols: <p>There are several options that give sense only with certain protocols:
<descrip> <descrip>
<tag><label id="proto-iface">interface [-] [ "<m/mask/" ] [ <m/prefix/ ] [, ...] [ { <m/option/ ; [...] } ]</tag> <tag><label id="proto-iface">interface [-] [ "<m/mask/" ] [ <m/prefix/ ] [, <m/.../] [ { <m/option/; [<m/.../] } ]</tag>
Specifies a set of interfaces on which the protocol is activated with Specifies a set of interfaces on which the protocol is activated with
given interface-specific options. A set of interfaces specified by one given interface-specific options. A set of interfaces specified by one
interface option is described using an interface pattern. The interface interface option is described using an interface pattern. The interface
@ -895,7 +895,7 @@ This argument can be omitted if there exists only a single instance.
<tag><label id="cli-down">down</tag> <tag><label id="cli-down">down</tag>
Shut BIRD down. Shut BIRD down.
<tag><label id="cli-debug">debug <m/protocol/|<m/pattern/|all all|off|{ states | routes | filters | events | packets }</tag> <tag><label id="cli-debug">debug <m/protocol/|<m/pattern/|all all|off|{ states|routes|filters|events|packets [, <m/.../] }</tag>
Control protocol debugging. Control protocol debugging.
<tag><label id="cli-dump">dump resources|sockets|interfaces|neighbors|attributes|routes|protocols</tag> <tag><label id="cli-dump">dump resources|sockets|interfaces|neighbors|attributes|routes|protocols</tag>
@ -1638,7 +1638,7 @@ protocol bfd [&lt;name&gt;] {
</code> </code>
<descrip> <descrip>
<tag><label id="bfd-iface">interface <m/pattern [, ...]/ { <m/options/ }</tag> <tag><label id="bfd-iface">interface <m/pattern/ [, <m/.../] { <m/options/ }</tag>
Interface definitions allow to specify options for sessions associated Interface definitions allow to specify options for sessions associated
with such interfaces and also may contain interface specific options. with such interfaces and also may contain interface specific options.
See <ref id="proto-iface" name="interface"> common option for a detailed See <ref id="proto-iface" name="interface"> common option for a detailed
@ -2356,7 +2356,7 @@ on Linux systems BIRD cannot change non-BIRD route in the kernel routing table.
<p>There are just few configuration options for the Direct protocol: <p>There are just few configuration options for the Direct protocol:
<p><descrip> <p><descrip>
<tag><label id="direct-iface">interface <m/pattern [, ...]/</tag> <tag><label id="direct-iface">interface <m/pattern/ [, <m/.../]</tag>
By default, the Direct protocol will generate device routes for all the By default, the Direct protocol will generate device routes for all the
interfaces available. If you want to restrict it to some subset of interfaces available. If you want to restrict it to some subset of
interfaces or addresses (e.g. if you're using multiple routing tables interfaces or addresses (e.g. if you're using multiple routing tables
@ -3253,7 +3253,7 @@ in <rfc id="4861"> and also the DNS extensions from <rfc id="6106">.
definitions, prefix definitions and DNS definitions: definitions, prefix definitions and DNS definitions:
<descrip> <descrip>
<tag><label id="radv-iface">interface <m/pattern [, ...]/ { <m/options/ }</tag> <tag><label id="radv-iface">interface <m/pattern/ [, <m/.../] { <m/options/ }</tag>
Interface definitions specify a set of interfaces on which the Interface definitions specify a set of interfaces on which the
protocol is activated and contain interface specific options. protocol is activated and contain interface specific options.
See <ref id="proto-iface" name="interface"> common options for See <ref id="proto-iface" name="interface"> common options for
@ -3563,7 +3563,7 @@ protocol rip [&lt;name&gt;] {
nexthops in one route. By default, ECMP is disabled. If enabled, nexthops in one route. By default, ECMP is disabled. If enabled,
default value of the limit is 16. default value of the limit is 16.
<tag><label id="rip-iface">interface <m/pattern [, ...]/ { <m/options/ }</tag> <tag><label id="rip-iface">interface <m/pattern/ [, <m/.../] { <m/options/ }</tag>
Interface definitions specify a set of interfaces on which the Interface definitions specify a set of interfaces on which the
protocol is activated and contain interface specific options. protocol is activated and contain interface specific options.
See <ref id="proto-iface" name="interface"> common options for See <ref id="proto-iface" name="interface"> common options for
@ -3795,7 +3795,7 @@ definition of the protocol contains mainly a list of static routes.
interface can be specified as a part of the address (e.g., interface can be specified as a part of the address (e.g.,
<cf/via fe80::1234%eth0/). <cf/via fe80::1234%eth0/).
<tag><label id="static-route-via-mpath">route <m/prefix/ multipath via <m/ip/ [weight <m/num/] [bfd <m/switch/] [via ...]</tag> <tag><label id="static-route-via-mpath">route <m/prefix/ multipath via <m/ip/ [weight <m/num/] [bfd <m/switch/] [via <m/.../]</tag>
Static multipath route. Contains several nexthops (gateways), possibly Static multipath route. Contains several nexthops (gateways), possibly
with their weights. with their weights.

6
nest/config.Y
View file

@ -658,7 +658,7 @@ CF_CLI(EVAL, term, <expr>, [[Evaluate an expression]])
{ cmd_eval($2); } ; { cmd_eval($2); } ;
CF_CLI_HELP(ECHO, ..., [[Control echoing of log messages]]) CF_CLI_HELP(ECHO, ..., [[Control echoing of log messages]])
CF_CLI(ECHO, echo_mask echo_size, (all | off | { debug | trace | info | remote | warning | error | auth }) [<buffer-size>], [[Control echoing of log messages]]) { CF_CLI(ECHO, echo_mask echo_size, (all | off | { debug|trace|info|remote|warning|error|auth [, ...] }) [<buffer-size>], [[Control echoing of log messages]]) {
cli_set_log_echo(this_cli, $2, $3); cli_set_log_echo(this_cli, $2, $3);
cli_msg(0, ""); cli_msg(0, "");
} ; } ;
@ -691,11 +691,11 @@ CF_CLI(RELOAD OUT, proto_patt, <protocol> | \"<pattern>\" | all, [[Reload protoc
{ proto_apply_cmd($3, proto_cmd_reload, 1, CMD_RELOAD_OUT); } ; { proto_apply_cmd($3, proto_cmd_reload, 1, CMD_RELOAD_OUT); } ;
CF_CLI_HELP(DEBUG, ..., [[Control protocol debugging via BIRD logs]]) CF_CLI_HELP(DEBUG, ..., [[Control protocol debugging via BIRD logs]])
CF_CLI(DEBUG, proto_patt debug_mask, (<protocol> | <pattern> | all) (all | off | { states | routes | filters | interfaces | events | packets }), [[Control protocol debugging via BIRD logs]]) CF_CLI(DEBUG, proto_patt debug_mask, (<protocol> | \"<pattern>\" | all) (all | off | { states|routes|filters|interfaces|events|packets [, ...] }), [[Control protocol debugging via BIRD logs]])
{ proto_apply_cmd($2, proto_cmd_debug, 1, $3); } ; { proto_apply_cmd($2, proto_cmd_debug, 1, $3); } ;
CF_CLI_HELP(MRTDUMP, ..., [[Control protocol debugging via MRTdump files]]) CF_CLI_HELP(MRTDUMP, ..., [[Control protocol debugging via MRTdump files]])
CF_CLI(MRTDUMP, proto_patt mrtdump_mask, (<protocol> | <pattern> | all) (all | off | { states | messages }), [[Control protocol debugging via MRTdump format]]) CF_CLI(MRTDUMP, proto_patt mrtdump_mask, (<protocol> | \"<pattern>\" | all) (all | off | { states|messages [, ...] }), [[Control protocol debugging via MRTdump format]])
{ proto_apply_cmd($2, proto_cmd_mrtdump, 1, $3); } ; { proto_apply_cmd($2, proto_cmd_mrtdump, 1, $3); } ;
CF_CLI(RESTRICT,,,[[Restrict current CLI session to safe commands]]) CF_CLI(RESTRICT,,,[[Restrict current CLI session to safe commands]])