vmm: comparison man/man1/vmm.1

equal deleted inserted replaced

-:2bc11dada296
+:6287cf6c6447
-.TH "VMM" "1" "2012-09-27" "vmm 0.6" "vmm"
+.TH "VMM" "1" "2013-01-06" "vmm 0.7" "vmm"
 .SH NAME
 vmm \- command line tool to manage email domains/accounts/aliases
 .\" -----------------------------------------------------------------------
 .SH SYNOPSIS
 .B vmm
-.IR subcommand " [" "argument ..." ]
+.BR   \-h | \-v | \-\-help | \-\-version
+.\" --------------------------
+.br
+.BI vmm " subcommand " \-h \c
+.RB | \-\-help
+.\" --------------------------
+.br
+.BI vmm " subcommand"
+.IR arguments " [" options ]
 .\" -----------------------------------------------------------------------
 .SH DESCRIPTION
 .B vmm
 (a virtual mail manager) is the easy to use command line tool for
 administrators and postmasters to manage (alias) domains, accounts, aliases
 .PP
 Most of the
 .IR subcommand s
 take one or more
 .IR argument s.
+.\" -----------------------------------------------------------------------
+.SH OPTIONS
+The following options are recognized by
+.BR vmm .
+.TP
+.BR \-h ", " \-\-help
+show a list of available subcommands and exit.
+.\" --------------------------
+.TP
+.BR \-v ", " \-\-version
+show
+.BR vmm \(aqs
+version and copyright information and exit.
 .\" -----------------------------------------------------------------------
 .SH ARGUMENTS
 .TP 12
 .I address
 The complete e\-mail address
 domain.transport = lmtp:unix:private/dovecot\-lmtp
 .fi
 .\" ------------------------------------
 .SS configure (cf)
 .B vmm configure
-.RI [ section ]
+.RB [ \-s
+.IR section ]
 .PP
 Starts the interactive configuration for all configuration sections.
 .PP
 In this process the currently set value of each option will be displayed in
 square brackets.
 .IR vmm.cfg.bak .
 .PP
 Example:
 .PP
 .nf
-.B vmm configure mailbox
+.B vmm configure \-s mailbox
 Using configuration file: /usr/local/etc/vmm.cfg
 * Configuration section: `mailbox'
 Enter new value for option folders [Drafts:Sent:Templates:Trash]:
 Enter new value for option format [maildir]: mdbox
 UID............: 79876
 GID............: 70704
 Address........: a.user@example.com
 .fi
 .\" ------------------------------------
-.SS help (h)
-.B vmm help
-.RI [ subcommand ]
-.PP
-Prints a list of available subcommands with a short description to stdout.
-When a
-.I subcommand
-was given, help for that
-.I subcommand
-will be displayed.
-After this
-.B vmm
-exits.
-.\" ------------------------------------
 .SS listdomains (ld)
 .B vmm listdomains
-.RI [ pattern ]
+.RB [ \-p
+.IR pattern ]
 .PP
 This subcommand lists all available domains.
 All domain names will be prefixed either with `[+]', if the domain is a
 primary domain, or with `[-]', if it is an alias domain name.
 The output can be limited with an optional
 .IR pattern .
 .PP
 Example:
 .PP
 .nf
-.B vmm listdomains %example%
+.B vmm listdomains \-p %example%
 Matching domains
 ----------------
 [+] example.com
 [\-]     e.g.example.com
 [\-]     example.name
 [+] example.org
 .fi
 .\" ------------------------------------
 .SS listaddresses (ll)
 .B vmm listaddresses
-.RI [ pattern ]
+.RB [ \-p
+.IR pattern ]
 .PP
 This command lists all defined addresses. Addresses belonging to
 alias-domains are prefixed with a '-', addresses of regular domains with
 a '+'. Additionally, the letters 'u', 'a', and 'r' indicate the type of
 each address: user, alias and relocated respectively.
 .IR pattern .
 .PP
 Example:
 .PP
 .nf
-.B vmm listaddresses example.com
+.B vmm listaddresses \-p example.com
-.B vmm listaddresses %master@%
+.B vmm listaddresses \-p %master@%
 .\" ------------------------------------
 .SS listaliases (la)
 .B vmm listaliases
-.RI [ pattern ]
+.RB [ \-p
+.IR pattern ]
 .PP
 This command lists all defined aliases. Aliases belonging to
 alias-domains are prefixed with a '-', addresses of regular domains with
 a '+'.
 The output can be limited with an optional
 .IR pattern .
 .PP
 Example:
 .PP
 .nf
-.B vmm listaliases example.com
+.B vmm listaliases \-p example.com
-.B vmm listaliases %master@%
+.B vmm listaliases \-p %master@%
 .\" ------------------------------------
 .SS listrelocated (lr)
 .B vmm listrelocated
-.RI [ pattern ]
+.RB [ \-p
+.IR pattern ]
 .PP
 This command lists all defined relocated addresses. Relocated entries
 belonging to alias-domains are prefixed with a '-', addresses of regular
 domains with
 a '+'.
 .IR pattern .
 .PP
 Example:
 .PP
 .nf
-.B vmm listrelocated example.com
+.B vmm listrelocated \-p example.com
-.B vmm listrelocated %master@%
+.B vmm listrelocated \-p %master@%
 .\" ------------------------------------
 .SS listusers (lu)
 .B vmm listusers
-.RI [ pattern ]
+.RB [ \-p
+.IR pattern ]
 .PP
 This command lists all user accounts. User accounts belonging to
 alias-domains are prefixed with a '-', addresses of regular
 domains with
 a '+'.
 .IR pattern .
 .PP
 Example:
 .PP
 .nf
-.B vmm listusers example.com
+.B vmm listusers \-p example.com
-.B vmm listusers %master@%
+.B vmm listusers \-p %master@%
 .\" ------------------------------------
 .SS listpwschemes (lp)
 .B vmm listpwschemes
 .PP
 This subcommand lists all password schemes which could be used in the
 .PP
 .nf
 .B vmm listpwschemes
 Usable password schemes
 -----------------------
-CRYPT SHA512-CRYPT LDAP-MD5 DIGEST-MD5 SHA256 SHA512 SSHA512
+CLEARTEXT CRAM-MD5 CRYPT DIGEST-MD5 HMAC-MD5 LANMAN LDAP-MD5 MD5
-SKEY SSHA NTLM RPA MD5-CRYPT HMAC-MD5 SHA1 PLAIN SHA CRAM-MD5
+MD5-CRYPT NTLM OTP PLAIN PLAIN-MD4 PLAIN-MD5 RPA SHA SHA1 SHA256
-SSHA256 MD5 LANMAN CLEARTEXT PLAIN-MD5 PLAIN-MD4 OTP SMD5
+SHA256-CRYPT SHA512 SHA512-CRYPT SKEY SMD5 SSHA SSHA256 SSHA512
-SHA256-CRYPT
 Usable encoding suffixes
 ------------------------
 .B64 .BASE64 .HEX
 .fi
-.\" ------------------------------------
-.SS version (v)
-.B vmm version
-.PP
-Prints
-.BR vmm 's
-version and copyright information to stdout.
-After this
-.B vmm
-exits.
 .\" -----------------------------------------------------------------------
 .SH DOMAIN SUBCOMMANDS
 .SS domainadd (da)
 .B vmm domainadd
-.IR fqdn " [" transport ]
+.I fqdn
+.RB [ \-t
+.IR transport ]
 .PP
 Adds the new domain into the database and creates the domain directory.
 .PP
 If the optional argument
 .I transport
 .RE
 .PP
 Examples:
 .PP
 .nf
-.B vmm domainadd support.example.com smtp:[mx1.example.com]:2025
+.B vmm domainadd support.example.com \-t smtp:[mx1.example.com]:2025
 Creating account for postmaster@support.example.com
 Enter new password:
 Retype new password:
 .B vmm cs account.random_password true
 .B vmm domainadd sales.example.com
 Generated password: pLJUQ6Xg_z
 .fi
 .\" ------------------------------------
 .SS domaindelete (dd)
 .BI "vmm domaindelete " fqdn
-.RB [ force ]
+.RB [ \-\-force ]
 .PP
 This subcommand deletes the domain specified by
 .IR fqdn .
 .PP
 If there are accounts, aliases and/or relocated users assigned to the given
 domain,
 .B vmm
 will abort the requested operation and show an error message.
-If you know, what you are doing, you can specify the optional keyword
+If you know, what you are doing, you can specify the optional argument
-.BR force .
+.BR \-\-force .
 .PP
 If you really always know what you are doing, edit your
 .I vmm.cfg
 and set the option
 .I domain.force_deletion
 to
 .BR true .
 .\" ------------------------------------
 .SS domaininfo (di)
 .B vmm domaininfo
-.IR fqdn \ [ details ]
+.I fqdn
+.RB [ \-d
+.IR details ]
 .PP
 This subcommand shows some information about the given domain.
 .PP
 For a more detailed information about the domain the optional argument
 .I details
 Catch-All Dests..: 1
 .fi
 .\" ------------------------------------
 .SS domainquota (dq)
 .B vmm domainquota
-.IR "fqdn storage" " [" messages ]
+.I fqdn storage
-.RB [ force ]
+.RB [ \-m
+.IR messages ]
+.RB [ --force ]
 .PP
 This subcommand is used to configure a new quota limit for the accounts of
 the domain - not for the domain itself.
 .PP
 The default quota limit for accounts is defined in the
 .IR vmm.cfg " (" domain.quota_bytes " and " domain.quota_messages ).
 .PP
 The new quota limit will affect only those accounts for which the limit
 has not been overridden. If you want to restore the default to all accounts,
-you may pass the keyword
+you may pass the optional argument
-.BR force .
+.BR \-\-force .
 .br
 When the argument
 .I messages
 was omitted the default number of messages
 .B 0
 (zero) will be applied.
 .PP
 Example:
 .PP
 .nf
-.B vmm domainquota example.com 1g force
+.B vmm domainquota example.com 1g \-\-force
 .fi
 .\" ------------------------------------
 .SS domainservices (ds)
 .B vmm domainservices
-.IR fqdn " [" "service ..." ]
+.I fqdn
-.RB [ force ]
+.RB [ \-s
+.IR "service ..." ]
+.RB [ \-\-force ]
 .PP
 To define which services could be used by the users of the domain \(em with
 the given
 .I fqdn
 \(em use this subcommand.
 Possible service names are:
 .BR  imap ", " pop3 ", " sieve " and " smtp .
 .br
 The new service set will affect only those accounts for which the set has not
 been overridden. If you want to restore the default to all accounts, you may
-pass the keyword
+pass the option
-.BR force .
+.BR \-\-force .
 .\" ------------------------------------
 .SS domaintransport (dt)
 .BI "vmm domaintransport" " fqdn transport"
-.RB [ force ]
+.RB [ --force ]
 .PP
 A new transport for the indicated domain can be set with this subcommand.
 .PP
 The new transport will affect only those accounts for which the transport has
 not been overridden. If you want to restore the default to all accounts, you
-may pass the keyword
+may give the option
-.BR force .
+.BR \-\-force .
 .PP
 Example:
 .PP
 .nf
 .B vmm domaintransport support.example.com dovecot:
 .fi
 .\" ------------------------------------
 .SS domainnote (do)
 .BI "vmm domainnote" " fqdn"
-.RI [ note ]
+.RB [ \-n
+.IR note ]
 .PP
 With this subcommand, it is possible to attach a note to the specified
 domain. Without an argument, an existing note is removed.
 .PP
 Example:
 .PP
 .nf
-.B vmm do example.com Belongs to Robert
+.B vmm do example.com \-n `Belongs to Robert'
 .fi
 .\" -----------------------------------------------------------------------
 .SH ALIAS DOMAIN SUBCOMMANDS
 An alias domain is an alias for a domain that was previously added with the
 subcommand
 .fi
 .\" -----------------------------------------------------------------------
 .SH ACCOUNT SUBCOMMANDS
 .SS useradd (ua)
 .B vmm useradd
-.IR address " [" password ]
+.I address
+.RB [ \-p
+.IR password ]
 .PP
 Use this subcommand to create a new e\-mail account for the given
 .IR address .
 .PP
 If the
 has been created.
 .PP
 Examples:
 .PP
 .nf
