{man1,doc/web}: Added description of userpassword's --hash option. v0.7.x
authorPascal Volk <user@localhost.localdomain.org>
Sun, 23 Feb 2014 23:38:12 +0000
branchv0.7.x
changeset 738 935b4901d652
parent 737 81f4bfc34ed8
child 740 aa346db76ee2
{man1,doc/web}: Added description of userpassword's --hash option.
doc/web/source/howto/manage_accounts.rst
man/man1/vmm.1
--- a/doc/web/source/howto/manage_accounts.rst	Sun Feb 23 18:16:57 2014 +0000
+++ b/doc/web/source/howto/manage_accounts.rst	Sun Feb 23 23:38:12 2014 +0000
@@ -151,8 +151,10 @@
 .. program:: vmm userpassword
 
 Syntax:
- | **vmm userpassword** *address* [**-p** *password*] [**-s** *scheme*]
- | **vmm up** *address* [**-p** *password*] [**-s** *scheme*]
+ | **vmm userpassword** *address* ([**-p** *password*] [**-s** *scheme*] | \
+  [**‒‒hash** *pwhash*])
+ | **vmm up** *address* ([**-p** *password*] [**-s** *scheme*] | \
+  [**‒‒hash** *pwhash*])
 
 .. option:: -p password
 
@@ -163,9 +165,22 @@
  When a *scheme* was specified, it overrides the *misc.password_scheme*
  setting, configured in the :file:`vmm.cfg` file.
 
+.. option:: --hash pwhash
+
+ A hashed password, prefixed with **{**\ *SCHEME*\ **}**; as generated by
+ :command:`doveadm pw`.
+ You should enclose the hashed password in single quotes, if it contains
+ one ore more dollar signs (**$**).
+
 The password of an account can be updated with this subcommand.
 
-If no *password* was provided, :command:`vmm` will prompt for it interactively.
+If no *password* or *pwhash* was provided, :command:`vmm` will prompt for a
+password interactively.
+
+.. note::
+  When passing a hashed password, :command:`vmm` checks only if the included
+  *SCHEME* is supported by your Dovecot installation.  No further checks are
+  done.
 
 Example:
 
--- a/man/man1/vmm.1	Sun Feb 23 18:16:57 2014 +0000
+++ b/man/man1/vmm.1	Sun Feb 23 23:38:12 2014 +0000
@@ -1,4 +1,4 @@
-.TH "VMM" "1" "2014-02-15" "vmm 0.7" "vmm"
+.TH "VMM" "1" "2014-02-23" "vmm 0.7" "vmm"
 .SH NAME
 vmm \- command line tool to manage email domains/accounts/aliases
 .\" -----------------------------------------------------------------------
@@ -836,10 +836,12 @@
 .\" ------------------------------------
 .SS userpassword (up)
 .BI "vmm userpassword" " address"
-.RB [ \-p
+.RB ([ \-p
 .IR password ]
 .RB [ \-s
-.IR scheme ]
+.IR scheme "] |"
+.B \-\-hash
+.IR pwhash ])
 .PP
 .TP
 .BI "\-p " password
@@ -855,14 +857,30 @@
 .I vmm.cfg
 file.
 .\" ------------------------------------
+.TP
+.BI "\-\-hash " pwhash
+A hashed password, prefixed with
+.BI { SCHEME };
+as generated by
+.BR "doveadm pw" .
+You should enclose the hashed password in single quotes, if it contains
+one ore more dollar signs
+.RB ( $ ).
+.\" ------------------------------------
 .PP
 The password of an account can be updated with this subcommand.
 .PP
 If no
-.I password
+.IR password " or " pwhash
 was provided,
 .B vmm
-will prompt for it interactively.
+will prompt for a password interactively.
+.IP Note:
+When passing a hashed password,
+.B vmm
+checks only if the included
+.I SCHEME
+is supported by your Dovecot installation.  No further checks are done.
 .PP
 Example:
 .PP
@@ -1140,6 +1158,7 @@
 will be used when none of the both above mentioned files exists.
 .\" -----------------------------------------------------------------------
 .SH SEE ALSO
+.BR doveadm\-pw (1),
 .BR dsync (1),
 .BR transport (5),
 .BR vmm.cfg (5)