man/man1/vmm.1
author Pascal Volk <user@localhost.localdomain.org>
Sun, 23 Feb 2014 23:38:12 +0000
branchv0.7.x
changeset 738 935b4901d652
parent 730 d3a246067e8f
child 752 271bd82c05c0
permissions -rw-r--r--
{man1,doc/web}: Added description of userpassword's --hash option.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
738
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
     1
.TH "VMM" "1" "2014-02-23" "vmm 0.7" "vmm"
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     2
.SH NAME
26
668951708f2f * 'vmm.cfg.5'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 25
diff changeset
     3
vmm \- command line tool to manage email domains/accounts/aliases
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
     4
.\" -----------------------------------------------------------------------
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     5
.SH SYNOPSIS
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     6
.B vmm
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
     7
.BR   \-h | \-v | \-\-help | \-\-version
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
     8
.\" --------------------------
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
     9
.br
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
    10
.BI vmm " subcommand " \-h \c
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
    11
.RB | \-\-help
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
    12
.\" --------------------------
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
    13
.br
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
    14
.BI vmm " subcommand"
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
    15
.IR arguments " [" options ]
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    16
.\" -----------------------------------------------------------------------
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    17
.SH DESCRIPTION
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    18
.B vmm
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    19
(a virtual mail manager) is the easy to use command line tool for
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    20
administrators and postmasters to manage (alias) domains, accounts, aliases
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    21
and relocated users.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    22
It allows you to simply and quickly administer your mail server.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    23
.br
416
f32b323fd347 man: Replaced unnecessary \(aq glyphs in man1/vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 411
diff changeset
    24
It's designed for Dovecot and Postfix with a PostgreSQL backend.
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    25
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    26
Each
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    27
.I subcommand
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    28
has both a long and a short form.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    29
The short form is shown enclosed in parentheses.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    30
Both forms are case sensitive.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    31
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    32
Most of the
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    33
.IR subcommand s
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    34
take one or more
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    35
.IR argument s.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    36
.\" -----------------------------------------------------------------------
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
    37
.SH OPTIONS
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
    38
The following options are recognized by
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
    39
.BR vmm .
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
    40
.TP
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
    41
.BR \-h ", " \-\-help
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
    42
show a list of available subcommands and exit.
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
    43
.\" --------------------------
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
    44
.TP
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
    45
.BR \-v ", " \-\-version
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
    46
show
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
    47
.BR vmm \(aqs
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
    48
version and copyright information and exit.
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
    49
.\" -----------------------------------------------------------------------
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    50
.SH ARGUMENTS
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    51
.TP 12
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    52
.I address
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    53
The complete e\-mail address
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    54
.RI ( local\-part @ fqdn )
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    55
of an user account, alias address or relocated user.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    56
.\" --------------------------
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    57
.TP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    58
.I destination
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    59
Is either an e\-mail
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    60
.I address
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    61
when used with
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    62
.IR "ALIAS SUBCOMMANDS" .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    63
Or a
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    64
.I fqdn
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    65
when used with
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    66
.IR "ALIASDOMAIN SUBCOMMANDS" .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    67
.\" --------------------------
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    68
.TP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    69
.I fqdn
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    70
The fully qualified domain name \- without the trailing dot \- of a domain
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    71
or alias domain.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    72
.\" --------------------------
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    73
.TP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    74
.I messages
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    75
An integer value which specifies a quota limit in number of messages.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    76
.B 0
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    77
(zero) means unlimited \- no quota limit for the number of messages.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    78
.\" --------------------------
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    79
.TP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    80
.I option
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    81
is the name of a configuration option, prefixed with the section name and a
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    82
dot.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    83
For example:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    84
.IB misc . transport
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    85
.br
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    86
All configuration options are described in
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    87
.BR vmm.cfg (5).
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    88
.\" --------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    89
.TP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    90
.I service
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    91
The name of a service, commonly used with Dovecot.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    92
Supported services are:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    93
.BR imap ", " pop3 ", " sieve " and " smtp .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    94
.\" --------------------------
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    95
.TP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    96
.I storage
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    97
Specifies a quota limit in bytes.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    98
One of the following prefixes can be appended to the integer value:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    99
.BR b " (bytes), " k " (kilobytes), " M " (megabytes) or " G
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   100
(gigabytes).
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   101
.B 0
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   102
(zero) means unlimited \- no quota limit in bytes.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   103
.\" --------------------------
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   104
.TP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   105
.I transport
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   106
A transport for Postfix, written as:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   107
.IB transport :
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   108
or
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   109
.IB transport :\c
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   110
.IR nexthop .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   111
See
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   112
.BR transport (5)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   113
for more details.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   114
.\" -----------------------------------------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   115
.SH GENERAL SUBCOMMANDS
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   116
.SS configget (cg)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   117
.BI "vmm configget" " option"
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   118
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   119
This subcommand is used to display the actual value of the given
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   120
configuration
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   121
.IR option .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   122
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   123
Example:
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   124
.PP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   125
.nf
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   126
.B vmm configget misc.crypt_sha512_rounds
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   127
misc.crypt_sha512_rounds = 5000
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   128
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   129
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   130
.SS configset (cs)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   131
.B vmm configset
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   132
.I option value
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   133
.PP
416
f32b323fd347 man: Replaced unnecessary \(aq glyphs in man1/vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 411
diff changeset
   134
Use this subcommand to set or update a single configuration option's value.
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   135
.I option
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   136
is the configuration option,
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   137
.I value
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   138
is the
416
f32b323fd347 man: Replaced unnecessary \(aq glyphs in man1/vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 411
diff changeset
   139
.IR option 's
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   140
new value.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   141
.IP Note:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   142
This subcommand will create a new
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   143
.I vmm.cfg
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   144
without any comments.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   145
Your current configuration file will be backed as
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   146
.IR vmm.cfg.bak .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   147
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   148
Example:
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   149
.PP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   150
.nf
479
b33bdc0c3669 man1: Updated configuration related descriptions/examples,
Pascal Volk <user@localhost.localdomain.org>
parents: 478
diff changeset
   151
.B vmm configget domain.transport
b33bdc0c3669 man1: Updated configuration related descriptions/examples,
Pascal Volk <user@localhost.localdomain.org>
parents: 478
diff changeset
   152
domain.transport = dovecot:
b33bdc0c3669 man1: Updated configuration related descriptions/examples,
Pascal Volk <user@localhost.localdomain.org>
parents: 478
diff changeset
   153
.B vmm configset domain.transport lmtp:unix:private/dovecot\-lmtp
b33bdc0c3669 man1: Updated configuration related descriptions/examples,
Pascal Volk <user@localhost.localdomain.org>
parents: 478
diff changeset
   154
.B vmm cg domain.transport
b33bdc0c3669 man1: Updated configuration related descriptions/examples,
Pascal Volk <user@localhost.localdomain.org>
parents: 478
diff changeset
   155
domain.transport = lmtp:unix:private/dovecot\-lmtp
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   156
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   157
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   158
.SS configure (cf)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   159
.B vmm configure
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   160
.RB [ \-s
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   161
.IR section ]
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   162
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   163
Starts the interactive configuration for all configuration sections.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   164
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   165
In this process the currently set value of each option will be displayed in
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   166
square brackets.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   167
If no value is configured, the default value of each option will be
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   168
displayed in square brackets.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   169
Press the return key, to accept the displayed value.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   170
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   171
If the optional argument
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   172
.I section
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   173
is given, only the configuration options from the given section will be
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   174
displayed and will be configurable.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   175
The following sections are available:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   176
.RS
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   177
.TP 10
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   178
.B account
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   179
Account settings
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   180
.TP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   181
.B bin
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   182
Paths to external binaries
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   183
.TP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   184
.B database
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   185
Database settings
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   186
.TP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   187
.B domain
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   188
Domain settings
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   189
.TP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   190
.B mailbox
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   191
Mailbox settings
36
8a9ce20d2569 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
   192
.TP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   193
.B misc
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   194
Miscellaneous settings
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   195
.RE
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   196
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   197
All configuration options are described in
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   198
.BR vmm.cfg (5).
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   199
.IP Note:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   200
This subcommand will create a new
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   201
.I vmm.cfg
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   202
without any comments.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   203
Your current configuration file will be backed as
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   204
.IR vmm.cfg.bak .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   205
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   206
Example:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   207
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   208
.nf
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   209
.B vmm configure \-s mailbox
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   210
Using configuration file: /usr/local/etc/vmm.cfg
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   211
416
f32b323fd347 man: Replaced unnecessary \(aq glyphs in man1/vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 411
diff changeset
   212
* Configuration section: `mailbox'
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   213
Enter new value for option folders [Drafts:Sent:Templates:Trash]:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   214
Enter new value for option format [maildir]: mdbox
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   215
Enter new value for option subscribe [True]:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   216
Enter new value for option root [Maildir]: mdbox
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   217
.fi
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   218
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   219
.SS getuser (gu)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   220
.BI "vmm getuser" " uid"
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   221
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   222
If only the
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   223
.I uid
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   224
is available, for example from process list, the subcommand
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   225
.B getuser
416
f32b323fd347 man: Replaced unnecessary \(aq glyphs in man1/vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 411
diff changeset
   226
will show the user's address.
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   227
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   228
Example:
36
8a9ce20d2569 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
   229
.PP
8a9ce20d2569 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
   230
.nf
475
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   231
.B vmm getuser 79876
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   232
Account information
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   233
-------------------
475
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   234
        UID............: 79876
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   235
        GID............: 70704
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   236
        Address........: a.user@example.com
36
8a9ce20d2569 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
   237
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   238
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   239
.SS listdomains (ld)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   240
.B vmm listdomains
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   241
.RB [ \-p
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   242
.IR pattern ]
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   243
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   244
This subcommand lists all available domains.
416
f32b323fd347 man: Replaced unnecessary \(aq glyphs in man1/vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 411
diff changeset
   245
All domain names will be prefixed either with `[+]', if the domain is a
f32b323fd347 man: Replaced unnecessary \(aq glyphs in man1/vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 411
diff changeset
   246
primary domain, or with `[-]', if it is an alias domain name.
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   247
The output can be limited with an optional
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   248
.IR pattern .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   249
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   250
To perform a wild card search, the % character can be used at the start
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   251
and/or the end of the
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   252
.IR pattern .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   253
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   254
Example:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   255
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   256
.nf
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   257
.B vmm listdomains \-p %example%
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   258
Matching domains
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   259
----------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   260
        [+] example.com
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   261
        [\-]     e.g.example.com
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   262
        [\-]     example.name
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   263
        [+] example.net
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   264
        [+] example.org
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   265
.fi
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   266
.\" ------------------------------------
625
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   267
.SS listaddresses (ll)
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   268
.B vmm listaddresses
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   269
.RB [ \-p
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   270
.IR pattern ]
625
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   271
.PP
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   272
This command lists all defined addresses. Addresses belonging to
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   273
alias-domains are prefixed with a '-', addresses of regular domains with
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   274
a '+'. Additionally, the letters 'u', 'a', and 'r' indicate the type of
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   275
each address: user, alias and relocated respectively.
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   276
The output can be limited with an optional
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   277
.IR pattern .
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   278
.PP
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   279
To perform a wild card search, the % character can be used at the start
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   280
and/or the end of the
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   281
.IR pattern .
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   282
.PP
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   283
Example:
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   284
.PP
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   285
.nf
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   286
.B vmm listaddresses \-p example.com
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   287
.B vmm listaddresses \-p %master@%
625
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   288
.\" ------------------------------------
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   289
.SS listaliases (la)
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   290
.B vmm listaliases
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   291
.RB [ \-p
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   292
.IR pattern ]
625
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   293
.PP
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   294
This command lists all defined aliases. Aliases belonging to
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   295
alias-domains are prefixed with a '-', addresses of regular domains with
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   296
a '+'.
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   297
The output can be limited with an optional
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   298
.IR pattern .
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   299
.PP
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   300
To perform a wild card search, the % character can be used at the start
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   301
and/or the end of the
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   302
.IR pattern .
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   303
.PP
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   304
Example:
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   305
.PP
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   306
.nf
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   307
.B vmm listaliases \-p example.com
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   308
.B vmm listaliases \-p %master@%
625
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   309
.\" ------------------------------------
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   310
.SS listrelocated (lr)
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   311
.B vmm listrelocated
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   312
.RB [ \-p
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   313
.IR pattern ]
625
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   314
.PP
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   315
This command lists all defined relocated addresses. Relocated entries
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   316
belonging to alias-domains are prefixed with a '-', addresses of regular
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   317
domains with
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   318
a '+'.
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   319
The output can be limited with an optional
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   320
.IR pattern .
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   321
.PP
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   322
To perform a wild card search, the % character can be used at the start
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   323
and/or the end of the
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   324
.IR pattern .
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   325
.PP
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   326
Example:
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   327
.PP
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   328
.nf
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   329
.B vmm listrelocated \-p example.com
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   330
.B vmm listrelocated \-p %master@%
625
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   331
.\" ------------------------------------
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   332
.SS listusers (lu)
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   333
.B vmm listusers
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   334
.RB [ \-p
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   335
.IR pattern ]
625
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   336
.PP
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   337
This command lists all user accounts. User accounts belonging to
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   338
alias-domains are prefixed with a '-', addresses of regular
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   339
domains with
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   340
a '+'.
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   341
The output can be limited with an optional
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   342
.IR pattern .
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   343
.PP
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   344
To perform a wild card search, the % character can be used at the start
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   345
and/or the end of the
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   346
.IR pattern .
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   347
.PP
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   348
Example:
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   349
.PP
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   350
.nf
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   351
.B vmm listusers \-p example.com
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   352
.B vmm listusers \-p %master@%
625
ac27f89fad86 Add list* commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 618
diff changeset
   353
.\" ------------------------------------
473
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   354
.SS listpwschemes (lp)
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   355
.B vmm listpwschemes
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   356
.PP
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   357
This subcommand lists all password schemes which could be used in the
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   358
.I vmm.cfg
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   359
as value of the
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   360
.I misc.password_scheme
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   361
option.
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   362
The output varies, depending on the used Dovecot version and the system's
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   363
libc.
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   364
.br
691
932cd76bf879 VMM: Dropped support for Dovecot versions before v1.2.0.
Pascal Volk <user@localhost.localdomain.org>
parents: 690
diff changeset
   365
Additionally a few usable encoding suffixes will be displayed.
473
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   366
One of them can be appended to the password scheme.
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   367
.PP
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   368
Example:
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   369
.PP
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   370
.nf
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   371
.B vmm listpwschemes
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   372
Usable password schemes
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   373
-----------------------
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   374
        CLEARTEXT CRAM-MD5 CRYPT DIGEST-MD5 HMAC-MD5 LANMAN LDAP-MD5 MD5
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   375
        MD5-CRYPT NTLM OTP PLAIN PLAIN-MD4 PLAIN-MD5 RPA SHA SHA1 SHA256
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   376
        SHA256-CRYPT SHA512 SHA512-CRYPT SKEY SMD5 SSHA SSHA256 SSHA512
473
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   377
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   378
Usable encoding suffixes
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   379
------------------------
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   380
        .B64 .BASE64 .HEX
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   381
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   382
.\" -----------------------------------------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   383
.SH DOMAIN SUBCOMMANDS
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   384
.SS domainadd (da)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   385
.B vmm domainadd
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   386
.I fqdn
687
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 684
diff changeset
   387
.RB [ \-n
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 684
diff changeset
   388
.IR note ]
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   389
.RB [ \-t
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   390
.IR transport ]
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   391
.PP
687
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 684
diff changeset
   392
.\" ------------------------------------
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 684
diff changeset
   393
.TP
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 684
diff changeset
   394
.BI "\-n " note
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 684
diff changeset
   395
the note that should be set.
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 684
diff changeset
   396
.\" ------------------------------------
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 684
diff changeset
   397
.TP
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 684
diff changeset
   398
.BI "\-t " transport
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 684
diff changeset
   399
a Postfix transport (transport: or transport:nexthop).
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 684
diff changeset
   400
.\" ------------------------------------
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 684
diff changeset
   401
.PP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   402
Adds the new domain into the database and creates the domain directory.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   403
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   404
If the optional argument
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   405
.I transport
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   406
is given, it will override the default transport
479
b33bdc0c3669 man1: Updated configuration related descriptions/examples,
Pascal Volk <user@localhost.localdomain.org>
parents: 478
diff changeset
   407
.RI ( domain.transport ") from " vmm.cfg .
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   408
The specified
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   409
.I transport
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   410
will be the default transport for all new accounts in this domain.
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   411
.PP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   412
Configuration\-related behavior:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   413
.RS
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   414
.TP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   415
.I domain.auto_postmaster
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   416
When that option is set to
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   417
.BR true " (default) " vmm
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   418
will automatically create the postmaster account for the new domain and
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   419
prompt for
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   420
.BI postmaster@ fqdn\c
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   421
\(aqs password.
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   422
.TP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   423
.I account.random_password
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   424
When the value of that option is also set to
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   425
.BR true ", " vmm
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   426
will automatically create the postmaster account for the new domain and
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   427
print the generated postmaster password to stdout.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   428
.RE
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   429
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   430
Examples:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   431
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   432
.nf
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   433
.B vmm domainadd support.example.com \-t smtp:[mx1.example.com]:2025
475
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   434
Creating account for postmaster@support.example.com
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   435
Enter new password:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   436
Retype new password:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   437
.B vmm cs account.random_password true
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   438
.B vmm domainadd sales.example.com
475
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   439
Creating account for postmaster@sales.example.com
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   440
Generated password: pLJUQ6Xg_z
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   441
.fi
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   442
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   443
.SS domaindelete (dd)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   444
.BI "vmm domaindelete " fqdn
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   445
.RB [ \-\-force ]
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   446
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   447
This subcommand deletes the domain specified by
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   448
.IR fqdn .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   449
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   450
If there are accounts, aliases and/or relocated users assigned to the given
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   451
domain,
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   452
.B vmm
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   453
will abort the requested operation and show an error message.
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   454
If you know, what you are doing, you can specify the optional argument
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   455
.BR \-\-force .
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   456
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   457
If you really always know what you are doing, edit your
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   458
.I vmm.cfg
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   459
and set the option
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   460
.I domain.force_deletion
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   461
to
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   462
.BR true .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   463
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   464
.SS domaininfo (di)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   465
.B vmm domaininfo
688
c14299bc1b99 man1: Deleted trailing whitespaces.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   466
.I fqdn
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   467
.RB [ \-d
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   468
.IR details ]
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   469
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   470
This subcommand shows some information about the given domain.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   471
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   472
For a more detailed information about the domain the optional argument
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   473
.I details
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   474
can be specified.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   475
A possible
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   476
.I details
589
60907fc875f7 man/{de/}man1: Small corrections for domaininfo's description.
Pascal Volk <user@localhost.localdomain.org>
parents: 587
diff changeset
   477
value can be one of the following six keywords:
62
869de537a020 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 59
diff changeset
   478
.RS
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   479
.TP 14
62
869de537a020 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 59
diff changeset
   480
.B accounts
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   481
to list the e\-mail addresses of all existing user accounts
62
869de537a020 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 59
diff changeset
   482
.TP
869de537a020 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 59
diff changeset
   483
.B aliasdomains
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   484
to list all assigned alias domain names
62
869de537a020 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 59
diff changeset
   485
.TP
869de537a020 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 59
diff changeset
   486
.B aliases
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   487
to list all available alias e\-mail addresses
62
869de537a020 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 59
diff changeset
   488
.TP
589
60907fc875f7 man/{de/}man1: Small corrections for domaininfo's description.
Pascal Volk <user@localhost.localdomain.org>
parents: 587
diff changeset
   489
.B catchall
60907fc875f7 man/{de/}man1: Small corrections for domaininfo's description.
Pascal Volk <user@localhost.localdomain.org>
parents: 587
diff changeset
   490
to list all catch\-all destinations
60907fc875f7 man/{de/}man1: Small corrections for domaininfo's description.
Pascal Volk <user@localhost.localdomain.org>
parents: 587
diff changeset
   491
.TP
81
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   492
.B relocated
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   493
to list the e\-mail addresses of all relocated users
81
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   494
.TP
62
869de537a020 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 59
diff changeset
   495
.B full
64
432a037658a8 * 'vmm'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 62
diff changeset
   496
to list all information mentioned above
62
869de537a020 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 59
diff changeset
   497
.RE
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   498
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   499
Example:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   500
.PP
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   501
.nf
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   502
.B vmm domaininfo sales.example.com
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   503
Domain information
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   504
------------------
475
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   505
        Domain Name......: sales.example.com
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   506
        GID..............: 70708
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   507
        Domain Directory.: /srv/mail/c/70708
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   508
        Quota Limit/User.: Storage: 500.00 MiB; Messages: 10,000
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   509
        Active Services..: IMAP SIEVE
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   510
        Transport........: lmtp:unix:private/dovecot-lmtp
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   511
        Alias Domains....: 0
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   512
        Accounts.........: 1
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   513
        Aliases..........: 0
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   514
        Relocated........: 0
553
6f2c41c3c7d6 man: add 'catchall' to domaininfo
martin f. krafft <madduck@madduck.net>
parents: 552
diff changeset
   515
        Catch-All Dests..: 1
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   516
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   517
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   518
.SS domainquota (dq)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   519
.B vmm domainquota
688
c14299bc1b99 man1: Deleted trailing whitespaces.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   520
.I fqdn storage
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   521
.RB [ \-m
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   522
.IR messages ]
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   523
.RB [ --force ]
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   524
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   525
This subcommand is used to configure a new quota limit for the accounts of
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   526
the domain - not for the domain itself.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   527
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   528
The default quota limit for accounts is defined in the
479
b33bdc0c3669 man1: Updated configuration related descriptions/examples,
Pascal Volk <user@localhost.localdomain.org>
parents: 478
diff changeset
   529
.IR vmm.cfg " (" domain.quota_bytes " and " domain.quota_messages ).
534
6a27c7529cd7 Change 'force' argument to reset user records for tid/ssid/qid
martin f. krafft <madduck@madduck.net>
parents: 533
diff changeset
   530
.PP
6a27c7529cd7 Change 'force' argument to reset user records for tid/ssid/qid
martin f. krafft <madduck@madduck.net>
parents: 533
diff changeset
   531
The new quota limit will affect only those accounts for which the limit
6a27c7529cd7 Change 'force' argument to reset user records for tid/ssid/qid
martin f. krafft <madduck@madduck.net>
parents: 533
diff changeset
   532
has not been overridden. If you want to restore the default to all accounts,
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   533
you may pass the optional argument
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   534
.BR \-\-force .
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   535
.br
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   536
When the argument
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   537
.I messages
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   538
was omitted the default number of messages
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   539
.B 0
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   540
(zero) will be applied.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   541
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   542
Example:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   543
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   544
.nf
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   545
.B vmm domainquota example.com 1g \-\-force
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   546
.fi
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   547
.\" ------------------------------------
473
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   548
.SS domainservices (ds)
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   549
.B vmm domainservices
688
c14299bc1b99 man1: Deleted trailing whitespaces.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   550
.I fqdn
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   551
.RB [ \-s
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   552
.IR "service ..." ]
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   553
.RB [ \-\-force ]
473
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   554
.PP
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   555
To define which services could be used by the users of the domain \(em with
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   556
the given
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   557
.I fqdn
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   558
\(em use this subcommand.
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   559
.PP
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   560
Each specified
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   561
.I service
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   562
will be enabled/usable.
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   563
All other services will be deactivated/unusable.
688
c14299bc1b99 man1: Deleted trailing whitespaces.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   564
Possible service names are:
473
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   565
.BR  imap ", " pop3 ", " sieve " and " smtp .
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   566
.br
534
6a27c7529cd7 Change 'force' argument to reset user records for tid/ssid/qid
martin f. krafft <madduck@madduck.net>
parents: 533
diff changeset
   567
The new service set will affect only those accounts for which the set has not
6a27c7529cd7 Change 'force' argument to reset user records for tid/ssid/qid
martin f. krafft <madduck@madduck.net>
parents: 533
diff changeset
   568
been overridden. If you want to restore the default to all accounts, you may
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   569
pass the option
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   570
.BR \-\-force .
473
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   571
.\" ------------------------------------
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   572
.SS domaintransport (dt)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   573
.BI "vmm domaintransport" " fqdn transport"
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   574
.RB [ --force ]
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   575
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   576
A new transport for the indicated domain can be set with this subcommand.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   577
.PP
534
6a27c7529cd7 Change 'force' argument to reset user records for tid/ssid/qid
martin f. krafft <madduck@madduck.net>
parents: 533
diff changeset
   578
The new transport will affect only those accounts for which the transport has
6a27c7529cd7 Change 'force' argument to reset user records for tid/ssid/qid
martin f. krafft <madduck@madduck.net>
parents: 533
diff changeset
   579
not been overridden. If you want to restore the default to all accounts, you
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   580
may give the option
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   581
.BR \-\-force .
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   582
.PP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   583
Example:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   584
.PP
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   585
.nf
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   586
.B vmm domaintransport support.example.com dovecot:
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   587
.fi
545
47254b46c361 Document domainnote in manpages
martin f. krafft <madduck@madduck.net>
parents: 540
diff changeset
   588
.\" ------------------------------------
47254b46c361 Document domainnote in manpages
martin f. krafft <madduck@madduck.net>
parents: 540
diff changeset
   589
.SS domainnote (do)
47254b46c361 Document domainnote in manpages
martin f. krafft <madduck@madduck.net>
parents: 540
diff changeset
   590
.BI "vmm domainnote" " fqdn"
690
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   591
.BR \-d | \-n
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   592
.I note
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   593
.PP
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   594
.\" ------------------------------------
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   595
.TP
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   596
.B \-d
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   597
delete the domain\(aqs note.
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   598
.\" ------------------------------------
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   599
.TP
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   600
.BI "\-n " note
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   601
the note that should be set.
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   602
.\" ------------------------------------
545
47254b46c361 Document domainnote in manpages
martin f. krafft <madduck@madduck.net>
parents: 540
diff changeset
   603
.PP
47254b46c361 Document domainnote in manpages
martin f. krafft <madduck@madduck.net>
parents: 540
diff changeset
   604
With this subcommand, it is possible to attach a note to the specified
690
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   605
domain.
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   606
In order to delete an existing note, pass the
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   607
.BR \-d " option."
545
47254b46c361 Document domainnote in manpages
martin f. krafft <madduck@madduck.net>
parents: 540
diff changeset
   608
.PP
47254b46c361 Document domainnote in manpages
martin f. krafft <madduck@madduck.net>
parents: 540
diff changeset
   609
Example:
47254b46c361 Document domainnote in manpages
martin f. krafft <madduck@madduck.net>
parents: 540
diff changeset
   610
.PP
47254b46c361 Document domainnote in manpages
martin f. krafft <madduck@madduck.net>
parents: 540
diff changeset
   611
.nf
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   612
.B vmm do example.com \-n `Belongs to Robert'
545
47254b46c361 Document domainnote in manpages
martin f. krafft <madduck@madduck.net>
parents: 540
diff changeset
   613
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   614
.\" -----------------------------------------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   615
.SH ALIAS DOMAIN SUBCOMMANDS
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   616
An alias domain is an alias for a domain that was previously added with the
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   617
subcommand
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   618
.BR domainadd .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   619
All accounts, aliases and relocated users from the domain will be also
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   620
available in the alias domain.
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   621
.br
475
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   622
In the following is to be assumed that example.net is an alias for
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   623
example.com.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   624
.PP
475
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   625
Postfix will not accept erroneously e\-mails for unknown.user@example.net
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   626
and bounce them back later to the mostly faked sender.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   627
Postfix will immediately reject all e\-mails addressed to nonexistent
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   628
users.
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   629
.br
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   630
This behavior is ensured as long as you use the recommended database
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   631
queries in your
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   632
.I $config_directory/pgsql\-*.cf
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   633
configuration files.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   634
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   635
.SS aliasdomainadd (ada)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   636
.BI "vmm aliasdomainadd" " fqdn destination"
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   637
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   638
This subcommand adds the new alias domain
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   639
.RI ( fqdn )
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   640
to the
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   641
.I destination
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   642
domain that should be aliased.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   643
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   644
Example:
57
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   645
.PP
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   646
.nf
475
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   647
.B vmm aliasdomainadd example.net example.com
57
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   648
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   649
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   650
.SS aliasdomaindelete (add)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   651
.BI "vmm aliasdomaindelete" " fqdn"
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   652
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   653
Use this subcommand if the alias domain
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   654
.I fqdn
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   655
should be removed.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   656
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   657
Example:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   658
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   659
.nf
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   660
.B vmm aliasdomaindelete e.g.example.com
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   661
.fi
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   662
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   663
.SS aliasdomaininfo (adi)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   664
.BI "vmm aliasdomaininfo" " fqdn"
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   665
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   666
This subcommand shows to which domain the alias domain
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   667
.I fqdn
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   668
is assigned to.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   669
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   670
Example:
57
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   671
.PP
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   672
.nf
475
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   673
.B vmm adi example.net
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   674
Alias domain information
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   675
------------------------
475
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   676
        The alias domain example.net belongs to:
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   677
            * example.com
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   678
.fi
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   679
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   680
.SS aliasdomainswitch (ads)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   681
.BI "vmm aliasdomainswitch" " fqdn destination"
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   682
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   683
If the destination of the existing alias domain
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   684
.I fqdn
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   685
should be switched to another
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   686
.I destination
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   687
use this subcommand.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   688
.nf
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   689
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   690
Example:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   691
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   692
.B vmm aliasdomainswitch example.name example.org
57
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   693
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   694
.\" -----------------------------------------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   695
.SH ACCOUNT SUBCOMMANDS
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   696
.SS useradd (ua)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   697
.B vmm useradd
687
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 684
diff changeset
   698
.I address
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 684
diff changeset
   699
.RB [ \-n
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 684
diff changeset
   700
.IR note ]
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 684
diff changeset
   701
.RB [ \-p
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   702
.IR password ]
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   703
.PP
687
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 684
diff changeset
   704
.\" ------------------------------------
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 684
diff changeset
   705
.TP
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 684
diff changeset
   706
.BI "\-n " note
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 684
diff changeset
   707
the note that should be set.
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 684
diff changeset
   708
.\" ------------------------------------
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 684
diff changeset
   709
.TP
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 684
diff changeset
   710
.BI "\-p " password
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 684
diff changeset
   711
the new user\(aqs password.
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 684
diff changeset
   712
.\" ------------------------------------
5eb033796444 doc: Added description of {domain,user}add's -n option.
Pascal Volk <user@localhost.localdomain.org>
parents: 684
diff changeset
   713
.PP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   714
Use this subcommand to create a new e\-mail account for the given
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   715
.IR address .
79
0ae7597eed11 * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 66
diff changeset
   716
.PP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   717
If the
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   718
.I password
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   719
is not provided,
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   720
.B vmm
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   721
will prompt for it interactively.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   722
When no
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   723
.I password
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   724
is provided and
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   725
.I account.random_password
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   726
is set to
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   727
.BR true ", " vmm
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   728
will generate a random password and print it to stdout after the account
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   729
has been created.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   730
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   731
Examples:
57
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   732
.PP
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   733
.nf
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   734
.B vmm ua d.user@example.com \-p \(dqA 5ecR3t P4s5\(rs/\(rs/0rd\(dq
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   735
.B vmm useradd e.user@example.com
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   736
Enter new password:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   737
Retype new password:
57
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   738
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   739
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   740
.SS userdelete (ud)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   741
.BI "vmm userdelete" " address"
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   742
.RB [ \-\-force ]
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   743
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   744
Use this subcommand to delete the account with the given
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   745
.IR address .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   746
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   747
If there are one or more aliases with an identical destination address,
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   748
.B vmm
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   749
will abort the requested operation and show an error message.
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   750
To prevent this, give the optional argument
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   751
.BR \-\-force .
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   752
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   753
.SS userinfo (ui)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   754
.B "vmm userinfo"
688
c14299bc1b99 man1: Deleted trailing whitespaces.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   755
.I address
c14299bc1b99 man1: Deleted trailing whitespaces.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   756
.RB [ \-d
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   757
.IR details ]
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   758
.PP
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   759
This subcommand displays some information about the account specified by
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   760
.IR address .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   761
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   762
If the optional argument
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   763
.I details
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   764
is given some more information will be displayed.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   765
Possible values for
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   766
.I details
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   767
are:
90
1734eb5101c6 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 81
diff changeset
   768
.RS
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   769
.TP 8
90
1734eb5101c6 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 81
diff changeset
   770
.B aliases
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   771
to list all alias addresses with the destination
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   772
.I address
90
1734eb5101c6 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 81
diff changeset
   773
.TP
1734eb5101c6 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 81
diff changeset
   774
.B du
416
f32b323fd347 man: Replaced unnecessary \(aq glyphs in man1/vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 411
diff changeset
   775
to display the disk usage of the user's mail directory.
590
9d343514b832 man/{de/}man1: A few more corrections.
Pascal Volk <user@localhost.localdomain.org>
parents: 589
diff changeset
   776
In order to summarize the disk usage each time this subcommand is
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   777
executed automatically, set
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   778
.I account.disk_usage
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   779
in your
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   780
.I vmm.cfg
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   781
to
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   782
.BR true .
90
1734eb5101c6 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 81
diff changeset
   783
.TP
1734eb5101c6 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 81
diff changeset
   784
.B full
1734eb5101c6 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 81
diff changeset
   785
to list all information mentioned above
432
ad7cfbfbc68d man: Added missing `.RE' macro to sub section userinfo (ui).
Pascal Volk <neverseen@users.sourceforge.net>
parents: 416
diff changeset
   786
.RE
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   787
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   788
Example:
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   789
.PP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   790
.nf
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   791
.B vmm ui d.user@example.com
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   792
Account information
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   793
-------------------
475
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   794
        Address..........: d.user@example.com
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   795
        Name.............: None
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   796
        UID..............: 79881
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   797
        GID..............: 70704
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   798
        Home.............: /srv/mail/2/70704/79881
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   799
        Mail_Location....: mdbox:~/mdbox
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   800
        Quota Storage....: [  0.00%] 0/500.00 MiB
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   801
        Quota Messages...: [  0.00%] 0/10,000
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   802
        Transport........: lmtp:unix:private/dovecot-lmtp
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   803
        SMTP.............: disabled
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   804
        POP3.............: disabled
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   805
        IMAP.............: enabled
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   806
        SIEVE............: enabled
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   807
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   808
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   809
.SS username (un)
537
9a23043b0530 man: vmm.1: subcommand's name argument is optional now.
Pascal Volk <user@localhost.localdomain.org>
parents: 536
diff changeset
   810
.BI "vmm username" " address"
690
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   811
.BR \-d | \-n
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   812
.IR name
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   813
.PP
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   814
.\" ------------------------------------
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   815
.TP
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   816
.B \-d
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   817
delete the user\(aqs name.
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   818
.\" ------------------------------------
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   819
.TP
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   820
.BI "\-n " name
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   821
a user\(aqs real name.
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   822
.\" ------------------------------------
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   823
.PP
416
f32b323fd347 man: Replaced unnecessary \(aq glyphs in man1/vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 411
diff changeset
   824
The user's real
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   825
.I name
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   826
can be set/updated with this subcommand.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   827
.PP
690
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   828
In order to delete the value stored for the account, pass the
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   829
.BR \-d " option."
536
c340ba4bd544 Allow username to take no argument to erase value
martin f. krafft <madduck@madduck.net>
parents: 534
diff changeset
   830
.PP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   831
Example:
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   832
.PP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   833
.nf
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   834
.B vmm un d.user@example.com \-n \(dqJohn Doe\(dq
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   835
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   836
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   837
.SS userpassword (up)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   838
.BI "vmm userpassword" " address"
738
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   839
.RB ([ \-p
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   840
.IR password ]
730
d3a246067e8f {man1,doc/web}: Added description of userpassword's -s option.
Pascal Volk <user@localhost.localdomain.org>
parents: 691
diff changeset
   841
.RB [ \-s
738
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   842
.IR scheme "] |"
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   843
.B \-\-hash
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   844
.IR pwhash ])
730
d3a246067e8f {man1,doc/web}: Added description of userpassword's -s option.
Pascal Volk <user@localhost.localdomain.org>
parents: 691
diff changeset
   845
.PP
d3a246067e8f {man1,doc/web}: Added description of userpassword's -s option.
Pascal Volk <user@localhost.localdomain.org>
parents: 691
diff changeset
   846
.TP
d3a246067e8f {man1,doc/web}: Added description of userpassword's -s option.
Pascal Volk <user@localhost.localdomain.org>
parents: 691
diff changeset
   847
.BI "\-p " password
d3a246067e8f {man1,doc/web}: Added description of userpassword's -s option.
Pascal Volk <user@localhost.localdomain.org>
parents: 691
diff changeset
   848
The user\(aqs new password.
d3a246067e8f {man1,doc/web}: Added description of userpassword's -s option.
Pascal Volk <user@localhost.localdomain.org>
parents: 691
diff changeset
   849
.\" ------------------------------------
d3a246067e8f {man1,doc/web}: Added description of userpassword's -s option.
Pascal Volk <user@localhost.localdomain.org>
parents: 691
diff changeset
   850
.TP
d3a246067e8f {man1,doc/web}: Added description of userpassword's -s option.
Pascal Volk <user@localhost.localdomain.org>
parents: 691
diff changeset
   851
.BI "\-s " scheme
d3a246067e8f {man1,doc/web}: Added description of userpassword's -s option.
Pascal Volk <user@localhost.localdomain.org>
parents: 691
diff changeset
   852
When a
d3a246067e8f {man1,doc/web}: Added description of userpassword's -s option.
Pascal Volk <user@localhost.localdomain.org>
parents: 691
diff changeset
   853
.I scheme
d3a246067e8f {man1,doc/web}: Added description of userpassword's -s option.
Pascal Volk <user@localhost.localdomain.org>
parents: 691
diff changeset
   854
was specified, it overrides the
d3a246067e8f {man1,doc/web}: Added description of userpassword's -s option.
Pascal Volk <user@localhost.localdomain.org>
parents: 691
diff changeset
   855
.I misc.password_scheme
d3a246067e8f {man1,doc/web}: Added description of userpassword's -s option.
Pascal Volk <user@localhost.localdomain.org>
parents: 691
diff changeset
   856
setting, configured in the
d3a246067e8f {man1,doc/web}: Added description of userpassword's -s option.
Pascal Volk <user@localhost.localdomain.org>
parents: 691
diff changeset
   857
.I vmm.cfg
d3a246067e8f {man1,doc/web}: Added description of userpassword's -s option.
Pascal Volk <user@localhost.localdomain.org>
parents: 691
diff changeset
   858
file.
d3a246067e8f {man1,doc/web}: Added description of userpassword's -s option.
Pascal Volk <user@localhost.localdomain.org>
parents: 691
diff changeset
   859
.\" ------------------------------------
738
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   860
.TP
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   861
.BI "\-\-hash " pwhash
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   862
A hashed password, prefixed with
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   863
.BI { SCHEME };
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   864
as generated by
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   865
.BR "doveadm pw" .
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   866
You should enclose the hashed password in single quotes, if it contains
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   867
one ore more dollar signs
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   868
.RB ( $ ).
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   869
.\" ------------------------------------
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   870
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   871
The password of an account can be updated with this subcommand.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   872
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   873
If no
738
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   874
.IR password " or " pwhash
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   875
was provided,
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   876
.B vmm
738
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   877
will prompt for a password interactively.
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   878
.IP Note:
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   879
When passing a hashed password,
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   880
.B vmm
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   881
checks only if the included
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   882
.I SCHEME
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
   883
is supported by your Dovecot installation.  No further checks are done.
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   884
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   885
Example:
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   886
.PP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   887
.nf
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   888
.B vmm up d.user@example.com \-p \(dqA |\(rs/|0r3 5ecur3 P4s5\(rs/\(rs/0rd?\(dq
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   889
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   890
.\" ------------------------------------
540
a8ee0328f908 Add user/domainnote commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 537
diff changeset
   891
.SS usernote (uo)
a8ee0328f908 Add user/domainnote commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 537
diff changeset
   892
.BI "vmm usernote" " address"
690
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   893
.BR \-d | \-n
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   894
.IR note
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   895
.PP
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   896
.\" ------------------------------------
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   897
.TP
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   898
.B \-d
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   899
delete the user\(aqs note.
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   900
.\" ------------------------------------
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   901
.TP
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   902
.BI "\-n " note
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   903
the note that should be set.
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   904
.\" ------------------------------------
540
a8ee0328f908 Add user/domainnote commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 537
diff changeset
   905
.PP
a8ee0328f908 Add user/domainnote commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 537
diff changeset
   906
With this subcommand, it is possible to attach a note to the specified
690
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   907
account.
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   908
In order to delete an existing note, pass the
06c0acf6c45d doc: Updated doc/web and man1.
Pascal Volk <user@localhost.localdomain.org>
parents: 688
diff changeset
   909
.BR \-d " option."
540
a8ee0328f908 Add user/domainnote commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 537
diff changeset
   910
.PP
a8ee0328f908 Add user/domainnote commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 537
diff changeset
   911
Example:
a8ee0328f908 Add user/domainnote commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 537
diff changeset
   912
.PP
a8ee0328f908 Add user/domainnote commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 537
diff changeset
   913
.nf
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   914
.B vmm uo d.user@example.com -n `Only needed until end of May 2013'
540
a8ee0328f908 Add user/domainnote commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 537
diff changeset
   915
.fi
a8ee0328f908 Add user/domainnote commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 537
diff changeset
   916
.\" ------------------------------------
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   917
.SS userquota (uq)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   918
.BI "vmm userquota" " address storage"
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   919
.RB [ \-m
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   920
.IR messages ]
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   921
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   922
This subcommand is used to set a new quota limit for the given account.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   923
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   924
When the argument
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   925
.I messages
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   926
was omitted the default number of messages
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   927
.B 0
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   928
(zero) will be applied.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   929
.PP
533
2676dbf43e1c Change UI to accept 'default' to restore inherited values
martin f. krafft <madduck@madduck.net>
parents: 529
diff changeset
   930
Instead of
590
9d343514b832 man/{de/}man1: A few more corrections.
Pascal Volk <user@localhost.localdomain.org>
parents: 589
diff changeset
   931
.I storage
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   932
limit pass the keyword
590
9d343514b832 man/{de/}man1: A few more corrections.
Pascal Volk <user@localhost.localdomain.org>
parents: 589
diff changeset
   933
.B domain
9d343514b832 man/{de/}man1: A few more corrections.
Pascal Volk <user@localhost.localdomain.org>
parents: 589
diff changeset
   934
to remove the account\-specific override, causing the domain's value to be
9d343514b832 man/{de/}man1: A few more corrections.
Pascal Volk <user@localhost.localdomain.org>
parents: 589
diff changeset
   935
in effect.
533
2676dbf43e1c Change UI to accept 'default' to restore inherited values
martin f. krafft <madduck@madduck.net>
parents: 529
diff changeset
   936
.PP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   937
Example:
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   938
.PP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   939
.nf
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   940
.B vmm userquota d.user@example.com 750m
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   941
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   942
.\" ------------------------------------
473
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   943
.SS userservices (us)
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   944
.B vmm userservices
688
c14299bc1b99 man1: Deleted trailing whitespaces.
Pascal Volk <user@localhost.localdomain.org>
parents: 687
diff changeset
   945
.I address
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   946
.RB [ \-s
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   947
.IR "service ..." ]
473
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   948
.PP
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   949
To grant a user access to the specified services, use this command.
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   950
.PP
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   951
All omitted services will be deactivated/unusable for the user with the
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   952
given
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   953
.IR address .
529
916b468cf994 man: Add examples for userservices
martin f. krafft <madduck@madduck.net>
parents: 520
diff changeset
   954
.PP
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   955
Instead of any
603
981f02b2d4c5 man: Typo-fix.
Pascal Volk <user@localhost.localdomain.org>
parents: 590
diff changeset
   956
.I service
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   957
pass the keyword
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   958
.B domain
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   959
to remove the account\-specific override, causing the domain's value to be
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
   960
in effect.
533
2676dbf43e1c Change UI to accept 'default' to restore inherited values
martin f. krafft <madduck@madduck.net>
parents: 529
diff changeset
   961
.PP
529
916b468cf994 man: Add examples for userservices
martin f. krafft <madduck@madduck.net>
parents: 520
diff changeset
   962
Example:
574
9acf628bf0be man: Deleted erroneous placed backslash.
Pascal Volk <user@localhost.localdomain.org>
parents: 565
diff changeset
   963
.PP
529
916b468cf994 man: Add examples for userservices
martin f. krafft <madduck@madduck.net>
parents: 520
diff changeset
   964
.nf
684
083d36f53297 man1: Use service names in lowercase letters.
Pascal Volk <user@localhost.localdomain.org>
parents: 677
diff changeset
   965
.B vmm userservices d.user@example.com \-s smtp imap
473
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   966
.\" ------------------------------------
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   967
.SS usertransport (ut)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   968
.BI "vmm usertransport" " address transport"
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   969
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   970
A different
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   971
.I transport
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   972
for an account can be specified with this subcommand.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   973
.PP
533
2676dbf43e1c Change UI to accept 'default' to restore inherited values
martin f. krafft <madduck@madduck.net>
parents: 529
diff changeset
   974
Instead of
2676dbf43e1c Change UI to accept 'default' to restore inherited values
martin f. krafft <madduck@madduck.net>
parents: 529
diff changeset
   975
.I transport
565
a75923ce2842 VMM/cli/subcommands: Replaced the keyword `default' by `domain'.
Pascal Volk <user@localhost.localdomain.org>
parents: 554
diff changeset
   976
pass 'domain' to remove the account\-specific override, causing the
533
2676dbf43e1c Change UI to accept 'default' to restore inherited values
martin f. krafft <madduck@madduck.net>
parents: 529
diff changeset
   977
domain's value to be in effect.
2676dbf43e1c Change UI to accept 'default' to restore inherited values
martin f. krafft <madduck@madduck.net>
parents: 529
diff changeset
   978
.PP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   979
Example:
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   980
.br
416
f32b323fd347 man: Replaced unnecessary \(aq glyphs in man1/vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 411
diff changeset
   981
Assumed you want to use Dovecot's
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   982
.BR dsync (1)
416
f32b323fd347 man: Replaced unnecessary \(aq glyphs in man1/vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 411
diff changeset
   983
to convert a user's mailbox from Maildir format to mdbox format, you
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   984
can tell Postfix to retry later.
66
995d538a6eb5 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 64
diff changeset
   985
.PP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   986
.nf
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   987
.B vmm ut d.user@example.com \(dqretry:4.0.0 Mailbox being migrated\(dq
416
f32b323fd347 man: Replaced unnecessary \(aq glyphs in man1/vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 411
diff changeset
   988
# convert the mailbox ... then set the transport to Dovecot's lmtp
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   989
.B vmm ut d.user@example.com lmtp:unix:private/dovecot\-lmtp
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   990
.fi
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   991
.\" -----------------------------------------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   992
.SH ALIAS SUBCOMMANDS
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   993
.SS aliasadd (aa)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   994
.BI "vmm aliasadd" " address destination ..."
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   995
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   996
This subcommand is used to create a new alias
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   997
.I address
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   998
with one or more
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   999
.I destination
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1000
addresses.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1001
.PP
518
5ec2068d02af Enable interpolation of alias destinations
martin f. krafft <madduck@madduck.net>
parents: 516
diff changeset
  1002
Within the destination address, the placeholders
5ec2068d02af Enable interpolation of alias destinations
martin f. krafft <madduck@madduck.net>
parents: 516
diff changeset
  1003
.IR %n ,
5ec2068d02af Enable interpolation of alias destinations
martin f. krafft <madduck@madduck.net>
parents: 516
diff changeset
  1004
.IR %d ,
5ec2068d02af Enable interpolation of alias destinations
martin f. krafft <madduck@madduck.net>
parents: 516
diff changeset
  1005
and
5ec2068d02af Enable interpolation of alias destinations
martin f. krafft <madduck@madduck.net>
parents: 516
diff changeset
  1006
.IR %=
5ec2068d02af Enable interpolation of alias destinations
martin f. krafft <madduck@madduck.net>
parents: 516
diff changeset
  1007
will be replaced by the local part, the domain, or the email address with '@'
5ec2068d02af Enable interpolation of alias destinations
martin f. krafft <madduck@madduck.net>
parents: 516
diff changeset
  1008
replaced by '=' respectively. In combination with alias domains, this enables
554
a93671970617 man: escape hyphens
martin f. krafft <madduck@madduck.net>
parents: 553
diff changeset
  1009
domain\-specific destinations.
518
5ec2068d02af Enable interpolation of alias destinations
martin f. krafft <madduck@madduck.net>
parents: 516
diff changeset
  1010
.PP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1011
Examples:
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
  1012
.PP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
  1013
.nf
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1014
.B vmm aliasadd john.doe@example.com d.user@example.com
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1015
.B vmm aa support@example.com d.user@example.com e.user@example.com
518
5ec2068d02af Enable interpolation of alias destinations
martin f. krafft <madduck@madduck.net>
parents: 516
diff changeset
  1016
.B vmm aa postmaster@example.com postmaster+%d@example.org
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
  1017
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1018
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1019
.SS aliasdelete (ad)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1020
.BI "vmm aliasdelete" " address"
618
d8736bb80bdc VMM: {alias,catchall}delete: Accept multiple destinations.
Pascal Volk <user@localhost.localdomain.org>
parents: 603
diff changeset
  1021
.RI [ destination " ...]"
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1022
.PP
618
d8736bb80bdc VMM: {alias,catchall}delete: Accept multiple destinations.
Pascal Volk <user@localhost.localdomain.org>
parents: 603
diff changeset
  1023
This subcommand is used to delete one or multiple
d8736bb80bdc VMM: {alias,catchall}delete: Accept multiple destinations.
Pascal Volk <user@localhost.localdomain.org>
parents: 603
diff changeset
  1024
.IR  destination s
d8736bb80bdc VMM: {alias,catchall}delete: Accept multiple destinations.
Pascal Volk <user@localhost.localdomain.org>
parents: 603
diff changeset
  1025
from the alias with the given
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1026
.IR address .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1027
.PP
618
d8736bb80bdc VMM: {alias,catchall}delete: Accept multiple destinations.
Pascal Volk <user@localhost.localdomain.org>
parents: 603
diff changeset
  1028
When no
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1029
.I destination
618
d8736bb80bdc VMM: {alias,catchall}delete: Accept multiple destinations.
Pascal Volk <user@localhost.localdomain.org>
parents: 603
diff changeset
  1030
address was specified the alias with all its destinations will be deleted.
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1031
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1032
Example:
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
  1033
.PP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
  1034
.nf
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1035
.B vmm ad support@example.com d.user@example.com
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
  1036
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1037
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1038
.SS aliasinfo (ai)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1039
.BI "vmm aliasinfo" " address"
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1040
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1041
Information about the alias with the given
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1042
.I address
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1043
can be displayed with this subcommand.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1044
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1045
Example:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1046
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1047
.nf
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1048
.B vmm aliasinfo support@example.com
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1049
Alias information
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1050
-----------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1051
        Mail for support@example.com will be redirected to:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1052
             * e.user@example.com
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1053
.fi
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1054
.\" -----------------------------------------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1055
.SH RELOCATED SUBCOMMANDS
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1056
.SS relocatedadd (ra)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1057
.BI "vmm relocatedadd" " address newaddress"
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1058
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1059
A new relocated user can be created with this subcommand.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1060
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1061
.I address
416
f32b323fd347 man: Replaced unnecessary \(aq glyphs in man1/vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 411
diff changeset
  1062
is the user's ex\-email address, for example b.user@example.com, and
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1063
.I newaddress
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1064
points to the new email address where the user can be reached.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1065
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1066
Example:
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
  1067
.PP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
  1068
.nf
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1069
.B vmm relocatedadd b.user@example.com b\-user@company.tld
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
  1070
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1071
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1072
.SS relocatedinfo (ri)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1073
.BI "vmm relocatedinfo " address
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1074
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1075
This subcommand shows the new address of the relocated user with the given
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1076
.IR address .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1077
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1078
Example:
81
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
  1079
.PP
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
  1080
.nf
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1081
.B vmm relocatedinfo b.user@example.com
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1082
Relocated information
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1083
---------------------
416
f32b323fd347 man: Replaced unnecessary \(aq glyphs in man1/vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 411
diff changeset
  1084
        User `b.user@example.com' has moved to `b\-user@company.tld'
81
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
  1085
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1086
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1087
.SS relocateddelete (rd)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1088
.BI "vmm relocateddelete " address
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1089
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1090
Use this subcommand in order to delete the relocated user with the given
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1091
.IR address .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1092
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1093
Example:
81
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
  1094
.PP
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
  1095
.nf
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1096
.B vmm relocateddelete b.user@example.com
81
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
  1097
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1098
.\" -----------------------------------------------------------------------
554
a93671970617 man: escape hyphens
martin f. krafft <madduck@madduck.net>
parents: 553
diff changeset
  1099
.SH CATCH\-ALL SUBCOMMANDS
516
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
  1100
.SS catchalladd (caa)
552
107f7a3be9f5 man: vmm1: Use `fqdn' instead of `domain' in catchall* descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 545
diff changeset
  1101
.BI "vmm catchalladd" " fqdn destination ..."
516
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
  1102
.PP
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
  1103
This subcommand allows to specify destination addresses for a domain, which
552
107f7a3be9f5 man: vmm1: Use `fqdn' instead of `domain' in catchall* descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 545
diff changeset
  1104
shall receive mail addressed to unknown local parts within that domain.
554
a93671970617 man: escape hyphens
martin f. krafft <madduck@madduck.net>
parents: 553
diff changeset
  1105
Those catch\-all aliases hence \(dqcatch all\(dq mail to any address in the
552
107f7a3be9f5 man: vmm1: Use `fqdn' instead of `domain' in catchall* descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 545
diff changeset
  1106
domain (unless a more specific alias, mailbox or relocated entry exists).
516
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
  1107
.PP
554
a93671970617 man: escape hyphens
martin f. krafft <madduck@madduck.net>
parents: 553
diff changeset
  1108
WARNING: Catch\-all addresses can cause mail server flooding because
552
107f7a3be9f5 man: vmm1: Use `fqdn' instead of `domain' in catchall* descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 545
diff changeset
  1109
spammers like to deliver mail to all possible combinations of names, e.g.
107f7a3be9f5 man: vmm1: Use `fqdn' instead of `domain' in catchall* descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 545
diff changeset
  1110
to all addresses between abba@example.org and zztop@example.org.
516
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
  1111
.PP
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
  1112
Example:
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
  1113
.PP
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
  1114
.nf
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
  1115
.B vmm catchalladd example.com user@example.org
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
  1116
.fi
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
  1117
.\" ------------------------------------
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
  1118
.SS catchallinfo (cai)
552
107f7a3be9f5 man: vmm1: Use `fqdn' instead of `domain' in catchall* descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 545
diff changeset
  1119
.BI "vmm catchallinfo " fqdn
516
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
  1120
.PP
554
a93671970617 man: escape hyphens
martin f. krafft <madduck@madduck.net>
parents: 553
diff changeset
  1121
This subcommand displays information about catch\-all aliases defined for
516
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
  1122
a domain.
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
  1123
.PP
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
  1124
Example:
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
  1125
.PP
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
  1126
.nf
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
  1127
.B vmm catchallinfo example.com
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
  1128
Catch-all information
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
  1129
---------------------
677
6287cf6c6447 man1: Updated to reflect the new cli.
Pascal Volk <user@localhost.localdomain.org>
parents: 625
diff changeset
  1130
  Mail to unknown local\-parts in domain example.com will be sent to:
516
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
  1131
         * user@example.org
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
  1132
.fi
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
  1133
.\" ------------------------------------
552
107f7a3be9f5 man: vmm1: Use `fqdn' instead of `domain' in catchall* descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 545
diff changeset
  1134
.SS catchalldelete (cad)
107f7a3be9f5 man: vmm1: Use `fqdn' instead of `domain' in catchall* descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 545
diff changeset
  1135
.BI "vmm catchalldelete " fqdn
618
d8736bb80bdc VMM: {alias,catchall}delete: Accept multiple destinations.
Pascal Volk <user@localhost.localdomain.org>
parents: 603
diff changeset
  1136
.RI [ destination " ...]"
516
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
  1137
.PP
554
a93671970617 man: escape hyphens
martin f. krafft <madduck@madduck.net>
parents: 553
diff changeset
  1138
With this subcommand, catch\-all aliases defined for a domain can be
618
d8736bb80bdc VMM: {alias,catchall}delete: Accept multiple destinations.
Pascal Volk <user@localhost.localdomain.org>
parents: 603
diff changeset
  1139
removed, either all of them, or those
d8736bb80bdc VMM: {alias,catchall}delete: Accept multiple destinations.
Pascal Volk <user@localhost.localdomain.org>
parents: 603
diff changeset
  1140
.IR destination s
d8736bb80bdc VMM: {alias,catchall}delete: Accept multiple destinations.
Pascal Volk <user@localhost.localdomain.org>
parents: 603
diff changeset
  1141
which were specified explicitly.
516
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
  1142
.PP
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
  1143
Example:
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
  1144
.PP
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
  1145
.nf
552
107f7a3be9f5 man: vmm1: Use `fqdn' instead of `domain' in catchall* descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 545
diff changeset
  1146
.B vmm catchalldelete example.com user@example.com
516
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
  1147
.fi
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
  1148
.\" -----------------------------------------------------------------------
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1149
.SH FILES
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1150
.TP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1151
.I /root/vmm.cfg
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1152
will be used when found.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1153
.TP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1154
.I /usr/local/etc/vmm.cfg
416
f32b323fd347 man: Replaced unnecessary \(aq glyphs in man1/vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 411
diff changeset
  1155
will be used when the above file doesn't exist.
81
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
  1156
.TP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1157
.I /etc/vmm.cfg
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1158
will be used when none of the both above mentioned files exists.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1159
.\" -----------------------------------------------------------------------
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
  1160
.SH SEE ALSO
738
935b4901d652 {man1,doc/web}: Added description of userpassword's --hash option.
Pascal Volk <user@localhost.localdomain.org>
parents: 730
diff changeset
  1161
.BR doveadm\-pw (1),
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1162
.BR dsync (1),
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1163
.BR transport (5),
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1164
.BR vmm.cfg (5)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1165
.\" -----------------------------------------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1166
.SH INTERNET RESOURCES
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1167
.TP
587
8767ec854084 man/{de/}man1: s/Wiki/Homepage/g
Pascal Volk <user@localhost.localdomain.org>
parents: 574
diff changeset
  1168
Homepage
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1169
http://vmm.localdomain.org/
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1170
.TP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1171
Project site
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1172
http://sf.net/projects/vmm/
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1173
.TP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1174
Bug tracker
477
86fa217cba11 man: Updated the URL of the bug tracker.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 475
diff changeset
  1175
https://bitbucket.org/pvo/vmm/issues
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1176
.\" -----------------------------------------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
  1177
.SH COPYING
478
6278a7a2a476 Updated the author's e-mail address.
Pascal Volk <user@localhost.localdomain.org>
parents: 477
diff changeset
  1178
vmm and its manual pages were written by Pascal Volk <user+vmm AT
6278a7a2a476 Updated the author's e-mail address.
Pascal Volk <user@localhost.localdomain.org>
parents: 477
diff changeset
  1179
localhost.localdomain.org> and are licensed under the terms of the BSD
587
8767ec854084 man/{de/}man1: s/Wiki/Homepage/g
Pascal Volk <user@localhost.localdomain.org>
parents: 574
diff changeset
  1180
License.