man/man1/vmm.1
changeset 81 89b71a9abfcf
parent 79 0ae7597eed11
child 90 1734eb5101c6
equal deleted inserted replaced
80:5dedc673524e 81:89b71a9abfcf
     1 .\" $Id$
     1 .\" $Id$
     2 .TH "VMM" "1" "09. Sep 2008" "Pascal Volk"
     2 .TH "VMM" "1" "10. Sep 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 ]
   124 \fBdomaininfo\fP (\fBdi\fP) \fIdomain\fP [ \fIdetails\fP ]
   124 \fBdomaininfo\fP (\fBdi\fP) \fIdomain\fP [ \fIdetails\fP ]
   125 This subcommand shows some information about the given \fIdomain\fP.
   125 This subcommand shows some information about the given \fIdomain\fP.
   126 .br
   126 .br
   127 For a more detailed information about the \fIdomain\fP the optional argument
   127 For a more detailed information about the \fIdomain\fP the optional argument
   128 \fIdetails\fP can be specified. A possible \fIdetails\fP value may be one of
   128 \fIdetails\fP can be specified. A possible \fIdetails\fP value may be one of
   129 the following four keywords:
   129 the following five keywords:
   130 .RS
   130 .RS
   131 .PD 0
   131 .PD 0
   132 .TP
   132 .TP
   133 .B accounts
   133 .B accounts
   134 to list all existing accounts
   134 to list all existing accounts
   136 .B aliasdomains
   136 .B aliasdomains
   137 to list all assigned alias domains
   137 to list all assigned alias domains
   138 .TP
   138 .TP
   139 .B aliases
   139 .B aliases
   140 to list all available aliases addresses
   140 to list all available aliases addresses
       
   141 .TP
       
   142 .B relocated
       
   143 to list all relocated users
   141 .TP
   144 .TP
   142 .B full
   145 .B full
   143 to list all information mentioned above
   146 to list all information mentioned above
   144 .PD
   147 .PD
   145 .RE
   148 .RE
   155                 Transport......: dovecot:
   158                 Transport......: dovecot:
   156                 Domaindir......: /home/mail/5/70002
   159                 Domaindir......: /home/mail/5/70002
   157                 Aliasdomains...: 0
   160                 Aliasdomains...: 0
   158                 Accounts.......: 0
   161                 Accounts.......: 0
   159                 Aliases........: 0
   162                 Aliases........: 0
       
   163                 Relocated......: 0
   160 
   164 
   161 .fi
   165 .fi
   162 .TP
   166 .TP
   163 \fBdomaintransport\fP (\fBdt\fP) \fIdomain\fP \fItransport\fP [ \fIforce\fP ]
   167 \fBdomaintransport\fP (\fBdt\fP) \fIdomain\fP \fItransport\fP [ \fIforce\fP ]
   164 A new transport for the indicated domain can be set with this subcommand.
   168 A new transport for the indicated domain can be set with this subcommand.
   348 If the optional destination address \fItarget\fP is given, only this
   352 If the optional destination address \fItarget\fP is given, only this
   349 destination will be removed from the \fIalias\fP.
   353 destination will be removed from the \fIalias\fP.
   350 .PP
   354 .PP
   351 .nf
   355 .nf
   352         Example:
   356         Example:
       
   357 
   353         \fBvmm ad support@example.com d.user@example.com\fP
   358         \fBvmm ad support@example.com d.user@example.com\fP
   354 .fi
   359 .fi
       
   360 .\"
       
   361 .SS RELOCATED SUBCOMMANDS
       
   362 .TP
       
   363 \fBrelocatedadd\fP (\fBra\fP) \fIold_address\fP \fInew_address\fP
       
   364 A new relocated user can be created with this subcommand.
       
   365 .br
       
   366 \fIold_address\fP is the users ex-email address, for example b.user@example.com,
       
   367 and \fInew_address\fP points to the new email address where the user can be
       
   368 reached.
       
   369 .PP
       
   370 .nf
       
   371         Example:
       
   372 
       
   373         \fBvmm relocatedadd b.user@example.com b-user@company.tld\fP
       
   374 .fi
       
   375 .TP
       
   376 \fBrelocatedinfo\fP (\fBri\fP) \fIold_address\fP
       
   377 This subcommand shows the new address of the relocated user with the 
       
   378 \fIold_address\fP.
       
   379 .PP
       
   380 .nf
       
   381         Example:
       
   382 
       
   383         \fBvmm relocatedinfo b.user@example.com\fP
       
   384         Relocated information
       
   385         ---------------------
       
   386                 User »b.user@example.com« has moved to »b-user@company.tld«
       
   387 .fi
       
   388 .TP
       
   389 \fBrelocateddelete\fP (\fBrd\fP) \fIold_address\fP
       
   390 Use this subcommand in order to delete the relocated user with the
       
   391 \fIold_address\fP.
       
   392 .PP
       
   393 .nf
       
   394         Example:
       
   395 
       
   396         \fBvmm relocateddelete b.user@example.com\fP
       
   397 .fi
       
   398 .\"
   355 .SH FILES
   399 .SH FILES
   356 /usr/local/etc/vmm.cfg
   400 /usr/local/etc/vmm.cfg
   357 .SH SEE ALSO
   401 .SH SEE ALSO
   358 vmm.cfg(5), configuration file for vmm
   402 vmm.cfg(5), configuration file for vmm
   359 .SH AUTHOR
   403 .SH AUTHOR