Author: adc
Date: Thu Jul 17 05:24:27 2014
New Revision: 1611251
URL: http://svn.apache.org/r1611251
Log:
Updated documentation
Modified:
labs/panopticon/pan-commands/docs/source/reference/commands/common_arguments.en.rst
labs/panopticon/pan-commands/docs/source/reference/commands/moderator.en.rst
Modified:
labs/panopticon/pan-commands/docs/source/reference/commands/common_arguments.en.rst
URL:
http://svn.apache.org/viewvc/labs/panopticon/pan-commands/docs/source/reference/commands/common_arguments.en.rst?rev=1611251&r1=1611250&r2=1611251&view=diff
==============================================================================
---
labs/panopticon/pan-commands/docs/source/reference/commands/common_arguments.en.rst
(original)
+++
labs/panopticon/pan-commands/docs/source/reference/commands/common_arguments.en.rst
Thu Jul 17 05:24:27 2014
@@ -24,6 +24,8 @@ Description
All Apache Panopticon utilities share a set of common command-line arguments::
+ -h, --help show this help message and exit
+ --completion SHELL Print out shell completion script: bash, zsh
--debug Turn on debug mode / logging.
--trace Turn on trace logging. Implies --debug.
--log LOG Log file destination. Defaults to stdout only.
@@ -31,6 +33,9 @@ All Apache Panopticon utilities share a
--password PASSWORD Password
--clear-store Clear password keystore
+.. option:: --completion SHELL
+
+ Print out shell completion script: bash, zsh
.. option:: --debug
Modified:
labs/panopticon/pan-commands/docs/source/reference/commands/moderator.en.rst
URL:
http://svn.apache.org/viewvc/labs/panopticon/pan-commands/docs/source/reference/commands/moderator.en.rst?rev=1611251&r1=1611250&r2=1611251&view=diff
==============================================================================
---
labs/panopticon/pan-commands/docs/source/reference/commands/moderator.en.rst
(original)
+++
labs/panopticon/pan-commands/docs/source/reference/commands/moderator.en.rst
Thu Jul 17 05:24:27 2014
@@ -25,23 +25,24 @@ Synopsis
A mailing list moderator tool used to manage mailing lists from the command
line::
- usage: moderator [-h] [--debug] [--trace] [--log LOG] [--username USERNAME]
- [--password PASSWORD] [--clear-store]
- {list,add,lookup,remove} ...
-
+ usage: moderator [-h] [--completion SHELL] [--debug] [--trace] [--log LOG]
+ [--username USERNAME] [--password PASSWORD]
[--clear-store]
+ {list,add,lookup,members,remove} ...
+
Mailing list moderator tool used to manage mailing lists from the command
line.
-
+
positional arguments:
- {list,add,lookup,remove}
-
+ {list,add,lookup,members,remove}
+
optional arguments:
- -h, --help show this help message and exit
- --debug Turn on debug mode / logging.
- --trace Turn on trace logging. Implies --debug.
- --log LOG Log file destination. Defaults to stdout only.
- --username USERNAME Username
- --password PASSWORD Password
- --clear-store Clear password keystore
+ -h, --help show this help message and exit
+ --completion SHELL Print out shell completion script: bash, zsh
+ --debug Turn on debug mode / logging.
+ --trace Turn on trace logging. Implies --debug.
+ --log LOG Log file destination. Defaults to stdout only.
+ --username USERNAME Username
+ --password PASSWORD Password
+ --clear-store Clear password keystore
Description
===========
@@ -85,6 +86,11 @@ member or is not the same person as the
The email alias to lookup.
+.. option:: -t, --type
+
+Restrict output to information of a specific type. Allowed
+values: ``username``, ``podlings``, ``pmcs``, ``member``, ``fullname``,
``emails``, ``projects``
+
``add``
=======
@@ -100,6 +106,10 @@ The mailing list to add the email addres
The email address to add.
+.. option:: -m, --moderator
+
+Email address is for moderator
+
``remove``
==========
@@ -115,6 +125,25 @@ The mailing list to remove the email add
The email address to remove.
+.. option:: -m, --moderator
+
+Email address is for moderator
+
+``members``
+===========
+
+List members a specific mailing list. Only mailing list
+moderators can list the members of their own mailing list. ASF
+members can list the members of any mailing list.
+
+.. option:: mailing_list
+
+The mailing list whose membership is to be listed.
+
+.. option:: -m, --moderator
+
+List moderators of mailing list
+
Examples
========
@@ -122,6 +151,5 @@ Manage the mailing list for ``dev@httpd.
$ moderator lookup presid...@whitehouse.gov
$ moderator list d...@httpd.apache.org
- $ moderator add d...@httpd.apache.org presid...@whitehouse.gov
+ $ moderator add d...@httpd.apache.org presid...@whitehouse.gov -m
$ moderator remove d...@httpd.apache.org jschae...@apache.org
-
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@labs.apache.org
For additional commands, e-mail: commits-h...@labs.apache.org
