# HG changeset patch # User Pascal Volk # Date 1348938809 0 # Node ID e60b8ed5fd35be12c7f024d809852730d123a009 # Parent d8b60e53334f31ec1f252074ae2d71cff1b832eb doc/web: Updated and extended documentation. Updated description of subcommands aliasdelete and catchalldelete. Added description of subcommands listaddresses, listaliases, listrelocated and listusers. diff -r d8b60e53334f -r e60b8ed5fd35 doc/web/source/howto/general_subcommands.rst --- a/doc/web/source/howto/general_subcommands.rst Sat Sep 29 15:57:24 2012 +0000 +++ b/doc/web/source/howto/general_subcommands.rst Sat Sep 29 17:13:29 2012 +0000 @@ -123,6 +123,62 @@ When a *subcommand* was given, help for that *subcommand* will be displayed. After this :command:`vmm` exits. +listaddresses +------------- +Syntax: + | **vmm listaddresses** [*pattern*] + | **vmm ll** [*pattern*] + +This command lists all defined addresses. Addresses belonging to +alias-domains are prefixed with a '-', addresses of regular domains with +a '+'. +Additionally, the letters 'u', 'a', and 'r' indicate the type of each +address: user, alias and relocated respectively. The output can be limited +with an optional *pattern*. + +To perform a wild card search, the **%** character can be used at the start +and/or the end of the *pattern*. + +Example: + +.. code-block:: console + + root@host:~# vmm ll example.com + Matching addresses + ------------------ + [u+] a.user@example.com + [r+] b.user@example.com + [u+] d.user@example.com + [u+] john.doe@example.com + [u+] postmaster@example.com + [a+] support@example.com + +.. versionadded:: 0.6.0 + +listaliases +----------- +Syntax: + | **vmm listaliases** [*pattern*] + | **vmm la** [*pattern*] + +This command lists all defined aliases. Aliases belonging to alias-domains +are prefixed with a '-', addresses of regular domains with a '+'. +The output can be limited with an optional *pattern*. + +To perform a wild card search, the **%** character can be used at the start +and/or the end of the *pattern*. + +Example: + +.. code-block:: console + + root@host:~# vmm listaliases example.com + Matching aliases + ---------------- + [+] support@example.com + +.. versionadded:: 0.6.0 + listdomains ----------- Syntax: @@ -183,6 +239,59 @@ .. versionadded:: 0.6.0 +listrelocated +------------- +Syntax: + | **vmm listrelocated** [*pattern*] + | **vmm lr** [*pattern*] + +This command lists all defined relocated addresses. +Relocated entries belonging to alias-domains are prefixed with a '-', +addresses of regular domains with a '+'. +The output can be limited with an optional *pattern*. + +To perform a wild card search, the **%** character can be used at the start +and/or the end of the *pattern*. + +Example: + +.. code-block:: console + + root@host:~# vmm listrelocated example.com + Matching relocated users + ------------------------ + [+] b.user@example.com + +.. versionadded:: 0.6.0 + +listusers +--------- +Syntax: + | **vmm listusers** [*pattern*] + | **vmm lu** [*pattern*] + +This command lists all user accounts. +User accounts belonging to alias-domains are prefixed with a '-', addresses +of regular domains with a '+'. +The output can be limited with an optional *pattern*. + +To perform a wild card search, the **%** character can be used at the start +and/or the end of the *pattern*. + +Example: + +.. code-block:: console + + root@host:~# vmm listusers example.com + Matching user accounts + ---------------------- + [+] a.user@example.com + [+] d.user@example.com + [+] john.doe@example.com + [+] postmaster@example.com + +.. versionadded:: 0.6.0 + version ------- Syntax: diff -r d8b60e53334f -r e60b8ed5fd35 doc/web/source/howto/manage_alias_addresses.rst --- a/doc/web/source/howto/manage_alias_addresses.rst Sat Sep 29 15:57:24 2012 +0000 +++ b/doc/web/source/howto/manage_alias_addresses.rst Sat Sep 29 17:13:29 2012 +0000 @@ -26,13 +26,14 @@ aliasdelete ----------- Syntax: - | **vmm aliasdelete** *address* [*destination*] - | **vmm ad** *address* [*destination*] + | **vmm aliasdelete** *address* [*destination* ...] + | **vmm ad** *address* [*destination* ...] -Use this subcommand to delete the alias with the given *address*. +This subcommand is used to delete one or multiple *destination*\ s from the +alias with the given *address*. -If the optional *destination* address is given, only this destination will -be removed from the alias. +When no *destination* address was specified the alias with all its +destinations will be deleted. Example: @@ -40,6 +41,9 @@ root@host:~# vmm ad support@example.com d.user@example.com +.. versionchanged:: 0.6.1 + Accept multiple destinations. + aliasinfo --------- Syntax: diff -r d8b60e53334f -r e60b8ed5fd35 doc/web/source/howto/manage_catch-all_addresses.rst --- a/doc/web/source/howto/manage_catch-all_addresses.rst Sat Sep 29 15:57:24 2012 +0000 +++ b/doc/web/source/howto/manage_catch-all_addresses.rst Sat Sep 29 17:13:29 2012 +0000 @@ -28,11 +28,11 @@ catchalldelete -------------- Syntax: - | **vmm catchalldelete** *fqdn* [*destination*] - | **vmm cad** *fqdn* [*destination*] + | **vmm catchalldelete** *fqdn* [*destination* ...] + | **vmm cad** *fqdn* [*destination* ...] With this subcommand, catch-all aliases defined for a domain can be removed, -either all of them, or a single one if specified explicitly. +either all of them, or those *destination*\ s which were specified explicitly. Example: @@ -42,6 +42,9 @@ .. versionadded:: 0.6.0 +.. versionchanged:: 0.6.1 + Accept multiple destinations. + catchallinfo ------------ Syntax: