diff options
Diffstat (limited to 'src/mailman/commands/docs/withlist.txt')
| -rw-r--r-- | src/mailman/commands/docs/withlist.txt | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/src/mailman/commands/docs/withlist.txt b/src/mailman/commands/docs/withlist.txt index f85607ab9..7632c726a 100644 --- a/src/mailman/commands/docs/withlist.txt +++ b/src/mailman/commands/docs/withlist.txt @@ -2,7 +2,7 @@ Operating on mailing lists ========================== -The 'withlist' command is a pretty powerful way to operate on mailing lists +The ``withlist`` command is a pretty powerful way to operate on mailing lists from the command line. This command allows you to interact with a list at a Python prompt, or process one or more mailing lists through custom made Python functions. @@ -13,7 +13,8 @@ XXX Test the interactive operation of withlist Getting detailed help ===================== -Because withlist is so complex, you need to request detailed help. +Because ``withlist`` is so complex, you need to request detailed help. +:: >>> from mailman.commands.cli_withlist import Withlist >>> command = Withlist() @@ -39,9 +40,10 @@ Because withlist is so complex, you need to request detailed help. Running a command ================= -By putting a Python function somewhere on your sys.path, you can have withlist -call that function on a given mailing list. The function takes a single -argument, the mailing list. +By putting a Python function somewhere on your ``sys.path``, you can have +``withlist`` call that function on a given mailing list. The function takes a +single argument, the mailing list. +:: >>> import os, sys >>> old_path = sys.path[:] @@ -78,8 +80,9 @@ Multiple lists ============== You can run a command over more than one list by using a regular expression in -the LISTNAME argument. To indicate a regular expression is used, the string +the `listname` argument. To indicate a regular expression is used, the string must start with a caret. +:: >>> mlist_2 = create_list('badger@example.com') >>> mlist_3 = create_list('badboys@example.com') |