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