man/man1/vmm.1.rst
author Pascal Volk <neverseen@users.sourceforge.net>
Tue, 08 Feb 2011 18:04:07 +0000
branchv0.6.x
changeset 388 dd95ed5bc9d2
parent 362 c2e8eab2616d
child 405 da80de422b3c
permissions -rw-r--r--
pgsql: Added quotalimit's bytes and messages to view vmm_domain_info.
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>
361
971577b89d26 VMM/cli/handler: Added support for random passwords in user_add().
Pascal Volk <neverseen@users.sourceforge.net>
parents: 345
diff changeset
    10
:Date:           |today|
179
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
-------------------
345
f8d5c8bb8bce VMM/cli/subcommands: Added subcommands configget and configset.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 335
diff changeset
    39
.. _configget:
f8d5c8bb8bce VMM/cli/subcommands: Added subcommands configget and configset.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 335
diff changeset
    40
f8d5c8bb8bce VMM/cli/subcommands: Added subcommands configget and configset.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 335
diff changeset
    41
``configget (cg) option``
f8d5c8bb8bce VMM/cli/subcommands: Added subcommands configget and configset.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 335
diff changeset
    42
  This subcommand is used to display the actual value of the given
f8d5c8bb8bce VMM/cli/subcommands: Added subcommands configget and configset.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 335
diff changeset
    43
  configuration *option*. The option has to be written as
f8d5c8bb8bce VMM/cli/subcommands: Added subcommands configget and configset.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 335
diff changeset
    44
  *section*\ **.**\ *option*, e.g. **misc.transport**.
f8d5c8bb8bce VMM/cli/subcommands: Added subcommands configget and configset.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 335
diff changeset
    45
f8d5c8bb8bce VMM/cli/subcommands: Added subcommands configget and configset.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 335
diff changeset
    46
.. _configset:
f8d5c8bb8bce VMM/cli/subcommands: Added subcommands configget and configset.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 335
diff changeset
    47
f8d5c8bb8bce VMM/cli/subcommands: Added subcommands configget and configset.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 335
diff changeset
    48
``configset (cs) option value``
f8d5c8bb8bce VMM/cli/subcommands: Added subcommands configget and configset.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 335
diff changeset
    49
  Use this subcommand to set/update a single configuration option. *option*
f8d5c8bb8bce VMM/cli/subcommands: Added subcommands configget and configset.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 335
diff changeset
    50
  is the configuration option, written as *section*\ **.**\ *option*. *value*
f8d5c8bb8bce VMM/cli/subcommands: Added subcommands configget and configset.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 335
diff changeset
    51
  is the *option*'s new value.
f8d5c8bb8bce VMM/cli/subcommands: Added subcommands configget and configset.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 335
diff changeset
    52
f8d5c8bb8bce VMM/cli/subcommands: Added subcommands configget and configset.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 335
diff changeset
    53
  Example::
f8d5c8bb8bce VMM/cli/subcommands: Added subcommands configget and configset.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 335
diff changeset
    54
f8d5c8bb8bce VMM/cli/subcommands: Added subcommands configget and configset.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 335
diff changeset
    55
    vmm configget misc.transport
f8d5c8bb8bce VMM/cli/subcommands: Added subcommands configget and configset.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 335
diff changeset
    56
    misc.transport = dovecot:
f8d5c8bb8bce VMM/cli/subcommands: Added subcommands configget and configset.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 335
diff changeset
    57
    vmm configset misc.transport lmtp:unix:private/dovecot-lmtp
f8d5c8bb8bce VMM/cli/subcommands: Added subcommands configget and configset.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 335
diff changeset
    58
    vmm cg misc.transport
f8d5c8bb8bce VMM/cli/subcommands: Added subcommands configget and configset.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 335
diff changeset
    59
    misc.transport = lmtp:unix:private/dovecot-lmtp
