man/man1/vmm.1
author Pascal Volk <neverseen@users.sourceforge.net>
Sat, 22 Aug 2009 20:24:50 +0000 (2009-08-22)
changeset 131 2b8154cc7ebe
parent 113 e35755191ff3
child 133 2d5c4745efec
permissions -rw-r--r--
Updated documentation
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
113
e35755191ff3 Config: renamed services.managesieve to services.sieve,
Pascal Volk <neverseen@users.sourceforge.net>
parents: 102
diff changeset
     1
.TH "VMM" "1" "17 Aug 2009" "Pascal Volk"
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     2
.SH NAME
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
     3
vmm \- command line tool to manage email domains/accounts/aliases
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     4
.SH SYNOPSIS
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     5
.B vmm
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
     6
\fIsubcommand\fP \fIobject\fP [ \fIargs\fP ]
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     7
.SH DESCRIPTION
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     8
\fBvmm\fP (Virtual Mail Manager) is a command line tool for
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     9
administrators/postmasters to manage domains, accounts and aliases. It's
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    10
designed for Dovecot and Postfix with a PostgreSQL backend.
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
    11
.SH SUBCOMMANDS
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
    12
Each subcommand has both a long and a short form. Both forms are case sensitive.
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
    13
.SS GENERAL SUBCOMMANDS
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    14
.TP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    15
\fBconfigure\fP (\fBcf\fP) [ \fIsection\fP ]
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    16
Starts the interactive configuration for all configuration sections.
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    17
.br
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
    18
If the optional argument \fIsection\fP is given, only the configuration options
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
    19
from the given section will be displayed and will be configurable. The following
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    20
sections are available:
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    21
.RS
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    22
.PD 0
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    23
.TP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    24
-
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    25
.B
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    26
database
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    27
.TP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    28
-
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    29
.B
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    30
maildir
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    31
.TP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    32
-
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    33
.B
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    34
services
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    35
.TP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    36
-
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    37
.B
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    38
domdir
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    39
.TP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    40
-
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    41
.B
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    42
bin
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    43
.TP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    44
-
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    45
.B
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    46
misc
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    47
.PD
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    48
.RE
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    49
.LP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    50
.PP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    51
.nf
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    52
        Example:
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    53
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    54
        \fBvmm configure services\fP
113
e35755191ff3 Config: renamed services.managesieve to services.sieve,
Pascal Volk <neverseen@users.sourceforge.net>
parents: 102
diff changeset
    55
        Using configuration file: /usr/local/etc/vmm.cfg
e35755191ff3 Config: renamed services.managesieve to services.sieve,
Pascal Volk <neverseen@users.sourceforge.net>
parents: 102
diff changeset
    56
57
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
    57
        * Config section: »services«
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
    58
        Enter new value for option pop3 [True]: 
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
    59
        Enter new value for option smtp [True]: 
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
    60
        Enter new value for option imap [True]: 
113
e35755191ff3 Config: renamed services.managesieve to services.sieve,
Pascal Volk <neverseen@users.sourceforge.net>
parents: 102
diff changeset
    61
        Enter new value for option sieve [True]: false
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    62
.fi
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    63
.PP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    64
.TP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    65
\fBgetuser\fP (\fBgu\fP) \fIuserid\fP
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
    66
If only the userid is available, for example from process list, the subcommand
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    67
\fBgetuser\fP will show the user's address.
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    68
.PP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    69
.nf
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    70
        Example:
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
    71
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    72
        \fBvmm getuser 70004\fP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    73
        Account information
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    74
        -------------------
37
89f952b0f366 * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 36
diff changeset
    75
                UID............: 70004
89f952b0f366 * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 36
diff changeset
    76
                GID............: 70000
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    77
                Address........: c.user@example.com
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    78
.fi
36
8a9ce20d2569 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
    79
.\"
8a9ce20d2569 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
    80
.TP
8a9ce20d2569 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
    81
