man/man1/vmm.1
branchv0.6.x
changeset 416 f32b323fd347
parent 411 1ca025a5ce0c
child 432 ad7cfbfbc68d
equal deleted inserted replaced
415:c7a963e6cf6e 416:f32b323fd347
     1 .TH "VMM" "1" "2011-02-22" "vmm 0.6" "vmm"
     1 .TH "VMM" "1" "2011-02-24" "vmm 0.6" "vmm"
     2 .SH NAME
     2 .SH NAME
     3 vmm \- command line tool to manage email domains/accounts/aliases
     3 vmm \- command line tool to manage email domains/accounts/aliases
     4 .\" -----------------------------------------------------------------------
     4 .\" -----------------------------------------------------------------------
     5 .SH SYNOPSIS
     5 .SH SYNOPSIS
     6 .B vmm
     6 .B vmm
    11 (a virtual mail manager) is the easy to use command line tool for
    11 (a virtual mail manager) is the easy to use command line tool for
    12 administrators and postmasters to manage (alias) domains, accounts, aliases
    12 administrators and postmasters to manage (alias) domains, accounts, aliases
    13 and relocated users.
    13 and relocated users.
    14 It allows you to simply and quickly administer your mail server.
    14 It allows you to simply and quickly administer your mail server.
    15 .br
    15 .br
    16 It\(aqs designed for Dovecot and Postfix with a PostgreSQL backend.
    16 It's designed for Dovecot and Postfix with a PostgreSQL backend.
    17 .PP
    17 .PP
    18 Each
    18 Each
    19 .I subcommand
    19 .I subcommand
    20 has both a long and a short form.
    20 has both a long and a short form.
    21 The short form is shown enclosed in parentheses.
    21 The short form is shown enclosed in parentheses.
   108 .\" ------------------------------------
   108 .\" ------------------------------------
   109 .SS configset (cs)
   109 .SS configset (cs)
   110 .B vmm configset
   110 .B vmm configset
   111 .I option value
   111 .I option value
   112 .PP
   112 .PP
   113 Use this subcommand to set or update a single configuration option\(aqs
   113 Use this subcommand to set or update a single configuration option's value.
   114 value.
       
   115 .I option
   114 .I option
   116 is the configuration option,
   115 is the configuration option,
   117 .I value
   116 .I value
   118 is the
   117 is the
   119 .IR option \(aqs
   118 .IR option 's
   120 new value.
   119 new value.
   121 .IP Note:
   120 .IP Note:
   122 This subcommand will create a new
   121 This subcommand will create a new
   123 .I vmm.cfg
   122 .I vmm.cfg
   124 without any comments.
   123 without any comments.
   186 .PP
   185 .PP
   187 .nf
   186 .nf
   188 .B vmm configure mailbox
   187 .B vmm configure mailbox
   189 Using configuration file: /usr/local/etc/vmm.cfg
   188 Using configuration file: /usr/local/etc/vmm.cfg
   190 
   189 
   191 * Configuration section: \(aqmailbox\(aq
   190 * Configuration section: `mailbox'
   192 Enter new value for option folders [Drafts:Sent:Templates:Trash]:
   191 Enter new value for option folders [Drafts:Sent:Templates:Trash]:
   193 Enter new value for option format [maildir]: mdbox
   192 Enter new value for option format [maildir]: mdbox
   194 Enter new value for option subscribe [True]:
   193 Enter new value for option subscribe [True]:
   195 Enter new value for option root [Maildir]: mdbox
   194 Enter new value for option root [Maildir]: mdbox
   196 .fi
   195 .fi
   200 .PP
   199 .PP
   201 If only the
   200 If only the
   202 .I uid
   201 .I uid
   203 is available, for example from process list, the subcommand
   202 is available, for example from process list, the subcommand
   204 .B getuser
   203 .B getuser
   205 will show the user\(aqs address.
   204 will show the user's address.
   206 .PP
   205 .PP
   207 Example:
   206 Example:
   208 .PP
   207 .PP
   209 .nf
   208 .nf
   210 .B vmm getuser 70772
   209 .B vmm getuser 70772
   232 .SS listdomains (ld)
   231 .SS listdomains (ld)
   233 .B vmm listdomains
   232 .B vmm listdomains
   234 .RI [ pattern ]
   233 .RI [ pattern ]
   235 .PP
   234 .PP
   236 This subcommand lists all available domains.
   235 This subcommand lists all available domains.
   237 All domain names will be prefixed either with `[+]\(aq, if the domain is a
   236 All domain names will be prefixed either with `[+]', if the domain is a
   238 primary domain, or with `[-]\(aq, if it is an alias domain name.
   237 primary domain, or with `[-]', if it is an alias domain name.
   239 The output can be limited with an optional
   238 The output can be limited with an optional
   240 .IR pattern .
   239 .IR pattern .
   241 .PP
   240 .PP
   242 To perform a wild card search, the % character can be used at the start
   241 To perform a wild card search, the % character can be used at the start
   243 and/or the end of the
   242 and/or the end of the
   258 .\" ------------------------------------
   257 .\" ------------------------------------
   259 .SS version (v)
   258 .SS version (v)
   260 .B vmm version
   259 .B vmm version
   261 .PP
   260 .PP
   262 Prints
   261 Prints
   263 .BR vmm \(aqs
   262 .BR vmm 's
   264 version and copyright information to stdout.
   263 version and copyright information to stdout.
   265 After this
   264 After this
   266 .B vmm
   265 .B vmm
   267 exits.
   266 exits.
   268 .\" -----------------------------------------------------------------------
   267 .\" -----------------------------------------------------------------------
   366 .nf
   365 .nf
   367 .B vmm domaininfo sales.example.com
   366 .B vmm domaininfo sales.example.com
   368 Domain information
   367 Domain information
   369 ------------------
   368 ------------------
   370         Domainname.....: sales.example.com
   369         Domainname.....: sales.example.com
   371         GID............: 70693
   370         GID............: 70698
   372         Transport......: dovecot:
   371         Transport......: dovecot:
   373         Domaindir......: /home/mail/v/70693
   372         Domaindir......: /srv/mail/k/70698
   374         Quota Limit....: Storage: 0 Messages 0
   373         Quota Limit....: Storage: 0; Messages: 0
   375         Aliasdomains...: 0
   374         Aliasdomains...: 0
   376         Accounts.......: 1
   375         Accounts.......: 1
   377         Aliases........: 0
   376         Aliases........: 0
   378         Relocated......: 0
   377         Relocated......: 0
   379 .fi
   378 .fi
   525 has been created.
   524 has been created.
   526 .PP
   525 .PP
   527 Examples:
   526 Examples:
   528 .PP
   527 .PP
   529 .nf
   528 .nf
   530 .B vmm ua d.user@example.com \(aqA 5ecR3t P4s5\(rs/\(rs/0rd\(aq
   529 .B vmm ua d.user@example.com \(dqA 5ecR3t P4s5\(rs/\(rs/0rd\(dq
   531 .B vmm useradd e.user@example.com
   530 .B vmm useradd e.user@example.com
   532 Enter new password:
   531 Enter new password:
   533 Retype new password:
   532 Retype new password:
   534 .fi
   533 .fi
   535 .\" ------------------------------------
   534 .\" ------------------------------------
   549 .SS userdisable (u0)
   548 .SS userdisable (u0)
   550 .BI "vmm userdisable" " address"
   549 .BI "vmm userdisable" " address"
   551 .RI [ "service ..." ]
   550 .RI [ "service ..." ]
   552 .PP
   551 .PP
   553 If a user should not be able to access one or more services you can
   552 If a user should not be able to access one or more services you can
   554 restrict the user\(aqs access with this subcommand.
   553 restrict the user's access with this subcommand.
   555 .PP
   554 .PP
   556 If no
   555 If no
   557 .I service
   556 .I service
   558 was given all services
   557 was given all services
   559 .RB ( imap ", " pop3 ", " sieve " and " smtp )
   558 .RB ( imap ", " pop3 ", " sieve " and " smtp )
   606 .B aliases
   605 .B aliases
   607 to list all alias addresses with the destination
   606 to list all alias addresses with the destination
   608 .I address
   607 .I address
   609 .TP
   608 .TP
   610 .B du
   609 .B du
   611 to display the disk usage of the user\(aqs mail directory.
   610 to display the disk usage of the user's mail directory.
   612 In order to summarize the disk usage each time the this subcommand is
   611 In order to summarize the disk usage each time the this subcommand is
   613 executed automatically, set
   612 executed automatically, set
   614 .I account.disk_usage
   613 .I account.disk_usage
   615 in your
   614 in your
   616 .I vmm.cfg
   615 .I vmm.cfg
   642 .fi
   641 .fi
   643 .\" ------------------------------------
   642 .\" ------------------------------------
   644 .SS username (un)
   643 .SS username (un)
   645 .BI "vmm username" " address name"
   644 .BI "vmm username" " address name"
   646 .PP
   645 .PP
   647 The user\(aqs real
   646 The user's real
   648 .I name
   647 .I name
   649 can be set/updated with this subcommand.
   648 can be set/updated with this subcommand.
   650 .PP
   649 .PP
   651 Example:
   650 Example:
   652 .PP
   651 .PP
   667 will prompt for it interactively.
   666 will prompt for it interactively.
   668 .PP
   667 .PP
   669 Example:
   668 Example:
   670 .PP
   669 .PP
   671 .nf
   670 .nf
   672 .B vmm up d.user@example.com \(aqA |\(rs/|0r3 5ecur3 P4s5\(rs/\(rs/0rd?\(aq
   671 .B vmm up d.user@example.com \(dqA |\(rs/|0r3 5ecur3 P4s5\(rs/\(rs/0rd?\(dq
   673 .fi
   672 .fi
   674 .\" ------------------------------------
   673 .\" ------------------------------------
   675 .SS userquota (uq)
   674 .SS userquota (uq)
   676 .BI "vmm userquota" " address storage"
   675 .BI "vmm userquota" " address storage"
   677 .RI [ messages ]
   676 .RI [ messages ]
   697 .I transport
   696 .I transport
   698 for an account can be specified with this subcommand.
   697 for an account can be specified with this subcommand.
   699 .PP
   698 .PP
   700 Example:
   699 Example:
   701 .br
   700 .br
   702 Assumed you want to use Dovecot\(aqs
   701 Assumed you want to use Dovecot's
   703 .BR dsync (1)
   702 .BR dsync (1)
   704 to convert a user\(aqs mailbox from Maildir format to mdbox format, you
   703 to convert a user's mailbox from Maildir format to mdbox format, you
   705 can tell Postfix to retry later.
   704 can tell Postfix to retry later.
   706 .PP
   705 .PP
   707 .nf
   706 .nf
   708 .B vmm ut d.user@example.com \(dqretry:4.0.0 Mailbox being migrated\(dq
   707 .B vmm ut d.user@example.com \(dqretry:4.0.0 Mailbox being migrated\(dq
   709 # convert the mailbox ... then set the transport to Dovecot\(aqs lmtp
   708 # convert the mailbox ... then set the transport to Dovecot's lmtp
   710 .B vmm ut d.user@example.com lmtp:unix:private/dovecot\-lmtp
   709 .B vmm ut d.user@example.com lmtp:unix:private/dovecot\-lmtp
   711 .fi
   710 .fi
   712 .\" -----------------------------------------------------------------------
   711 .\" -----------------------------------------------------------------------
   713 .SH ALIAS SUBCOMMANDS
   712 .SH ALIAS SUBCOMMANDS
   714 .SS aliasadd (aa)
   713 .SS aliasadd (aa)
   767 .BI "vmm relocatedadd" " address newaddress"
   766 .BI "vmm relocatedadd" " address newaddress"
   768 .PP
   767 .PP
   769 A new relocated user can be created with this subcommand.
   768 A new relocated user can be created with this subcommand.
   770 .PP
   769 .PP
   771 .I address
   770 .I address
   772 is the user\(aqs ex\-email address, for example b.user@example.com, and
   771 is the user's ex\-email address, for example b.user@example.com, and
   773 .I newaddress
   772 .I newaddress
   774 points to the new email address where the user can be reached.
   773 points to the new email address where the user can be reached.
   775 .PP
   774 .PP
   776 Example:
   775 Example:
   777 .PP
   776 .PP
   789 .PP
   788 .PP
   790 .nf
   789 .nf
   791 .B vmm relocatedinfo b.user@example.com
   790 .B vmm relocatedinfo b.user@example.com
   792 Relocated information
   791 Relocated information
   793 ---------------------
   792 ---------------------
   794         User \(aqb.user@example.com\(aq has moved to \(aqb\-user@company.tld\(aq
   793         User `b.user@example.com' has moved to `b\-user@company.tld'
   795 .fi
   794 .fi
   796 .\" ------------------------------------
   795 .\" ------------------------------------
   797 .SS relocateddelete (rd)
   796 .SS relocateddelete (rd)
   798 .BI "vmm relocateddelete " address
   797 .BI "vmm relocateddelete " address
   799 .PP
   798 .PP
   810 .TP
   809 .TP
   811 .I /root/vmm.cfg
   810 .I /root/vmm.cfg
   812 will be used when found.
   811 will be used when found.
   813 .TP
   812 .TP
   814 .I /usr/local/etc/vmm.cfg
   813 .I /usr/local/etc/vmm.cfg
   815 will be used when the above file doesn\(aqt exist.
   814 will be used when the above file doesn't exist.
   816 .TP
   815 .TP
   817 .I /etc/vmm.cfg
   816 .I /etc/vmm.cfg
   818 will be used when none of the both above mentioned files exists.
   817 will be used when none of the both above mentioned files exists.
   819 .\" -----------------------------------------------------------------------
   818 .\" -----------------------------------------------------------------------
   820 .SH SEE ALSO
   819 .SH SEE ALSO
   832 .TP
   831 .TP
   833 Bug tracker
   832 Bug tracker
   834 http://sf.net/tracker/?group_id=213727&atid=1026862
   833 http://sf.net/tracker/?group_id=213727&atid=1026862
   835 .\" -----------------------------------------------------------------------
   834 .\" -----------------------------------------------------------------------
   836 .SH COPYING
   835 .SH COPYING
   837 .B vmm
   836 vmm and its manual pages were written by Pascal Volk <neverseen AT
   838 and its man pages were written by Pascal Volk
   837 users.sourceforge.net> and are licensed under the terms of the BSD License.
   839 .RI < neverseen@users.sourceforge.net >
       
   840 and are licensed under the terms of the BSD License.