man/man1/vmm.1
changeset 81 89b71a9abfcf
parent 79 0ae7597eed11
child 90 1734eb5101c6
--- a/man/man1/vmm.1	Tue Sep 09 04:29:13 2008 +0000
+++ b/man/man1/vmm.1	Wed Sep 10 00:00:37 2008 +0000
@@ -1,5 +1,5 @@
 .\" $Id$
-.TH "VMM" "1" "09. Sep 2008" "Pascal Volk"
+.TH "VMM" "1" "10. Sep 2008" "Pascal Volk"
 .SH NAME
 vmm \- command line tool to manage email domains/accounts/aliases
 .SH SYNOPSIS
@@ -126,7 +126,7 @@
 .br
 For a more detailed information about the \fIdomain\fP the optional argument
 \fIdetails\fP can be specified. A possible \fIdetails\fP value may be one of
-the following four keywords:
+the following five keywords:
 .RS
 .PD 0
 .TP
@@ -139,6 +139,9 @@
 .B aliases
 to list all available aliases addresses
 .TP
+.B relocated
+to list all relocated users
+.TP
 .B full
 to list all information mentioned above
 .PD
@@ -157,6 +160,7 @@
                 Aliasdomains...: 0
                 Accounts.......: 0
                 Aliases........: 0
+                Relocated......: 0
 
 .fi
 .TP
@@ -350,8 +354,48 @@
 .PP
 .nf
         Example:
+
         \fBvmm ad support@example.com d.user@example.com\fP
 .fi
+.\"
+.SS RELOCATED SUBCOMMANDS
+.TP
+\fBrelocatedadd\fP (\fBra\fP) \fIold_address\fP \fInew_address\fP
+A new relocated user can be created with this subcommand.
+.br
+\fIold_address\fP is the users ex-email address, for example b.user@example.com,
+and \fInew_address\fP points to the new email address where the user can be
+reached.
+.PP
+.nf
+        Example:
+
+        \fBvmm relocatedadd b.user@example.com b-user@company.tld\fP
+.fi
+.TP
+\fBrelocatedinfo\fP (\fBri\fP) \fIold_address\fP
+This subcommand shows the new address of the relocated user with the 
+\fIold_address\fP.
+.PP
+.nf
+        Example:
+
+        \fBvmm relocatedinfo b.user@example.com\fP
+        Relocated information
+        ---------------------
+                User »b.user@example.com« has moved to »b-user@company.tld«
+.fi
+.TP
+\fBrelocateddelete\fP (\fBrd\fP) \fIold_address\fP
+Use this subcommand in order to delete the relocated user with the
+\fIold_address\fP.
+.PP
+.nf
+        Example:
+
+        \fBvmm relocateddelete b.user@example.com\fP
+.fi
+.\"
 .SH FILES
 /usr/local/etc/vmm.cfg
 .SH SEE ALSO