\fBlistdomains\fP (\fBld\fP) [ \fIpattern\fP ]
57
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
    82
This subcommand lists all available domains. All domain names will be prefixed
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
    83
either with '[+]', if the domain is a primary domain, or with '[-]', if it is
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
    84
an alias domain name. The output can be limited with an optional \fIpattern\fP.
36
8a9ce20d2569 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
    85
.br
8a9ce20d2569 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
    86
To perform a wild card search, the % character can be used at the start and/or
8a9ce20d2569 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
    87
the end of the \fIpattern\fP.
8a9ce20d2569 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
    88
.PP
8a9ce20d2569 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
    89
.nf
8a9ce20d2569 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
    90
        Example:
8a9ce20d2569 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
    91
57
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
    92
        \fBvmm listdomains %example%\fP
36
8a9ce20d2569 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
    93
        Matching domains
8a9ce20d2569 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
    94
        ----------------
57
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
    95
                [+] example.com
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
    96
                [-]     e.g.example.com
79
0ae7597eed11 * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 66
diff changeset
    97
                [-]     example.name
57
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
    98
                [+] example.net
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
    99
                [+] example.org
36
8a9ce20d2569 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
   100
.fi
8a9ce20d2569 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
   101
.\"
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   102
.TP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   103
\fBhelp\fP (\fBh\fP)
57
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   104
Prints all available commands to stdout. After this \fBvmm\fP exits.
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   105
.TP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   106
\fBversion\fP (\fBv\fP)
37
89f952b0f366 * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 36
diff changeset
   107
Prints the version information from \fBvmm\fP.
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   108
.\"
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   109
.SS DOMAIN SUBCOMMANDS
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   110
.TP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   111
\fBdomainadd\fP (\fBda\fP) \fIdomain\fP [ \fItransport\fP ]
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   112
Adds the new \fIdomain\fP into the database.
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   113
.br
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   114
If the optional argument \fItransport\fP is given, it will overwrite the
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   115
default transport from \fBvmm.cfg\fP (misc/transport). The specified transport
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   116
will be the default transport for all new accounts in this domain.
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   117
.PP
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   118
.nf
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   119
        Examples:
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   120
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   121
        \fBvmm domainadd support.example.com smtp:mx1.example.com
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   122
        vmm domainadd sales.example.com\fP
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   123
.fi
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   124
.TP
64
432a037658a8 * 'vmm'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 62
diff changeset
   125
\fBdomaininfo\fP (\fBdi\fP) \fIdomain\fP [ \fIdetails\fP ]
62
869de537a020 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 59
diff changeset
   126
This subcommand shows some information about the given \fIdomain\fP.
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   127
.br
64
432a037658a8 * 'vmm'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 62
diff changeset
   128
For a more detailed information about the \fIdomain\fP the optional argument
432a037658a8 * 'vmm'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 62
diff changeset
   129
\fIdetails\fP can be specified. A possible \fIdetails\fP value may be one of
81
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   130
the following five keywords:
62
869de537a020 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 59
diff changeset
   131
.RS
869de537a020 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 59
diff changeset
   132
.PD 0
869de537a020 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 59
diff changeset
   133
.TP
869de537a020 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 59
diff changeset
   134
.B accounts
64
432a037658a8 * 'vmm'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 62
diff changeset
   135
to list all existing accounts
62
869de537a020 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 59
diff changeset
   136
.TP
869de537a020 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 59
diff changeset
   137
.B aliasdomains
64
432a037658a8 * 'vmm'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 62
diff changeset
   138
to list all assigned alias domains
62
869de537a020 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 59
diff changeset
   139
.TP
869de537a020 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 59
diff changeset
   140
.B aliases
64
432a037658a8 * 'vmm'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 62
diff changeset
   141
to list all available aliases addresses
62
869de537a020 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 59
diff changeset
   142
