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