summaryrefslogtreecommitdiff
path: root/doc/bird.sgml
diff options
context:
space:
mode:
authorJohannes Moos <johannes.moos@de-cix.net>2023-03-18 15:33:48 +0100
committerMaria Matejka <mq@ucw.cz>2023-03-18 15:36:05 +0100
commit231c63851e3a56201dd02abfbf3fce47a80f8ae0 (patch)
tree071b2d82f1038f9f4ad25beda63ea98ca9d432f3 /doc/bird.sgml
parent2b712554d18dfb09274c003315a573f8578270ec (diff)
Add missing references to "show route in" in the cli-help and doc.
The feature of showing all prefixes inside the given one has been added in v2.0.9 but not well documented. Fixing it by this update. Text in doc and commit message added by commiter.
Diffstat (limited to 'doc/bird.sgml')
-rw-r--r--doc/bird.sgml6
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/bird.sgml b/doc/bird.sgml
index 85711c31..f75fa9fe 100644
--- a/doc/bird.sgml
+++ b/doc/bird.sgml
@@ -1113,14 +1113,16 @@ This argument can be omitted if there exists only a single instance.
Show the list of symbols defined in the configuration (names of
protocols, routing tables etc.).
- <tag><label id="cli-show-route">show route [[for] <m/prefix/|<m/IP/] [table (<m/t/ | all)] [(import|export) table <m/p/.<m/c/] [filter <m/f/|where <m/c/] [(export|preexport|noexport) <m/p/] [protocol <m/p/] [(stats|count)] [<m/options/]</tag>
+ <tag><label id="cli-show-route">show route [[(for|in)] <m/prefix/|for <m/IP/] [table (<m/t/|all)] [(import|export) table <m/p/.<m/c/] [filter <m/f/|where <m/cond/] [(export|preexport|noexport) <m/p/] [protocol <m/p/] [(stats|count)] [<m/options/]</tag>
Show contents of specified routing tables, that is routes, their metrics
and (in case the <cf/all/ switch is given) all their attributes.
<p>You can specify a <m/prefix/ if you want to print routes for a
specific network. If you use <cf>for <m/prefix or IP/</cf>, you'll get
the entry which will be used for forwarding of packets to the given
- destination. By default, all routes for each network are printed with
+ destination. Finally, if you use <cf>in <m/prefix/</cf>, you get all
+ prefixes covered by the given prefix.
+ By default, all routes for each network are printed with
the selected one at the top, unless <cf/primary/ is given in which case
only the selected route is shown.