.TP
81
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   143
.B relocated
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   144
to list all relocated users
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   145
.TP
62
869de537a020 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 59
diff changeset
   146
.B full
64
432a037658a8 * 'vmm'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 62
diff changeset
   147
to list all information mentioned above
62
869de537a020 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 59
diff changeset
   148
.PD
869de537a020 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 59
diff changeset
   149
.RE
869de537a020 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 59
diff changeset
   150
.LP
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   151
.nf
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   152
        Example:
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   153
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   154
        \fBvmm domaininfo sales.example.com\fP
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   155
        Domain information
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   156
        ------------------
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   157
                Domainname.....: sales.example.com
37
89f952b0f366 * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 36
diff changeset
   158
                GID............: 70002
89f952b0f366 * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 36
diff changeset
   159
                Transport......: dovecot:
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   160
                Domaindir......: /home/mail/5/70002
57
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   161
                Aliasdomains...: 0
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   162
                Accounts.......: 0
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   163
                Aliases........: 0
81
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   164
                Relocated......: 0
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   165
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   166
.fi
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   167
.TP
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   168
\fBdomaintransport\fP (\fBdt\fP) \fIdomain\fP \fItransport\fP [ \fIforce\fP ]
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
   169
A new transport for the indicated domain can be set with this subcommand.
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   170
.br
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   171
If the additional keyword '\fBforce\fP' is given all account specific transport
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   172
settings will be overwritten.
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   173
.br
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   174
Otherwise this setting will affect only new created accounts.
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   175
.PP
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   176
.nf
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   177
        Example:
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   178
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   179
        \fBvmm domaintransport support.example.com dovecot:\fP
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   180
.fi
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   181
.TP
37
89f952b0f366 * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 36
diff changeset
   182
\fBdomaindelete\fP (\fBdd\fP) \fIdomain\fP [ \fIdelalias\fP | \fIdeluser\fP | \fIdelall\fP ]
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   183
This subcommand deletes the specified \fIdomain\fP.
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   184
.br
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   185
If there are accounts and/or aliases assigned to the given domain, \fBvmm\fP
62
869de537a020 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 59
diff changeset
   186
will abort the requested operation and show an error message. If you know, what
37
89f952b0f366 * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 36
diff changeset
   187
you are doing, you can specify one of the following keywords: '\fBdelalias\fP', '\fBdeluser\fP' or '\fBdelall\fP'.
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   188
.br
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   189
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   190
If you really always know what you are doing, edit your \fBvmm.cfg\fP and set
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   191
the option \fIforcedel\fP, in section \fImisc\fP, to true.
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   192
.\"
57
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   193
.SS ALIAS DOMAIN SUBCOMMANDS
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   194
.TP
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   195
\fBaliasdomainaddd\fP (\fBada\fP) \fIaliasdomain\fP \fItargetdomain\fP
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   196
This subcommand adds the new \fIaliasdomain\fP to the \fItargetdomain\fP that
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   197
should be aliased.
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   198
.PP
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   199
.nf
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   200
        Example:
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   201
79
0ae7597eed11 * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 66
diff changeset
   202
        \fBvmm aliasdomainadd example.name example.com\fP
57
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   203
.fi
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   204
.TP
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   205
\fBaliasdomaininfo (\fBadi\fP) \fIaliasdomain\fP
59
f2f784667040 * 'man/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 57
diff changeset
   206
This subcommand shows to which domain the \fIaliasdomain\fP is assigned to.
57
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   207
.PP
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   208
.nf
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   209
        Example:
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   210
79
0ae7597eed11 * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 66
diff changeset
   211
        \fBvmm aliasdomaininfo example.name\fP
57
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   212
        Alias domain information
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   213
        ------------------------
79
0ae7597eed11 * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 66
diff changeset
   214
                The alias domain example.name belongs to:
57
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   215
                    * example.com
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   216
.fi
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   217
.TP
79
0ae7597eed11 * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 66
diff changeset
   218
