vmm.1
author Pascal Volk <neverseen@users.sourceforge.net>
Wed, 30 Apr 2008 04:05:13 +0000
changeset 26 668951708f2f
parent 25 985cee77da5f
child 36 8a9ce20d2569
permissions -rw-r--r--
* 'vmm.cfg.5' * 'vmm.1' - Reworded some parts. * 'vmm' - Added function _getOrder() for a (hopefully) better structured output from the domaininfo, userinfo and getuser subcommands.
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$
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
     2
.TH "VMM" "1" "30. April 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
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    56
        * Config section: services
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    57
        Enter new value for pop3 [True]: 
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    58
        Enter new value for smtp [True]: 
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    59
        Enter new value for imap [True]: 
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    60
        Enter new value for managesieve [True]: false
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
        -------------------
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    74
                Gid............: 70000
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    75
                Uid............: 70004
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
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    78
.TP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    79
\fBhelp\fP (\fBh\fP)
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
    80
Prints all available commands to stderr. After this \fBvmm\fP exits.
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    81
.TP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    82
\fBversion\fP (\fBv\fP)
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    83
Prints the version information from \fBvmm\fB.
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    84
.\"
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
    85
.SS DOMAIN SUBCOMMANDS
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    86
.TP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    87
\fBdomainadd\fP (\fBda\fP) \fIdomain\fP [ \fItransport\fP ]
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
    88
Adds the new \fIdomain\fP into the database.
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
    89
.br
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
    90
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
    91
default transport from \fBvmm.cfg\fP (misc/transport). The specified transport
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
    92
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
    93
.PP
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
    94
.nf
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
    95
        Examples:
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
    96
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
    97
        \fBvmm domainadd support.example.com smtp:mx1.example.com
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
    98
        vmm domainadd sales.example.com\fP
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
    99
.fi
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   100
.TP
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   101
\fBdomaininfo\fP (\fBdi\fP) \fIdomain\fP [ \fIdetailed\fP ]
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   102
This subcommand shows some information about the given domain.
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   103
.br
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   104
If the keyword '\fBdetailed\fP' is specified as optional argument, all
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   105
available accounts and aliases will be listed.
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   106
.PP
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   107
.nf
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   108
        Example:
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   109
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   110
        \fBvmm domaininfo sales.example.com\fP
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   111
        Domain information
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   112
        ------------------
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   113
                Domainname.....: sales.example.com
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   114
                Domaindir......: /home/mail/5/70002
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   115
                Gid............: 70002
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   116
                Accounts.......: 0
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   117
                Transport......: dovecot:
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   118
                Aliases........: 0
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
.fi
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   121
.TP
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   122
\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
   123
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
   124
.br
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   125
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
   126
settings will be overwritten.
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   127
.br
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   128
Otherwise this setting will affect only new created accounts.
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   129
.PP
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   130
.nf
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   131
        Example:
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   132
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   133
        \fBvmm domaintransport support.example.com dovecot:\fP
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   134
.fi
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   135
.TP
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   136
\fBdomaindelete\fP (\fBdd\fP) \fIdomain\fP [ \fIdelalias\fP | \fIdeluser\fP |\
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   137
 \fIdelall\fP ]
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   138
This subcommand deletes the specified \fIdomain\fP.
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   139
.br
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   140
If there are accounts and/or aliases assigned to the given domain, \fBvmm\fP
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   141
will abort the requested operation and show a error message. If you know, what
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   142
you are doing, you can specify one of the following keywords: '\fPdelalias\fP', '\fBdeluser\fP' or '\fBdelall\fP'.
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   143
.br
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   144
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   145
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
   146
the option \fIforcedel\fP, in section \fImisc\fP, to true.
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   147
.\"
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   148
.SS ACCOUNT SUBCOMMANDS
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   149
.TP
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   150
\fBuseradd\fP (\fBua\fP) \fIaddress\fP [ \fIpassword\fP ]
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   151
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
   152
.br
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   153
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
   154
interactively.
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   155
.PP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   156
.nf
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   157
        Examples:
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   158
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   159
        \fBvmm ua d.user@example.com 'A 5ecR3t P4s5\\/\\/0rd'\fP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   160
        \fBvmm ua e.user@example.com\fP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   161
        Enter new password:
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   162
        Retype new password:
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   163
.fi
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   164
.TP
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   165
\fBuserinfo\fP (\fBui\fP) \fIaddress\fP [ \fIdu\fP ]
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   166
This subcommand displays some information about the account specified by
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   167
\fIaddress\fP.
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   168
.br
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   169
If the optional argument \fIdu\fP is given, the disk usage of users maildir will
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   170
be summarized and displayed too.
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   171
.TP
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   172
\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
   173
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
   174
