From b38154da1aa53763cd3515163501dfef305c63e7 Mon Sep 17 00:00:00 2001
From: Naoto Hanaue <hanaue.naoto@po.ntts.co.jp>
Date: Wed, 17 Jun 2015 15:49:25 +0900
Subject: docs: update cli-command-syntax.md

---
 docs/sources/cli-command-syntax.md | 98 ++++++++++++++++++++++++++------------
 1 file changed, 67 insertions(+), 31 deletions(-)

(limited to 'docs/sources/cli-command-syntax.md')

diff --git a/docs/sources/cli-command-syntax.md b/docs/sources/cli-command-syntax.md
index 1c5a9ed9..f183d281 100644
--- a/docs/sources/cli-command-syntax.md
+++ b/docs/sources/cli-command-syntax.md
@@ -21,12 +21,14 @@ Note: Currently gobgp supports only **global** and **neighbor** subcommand.
 ### Operations for Global-Rib - add/del/show -
 ```shell
 # add Route
-% gobgp global rib add <prefix> -a <address family>
+% gobgp global rib add <prefix> [-a <address family>]
 # delete a specific Route
-% gobgp global rib del <prefix> -a <address family>
+% gobgp global rib del <prefix> [-a <address family>]
 # show all Route information
-% gobgp global rib -a <address family>
+% gobgp global rib [-a <address family>]
 ```
+ - **Option**
+  - \-a , \-\-address-family: specify the ipv4, ipv6, evpn, encap, or rtc
 
 <br>
 
@@ -45,19 +47,23 @@ Note: Currently gobgp supports only **global** and **neighbor** subcommand.
 ```shell
 % gobgp neighbor <neighbor address> shutdown
 % gobgp neighbor <neighbor address> reset
-% gobgp neighbor <neighbor address> softreset -a <address family>
-% gobgp neighbor <neighbor address> softresetin -a <address family>
-% gobgp neighbor <neighbor address> softresetout -a <address family>
+% gobgp neighbor <neighbor address> softreset [-a <address family>]
+% gobgp neighbor <neighbor address> softresetin [-a <address family>]
+% gobgp neighbor <neighbor address> softresetout [-a <address family>]
 % gobgp neighbor <neighbor address> enable
 % gobgp neighbor <neighbor address> disable
 ```
+ - **Option**
+  - \-a , \-\-address-family: specify the ipv4 or ipv6
 
 ### Show Rib - local-rib/adj-rib-in/adj-rib-out -
 ```shell
-% gobgp neighbor <neighbor address> local -a <address family>
-% gobgp neighbor <neighbor address> adj-in -a <address family>
-% gobgp neighbor <neighbor address> adj-out -a <address family>
+% gobgp neighbor <neighbor address> local [-a <address family>]
+% gobgp neighbor <neighbor address> adj-in [-a <address family>]
+% gobgp neighbor <neighbor address> adj-out [-a <address family>]
 ```
+ - **Option**
+  - \-a , \-\-address-family: specify the ipv4 or ipv6
 
 ### Operations for Policy  - add/del/show -
 ```shell
@@ -73,18 +79,6 @@ Note: Currently gobgp supports only **global** and **neighbor** subcommand.
 % gobgp neighbor <neighbor address> policy
 ```
 
-### Operations for Static Route - add/del/show -
-```shell
-# add Route
-% gobgp neighbor <neighbor address> route add <prefix> -a <address family>
-# delete all Route
-% gobgp neighbor <neighbor address> route del -a <address family>
-# delete a specific Route
-% gobgp neighbor <neighbor address> route del <prefix> -a <address family>
-# show all Route information
-% gobgp neighbor <neighbor address> route -a <address family>
-```
-
 <br>
 
 ## policy subcommand
@@ -95,13 +89,13 @@ Note: Currently gobgp supports only **global** and **neighbor** subcommand.
 # delete all PrefixSet
 % gobgp policy prefix del all
 # delete a specific PrefixSet
-% gobgp policy prefix del <prefix set name>
-% gobgp policy prefix del <prefix set name> <prefix> <mask length range>
+% gobgp policy prefix del <prefix set name> [<prefix> <mask length range>]
 # show all PrefixSet information
 % gobgp policy prefix
 # show a specific PrefixSet
 % gobgp policy prefix <prefix set name>
 ```
+
 ### Operations for NeighborSet - add/del/show -
 ```shell
 # add NeighborSet
@@ -109,26 +103,68 @@ Note: Currently gobgp supports only **global** and **neighbor** subcommand.
 # delete all NeighborSet
 % gobgp policy neighbor del all
 # delete a specific NeighborSet
-% gobgp policy neighbor del <neighbor set name>
-% gobgp policy neighbor del <neighbor set name> <address>
+% gobgp policy neighbor del <neighbor set name> [<address>]
 # show all NeighborSet information
 % gobgp policy neighbor
 # show a specific NeighborSet information
 % gobgp policy neighbor <neighbor set name>
 ```
+
+### Operations for AsPathSet - add/del/show -
+```shell
+# add AsPathSet
+% gobgp policy aspath add <aspath set name> <as path>
+# delete all AsPathSet
+% gobgp policy aspath del all
+# delete a specific AsPathSet
+% gobgp policy aspath del <aspath set name> [<as path>]
+# show all AsPathSet information
+% gobgp policy aspath
+# show a specific AsPathSet information
+% gobgp policy aspath <aspath set name>
+```
+
+### Operations for CommunitySet - add/del/show -
+```shell
+# add CommunitySet
+% gobgp policy community add <community set name> <community>
+# delete all CommunitySet
+% gobgp policy community del all
+# delete a specific CommunitySet
+% gobgp policy community del <community set name> [<community>]
+# show all CommunitySet information
+% gobgp policy community
+# show a specific CommunitySet information
+% gobgp policy community <community set name>
+```
+
+
 ### Operations for RoutePolicy - add/del/show -
 ```shell
-# add conditions to RoutePolicy
-% gobgp policy routepoilcy add <route policy name> <statement name> condition <condtion>
-# add actions to RoutePolicy
-% gobgp policy routepoilcy add <route policy name> <statement name> action <aciton>
+# add RoutePolicy
+% gobgp policy routepoilcy add <route policy name> <statement name> [<conditions and actions>]
 # delete all RoutePolicy
 % gobgp policy routepoilcy del all
 # delete a specific RoutePolicy
-% gobgp policy routepoilcy del <route policy name>
-% gobgp policy routepoilcy del <route policy name> <statement name>
+% gobgp policy routepoilcy del <route policy name> [<statement name>]
 # show all RoutePolicy information
 % gobgp policy routepoilcy
 # show a specific RoutePolicy information
 % gobgp policy routepoilcy <route policy name>
 ```
+ - **Option (Conditon)**
+
+  Specify the options of condition when you use the routepolicy add subcommand.
+  - \-\-c-prefix    : specify the name that added prefix set in PrefixSet subcommand
+  - \-\-c-neighbor  : specify the name that added neighbor set in NeighborSet subcommand
+  - \-\-c-aspath    : specify the name that added as path set in AsPathSet subcommand
+  - \-\-c-community : specify the name that added community set in CommunitySet subcommand
+  - \-\-c-aslen     : specify the operator(eq, ge, le) and value(numric)
+  - \-\-c-option    : specify the match option(any, all, invert)
+
+<br>
+ - **Option (Action)**
+
+  Specify the options of action when you use the routepolicy add subcommand.
+  - \-\-a-route     : specify the action(accept, reject) of the route that match to the conditions
+  - \-\-a-community : specify the community operation of the route that match to the conditions
\ No newline at end of file
-- 
cgit v1.2.3