f8d5c8bb8bce VMM/cli/subcommands: Added subcommands configget and configset.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 335
diff changeset
    60
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    61
.. _configure:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    62
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    63
``configure (cf) [ section ]``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    64
  Starts the interactive configuration for all configuration sections.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    65
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    66
  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
    67
  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
    68
  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
    69
  the displayed value.
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
  If the optional argument *section* is given, only the configuration
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    72
  options from the given section will be displayed and will be
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    73
  configurable. The following sections are available:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    74
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    75
  | - **account**
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    76
  | - **bin**
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    77
  | - **database**
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    78
  | - **domain**
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    79
  | - **maildir**
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    80
  | - **misc**
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
  Example::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    83
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    84
    vmm configure domain
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    85
    Using configuration file: /usr/local/etc/vmm.cfg
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    86
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    87
    * Configuration section: “domain”
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    88
    Enter new value for option directory_mode [504]:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    89
    Enter new value for option delete_directory [True]: no
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    90
    Enter new value for option auto_postmaster [True]:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    91
    Enter new value for option force_deletion [True]: off
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    92
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    93
.. _getuser:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    94
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    95
``getuser (gu) userid``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    96
  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
    97
  subcommand **getuser** will show the user's address.
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
  Example::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   100
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   101
    vmm getuser 70004
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   102
    Account information
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   103
    -------------------
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   104
            UID............: 70004
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   105
            GID............: 70000
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   106
            Address........: c.user@example.com
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
.. _listdomains:
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
``listdomains (ld) [ pattern ]``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   111
  This subcommand lists all available domains. All domain names will be
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   112
  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
   113
  '[-]', 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
   114
  optional *pattern*.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   115
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   116
  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
   117
  start and/or the end of the *pattern*.
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
  Example::
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
    vmm listdomains %example%
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   122
    Matching domains
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   123
    ----------------
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   124
            [+] example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   125
            [-]     e.g.example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   126
            [-]     example.name
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   127
            [+] example.net
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   128
            [+] example.org
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   129
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   130
.. _help:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   131
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   132
``help (h)``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   133
  Prints all available subcommands to stdout. After this **vmm** exits.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   134
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   135
.. _version:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   136
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   137
``version (v)``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   138
  Prints the version information from **vmm**.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   139
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
DOMAIN SUBCOMMANDS
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   142
------------------
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   143
.. _domainadd:
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
``domainadd (da) domain [ transport ]``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   146
  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
   147
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   148
  If the optional argument *transport* is given, it will overwrite the
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   149
  default transport (|misc.transport|_) from |vmm.cfg(5)|_. The specified
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   150
  *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
   151
  domain.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   152
362
c2e8eab2616d VMM/cli/subcommands: Added 'auto postmaster' to domain_add().
Pascal Volk <neverseen@users.sourceforge.net>
parents: 361
diff changeset
   153
  When |domain.auto_postmaster|_ is set to **true**, **vmm** will also create
c2e8eab2616d VMM/cli/subcommands: Added 'auto postmaster' to domain_add().
Pascal Volk <neverseen@users.sourceforge.net>
parents: 361
diff changeset
   154
  an account for **postmaster@**\ *domain*.
c2e8eab2616d VMM/cli/subcommands: Added 'auto postmaster' to domain_add().
Pascal Volk <neverseen@users.sourceforge.net>
parents: 361
diff changeset
   155
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   156
  Examples::
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 domainadd support.example.com smtp:mx1.example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   159
    vmm domainadd sales.example.com
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
.. _domaininfo:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   162
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   163
``domaininfo (di) domain [ details ]``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   164
  This subcommand shows some information about the given *domain*.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   165
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   166
  For a more detailed information about the *domain* the optional argument
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   167
  *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
   168
  following five keywords:
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
  ``accounts``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   171
    to list all existing accounts
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   172
  ``aliasdomains``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   173
    to list all assigned alias domains
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   174
  ``aliases``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   175
    to list all available aliases addresses
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   176
  ``relocated``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   177
    to list all relocated users
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   178
  ``full``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   179
    to list all information mentioned above
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   180
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   181
  Example::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   182
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   183
    vmm domaininfo sales.example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   184
    Domain information
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
            Domainname.....: sales.example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   187
            GID............: 70002
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   188
            Transport......: dovecot:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   189
            Domaindir......: /home/mail/5/70002
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   190
            Aliasdomains...: 0
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   191
            Accounts.......: 0
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   192
            Aliases........: 0
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   193
            Relocated......: 0
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   194
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   195
.. _domaintransport:
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
``domaintransport (dt) domain transport [ force ]``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   198
  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
   199
  subcommand.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   200
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   201
  If the additional keyword **force** is given all account specific
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   202
  transport settings will be overwritten. Otherwise this setting will affect
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   203
  only new created accounts.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   204
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   205
  Example::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   206
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   207
    vmm domaintransport support.example.com dovecot:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   208
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   209
.. _domaindelete:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   210
332
352ca7f1b332 man/{,de/}man1/vmm.1.rst: Updated domaindelete part.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 179
diff changeset
   211
