1 .TH "VMM" "1" "21. April 2008" "Pascal Volk" "Virtual Mail Manager" |
1 .TH "VMM" "1" "22. April 2008" "Pascal Volk" "Virtual Mail Manager" |
2 .SH NAME |
2 .SH NAME |
3 vmm \- commandline tool to manage e-mail domains/accounts/alias |
3 vmm \- commandline tool to manage email domains/accounts/aliases |
4 .SH SYNOPSIS |
4 .SH SYNOPSIS |
5 .B vmm |
5 .B vmm |
6 \fIcommand\fP \fIobject\fP [ \fIargs\fP ] |
6 \fIsubcommand\fP \fIobject\fP [ \fIargs\fP ] |
7 .SH DESCRIPTION |
7 .SH DESCRIPTION |
8 \fBvmm\fP (Virtual Mail Manager) is a command line tool for |
8 \fBvmm\fP (Virtual Mail Manager) is a command line tool for |
9 administrators/postmasters to manage domains, accounts and aliases. It's |
9 administrators/postmasters to manage domains, accounts and aliases. It's |
10 designed for Dovecot and Postfix with a PostgreSQL backend. |
10 designed for Dovecot and Postfix with a PostgreSQL backend. |
11 .SH COMMANDS |
11 .SH SUBCOMMANDS |
12 Each command has both a long and a short form. Both forms are case sensitive. |
12 Each subcommand has both a long and a short form. Both forms are case sensitive. |
13 .SS GENERAL COMMANDS |
13 .SS GENERAL SUBCOMMANDS |
14 .TP |
14 .TP |
15 \fBconfigure\fP (\fBcf\fP) [ \fIsection\fP ] |
15 \fBconfigure\fP (\fBcf\fP) [ \fIsection\fP ] |
16 Starts the interactive configuration for all configuration sections. |
16 Starts the interactive configuration for all configuration sections. |
17 .br |
17 .br |
18 If the optional argument »section« is given, only the configuration options |
18 If the optional argument »section« is given, only the configuration options |
74 Uid............: 70004 |
74 Uid............: 70004 |
75 Address........: c.user@example.com |
75 Address........: c.user@example.com |
76 .fi |
76 .fi |
77 .TP |
77 .TP |
78 \fBhelp\fP (\fBh\fP) |
78 \fBhelp\fP (\fBh\fP) |
79 Prints all available commands to stdout. After this \fBvmm\fP exits. |
79 Prints all available commands to stderr. After this \fBvmm\fP exits. |
80 .TP |
80 .TP |
81 \fBversion\fP (\fBv\fP) |
81 \fBversion\fP (\fBv\fP) |
82 Prints the version information from \fBvmm\fB. |
82 Prints the version information from \fBvmm\fB. |
83 .\" |
83 .\" |
84 .SS DOMAIN COMMANDS |
84 .SS DOMAIN SUBCOMMANDS |
85 .TP |
85 .TP |
86 \fBdomainadd\fP (\fBda\fP) \fIdomain\fP [ \fItransport\fP ] |
86 \fBdomainadd\fP (\fBda\fP) \fIdomain\fP [ \fItransport\fP ] |
87 Adds the new domain »domain« into the database. |
87 Adds the new domain »domain« into the database. |
|
88 .br |
|
89 If the optional argument »transport« is given, it will overwrite the default |
|
90 transport from \fBvmm.cfg\fP (misc/transport). The specified transport will be |
|
91 the default transport for all new accounts in this domain. |
|
92 .PP |
|
93 .nf |
|
94 Examples: |
|
95 |
|
96 \fBvmm domainadd support.example.com smtp:mx1.example.com |
|
97 vmm domainadd sales.example.com\fP |
|
98 .fi |
88 .TP |
99 .TP |
89 \fBdomaininfo\fP (\fBdi\fP) |
100 \fBdomaininfo\fP (\fBdi\fP) \fIdomain\fP [ \fIdetailed\fP ] |
|
101 This subcommand shows some information about the given domain. |
|
102 .br |
|
103 If the optional argument detailed is specified, all available accounts and |
|
104 aliases will be listed. |
|
105 .PP |
|
106 .nf |
|
107 Example: |
|
108 |
|
109 \fBvmm domaininfo sales.example.com\fP |
|
110 Domain information |
|
111 ------------------ |
|
112 Domainname.....: sales.example.com |
|
113 Domaindir......: /home/mail/5/70002 |
|
114 Gid............: 70002 |
|
115 Accounts.......: 0 |
|
116 Transport......: dovecot: |
|
117 Aliases........: 0 |
|
118 |
|
119 .fi |
90 .TP |
120 .TP |
91 \fBdomaintransport\fP (\fBdt\fP) |
121 \fBdomaintransport\fP (\fBdt\fP) \fIdomain\fP \fItransport\fP [ \fIforce\fP ] |
|
122 A new transport for the given domain can be set with this subcommand. |
|
123 .br |
|
124 If the optional argument \fIforce\fP is given all account specific transport |
|
125 settings will be overwritten. |
|
126 .br |
|
127 Otherwise this setting will affect only new created accounts. |
|
128 .PP |
|
129 .nf |
|
130 Example: |
|
131 |
|
132 \fBvmm domaintransport support.example.com dovecot:\fP |
|
133 .fi |
92 .TP |
134 .TP |
93 \fBdomaindelete\fP (\fBdd\fP) |
135 \fBdomaindelete\fP (\fBdd\fP) \fIdomain\fP [ \fIdelalias\fP | \fIdeluser\fP |\ |
|
136 \fIdelall\fP ] |
|
137 This subcommand deletes the specified domain. |
|
138 .br |
|
139 If there are accounts and/or aliases assigned to the given domain, \fBvmm\fP |
|
140 will abort the requested operation and show a error message. If you know, what |
|
141 you are doing, you can specify one of this arguments: \fIdelalias\fP, |
|
142 \fIdeluser\fP or \fIdelall\fP. |
|
143 .br |
|
144 If you really always know what you are doing, edit your \fBvmm.cfg\fP and set |
|
145 the option \fIforcedel\fP, in section \fImisc\fP, to true. |
94 .\" |
146 .\" |
95 .SS ACCOUNT COMMANDS |
147 .SS ACCOUNT SUBCOMMANDS |
96 .TP |
148 .TP |
97 \fBuseradd\fP (\fBua\fP) |
149 \fBuseradd\fP (\fBua\fP) \fIaddress\fP [ \fIpassword\fP ] |
98 .TP |
150 .TP |
99 \fBuserinfo\fP (\fBui\fP) |
151 \fBuserinfo\fP (\fBui\fP) \fIaddress\fP [ \fIdu\fP ] |
100 .TP |
152 .TP |
101 \fBusername\fP (\fBun\fP) |
153 \fBusername\fP (\fBun\fP) \fIaddress\fP [ \fI'Users Name'\fP ] |
102 .TP |
154 .TP |
103 \fBuserpassword\fP (\fBup\fP) |
155 \fBuserpassword\fP (\fBup\fP) \fIaddress\fP [ \fIpassword\fP ] |
104 .TP |
156 .TP |
105 \fBusertransport\fP (\fBut\fP) |
157 \fBusertransport\fP (\fBut\fP) \fIaddress\fP [ \fItransport\fP ] |
106 .TP |
158 .TP |
107 \fBuserdisable\fP (\fBu0\fP) |
159 \fBuserdisable\fP (\fBu0\fP) \fIaddress\fP [ \fIsmtp\fP | \fIpop3\fP |\ |
|
160 \fIimap\fP | \fImanagesieve\fP | \fIall\fP ] |
108 .TP |
161 .TP |
109 \fBuserenable\fP (\fBu1\fP) |
162 \fBuserenable\fP (\fBu1\fP) \fIaddress\fP [ \fIsmtp\fP | \fIpop3\fP |\ |
|
163 \fIimap\fP | \fImanagesieve\fP | \fIall\fP ] |
110 .TP |
164 .TP |
111 \fBuserdelete\fP (\fBud\fP) |
165 \fBuserdelete\fP (\fBud\fP) \fIaddress\fP |
112 .\" |
166 .\" |
113 .SS ALIAS COMMANDS |
167 .SS ALIAS SUBCOMMANDS |
114 .TP |
168 .TP |
115 \fBaliasadd\fP (\fBaa\fP) |
169 \fBaliasadd\fP (\fBaa\fP) \fIalias\fP \fItarget\fP |
116 .TP |
170 .TP |
117 \fBaliasinfo\fP (\fBai\fP) |
171 \fBaliasinfo\fP (\fBai\fP) \fIalias\fP |
118 .TP |
172 .TP |
119 \fBaliasdelete\fP (\fBad\fP) |
173 \fBaliasdelete\fP (\fBad\fP) \fIalias\fP [ \fItarget\fP ] |
120 |
174 |
121 .SH FILES |
175 .SH FILES |
122 /usr/local/etc/vmm.cfg |
176 /usr/local/etc/vmm.cfg |
123 .SH SEE ALSO |
177 .SH SEE ALSO |
124 vmm.cgf(5), vmm configuration parameters |
178 vmm.cgf(5), vmm configuration parameters |
125 .SH AUTHOR |
179 .SH AUTHOR |
126 \fBvmm\fP and it's man pages were written by Pascal Volk |
180 \fBvmm\fP and its man pages were written by Pascal Volk |
127 <\fIp.volk@veb-it.de\fP> and are licensed under the terms of the |
181 <\fIp.volk@veb-it.de\fP> and are licensed under the terms of the BSD License. |
128 BSD License. |
|
129 |
182 |