man/man1/vmm.1.rst
author Pascal Volk <neverseen@users.sourceforge.net>
Thu, 22 Jul 2010 23:56:14 +0000
branchv0.6.x
changeset 306 504fd29b4712
parent 179 3d09c657e9e5
child 332 352ca7f1b332
permissions -rw-r--r--
VMM/Account: s/prefix/mbformat/ and pass the dbh to MailLocation.__init__.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     1
=====
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     2
 vmm
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     3
=====
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     4
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     5
----------------------------------------------------------
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     6
command line tool to manage email domains/accounts/aliases
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     7
----------------------------------------------------------
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     8
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     9
:Author:         Pascal Volk <neverseen@users.sourceforge.net>
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    10
:Date:           2010-01-30
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    11
:Version:        vmm-0.6.0
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    12
:Manual group:   vmm Manual
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    13
:Manual section: 1
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    14
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    15
.. contents::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    16
  :backlinks: top
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    17
  :class: htmlout
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    18
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    19
SYNOPSIS
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    20
========
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    21
**vmm** *subcommand* *object* [ *arguments* ]
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    22
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    23
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    24
DESCRIPTION
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    25
===========
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    26
**vmm** (a virtual mail manager) is a command line tool for
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    27
administrators/postmasters to manage (alias) domains, accounts and alias
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    28
addresses. It's designed for Dovecot and Postfix with a PostgreSQL backend.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    29
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    30
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    31
SUBCOMMANDS
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    32
===========
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    33
Each subcommand has both a long and a short form. The short form is shown
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    34
enclosed in parentheses. Both forms are case sensitive.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    35
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    36
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    37
GENERAL SUBCOMMANDS
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    38
-------------------
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    39
.. _configure:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    40
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    41
``configure (cf) [ section ]``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    42
  Starts the interactive configuration for all configuration sections.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    43
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    44
  In this process the currently set value of each option will be shown in
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    45
  square brackets. If no value is configured, the default value of each
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    46
  option will be displayed in square brackets. Pres the enter key, to accept
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    47
  the displayed value.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    48
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    49
  If the optional argument *section* is given, only the configuration
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    50
  options from the given section will be displayed and will be
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    51
  configurable. The following sections are available:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    52
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    53
  | - **account**
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    54
  | - **bin**
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    55
  | - **database**
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    56
  | - **domain**
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    57
  | - **maildir**
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    58
  | - **misc**
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    59
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    60
  Example::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    61
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    62
    vmm configure domain
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    63
    Using configuration file: /usr/local/etc/vmm.cfg
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    64
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    65
    * Configuration section: “domain”
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    66
    Enter new value for option directory_mode [504]:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    67
    Enter new value for option delete_directory [True]: no
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    68
    Enter new value for option auto_postmaster [True]:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    69
    Enter new value for option force_deletion [True]: off
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    70
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    71
.. _getuser:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    72
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    73
``getuser (gu) userid``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    74
  If only the *userid* is available, for example from process list, the
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    75
  subcommand **getuser** will show the user's address.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    76
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    77
  Example::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    78
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    79
    vmm getuser 70004
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    80
    Account information
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    81
    -------------------
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    82
            UID............: 70004
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    83
            GID............: 70000
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    84
            Address........: c.user@example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    85
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    86
.. _listdomains:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    87
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    88
``listdomains (ld) [ pattern ]``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    89
  This subcommand lists all available domains. All domain names will be
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    90
  prefixed either with '[+]', if the domain is a primary domain, or with
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    91
  '[-]', if it is an alias domain name. The output can be limited with an
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    92
  optional *pattern*.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    93
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    94
  To perform a wild card search, the **%** character can be used at the
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    95
  start and/or the end of the *pattern*.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    96
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    97
  Example::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    98
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    99
    vmm listdomains %example%
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   100
    Matching domains
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   101
    ----------------
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   102
            [+] example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   103
            [-]     e.g.example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   104
            [-]     example.name
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   105
            [+] example.net
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   106
            [+] example.org
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   107
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   108
.. _help:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   109
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   110
``help (h)``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   111
  Prints all available subcommands to stdout. After this **vmm** exits.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   112
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   113
.. _version:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   114
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   115
``version (v)``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   116
  Prints the version information from **vmm**.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   117
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   118
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   119
DOMAIN SUBCOMMANDS
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   120
------------------
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   121
.. _domainadd:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   122
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   123
``domainadd (da) domain [ transport ]``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   124
  Adds the new *domain* into the database and creates the domain directory.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   125
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   126
  If the optional argument *transport* is given, it will overwrite the
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   127
  default transport (|misc.transport|_) from |vmm.cfg(5)|_. The specified
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   128
  *transport* will be the default transport for all new accounts in this
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   129
  domain.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   130
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   131
  Examples::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   132
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   133
    vmm domainadd support.example.com smtp:mx1.example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   134
    vmm domainadd sales.example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   135
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   136
.. _domaininfo:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   137
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   138
``domaininfo (di) domain [ details ]``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   139
  This subcommand shows some information about the given *domain*.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   140
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   141
  For a more detailed information about the *domain* the optional argument
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   142
  *details* can be specified. A possible *details* value may be one of the
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   143
  following five keywords:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   144
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   145
  ``accounts``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   146
    to list all existing accounts
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   147
  ``aliasdomains``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   148
    to list all assigned alias domains
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   149
  ``aliases``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   150
    to list all available aliases addresses
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   151
  ``relocated``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   152
    to list all relocated users
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   153
  ``full``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   154
    to list all information mentioned above
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   155
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   156
  Example::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   157
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   158
    vmm domaininfo sales.example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   159
    Domain information
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   160
    ------------------
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   161
            Domainname.....: sales.example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   162
            GID............: 70002
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   163
            Transport......: dovecot:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   164
            Domaindir......: /home/mail/5/70002
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   165
            Aliasdomains...: 0
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   166
            Accounts.......: 0
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   167
            Aliases........: 0
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   168
            Relocated......: 0
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   169
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   170
.. _domaintransport:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   171
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   172
``domaintransport (dt) domain transport [ force ]``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   173
  A new *transport* for the indicated *domain* can be set with this
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   174
  subcommand.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   175
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   176
  If the additional keyword **force** is given all account specific
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   177
  transport settings will be overwritten. Otherwise this setting will affect
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   178
  only new created accounts.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   180
  Example::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   181
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   182
    vmm domaintransport support.example.com dovecot:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   183
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   184
.. _domaindelete:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   185
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   186
``domaindelete (dd) domain [ delalias | deluser | delall ]``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   187
  This subcommand deletes the specified *domain*.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   188
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   189
  If there are accounts and/or aliases assigned to the given domain, **vmm**
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   190
  will abort the requested operation and show an error message. If you know,
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   191
  what you are doing, you can specify one of the following keywords:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   192
  **delalias**, **deluser** or **delall**.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   193
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   194
  If you really always know what you are doing, edit your *vmm.cfg* and set
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   195
  the option |domain.force_deletion|_ to true.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   196
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   197
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   198
ALIAS DOMAIN SUBCOMMANDS
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   199
------------------------
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   200
.. _aliasdomainadd:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   201
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   202
``aliasdomainadd (ada) aliasdomain targetdomain``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   203
  This subcommand adds the new *aliasdomain* to the *targetdomain* that
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   204
  should be aliased.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   205
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   206
  Example::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   207
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   208
    vmm aliasdomainadd example.name example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   209
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   210
.. _aliasdomaininfo:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   211
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   212
``aliasdomaininfo (adi) aliasdomain``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   213
  This subcommand shows to which domain the *aliasdomain* is assigned to.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   214
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   215
  Example::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   216
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   217
    vmm aliasdomaininfo example.name
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   218
    Alias domain information
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   219
    ------------------------
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   220
            The alias domain example.name belongs to:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   221
                * example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   222
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   223
.. _aliasdomainswitch:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   224
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   225
``aliasdomainswitch (ads) aliasdomain targetdomain``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   226
  If the target of the existing *aliasdomain* should be switched to another
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   227
  *targetdomain* use this subcommand.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   228
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   229
  Example::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   230
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   231
    vmm aliasdomainswitch example.name example.org
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   232
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   233
.. _aliasdomaindelete:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   234
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   235
``aliasdomaindelete (add) aliasdomain``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   236
  Use this subcommand if the alias domain *aliasdomain* should be removed.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   237
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   238
  Example::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   239
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   240
    vmm aliasdomaindelete e.g.example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   241
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   242
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   243
ACCOUNT SUBCOMMANDS
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   244
-------------------
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   245
.. _useradd:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   246
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   247
``useradd (ua) address [ password ]``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   248
  Use this subcommand to create a new email account for the given *address*.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   249
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   250
  If the *password* is not provided, **vmm** will prompt for it
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   251
  interactively.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   252
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   253
  Examples::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   254
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   255
    vmm ua d.user@example.com 'A 5ecR3t P4s5\\/\\/0rd'
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   256
    vmm ua e.user@example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   257
    Enter new password:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   258
    Retype new password:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   259
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   260
.. _userinfo:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   261
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   262
``userinfo (ui) address [ details ]``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   263
  This subcommand displays some information about the account specified by
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   264
  *address*.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   265
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   266
  If the optional argument *details* is given some more information will be
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   267
  displayed. Possible values for *details* are:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   268
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   269
  ``aliases``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   270
    to list all alias addresses with the destination *address*
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   271
  ``du``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   272
    to display the disk usage of a user's Maildir. In order to summarize the
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   273
    disk usage each time the this subcommand is executed automatically, set
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   274
    |account.disk_usage|_ in the *vmm.cfg* to true.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   275
  ``full``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   276
    to list all information mentioned above
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   277
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   278
.. _username:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   279
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   280
``username (un) address "User's Name"``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   281
  The user's real name can be set/updated with this subcommand.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   282
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   283
  Example::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   284
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   285
    vmm un d.user@example.com 'John Doe'
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   286
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   287
.. _userpassword:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   288
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   289
``userpassword (up) address [ password ]``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   290
  The *password* from an account can be updated with this subcommand.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   291
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   292
  If the *password* is not provided, **vmm** will prompt for it
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   293
  interactively.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   294
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   295
  Example::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   296
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   297
    vmm up d.user@example.com 'A |\\/|0r3 5ecur3 P4s5\\/\\/0rd?'
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   298
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   299
.. _usertransport:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   300
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   301
``usertransport (ut) address transport``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   302
  A different *transport* for an account can be specified with this
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   303
  subcommand.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   304
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   305
  Example::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   306
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   307
    vmm ut d.user@example.com smtp:pc105.it.example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   308
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   309
.. _userdisable:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   310
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   311
``userdisable (u0) address [ service ]``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   312
  If a user shouldn't have access to one or all services you can restrict
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   313
  the access with this subcommand.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   314
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   315
  If neither a *service* nor the keyword **all** is given all services
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   316
  (**smtp**, **pop3**, **imap**, and **sieve**) will be disabled for the
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   317
  account with the specified *address*. Otherwise only the specified
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   318
  *service* will be restricted.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   319
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   320
  Examples::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   321
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   322
    vmm u0 b.user@example.com imap
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   323
    vmm userdisable c.user@example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   324
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   325
.. _userenable:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   326
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   327
``userenable (u1) address [ service ]``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   328
  To allow access to one or all restricted services use this subcommand.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   329
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   330
  If neither a *service* nor the keyword **all** is given all services
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   331
  (**smtp**, **pop3**, **imap**, and **sieve**) will be enabled for the
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   332
  account with the specified *address*. Otherwise only the specified
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   333
  *service* will be enabled.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   334
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   335
.. _userdelete:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   336
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   337
``userdelete (ud) address [ delalias ]``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   338
  Use this subcommand to delete the account with the given *address*.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   339
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   340
  If there are one or more aliases with an identical destination *address*,
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   341
  **vmm** will abort the requested operation and show an error message. To
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   342
  prevent this, specify the optional keyword **delalias**.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   343
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   344
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   345
ALIAS SUBCOMMANDS
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   346
-----------------
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   347
.. _aliasadd:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   348
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   349
``aliasadd (aa) alias target``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   350
  This subcommand is used to create a new alias.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   351
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   352
  Examples::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   353
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   354
    vmm aliasadd john.doe@example.com d.user@example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   355
    vmm aa support@example.com d.user@example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   356
    vmm aa support@example.com e.user@example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   357
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   358
.. _aliasinfo:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   359
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   360
``aliasinfo (ai) alias``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   361
  Information about an alias can be displayed with this subcommand.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   362
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   363
  Example::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   364
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   365
    vmm aliasinfo support@example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   366
    Alias information
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   367
    -----------------
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   368
            Mail for support@example.com will be redirected to:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   369
                 * d.user@example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   370
                 * e.user@example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   371
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   372
.. _aliasdelete:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   373
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   374
``aliasdelete (ad) alias [ target ]``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   375
  Use this subcommand to delete the *alias*.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   376
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   377
  If the optional destination address *target* is given, only this
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   378
  destination will be removed from the *alias*.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   379
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   380
  Example::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   381
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   382
    vmm ad support@example.com d.user@example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   383
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   384
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   385
RELOCATED SUBCOMMANDS
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   386
---------------------
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   387
.. _relocatedadd:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   388
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   389
``relocatedadd (ra) old_address new_address``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   390
  A new relocated user can be created with this subcommand.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   391
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   392
  *old_address* is the users ex-email address, for example
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   393
  b.user@example.com, and *new_address* points to the new email address
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   394
  where the user can be reached.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   395
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   396
  Example::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   397
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   398
    vmm relocatedadd b.user@example.com b-user@company.tld
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   399
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   400
.. _relocatedinfo:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   401
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   402
``relocatedinfo (ri) old_address``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   403
  This subcommand shows the new address of the relocated user with the
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   404
  *old_address*.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   405
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   406
  Example::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   407
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   408
    vmm relocatedinfo b.user@example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   409
    Relocated information
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   410
    ---------------------
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   411
            User “b.user@example.com” has moved to “b-user@company.tld”
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   412
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   413
.. _relocateddelete:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   414
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   415
``relocateddelete (rd) old_address``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   416
  Use this subcommand in order to delete the relocated user with the
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   417
  *old_address*.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   418
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   419
  Example::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   420
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   421
    vmm relocateddelete b.user@example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   422
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   423
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   424
FILES
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   425
=====
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   426
*/root/vmm.cfg*
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   427
  | will be used when found.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   428
*/usr/local/etc/vmm.cfg*
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   429
  | will be used when the above file doesn't exist.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   430
*/etc/vmm.cfg*
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   431
  | will be used when none of the both above mentioned files exists.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   432
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   433
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   434
SEE ALSO
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   435
========
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   436
|vmm.cfg(5)|_
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   437
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   438
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   439
COPYING
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   440
=======
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   441
vmm and its manual pages were written by Pascal Volk and are licensed under
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   442
the terms of the BSD License.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   443
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   444
.. include:: ../substitute_links.rst
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   445
.. include:: ../substitute_links_1.rst