``domaindelete (dd) domain [ force ]``
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   212
  This subcommand deletes the specified *domain*.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   213
332
352ca7f1b332 man/{,de/}man1/vmm.1.rst: Updated domaindelete part.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 179
diff changeset
   214
  If there are accounts, aliases and/or relocated users assigned to the given
352ca7f1b332 man/{,de/}man1/vmm.1.rst: Updated domaindelete part.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 179
diff changeset
   215
  domain, **vmm** will abort the requested operation and show an error
352ca7f1b332 man/{,de/}man1/vmm.1.rst: Updated domaindelete part.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 179
diff changeset
   216
  message. If you know, what you are doing, you can specify the keyword
352ca7f1b332 man/{,de/}man1/vmm.1.rst: Updated domaindelete part.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 179
diff changeset
   217
  **force**.
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   218
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   219
  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
   220
  the option |domain.force_deletion|_ to true.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   221
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
ALIAS DOMAIN SUBCOMMANDS
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
.. _aliasdomainadd:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   226
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   227
``aliasdomainadd (ada) aliasdomain targetdomain``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   228
  This subcommand adds the new *aliasdomain* to the *targetdomain* that
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   229
  should be aliased.
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
  Example::
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
    vmm aliasdomainadd example.name example.com
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
.. _aliasdomaininfo:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   236
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   237
``aliasdomaininfo (adi) aliasdomain``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   238
  This subcommand shows to which domain the *aliasdomain* is assigned to.
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
  Example::
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
    vmm aliasdomaininfo example.name
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   243
    Alias domain information
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
            The alias domain example.name belongs to:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   246
                * example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   247
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   248
.. _aliasdomainswitch:
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
``aliasdomainswitch (ads) aliasdomain targetdomain``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   251
  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
   252
  *targetdomain* use this subcommand.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   253
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   254
  Example::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   255
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   256
    vmm aliasdomainswitch example.name example.org
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   257
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   258
.. _aliasdomaindelete:
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
``aliasdomaindelete (add) aliasdomain``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   261
  Use this subcommand if the alias domain *aliasdomain* should be removed.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   262
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   263
  Example::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   264
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   265
    vmm aliasdomaindelete e.g.example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   266
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   267
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   268
ACCOUNT SUBCOMMANDS
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   269
-------------------
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   270
.. _useradd:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   271
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   272
``useradd (ua) address [ password ]``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   273
  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
   274
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   275
  If the *password* is not provided, **vmm** will prompt for it
361
971577b89d26 VMM/cli/handler: Added support for random passwords in user_add().
Pascal Volk <neverseen@users.sourceforge.net>
parents: 345
diff changeset
   276
  interactively. When no *password* is provided and |account.random_password|_
971577b89d26 VMM/cli/handler: Added support for random passwords in user_add().
Pascal Volk <neverseen@users.sourceforge.net>
parents: 345
diff changeset
   277
  is set to **true**, **vmm** will generate a random password and print it to
971577b89d26 VMM/cli/handler: Added support for random passwords in user_add().
Pascal Volk <neverseen@users.sourceforge.net>
parents: 345
diff changeset
   278
  stdout after the account has been created.
