[PATCH nft] doc: update nft list plural form parameters

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Signed-off-by: Fernando Fernandez Mancera <ffmancera@xxxxxxxxxx>
---
 doc/nft.txt | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

diff --git a/doc/nft.txt b/doc/nft.txt
index d162dad..36a92fe 100644
--- a/doc/nft.txt
+++ b/doc/nft.txt
@@ -256,6 +256,7 @@ TABLES
 [verse]
 {add | create} *table* ['family'] 'table' [ {flags 'flags'} ]
 {delete | list | flush} *table* ['family'] 'table'
+list *tables*
 delete *table* ['family'] handle 'handle'
 
 Tables are containers for chains, sets and stateful objects. They are identified
@@ -266,7 +267,8 @@ nfproto* keyword can be used to test which family (ipv4 or ipv6) context the
 packet is being processed in. When no address family is specified, *ip* is used
 by default. The only difference between add and create is that the former will
 not return an error if the specified table already exists while *create* will
-return an error.
+return an error. The plural form of list can be used to list all the existing
+tables.
 
 .Table flags
 [options="header"]
@@ -308,6 +310,7 @@ CHAINS
 [verse]
 {add | create} *chain* ['family'] 'table' 'chain' [ { type 'type' hook 'hook' [device 'device'] priority 'priority' ; [policy 'policy' ;] }]
 {delete | list | flush} *chain* ['family'] 'table' 'chain'
+list *chains*
 delete *chain* ['family'] 'table' handle 'handle'
 rename *chain* ['family'] 'table' 'chain' 'newname'
 
@@ -322,7 +325,7 @@ are specified, the chain is created as a base chain and hooked up to the network
 *create*:: Similar to the *add* command, but returns an error if the chain already exists.
 *delete*:: Delete the specified chain. The chain must not contain any rules or be used as jump target.
 *rename*:: Rename the specified chain.
-*list*:: List all rules of the specified chain.
+*list*:: List all rules of the specified chain. The plural form can be used to list all existing chains.
 *flush*:: Flush all rules of the specified chain.
 
 For base chains, *type*, *hook* and *priority* parameters are mandatory.
@@ -486,6 +489,7 @@ section describes nft set syntax in more detail.
 add *set* ['family'] 'table' 'set' { type 'type' ; [flags 'flags' ;] [timeout 'timeout' ;] [gc-interval 'gc-interval' ;] [elements = { 'element'[,...]
 } ;] [size size ;] [policy policy ;] [auto-merge auto-merge ;] }
 {delete | list | flush} *set* ['family'] 'table' 'set'
+list *sets*
 delete *set* ['family'] 'table' handle 'handle'
 {add | delete} *element* ['family'] 'table' 'set' { 'element'[,...] }
 
@@ -496,7 +500,7 @@ be tuned with the flags that can be specified at set creation time.
 [horizontal]
 *add*:: Add a new set in the specified table. See the Set specification table below for more information about how to specify a sets properties.
 *delete*:: Delete the specified set.
-*list*:: Display the elements in the specified set.
+*list*:: Display the elements in the specified set. The plural form can be used to list all the existing sets.
 *flush*:: Remove all elements from the specified set.
 *add element*:: Comma-separated list of elements to add into the specified set.
 *delete element*:: Comma-separated list of elements to delete from the specified set.
@@ -609,7 +613,8 @@ delete type ['family'] 'table' handle 'handle'
 
 Stateful objects are attached to tables and are identified by an unique name.
 They group stateful information from rules, to reference them in rules the
-keywords "type name" are used e.g. "counter name".
+keywords "type name" are used e.g. "counter name". The plural form can be used
+to list all exisiting stateful objects e.g "list counters".
 
 [horizontal]
 *add*:: Add a new stateful object in the specified table.
-- 
2.20.1




[Index of Archives]     [Netfitler Users]     [Berkeley Packet Filter]     [LARTC]     [Bugtraq]     [Yosemite Forum]

  Powered by Linux