.PP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   175
.nf
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   176
        Example:
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   177
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   178
        \fBvmm un d.user@example.com 'John Doe'\fP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   179
.fi
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   180
.TP
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   181
\fBuserpassword\fP (\fBup\fP) \fIaddress\fP [ \fIpassword\fP ]
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   182
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
   183
.br
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   184
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
   185
interactively.
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   186
.PP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   187
.nf
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   188
        Example:
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   189
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   190
        \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
   191
.fi
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   192
.TP
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   193
\fBusertransport\fP (\fBut\fP) \fIaddress\fP \fItransport\fP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   194
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
   195
.PP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   196
.nf
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   197
        Example:
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   198
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   199
        \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
   200
.fi
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   201
.TP
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   202
\fBuserdisable\fP (\fBu0\fP) \fIaddress\fP [ \fIsmtp\fP | \fIpop3\fP |\
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   203
 \fIimap\fP | \fImanagesieve\fP | \fIall\fP ]
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   204
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
   205
access with this subcommand.
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   206
.br
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
   207
If neither a service nor the keyword '\fIall\fP' is given all services ('smtp', 'pop3', 'imap', and 'managesieve') will be disabled for the account with the specified
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   208
\fIaddress\fP. Otherwise only the specified service will be restricted.
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   209
.PP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   210
.nf
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   211
        Examples:
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   212
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   213
        \fBvmm u0 b.user@example.com imap\fP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   214
        \fBvmm userdisable c.user@example.com\fP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   215
.fi
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   216
.TP
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   217
\fBuserenable\fP (\fBu1\fP) \fIaddress\fP [ \fIsmtp\fP | \fIpop3\fP |\
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   218
 \fIimap\fP | \fImanagesieve\fP | \fIall\fP ]
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   219
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
   220
.br
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
   221
If neither a service nor the keyword '\fIall\fP' is given all services ('smtp', 'pop3', 'imap', and 'managesieve') will be enabled for the account with the specified
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   222
\fIaddress\fP. Otherwise only the specified service will be enabled.
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   223
.TP
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   224
\fBuserdelete\fP (\fBud\fP) \fIaddress\fP
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   225
Use this subcommand to delete the account with the given \fIaddress\fP.
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   226
.\"
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   227
.SS ALIAS SUBCOMMANDS
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   228
.TP
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   229
\fBaliasadd\fP (\fBaa\fP) \fIalias\fP \fItarget\fP
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   230
This subcommand is used to create a new alias.
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   231
.PP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   232
.nf
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   233
        Examples:
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   234
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   235
        \fBvmm aliasadd john.doe@example.com d.user@example.com\fP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   236
        \fBvmm aa support@example.com d.user@example.com\fP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   237
        \fBvmm aa support@example.com e.user@example.com\fP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   238
.fi
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   239
.TP
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   240
\fBaliasinfo\fP (\fBai\fP) \fIalias\fP
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   241
Information about an alias can be displayed with this subcommand.
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
        Example:
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 aliasinfo support@example.com\fP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   247
        Alias information
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   248
        -----------------
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   249
                Mail for support@example.com goes to:
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   250
                     -> d.user@example.com
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   251
                     -> e.user@example.com
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   252
.fi
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   253
.TP
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   254
\fBaliasdelete\fP (\fBad\fP) \fIalias\fP [ \fItarget\fP ]
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   255
Use this subcommand to delete the \fIalias\fP.
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   256
.br
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   257
If the optional destination address \fItarget\fP is given, only this
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   258
destination will be removed from the \fIalias\fP.
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   259
.PP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   260
.nf
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   261
        Example:
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   262
        \fBvmm ad support@example.com d.user@example.com\fP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   263
.fi
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   264
.SH FILES
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   265
/usr/local/etc/vmm.cfg
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   266
.SH SEE ALSO
25
985cee77da5f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 24
diff changeset
   267
vmm.cfg(5), configuration file for vmm
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   268
.SH AUTHOR
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   269
\fBvmm\fP and its man pages were written by Pascal Volk
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   270
<\fIp.volk@veb-it.de\fP> and are licensed under the terms of the BSD License.