179
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
  Examples::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   281
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   282
    vmm ua d.user@example.com 'A 5ecR3t P4s5\\/\\/0rd'
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   283
    vmm ua e.user@example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   284
    Enter new password:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   285
    Retype new password:
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
.. _userinfo:
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
``userinfo (ui) address [ details ]``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   290
  This subcommand displays some information about the account specified by
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   291
  *address*.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   292
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   293
  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
   294
  displayed. Possible values for *details* are:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   295
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   296
  ``aliases``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   297
    to list all alias addresses with the destination *address*
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   298
  ``du``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   299
    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
   300
    disk usage each time the this subcommand is executed automatically, set
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   301
    |account.disk_usage|_ in the *vmm.cfg* to true.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   302
  ``full``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   303
    to list all information mentioned above
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
.. _username:
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
``username (un) address "User's Name"``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   308
  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
   309
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   310
  Example::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   311
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   312
    vmm un d.user@example.com 'John Doe'
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   313
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   314
.. _userpassword:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   315
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   316
``userpassword (up) address [ password ]``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   317
  The *password* from an account can be updated with this subcommand.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   318
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   319
  If the *password* is not provided, **vmm** will prompt for it
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   320
  interactively.
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
  Example::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   323
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   324
    vmm up d.user@example.com 'A |\\/|0r3 5ecur3 P4s5\\/\\/0rd?'
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   325
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   326
.. _usertransport:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   327
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   328
``usertransport (ut) address transport``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   329
  A different *transport* for an account can be specified with this
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   330
  subcommand.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   331
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   332
  Example::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   333
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   334
    vmm ut d.user@example.com smtp:pc105.it.example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   335
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   336
.. _userdisable:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   337
335
7a471cace3ba VMM/handler: Updated Handler.user_{disable,enable} methods to
Pascal Volk <neverseen@users.sourceforge.net>
parents: 333
diff changeset
   338
``userdisable (u0) address [ service ... ]``
7a471cace3ba VMM/handler: Updated Handler.user_{disable,enable} methods to
Pascal Volk <neverseen@users.sourceforge.net>
parents: 333
diff changeset
   339
  If a user shouldn't have access to one or more services you can restrict
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   340
  the access with this subcommand.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   341
335
7a471cace3ba VMM/handler: Updated Handler.user_{disable,enable} methods to
Pascal Volk <neverseen@users.sourceforge.net>
parents: 333
diff changeset
   342
  If no *service* was given all services  (**smtp**, **pop3**, **imap**, and
7a471cace3ba VMM/handler: Updated Handler.user_{disable,enable} methods to
Pascal Volk <neverseen@users.sourceforge.net>
parents: 333
diff changeset
   343
  **sieve**) will be disabled for the account with the specified *address*.
7a471cace3ba VMM/handler: Updated Handler.user_{disable,enable} methods to
Pascal Volk <neverseen@users.sourceforge.net>
parents: 333
diff changeset
   344
  Otherwise only the specified *service*/s will be restricted.
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   345
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   346
  Examples::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   347
335
7a471cace3ba VMM/handler: Updated Handler.user_{disable,enable} methods to
Pascal Volk <neverseen@users.sourceforge.net>
parents: 333
diff changeset
   348
    vmm u0 b.user@example.com imap pop3
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   349
    vmm userdisable c.user@example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   350
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   351
.. _userenable:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   352
335
7a471cace3ba VMM/handler: Updated Handler.user_{disable,enable} methods to
Pascal Volk <neverseen@users.sourceforge.net>
parents: 333
diff changeset
   353
