doc/web/source/howto/general_subcommands.rst
changeset 622 e60b8ed5fd35
parent 591 2b165e90e225
child 682 697350dd9369
equal deleted inserted replaced
621:d8b60e53334f 622:e60b8ed5fd35
   121 
   121 
   122 Prints a list of available subcommands with a short description to stdout.
   122 Prints a list of available subcommands with a short description to stdout.
   123 When a *subcommand* was given, help for that *subcommand* will be displayed.
   123 When a *subcommand* was given, help for that *subcommand* will be displayed.
   124 After this :command:`vmm` exits.
   124 After this :command:`vmm` exits.
   125 
   125 
       
   126 listaddresses
       
   127 -------------
       
   128 Syntax:
       
   129  | **vmm listaddresses** [*pattern*]
       
   130  | **vmm ll** [*pattern*]
       
   131 
       
   132 This command lists all defined addresses. Addresses belonging to
       
   133 alias-domains are prefixed with a '-', addresses of regular domains with
       
   134 a '+'.
       
   135 Additionally, the letters 'u', 'a', and 'r' indicate the type of each
       
   136 address: user, alias and relocated respectively. The output can be limited
       
   137 with an optional *pattern*.
       
   138 
       
   139 To perform a wild card search, the **%** character can be used at the start
       
   140 and/or the end of the *pattern*.
       
   141 
       
   142 Example:
       
   143 
       
   144 .. code-block:: console
       
   145 
       
   146  root@host:~# vmm ll example.com
       
   147  Matching addresses
       
   148  ------------------
       
   149          [u+] a.user@example.com
       
   150          [r+] b.user@example.com
       
   151          [u+] d.user@example.com
       
   152          [u+] john.doe@example.com
       
   153          [u+] postmaster@example.com
       
   154          [a+] support@example.com
       
   155 
       
   156 .. versionadded:: 0.6.0
       
   157 
       
   158 listaliases
       
   159 -----------
       
   160 Syntax:
       
   161  | **vmm listaliases** [*pattern*]
       
   162  | **vmm la** [*pattern*]
       
   163 
       
   164 This command lists all defined aliases. Aliases belonging to alias-domains
       
   165 are prefixed with a '-', addresses of regular domains with a '+'.
       
   166 The output can be limited with an optional *pattern*.
       
   167 
       
   168 To perform a wild card search, the **%** character can be used at the start
       
   169 and/or the end of the *pattern*.
       
   170 
       
   171 Example:
       
   172 
       
   173 .. code-block:: console
       
   174 
       
   175  root@host:~# vmm listaliases example.com
       
   176  Matching aliases
       
   177  ----------------
       
   178          [+] support@example.com
       
   179 
       
   180 .. versionadded:: 0.6.0
       
   181 
   126 listdomains
   182 listdomains
   127 -----------
   183 -----------
   128 Syntax:
   184 Syntax:
   129  | **vmm listdomains** [*pattern*]
   185  | **vmm listdomains** [*pattern*]
   130  | **vmm ld** [*pattern*]
   186  | **vmm ld** [*pattern*]
   181  ------------------------
   237  ------------------------
   182          .B64 .BASE64 .HEX
   238          .B64 .BASE64 .HEX
   183 
   239 
   184 .. versionadded:: 0.6.0
   240 .. versionadded:: 0.6.0
   185 
   241 
       
   242 listrelocated
       
   243 -------------
       
   244 Syntax:
       
   245  | **vmm listrelocated** [*pattern*]
       
   246  | **vmm lr** [*pattern*]
       
   247 
       
   248 This command lists all defined relocated addresses.
       
   249 Relocated entries belonging to alias-domains are prefixed with a '-',
       
   250 addresses of regular domains with a '+'.
       
   251 The output can be limited with an optional *pattern*.
       
   252 
       
   253 To perform a wild card search, the **%** character can be used at the start
       
   254 and/or the end of the *pattern*.
       
   255 
       
   256 Example:
       
   257 
       
   258 .. code-block:: console
       
   259 
       
   260  root@host:~# vmm listrelocated example.com
       
   261  Matching relocated users
       
   262  ------------------------
       
   263          [+] b.user@example.com
       
   264 
       
   265 .. versionadded:: 0.6.0
       
   266 
       
   267 listusers
       
   268 ---------
       
   269 Syntax:
       
   270  | **vmm listusers** [*pattern*]
       
   271  | **vmm lu** [*pattern*]
       
   272 
       
   273 This command lists all user accounts.
       
   274 User accounts belonging to alias-domains are prefixed with a '-', addresses
       
   275 of regular domains with a '+'.
       
   276 The output can be limited with an optional *pattern*.
       
   277 
       
   278 To perform a wild card search, the **%** character can be used at the start
       
   279 and/or the end of the *pattern*.
       
   280 
       
   281 Example:
       
   282 
       
   283 .. code-block:: console
       
   284 
       
   285  root@host:~# vmm listusers example.com
       
   286  Matching user accounts
       
   287  ----------------------
       
   288          [+] a.user@example.com
       
   289          [+] d.user@example.com
       
   290          [+] john.doe@example.com
       
   291          [+] postmaster@example.com
       
   292 
       
   293 .. versionadded:: 0.6.0
       
   294 
   186 version
   295 version
   187 -------
   296 -------
   188 Syntax:
   297 Syntax:
   189  | **vmm version**
   298  | **vmm version**
   190  | **vmm v**
   299  | **vmm v**