Mercurial Mercurial > vmm / changeset
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | raw | gz | bz2 | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
man1: Updated to reflect the new cli. v0.7.x
authorPascal Volk <user@localhost.localdomain.org>
Sun, 06 Jan 2013 18:11:49 +0000
branchv0.7.x
changeset 677 6287cf6c6447
parent 676 2bc11dada296
child 678 5dba8063b708
man1: Updated to reflect the new cli.
man/man1/vmm.1 file | annotate | diff | comparison | revisions 
--- a/man/man1/vmm.1	Sun Jan 06 00:09:47 2013 +0000
+++ b/man/man1/vmm.1	Sun Jan 06 18:11:49 2013 +0000
@@ -1,10 +1,18 @@
-.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
@@ -26,6 +34,19 @@
 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
@@ -136,7 +157,8 @@
 .\" ------------------------------------
 .SS configure (cf)
 .B vmm configure
-.RI [ section ]
+.RB [ \-s
+.IR section ]
 .PP
 Starts the interactive configuration for all configuration sections.
 .PP
@@ -184,7 +206,7 @@
 Example:
 .PP
 .nf
-.B vmm configure mailbox
+.B vmm configure \-s mailbox
 Using configuration file: /usr/local/etc/vmm.cfg
 
 * Configuration section: `mailbox'
@@ -214,23 +236,10 @@
         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
@@ -245,7 +254,7 @@
 Example:
 .PP
 .nf
-.B vmm listdomains %example%
+.B vmm listdomains \-p %example%
 Matching domains
 ----------------
         [+] example.com
@@ -257,7 +266,8 @@
 .\" ------------------------------------
 .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
@@ -273,12 +283,13 @@
 Example:
 .PP
 .nf
-.B vmm listaddresses example.com
-.B vmm listaddresses %master@%
+.B vmm listaddresses \-p example.com
+.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
@@ -293,12 +304,13 @@
 Example:
 .PP
 .nf
-.B vmm listaliases example.com
-.B vmm listaliases %master@%
+.B vmm listaliases \-p example.com
+.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
@@ -314,12 +326,13 @@
 Example:
 .PP
 .nf
-.B vmm listrelocated example.com
-.B vmm listrelocated %master@%
+.B vmm listrelocated \-p example.com
+.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
@@ -335,8 +348,8 @@
 Example:
 .PP
 .nf
-.B vmm listusers example.com
-.B vmm listusers %master@%
+.B vmm listusers \-p example.com
+.B vmm listusers \-p %master@%
 .\" ------------------------------------
 .SS listpwschemes (lp)
 .B vmm listpwschemes
@@ -359,30 +372,21 @@
 .B vmm listpwschemes
 Usable password schemes
 -----------------------
-        CRYPT SHA512-CRYPT LDAP-MD5 DIGEST-MD5 SHA256 SHA512 SSHA512
-        SKEY SSHA NTLM RPA MD5-CRYPT HMAC-MD5 SHA1 PLAIN SHA CRAM-MD5
-        SSHA256 MD5 LANMAN CLEARTEXT PLAIN-MD5 PLAIN-MD4 OTP SMD5
-        SHA256-CRYPT
+        CLEARTEXT CRAM-MD5 CRYPT DIGEST-MD5 HMAC-MD5 LANMAN LDAP-MD5 MD5
+        MD5-CRYPT NTLM OTP PLAIN PLAIN-MD4 PLAIN-MD5 RPA SHA SHA1 SHA256
+        SHA256-CRYPT SHA512 SHA512-CRYPT SKEY SMD5 SSHA SSHA256 SSHA512
 
 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
@@ -415,7 +419,7 @@
 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:
@@ -427,7 +431,7 @@
 .\" ------------------------------------
 .SS domaindelete (dd)
 .BI "vmm domaindelete " fqdn
-.RB [ force ]
+.RB [ \-\-force ]
 .PP
 This subcommand deletes the domain specified by
 .IR fqdn .
@@ -436,8 +440,8 @@
 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
-.BR force .
+If you know, what you are doing, you can specify the optional argument
+.BR \-\-force .
 .PP
 If you really always know what you are doing, edit your
 .I vmm.cfg
@@ -448,7 +452,9 @@
 .\" ------------------------------------
 .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
@@ -500,8 +506,10 @@
 .\" ------------------------------------
 .SS domainquota (dq)
 .B vmm domainquota
-.IR "fqdn storage" " [" messages ]
-.RB [ force ]
+.I fqdn storage 
+.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.
@@ -511,8 +519,8 @@
 .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
-.BR force .
+you may pass the optional argument
+.BR \-\-force .
 .br
 When the argument
 .I messages
@@ -523,13 +531,15 @@
 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 ..." ]
-.RB [ force ]
+.I fqdn 
+.RB [ \-s
+.IR "service ..." ]
+.RB [ \-\-force ]
 .PP
 To define which services could be used by the users of the domain \(em with
 the given
@@ -545,19 +555,19 @@
 .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
-.BR force .
+pass the option
+.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
-.BR force .
+may give the option
+.BR \-\-force .
 .PP
 Example:
 .PP
@@ -567,7 +577,8 @@
 .\" ------------------------------------
 .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.
@@ -575,7 +586,7 @@
 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
@@ -661,7 +672,9 @@
 .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 .
@@ -683,7 +696,7 @@
 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:
@@ -691,7 +704,7 @@
 .\" ------------------------------------
 .SS userdelete (ud)
 .BI "vmm userdelete" " address"
-.RB [ force ]
+.RB [ \-\-force ]
 .PP
 Use this subcommand to delete the account with the given
 .IR address .
@@ -699,12 +712,14 @@
 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
-.BR force .
+To prevent this, give the optional argument
+.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 .
@@ -758,7 +773,8 @@
 .\" ------------------------------------
 .SS username (un)
 .BI "vmm username" " address"
-.RI [ name ]
+.RB [ \-n
+.IR name ]
 .PP
 The user's real
 .I name
@@ -771,12 +787,13 @@
 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
@@ -789,12 +806,13 @@
 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.
@@ -802,12 +820,13 @@
 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
@@ -819,7 +838,7 @@
 .PP
 Instead of
 .I storage
-pass the keyword
+limit pass the keyword
 .B domain
 to remove the account\-specific override, causing the domain's value to be
 in effect.
@@ -832,7 +851,9 @@
 .\" ------------------------------------
 .SS userservices (us)
 .B vmm userservices
-.IR address " [" "service ..." ]
+.I address 
+.RB [ \-s
+.IR "service ..." ]
 .PP
 To grant a user access to the specified services, use this command.
 .PP
@@ -840,15 +861,17 @@
 given
 .IR address .
 .PP
-Instead of
+Instead of any
 .I service
-pass 'domain' to remove the account\-specific override, causing the
-domain's value to be in effect.
+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 userservices d.user@example.com SMTP IMAP
+.B vmm userservices d.user@example.com \-s SMTP IMAP
 .\" ------------------------------------
 .SS usertransport (ut)
 .BI "vmm usertransport" " address transport"
@@ -1013,7 +1036,7 @@
 .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
 .\" ------------------------------------
vmm

Repositories index