``userenable (u1) address [ service ... ]``
7a471cace3ba VMM/handler: Updated Handler.user_{disable,enable} methods to
Pascal Volk <neverseen@users.sourceforge.net>
parents: 333
diff changeset
   354
  To allow access to one or more restricted services use this subcommand.
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   355
335
7a471cace3ba VMM/handler: Updated Handler.user_{disable,enable} methods to
Pascal Volk <neverseen@users.sourceforge.net>
parents: 333
diff changeset
   356
  If no *service* was given all services (**smtp**, **pop3**, **imap**, and
7a471cace3ba VMM/handler: Updated Handler.user_{disable,enable} methods to
Pascal Volk <neverseen@users.sourceforge.net>
parents: 333
diff changeset
   357
  **sieve**) will be enabled for the account with the specified *address*.
7a471cace3ba VMM/handler: Updated Handler.user_{disable,enable} methods to
Pascal Volk <neverseen@users.sourceforge.net>
parents: 333
diff changeset
   358
  Otherwise only the specified *service*/s will be enabled.
179
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
.. _userdelete:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   361
333
1ed85e696748 VMM/{account,handler}: Account delete, use the boolean keyword force too.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 332
diff changeset
   362
``userdelete (ud) address [ force ]``
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   363
  Use this subcommand to delete the account with the given *address*.
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
  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
   366
  **vmm** will abort the requested operation and show an error message. To
333
1ed85e696748 VMM/{account,handler}: Account delete, use the boolean keyword force too.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 332
diff changeset
   367
  prevent this, specify the optional keyword **force**.
179
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   368
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   369
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   370
ALIAS SUBCOMMANDS
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
.. _aliasadd:
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
``aliasadd (aa) alias target``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   375
  This subcommand is used to create a new 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
  Examples::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   378
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   379
    vmm aliasadd john.doe@example.com d.user@example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   380
    vmm aa support@example.com d.user@example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   381
    vmm aa support@example.com e.user@example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   382
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   383
.. _aliasinfo:
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
``aliasinfo (ai) alias``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   386
  Information about an alias can be displayed with this subcommand.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   387
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   388
  Example::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   389
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   390
    vmm aliasinfo support@example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   391
    Alias information
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   392
    -----------------
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   393
            Mail for support@example.com will be redirected to:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   394
                 * d.user@example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   395
                 * e.user@example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   396
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   397
.. _aliasdelete:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   398
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   399
``aliasdelete (ad) alias [ target ]``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   400
  Use this subcommand to delete the *alias*.
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
  If the optional destination address *target* is given, only this
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   403
  destination will be removed from the *alias*.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   404
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   405
  Example::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   406
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   407
    vmm ad support@example.com d.user@example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   408
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   409
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   410
RELOCATED SUBCOMMANDS
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   411
---------------------
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   412
.. _relocatedadd:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   413
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   414
``relocatedadd (ra) old_address new_address``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   415
  A new relocated user can be created with this subcommand.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   416
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   417
  *old_address* is the users ex-email address, for example
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   418
  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
   419
  where the user can be reached.
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
  Example::
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
    vmm relocatedadd b.user@example.com b-user@company.tld
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   424
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   425
.. _relocatedinfo:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   426
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   427
``relocatedinfo (ri) old_address``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   428
  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
   429
  *old_address*.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   430
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   431
  Example::
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
    vmm relocatedinfo b.user@example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   434
    Relocated information
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
            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
   437
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   438
.. _relocateddelete:
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   439
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   440
``relocateddelete (rd) old_address``
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   441
  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
   442
  *old_address*.
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
  Example::
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   445
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   446
    vmm relocateddelete b.user@example.com
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   447
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   448
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   449
FILES
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   450
=====
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   451
*/root/vmm.cfg*
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   452
  | will be used when found.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   453
*/usr/local/etc/vmm.cfg*
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   454
  | will be used when the above file doesn't exist.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   455
*/etc/vmm.cfg*
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   456
  | 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
   457
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   458
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   459
SEE ALSO
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   460
========
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   461
|vmm.cfg(5)|_
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   462
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   463
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   464
COPYING
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   465
=======
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   466
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
   467
the terms of the BSD License.
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   468
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   469
.. include:: ../substitute_links.rst
3d09c657e9e5 man: updated documentation …
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   470
.. include:: ../substitute_links_1.rst