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