[svn-commits] junky: branch junky/cli-tls r210769 - /team/junky/cli-tls/doc/cli_filters.txt

[SVN commits to the Digium repositories]

Author: junky
Date: Wed Aug  5 20:51:30 2009
New Revision: 210769

URL: http://svn.asterisk.org/svn-view/asterisk?view=rev&rev=210769
Log:
Added the documentation for the cli filtering
reviewed by Mark Michelson (thanks!)


Added:
    team/junky/cli-tls/doc/cli_filters.txt   (with props)

Added: team/junky/cli-tls/doc/cli_filters.txt
URL: http://svn.asterisk.org/svn-view/asterisk/team/junky/cli-tls/doc/cli_filters.txt?view=auto&rev=210769
==============================================================================
--- team/junky/cli-tls/doc/cli_filters.txt (added)
+++ team/junky/cli-tls/doc/cli_filters.txt Wed Aug  5 20:51:30 2009
@@ -1,0 +1,71 @@
+User Guide - CLI filtering
+
+Note: filters are case sensitive, which means creating a filter name with 'SIP' and 'sip' are different.
+
+There's basically four usages:
+1. Viewing all CLI filters
+2. Addition of CLI filters
+3. Deletion of CLI filters
+4. Deletion of all CLI filters
+
+1. viewing all CLI filters
+By default, all verbosity will be like before the addition of CLI filters, which means if no filters are created, all output to the CLI will be output, like before.
+These filters allow you to restrict the output when you're in the CLI.
+
+To view all filters, just type 'cli show filters' in the CLI. 
+All active filters will be displayed.
+
+example:
+*CLI> cli show filters 
+Active CLI Filters:
+---------------------------------------------------------------------
+0 active CLI filters.
+*CLI> 
+
+2. addition of CLI filters
+
+To add filters, you must issue the command "cli add filter <keyword> <name>", where 
+<keyword> is the type of filter you want to filter with.
+Right now, you can use name, cid_num and accountcode for keyword.
+<name> is the filter name you wish to create.
+
+When adding a filter, all verbosity will be disabled, except if it matches <name>
+
+You can't add the exact same name twice or an error will be triggered.
+You can add many filters, if needed.
+
+example:
+*CLI> cli add filter name SIP
+SIP sucessfully added to CLI filters.
+*CLI> 
+
+After the addition is completed, you should see that new filter if you perform action #1 (cli show filters).
+
+
+3. deletion of CLI filters
+To delete an active filter, you must type cli remove filter <name>, where name is the filter name to delete.
+
+You cannot remove a filter which is not active or an error will be triggered.
+
+example:
+*CLI> cli remove filter SIP
+SIP has been sucessfully removed from CLI filter list.
+*CLI> 
+
+After the deletion is completed, you should not see it anymore if you perform action #1 (cli show filters).
+
+4. Deletion of all CLI filters
+
+When having many filters, if you want to get back quickly to normal mode, it could be long to delete filter by filter (action #3).
+You can delete all active CLI filters by simply calling :
+cli reset filters
+
+Example :
+*CLI> cli reset filters
+6 active filters has been sucessfully removed from CLI filter list.
+*CLI> 
+After the reset is completed, you should not see any filters if you perform action #1 (cli show filters).
+
+Of course, you can combine all these actions in any order.
+
+

Propchange: team/junky/cli-tls/doc/cli_filters.txt
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: team/junky/cli-tls/doc/cli_filters.txt
------------------------------------------------------------------------------
    svn:keywords = Author Date Id Revision

Propchange: team/junky/cli-tls/doc/cli_filters.txt
------------------------------------------------------------------------------
    svn:mime-type = text/plain