diff options
| author | Quentin Young <qlyoung@cumulusnetworks.com> | 2018-06-08 09:55:55 +0200 |
|---|---|---|
| committer | Quentin Young <qlyoung@cumulusnetworks.com> | 2018-06-08 09:55:55 +0200 |
| commit | 8421b1401de79b633b064f6c6ea6c62eebbe5672 (patch) | |
| tree | a95ad8b711b67bfea950c5e6b3480d1d84b0519e /doc | |
| parent | doc: remove :caption: from toctree (diff) | |
| download | frr-8421b1401de79b633b064f6c6ea6c62eebbe5672.tar.xz frr-8421b1401de79b633b064f6c6ea6c62eebbe5672.zip | |
doc: move find command docs to better spot
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/user/basic.rst | 54 |
1 files changed, 27 insertions, 27 deletions
diff --git a/doc/user/basic.rst b/doc/user/basic.rst index 0c2ef8ccd..a75017c44 100644 --- a/doc/user/basic.rst +++ b/doc/user/basic.rst @@ -326,6 +326,33 @@ Terminal Mode Commands Send a message to all logging destinations that are enabled for messages of the given severity. +.. index:: find COMMAND... +.. clicmd:: find COMMAND... + + This commmand performs a simple substring search across all defined commands + in all modes. As an example, suppose you're in enable mode and can't + remember where the command to turn OSPF segment routing on is: + + :: + + frr# find segment-routing on + (ospf) segment-routing on + + The CLI mode is displayed next to each command. In this example, + :clicmd:`segment-routing on` is under the `router ospf` mode. + + Similarly, suppose you want a listing of all commands that contain "l2vpn": + + :: + + frr# find l2vpn + (view) show [ip] bgp l2vpn evpn [json] + (view) show [ip] bgp l2vpn evpn all <A.B.C.D|A.B.C.D/M> [json] + (view) show [ip] bgp l2vpn evpn all neighbors A.B.C.D advertised-routes [json] + (view) show [ip] bgp l2vpn evpn all neighbors A.B.C.D routes [json] + (view) show [ip] bgp l2vpn evpn all overlay + ... + .. _common-invocation-options: @@ -611,33 +638,6 @@ insta-help, and VTY session management. line. Typing :kbd:`?` at any point in the line will show possible completions. -.. index:: find COMMAND... -.. clicmd:: find COMMAND... - - This commmand performs a simple substring search across all defined commands - in all modes. As an example, suppose you're in enable mode and can't - remember where the command to turn OSPF segment routing on is: - - :: - - frr# find segment-routing on - (ospf) segment-routing on - - The CLI mode is displayed next to each command. In this example, - :clicmd:`segment-routing on` is under the `router ospf` mode. - - Similarly, suppose you want a listing of all commands that contain "l2vpn": - - :: - - frr# find l2vpn - (view) show [ip] bgp l2vpn evpn [json] - (view) show [ip] bgp l2vpn evpn all <A.B.C.D|A.B.C.D/M> [json] - (view) show [ip] bgp l2vpn evpn all neighbors A.B.C.D advertised-routes [json] - (view) show [ip] bgp l2vpn evpn all neighbors A.B.C.D routes [json] - (view) show [ip] bgp l2vpn evpn all overlay - ... - Pipe Actions ^^^^^^^^^^^^ |