\fBaliasdomainswitch\fP (\fBads\fP) \fIaliasdomain\fP \fItargetdomain\fP
0ae7597eed11 * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 66
diff changeset
   219
If the target of the existing \fIaliasdomain\fP should be switched to another
0ae7597eed11 * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 66
diff changeset
   220
\fItargetdomain\fP use this subcommand.
0ae7597eed11 * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 66
diff changeset
   221
.PP
0ae7597eed11 * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 66
diff changeset
   222
.nf
0ae7597eed11 * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 66
diff changeset
   223
        Example:
0ae7597eed11 * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 66
diff changeset
   224
0ae7597eed11 * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 66
diff changeset
   225
        \fBvmm aliasdomainswitch example.name example.org\fP
0ae7597eed11 * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 66
diff changeset
   226
.fi
0ae7597eed11 * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 66
diff changeset
   227
.TP
57
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   228
\fBaliasdomaindelete\fP (\fBadd\fP) \fIaliasdomain\fP
59
f2f784667040 * 'man/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 57
diff changeset
   229
Use this subcommand if the alias domain \fIaliasdomain\fP should be removed.
57
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   230
.PP
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   231
.nf
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   232
        Example:
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   233
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   234
        \fBvmm aliasdomaindelete e.g.example.com\fP
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   235
.fi
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   236
.\"
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   237
.SS ACCOUNT SUBCOMMANDS
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   238
.TP
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   239
\fBuseradd\fP (\fBua\fP) \fIaddress\fP [ \fIpassword\fP ]
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   240
Use this subcommand to create a new email account for the given \fIaddress\fP.
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   241
.br
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   242
If the \fIpassword\fP is not provided, \fBvmm\fP will prompt for it
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   243
interactively.
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   244
.PP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   245
.nf
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   246
        Examples:
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   247
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   248
        \fBvmm ua d.user@example.com 'A 5ecR3t P4s5\\/\\/0rd'\fP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   249
        \fBvmm ua e.user@example.com\fP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   250
        Enter new password:
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   251
        Retype new password:
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   252
.fi
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   253
.TP
90
1734eb5101c6 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 81
diff changeset
   254
\fBuserinfo\fP (\fBui\fP) \fIaddress\fP [ \fIdetails\fP ]
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   255
This subcommand displays some information about the account specified by
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   256
\fIaddress\fP.
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   257
.br
90
1734eb5101c6 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 81
diff changeset
   258
If the optional argument \fIdetails\fP is given some more information will be
1734eb5101c6 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 81
diff changeset
   259
displayed.
1734eb5101c6 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 81
diff changeset
   260
.br
1734eb5101c6 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 81
diff changeset
   261
Possible values for \fIdetails\fP are:
1734eb5101c6 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 81
diff changeset
   262
.RS
1734eb5101c6 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 81
diff changeset
   263
.PD 0
1734eb5101c6 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 81
diff changeset
   264
.TP 
1734eb5101c6 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 81
diff changeset
   265
.B aliases
1734eb5101c6 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 81
diff changeset
   266
to list all alias addresses with the destination \fIaddress\fP
1734eb5101c6 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 81
diff changeset
   267
.TP
1734eb5101c6 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 81
diff changeset
   268
.B du
1734eb5101c6 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 81
diff changeset
   269
to display the disk usage of users maildir
1734eb5101c6 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 81
diff changeset
   270
.TP
1734eb5101c6 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 81
diff changeset
   271
.B full
1734eb5101c6 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 81
diff changeset
   272
to list all information mentioned above
1734eb5101c6 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 81
diff changeset
   273
.PD
1734eb5101c6 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 81
diff changeset
   274
.RE
1734eb5101c6 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 81
diff changeset
   275
.LP
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   276
.TP
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   277
\fBusername\fP (\fBun\fP) \fIaddress\fP \fI'Users Name'\fP
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
   278
