vmm.1
author Pascal Volk <neverseen@users.sourceforge.net>
Mon, 21 Apr 2008 21:37:28 +0000
changeset 21 6feb31787a66
child 22 576a4709a44f
permissions -rw-r--r--
* 'vmm.1' - Added to repository (not completed yet)
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     1
.TH "VMM" "1" "21. April 2008" "Pascal Volk" "Virtual Mail Manager"
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     2
.SH NAME
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     3
vmm \- commandline tool to manage e-mail domains/accounts/alias
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
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     6
\fIcommand\fP \fIobject\fP [ \fIargs\fP ]
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.
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    11
.SH COMMANDS
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    12
Each command has both a long and a short form. Both forms are case sensitive.
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    13
.SS GENERAL COMMANDS
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
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    18
If the optional argument »section« is given, only the configuration options
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    19
from the given section will be displayed and be configurable. The following
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
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    55
        * Config section: services
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    56
        Enter new value for pop3 [True]: 
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    57
        Enter new value for smtp [True]: 
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    58
        Enter new value for imap [True]: 
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    59
        Enter new value for managesieve [True]: false
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
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    64
If only the userid is available, for example from process list, the command
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:
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    69
.PP
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
        -------------------
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    73
                Gid............: 70000
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    74
                Uid............: 70004
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
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    77
.TP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    78
\fBhelp\fP (\fBh\fP)
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    79
Prints all available commands to stdout. After this \fBvmm\fP exits.
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    80
.TP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    81
\fBversion\fP (\fBv\fP)
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    82
Prints the version information from \fBvmm\fB.
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    83
.\"
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    84
.SS DOMAIN COMMANDS
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    85
.TP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    86
\fBdomainadd\fP (\fBda\fP) \fIdomain\fP [ \fItransport\fP ]
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    87
Adds the new domain »domain« into the database.
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    88
.TP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    89
\fBdomaininfo\fP (\fBdi\fP)
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    90
.TP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    91
\fBdomaintransport\fP (\fBdt\fP)
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    92
.TP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    93
\fBdomaindelete\fP (\fBdd\fP)
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    94
.\"
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    95
.SS ACCOUNT COMMANDS
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    96
.TP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    97
\fBuseradd\fP (\fBua\fP)
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    98
.TP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    99
\fBuserinfo\fP (\fBui\fP)
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
\fBusername\fP (\fBun\fP)
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   102
.TP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   103
\fBuserpassword\fP (\fBup\fP)
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   104
.TP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   105
\fBusertransport\fP (\fBut\fP)
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   106
.TP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   107
\fBuserdisable\fP (\fBu0\fP)
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
\fBuserenable\fP (\fBu1\fP)
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   110
.TP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   111
\fBuserdelete\fP (\fBud\fP)
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   112
.\"
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   113
.SS ALIAS COMMANDS
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   114
.TP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   115
\fBaliasadd\fP (\fBaa\fP)
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   116
.TP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   117
\fBaliasinfo\fP (\fBai\fP)
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   118
.TP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   119
\fBaliasdelete\fP (\fBad\fP)
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   120
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   121
.SH FILES
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   122
/usr/local/etc/vmm.cfg
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   123
.SH SEE ALSO
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   124
vmm.cgf(5), vmm configuration parameters
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   125
.SH AUTHOR
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   126
\fBvmm\fP and it's man pages were written by Pascal Volk
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   127
<\fIp.volk@veb-it.de\fP> and are licensed under the terms of the
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   128
BSD License.
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   129