|
1 .TH "VMM" "1" "21. April 2008" "Pascal Volk" "Virtual Mail Manager" |
|
2 .SH NAME |
|
3 vmm \- commandline tool to manage e-mail domains/accounts/alias |
|
4 .SH SYNOPSIS |
|
5 .B vmm |
|
6 \fIcommand\fP \fIobject\fP [ \fIargs\fP ] |
|
7 .SH DESCRIPTION |
|
8 \fBvmm\fP (Virtual Mail Manager) is a command line tool for |
|
9 administrators/postmasters to manage domains, accounts and aliases. It's |
|
10 designed for Dovecot and Postfix with a PostgreSQL backend. |
|
11 .SH COMMANDS |
|
12 Each command has both a long and a short form. Both forms are case sensitive. |
|
13 .SS GENERAL COMMANDS |
|
14 .TP |
|
15 \fBconfigure\fP (\fBcf\fP) [ \fIsection\fP ] |
|
16 Starts the interactive configuration for all configuration sections. |
|
17 .br |
|
18 If the optional argument »section« is given, only the configuration options |
|
19 from the given section will be displayed and be configurable. The following |
|
20 sections are available: |
|
21 .RS |
|
22 .PD 0 |
|
23 .TP |
|
24 - |
|
25 .B |
|
26 database |
|
27 .TP |
|
28 - |
|
29 .B |
|
30 maildir |
|
31 .TP |
|
32 - |
|
33 .B |
|
34 services |
|
35 .TP |
|
36 - |
|
37 .B |
|
38 domdir |
|
39 .TP |
|
40 - |
|
41 .B |
|
42 bin |
|
43 .TP |
|
44 - |
|
45 .B |
|
46 misc |
|
47 .PD |
|
48 .RE |
|
49 .LP |
|
50 .PP |
|
51 .nf |
|
52 Example: |
|
53 |
|
54 \fBvmm configure services\fP |
|
55 * Config section: services |
|
56 Enter new value for pop3 [True]: |
|
57 Enter new value for smtp [True]: |
|
58 Enter new value for imap [True]: |
|
59 Enter new value for managesieve [True]: false |
|
60 .fi |
|
61 .PP |
|
62 .TP |
|
63 \fBgetuser\fP (\fBgu\fP) \fIuserid\fP |
|
64 If only the userid is available, for example from process list, the command |
|
65 \fBgetuser\fP will show the user's address. |
|
66 .PP |
|
67 .nf |
|
68 Example: |
|
69 .PP |
|
70 \fBvmm getuser 70004\fP |
|
71 Account information |
|
72 ------------------- |
|
73 Gid............: 70000 |
|
74 Uid............: 70004 |
|
75 Address........: c.user@example.com |
|
76 .fi |
|
77 .TP |
|
78 \fBhelp\fP (\fBh\fP) |
|
79 Prints all available commands to stdout. After this \fBvmm\fP exits. |
|
80 .TP |
|
81 \fBversion\fP (\fBv\fP) |
|
82 Prints the version information from \fBvmm\fB. |
|
83 .\" |
|
84 .SS DOMAIN COMMANDS |
|
85 .TP |
|
86 \fBdomainadd\fP (\fBda\fP) \fIdomain\fP [ \fItransport\fP ] |
|
87 Adds the new domain »domain« into the database. |
|
88 .TP |
|
89 \fBdomaininfo\fP (\fBdi\fP) |
|
90 .TP |
|
91 \fBdomaintransport\fP (\fBdt\fP) |
|
92 .TP |
|
93 \fBdomaindelete\fP (\fBdd\fP) |
|
94 .\" |
|
95 .SS ACCOUNT COMMANDS |
|
96 .TP |
|
97 \fBuseradd\fP (\fBua\fP) |
|
98 .TP |
|
99 \fBuserinfo\fP (\fBui\fP) |
|
100 .TP |
|
101 \fBusername\fP (\fBun\fP) |
|
102 .TP |
|
103 \fBuserpassword\fP (\fBup\fP) |
|
104 .TP |
|
105 \fBusertransport\fP (\fBut\fP) |
|
106 .TP |
|
107 \fBuserdisable\fP (\fBu0\fP) |
|
108 .TP |
|
109 \fBuserenable\fP (\fBu1\fP) |
|
110 .TP |
|
111 \fBuserdelete\fP (\fBud\fP) |
|
112 .\" |
|
113 .SS ALIAS COMMANDS |
|
114 .TP |
|
115 \fBaliasadd\fP (\fBaa\fP) |
|
116 .TP |
|
117 \fBaliasinfo\fP (\fBai\fP) |
|
118 .TP |
|
119 \fBaliasdelete\fP (\fBad\fP) |
|
120 |
|
121 .SH FILES |
|
122 /usr/local/etc/vmm.cfg |
|
123 .SH SEE ALSO |
|
124 vmm.cgf(5), vmm configuration parameters |
|
125 .SH AUTHOR |
|
126 \fBvmm\fP and it's man pages were written by Pascal Volk |
|
127 <\fIp.volk@veb-it.de\fP> and are licensed under the terms of the |
|
128 BSD License. |
|
129 |