The user's real name can be set/updated with this subcommand.
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   279
.PP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   280
.nf
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   281
        Example:
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   282
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   283
        \fBvmm un d.user@example.com 'John Doe'\fP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   284
.fi
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   285
.TP
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   286
\fBuserpassword\fP (\fBup\fP) \fIaddress\fP [ \fIpassword\fP ]
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   287
The \fIpassword\fP from an account can be updated with this subcommand.
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   288
.br
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   289
If the \fIpassword\fP is not provided, \fBvmm\fP will prompt for it
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   290
interactively.
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   291
.PP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   292
.nf
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   293
        Example:
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   294
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   295
        \fBvmm up d.user@example.com 'A |\\/|0r3 5ecur3 P4s5\\/\\/0rd?'\fP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   296
.fi
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   297
.TP
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   298
\fBusertransport\fP (\fBut\fP) \fIaddress\fP \fItransport\fP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   299
A different transport for an account can be specified with this subcommand.
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   300
.PP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   301
.nf
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   302
        Example:
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   303
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   304
        \fBvmm ut d.user@example.com smtp:pc105.it.example.com\fP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   305
.fi
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   306
.TP
64
432a037658a8 * 'vmm'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 62
diff changeset
   307
\fBuserdisable\fP (\fBu0\fP) \fIaddress\fP [ \fIservice\fP ]
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   308
If a user shouldn't have access to one or all services you can restrict the 
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   309
access with this subcommand.
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   310
.br
64
432a037658a8 * 'vmm'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 62
diff changeset
   311
If neither a \fIservice\fP nor the keyword '\fIall\fP' is given all services
113
e35755191ff3 Config: renamed services.managesieve to services.sieve,
Pascal Volk <neverseen@users.sourceforge.net>
parents: 102
diff changeset
   312
(\fIsmtp\fP, \fIpop3\fP, \fIimap\fP, and \fIsieve\fP) will be disabled for the
e35755191ff3 Config: renamed services.managesieve to services.sieve,
Pascal Volk <neverseen@users.sourceforge.net>
parents: 102
diff changeset
   313
account with the specified \fIaddress\fP. Otherwise only the specified 
64
432a037658a8 * 'vmm'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 62
diff changeset
   314
\fIservice\fP will be restricted.
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   315
.PP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   316
.nf
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   317
        Examples:
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   318
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   319
        \fBvmm u0 b.user@example.com imap\fP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   320
        \fBvmm userdisable c.user@example.com\fP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   321
.fi
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   322
.TP
66
995d538a6eb5 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 64
diff changeset
   323
\fBuserenable\fP (\fBu1\fP) \fIaddress\fP [ \fIservice\fP ]
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   324
To allow access to one or all restricted services use this subcommand.
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   325
.br
64
432a037658a8 * 'vmm'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 62
diff changeset
   326
If neither a \fIservice\fP nor the keyword '\fIall\fP' is given all services
113
e35755191ff3 Config: renamed services.managesieve to services.sieve,
Pascal Volk <neverseen@users.sourceforge.net>
parents: 102
diff changeset
   327
(\fIsmtp\fP, \fIpop3\fP, \fIimap\fP, and \fIsieve\fP) will be enabled for the
e35755191ff3 Config: renamed services.managesieve to services.sieve,
Pascal Volk <neverseen@users.sourceforge.net>
parents: 102
diff changeset
   328
account with the specified \fIaddress\fP. Otherwise only the specified 
64
432a037658a8 * 'vmm'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 62
diff changeset
   329
\fIservice\fP will be enabled.
66
995d538a6eb5 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 64
diff changeset
   330
.PP
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   331
.TP
66
995d538a6eb5 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 64
diff changeset
   332
\fBuserdelete\fP (\fBud\fP) \fIaddress\fP [ \fIdelalias\fP ]
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   333
Use this subcommand to delete the account with the given \fIaddress\fP.
66
995d538a6eb5 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 64
diff changeset
   334