-.B vmm ua d.user@example.com \(dqA 5ecR3t P4s5\(rs/\(rs/0rd\(dq
+.B vmm ua d.user@example.com \-p \(dqA 5ecR3t P4s5\(rs/\(rs/0rd\(dq
 .B vmm useradd e.user@example.com
 Enter new password:
 Retype new password:
 .fi
 .\" ------------------------------------
 .SS userdelete (ud)
 .BI "vmm userdelete" " address"
-.RB [ force ]
+.RB [ \-\-force ]
 .PP
 Use this subcommand to delete the account with the given
 .IR address .
 .PP
 If there are one or more aliases with an identical destination address,
 .B vmm
 will abort the requested operation and show an error message.
-To prevent this, specify the optional keyword
+To prevent this, give the optional argument
-.BR force .
+.BR \-\-force .
 .\" ------------------------------------
 .SS userinfo (ui)
 .B "vmm userinfo"
-.IR address " [" details ]
+.I address
+.RB [ \-d
+.IR details ]
 .PP
 This subcommand displays some information about the account specified by
 .IR address .
 .PP
 If the optional argument
 SIEVE............: enabled
 .fi
 .\" ------------------------------------
 .SS username (un)
 .BI "vmm username" " address"
-.RI [ name ]
+.RB [ \-n
+.IR name ]
 .PP
 The user's real
 .I name
 can be set/updated with this subcommand.
 .PP
 is given, the value stored for the account is erased.
 .PP
 Example:
 .PP
 .nf
-.B vmm un d.user@example.com \(dqJohn Doe\(dq
+.B vmm un d.user@example.com \-n \(dqJohn Doe\(dq
 .fi
 .\" ------------------------------------
 .SS userpassword (up)
 .BI "vmm userpassword" " address"
-.RI [ password ]
+.RB [ \-p
+.IR password ]
 .PP
 The password of an account can be updated with this subcommand.
 .PP
 If no
 .I password
 will prompt for it interactively.
 .PP
 Example:
 .PP
 .nf
-.B vmm up d.user@example.com \(dqA |\(rs/|0r3 5ecur3 P4s5\(rs/\(rs/0rd?\(dq
+.B vmm up d.user@example.com \-p \(dqA |\(rs/|0r3 5ecur3 P4s5\(rs/\(rs/0rd?\(dq
 .fi
 .\" ------------------------------------
 .SS usernote (uo)
 .BI "vmm usernote" " address"
-.RI [ note ]
+.RB [ \-n
+.IR note ]
 .PP
 With this subcommand, it is possible to attach a note to the specified
 account. Without an argument, an existing note is removed.
 .PP
 Example:
 .PP
 .nf
-.B vmm uo d.user@example.com Only needed until end of May 2012
+.B vmm uo d.user@example.com -n `Only needed until end of May 2013'
 .fi
 .\" ------------------------------------
 .SS userquota (uq)
 .BI "vmm userquota" " address storage"
-.RI [ messages ]
+.RB [ \-m
+.IR messages ]
 .PP
 This subcommand is used to set a new quota limit for the given account.
 .PP
 When the argument
 .I messages
 .B 0
 (zero) will be applied.
 .PP
 Instead of
 .I storage
+limit pass the keyword
+.B domain
+to remove the account\-specific override, causing the domain's value to be
+in effect.
+.PP
+Example:
+.PP
+.nf
+.B vmm userquota d.user@example.com 750m
+.fi
+.\" ------------------------------------
+.SS userservices (us)
+.B vmm userservices
+.I address
+.RB [ \-s
+.IR "service ..." ]
+.PP
+To grant a user access to the specified services, use this command.
+.PP
+All omitted services will be deactivated/unusable for the user with the
+given
+.IR address .
+.PP
+Instead of any
+.I service
 pass the keyword
 .B domain
 to remove the account\-specific override, causing the domain's value to be
 in effect.
 .PP
 Example:
 .PP
 .nf
-.B vmm userquota d.user@example.com 750m
+.B vmm userservices d.user@example.com \-s SMTP IMAP
-.fi
-.\" ------------------------------------
-.SS userservices (us)
-.B vmm userservices
-.IR address " [" "service ..." ]
-.PP
-To grant a user access to the specified services, use this command.
-.PP
-All omitted services will be deactivated/unusable for the user with the
-given
-.IR address .
-.PP
-Instead of
-.I service
-pass 'domain' to remove the account\-specific override, causing the
-domain's value to be in effect.
-.PP
-Example:
-.PP
-.nf
-.B vmm userservices d.user@example.com SMTP IMAP
 .\" ------------------------------------
 .SS usertransport (ut)
 .BI "vmm usertransport" " address transport"
 .PP
 A different
 .PP
 .nf
 .B vmm catchallinfo example.com
 Catch-all information
 ---------------------
-Mail to unknown localparts in domain example.com will be sent to:
+Mail to unknown local\-parts in domain example.com will be sent to:
 * user@example.org
 .fi
 .\" ------------------------------------
 .SS catchalldelete (cad)
 .BI "vmm catchalldelete " fqdn

branch	v0.7.x
changeset 677	6287cf6c6447
parent 625	ac27f89fad86
child 684	083d36f53297