man/man1/vmm.1
changeset 57 38c42e09677a
parent 37 89f952b0f366
child 59 f2f784667040
equal deleted inserted replaced
56:9ae1b1b2ee5c 57:38c42e09677a
     1 .\" $Id$
     1 .\" $Id$
     2 .TH "VMM" "1" "11. Jun 2008" "Pascal Volk"
     2 .TH "VMM" "1" "23. Aug 2008" "Pascal Volk"
     3 .SH NAME
     3 .SH NAME
     4 vmm \- command line tool to manage email domains/accounts/aliases
     4 vmm \- command line tool to manage email domains/accounts/aliases
     5 .SH SYNOPSIS
     5 .SH SYNOPSIS
     6 .B vmm
     6 .B vmm
     7 \fIsubcommand\fP \fIobject\fP [ \fIargs\fP ]
     7 \fIsubcommand\fP \fIobject\fP [ \fIargs\fP ]
    51 .PP
    51 .PP
    52 .nf
    52 .nf
    53         Example:
    53         Example:
    54 
    54 
    55         \fBvmm configure services\fP
    55         \fBvmm configure services\fP
    56         * Config section: services
    56         * Config section: »services«
    57         Enter new value for pop3 [True]: 
    57         Enter new value for option pop3 [True]: 
    58         Enter new value for smtp [True]: 
    58         Enter new value for option smtp [True]: 
    59         Enter new value for imap [True]: 
    59         Enter new value for option imap [True]: 
    60         Enter new value for managesieve [True]: false
    60         Enter new value for option managesieve [True]: false
    61 .fi
    61 .fi
    62 .PP
    62 .PP
    63 .TP
    63 .TP
    64 \fBgetuser\fP (\fBgu\fP) \fIuserid\fP
    64 \fBgetuser\fP (\fBgu\fP) \fIuserid\fP
    65 If only the userid is available, for example from process list, the subcommand
    65 If only the userid is available, for example from process list, the subcommand
    76                 Address........: c.user@example.com
    76                 Address........: c.user@example.com
    77 .fi
    77 .fi
    78 .\"
    78 .\"
    79 .TP
    79 .TP
    80 \fBlistdomains\fP (\fBld\fP) [ \fIpattern\fP ]
    80 \fBlistdomains\fP (\fBld\fP) [ \fIpattern\fP ]
    81 This subcommand lists all available domains. The output can be limited with an
    81 This subcommand lists all available domains. All domain names will be prefixed
    82 optional \fIpattern\fP.
    82 either with '[+]', if the domain is a primary domain, or with '[-]', if it is
       
    83 an alias domain name. The output can be limited with an optional \fIpattern\fP.
    83 .br
    84 .br
    84 To perform a wild card search, the % character can be used at the start and/or
    85 To perform a wild card search, the % character can be used at the start and/or
    85 the end of the \fIpattern\fP.
    86 the end of the \fIpattern\fP.
    86 .PP
    87 .PP
    87 .nf
    88 .nf
    88         Example:
    89         Example:
    89 
    90 
    90         \fBvmm listdomains example%\fP
    91         \fBvmm listdomains %example%\fP
    91         Matching domains
    92         Matching domains
    92         ----------------
    93         ----------------
    93                 example.com
    94                 [+] example.com
    94                 example.net
    95                 [-]     e.g.example.com
    95                 example.org
    96                 [-]     exempli-gratia.example.com
       
    97                 [+] example.net
       
    98                 [+] example.org
    96 .fi
    99 .fi
    97 .\"
   100 .\"
    98 .TP
   101 .TP
    99 \fBhelp\fP (\fBh\fP)
   102 \fBhelp\fP (\fBh\fP)
   100 Prints all available commands to stderr. After this \fBvmm\fP exits.
   103 Prints all available commands to stdout. After this \fBvmm\fP exits.
   101 .TP
   104 .TP
   102 \fBversion\fP (\fBv\fP)
   105 \fBversion\fP (\fBv\fP)
   103 Prints the version information from \fBvmm\fP.
   106 Prints the version information from \fBvmm\fP.
   104 .\"
   107 .\"
   105 .SS DOMAIN SUBCOMMANDS
   108 .SS DOMAIN SUBCOMMANDS
   120 .TP
   123 .TP
   121 \fBdomaininfo\fP (\fBdi\fP) \fIdomain\fP [ \fIdetailed\fP ]
   124 \fBdomaininfo\fP (\fBdi\fP) \fIdomain\fP [ \fIdetailed\fP ]
   122 This subcommand shows some information about the given domain.
   125 This subcommand shows some information about the given domain.
   123 .br
   126 .br
   124 If the keyword '\fBdetailed\fP' is specified as optional argument, all
   127 If the keyword '\fBdetailed\fP' is specified as optional argument, all
   125 available accounts and aliases will be listed.
   128 available alias domains, accounts and aliases will be listed.
   126 .PP
   129 .PP
   127 .nf
   130 .nf
   128         Example:
   131         Example:
   129 
   132 
   130         \fBvmm domaininfo sales.example.com\fP
   133         \fBvmm domaininfo sales.example.com\fP
   132         ------------------
   135         ------------------
   133                 Domainname.....: sales.example.com
   136                 Domainname.....: sales.example.com
   134                 GID............: 70002
   137                 GID............: 70002
   135                 Transport......: dovecot:
   138                 Transport......: dovecot:
   136                 Domaindir......: /home/mail/5/70002
   139                 Domaindir......: /home/mail/5/70002
       
   140                 Aliasdomains...: 0
   137                 Accounts.......: 0
   141                 Accounts.......: 0
   138                 Aliases........: 0
   142                 Aliases........: 0
   139 
   143 
   140 .fi
   144 .fi
   141 .TP
   145 .TP
   161 you are doing, you can specify one of the following keywords: '\fBdelalias\fP', '\fBdeluser\fP' or '\fBdelall\fP'.
   165 you are doing, you can specify one of the following keywords: '\fBdelalias\fP', '\fBdeluser\fP' or '\fBdelall\fP'.
   162 .br
   166 .br
   163 
   167 
   164 If you really always know what you are doing, edit your \fBvmm.cfg\fP and set
   168 If you really always know what you are doing, edit your \fBvmm.cfg\fP and set
   165 the option \fIforcedel\fP, in section \fImisc\fP, to true.
   169 the option \fIforcedel\fP, in section \fImisc\fP, to true.
       
   170 .\"
       
   171 .SS ALIAS DOMAIN SUBCOMMANDS
       
   172 .TP
       
   173 \fBaliasdomainaddd\fP (\fBada\fP) \fIaliasdomain\fP \fItargetdomain\fP
       
   174 This subcommand adds the new \fIaliasdomain\fP to the \fItargetdomain\fP that
       
   175 should be aliased.
       
   176 .PP
       
   177 .nf
       
   178         Example:
       
   179 
       
   180         \fBvmm aliasdomainadd exempli-gratia.example.com example.com\fP
       
   181 .fi
       
   182 .TP
       
   183 \fBaliasdomaininfo (\fBadi\fP) \fIaliasdomain\fP
       
   184 This subcommand shows to which domain the \fIaliasdomain\fP is assigned.
       
   185 .PP
       
   186 .nf
       
   187         Example:
       
   188 
       
   189         \fBvmm aliasdomaininfo exempli-gratia.example.com\fP
       
   190         Alias domain information
       
   191         ------------------------
       
   192                 The alias domain exempli-gratia.example.com belongs to:
       
   193                     * example.com
       
   194 .fi
       
   195 .TP
       
   196 \fBaliasdomaindelete\fP (\fBadd\fP) \fIaliasdomain\fP
       
   197 If the \fIaliasdomain\fP named alias domain should be removed use this
       
   198 subcommand.
       
   199 .PP
       
   200 .nf
       
   201         Example:
       
   202 
       
   203         \fBvmm aliasdomaindelete e.g.example.com\fP
       
   204 .fi
   166 .\"
   205 .\"
   167 .SS ACCOUNT SUBCOMMANDS
   206 .SS ACCOUNT SUBCOMMANDS
   168 .TP
   207 .TP
   169 \fBuseradd\fP (\fBua\fP) \fIaddress\fP [ \fIpassword\fP ]
   208 \fBuseradd\fP (\fBua\fP) \fIaddress\fP [ \fIpassword\fP ]
   170 Use this subcommand to create a new email account for the given \fIaddress\fP.
   209 Use this subcommand to create a new email account for the given \fIaddress\fP.
   261         Example:
   300         Example:
   262 
   301 
   263         \fBvmm aliasinfo support@example.com\fP
   302         \fBvmm aliasinfo support@example.com\fP
   264         Alias information
   303         Alias information
   265         -----------------
   304         -----------------
   266                 Mail for support@example.com goes to:
   305                 Mail for support@example.com will be redirected to:
   267                      -> d.user@example.com
   306                      * d.user@example.com
   268                      -> e.user@example.com
   307                      * e.user@example.com
   269 .fi
   308 .fi
   270 .TP
   309 .TP
   271 \fBaliasdelete\fP (\fBad\fP) \fIalias\fP [ \fItarget\fP ]
   310 \fBaliasdelete\fP (\fBad\fP) \fIalias\fP [ \fItarget\fP ]
   272 Use this subcommand to delete the \fIalias\fP.
   311 Use this subcommand to delete the \fIalias\fP.
   273 .br
   312 .br