.br
995d538a6eb5 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 64
diff changeset
   335
If there are one or more aliases with an identical destination address,
995d538a6eb5 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 64
diff changeset
   336
\fBvmm\fP will abort the requested operation and show an error message. To
995d538a6eb5 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 64
diff changeset
   337
prevent this, specify the optional keyword '\fIdelalias\fP'.
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   338
.\"
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   339
.SS ALIAS SUBCOMMANDS
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   340
.TP
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   341
\fBaliasadd\fP (\fBaa\fP) \fIalias\fP \fItarget\fP
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   342
This subcommand is used to create a new alias.
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   343
.PP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   344
.nf
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   345
        Examples:
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   346
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   347
        \fBvmm aliasadd john.doe@example.com d.user@example.com\fP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   348
        \fBvmm aa support@example.com d.user@example.com\fP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   349
        \fBvmm aa support@example.com e.user@example.com\fP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   350
.fi
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   351
.TP
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   352
\fBaliasinfo\fP (\fBai\fP) \fIalias\fP
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   353
Information about an alias can be displayed with this subcommand.
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   354
.PP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   355
.nf
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   356
        Example:
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   357
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   358
        \fBvmm aliasinfo support@example.com\fP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   359
        Alias information
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   360
        -----------------
57
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   361
                Mail for support@example.com will be redirected to:
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   362
                     * d.user@example.com
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   363
                     * e.user@example.com
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   364
.fi
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   365
.TP
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   366
\fBaliasdelete\fP (\fBad\fP) \fIalias\fP [ \fItarget\fP ]
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   367
Use this subcommand to delete the \fIalias\fP.
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   368
.br
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   369
If the optional destination address \fItarget\fP is given, only this
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   370
destination will be removed from the \fIalias\fP.
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   371
.PP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   372
.nf
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   373
        Example:
81
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   374
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   375
        \fBvmm ad support@example.com d.user@example.com\fP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   376
.fi
81
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   377
.\"
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   378
.SS RELOCATED SUBCOMMANDS
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   379
.TP
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   380
\fBrelocatedadd\fP (\fBra\fP) \fIold_address\fP \fInew_address\fP
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   381
A new relocated user can be created with this subcommand.
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   382
.br
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   383
\fIold_address\fP is the users ex-email address, for example b.user@example.com,
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   384
and \fInew_address\fP points to the new email address where the user can be
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   385
reached.
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   386
.PP
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   387
.nf
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   388
        Example:
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   389
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   390
        \fBvmm relocatedadd b.user@example.com b-user@company.tld\fP
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   391
.fi
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   392
.TP
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   393
\fBrelocatedinfo\fP (\fBri\fP) \fIold_address\fP
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   394
This subcommand shows the new address of the relocated user with the 
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   395
\fIold_address\fP.
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   396
.PP
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   397
.nf
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   398
        Example:
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   399
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   400
        \fBvmm relocatedinfo b.user@example.com\fP
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   401
        Relocated information
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   402
        ---------------------
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   403
                User »b.user@example.com« has moved to »b-user@company.tld«
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   404
.fi
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   405
.TP
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   406
\fBrelocateddelete\fP (\fBrd\fP) \fIold_address\fP
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   407
Use this subcommand in order to delete the relocated user with the
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   408
\fIold_address\fP.
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   409
.PP
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   410
.nf
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   411
        Example:
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   412
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   413
        \fBvmm relocateddelete b.user@example.com\fP
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   414
.fi
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   415
.\"
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   416
.SH FILES
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   417
/usr/local/etc/vmm.cfg
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   418
.SH SEE ALSO
25
985cee77da5f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 24
diff changeset
   419
vmm.cfg(5), configuration file for vmm
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   420
.SH AUTHOR
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   421
\fBvmm\fP and its man pages were written by Pascal Volk
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   422
<\fIp.volk@veb-it.de\fP> and are licensed under the terms of the BSD License.