man/man1/vmm.1
author martin f. krafft <madduck@debian.org>
Wed, 08 Aug 2012 14:37:29 +0000
changeset 586 cd1200d06700
parent 574 9acf628bf0be
child 587 8767ec854084
permissions -rw-r--r--
VMM/common: Improve search_address complexity Checking the dictionary (a hash) for existence of a key is likely to be O(log(n)), while checking a list is O(n). Therefore, to increase performance, this patch changes the check accordingly.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
552
107f7a3be9f5 man: vmm1: Use `fqdn' instead of `domain' in catchall* descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 545
diff changeset
     1
.TH "VMM" "1" "2012-04-15" "vmm 0.6" "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
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
     7
.IR subcommand " [" "argument ..." ]
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
     8
.\" -----------------------------------------------------------------------
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
     9
.SH DESCRIPTION
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    10
.B vmm
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    11
(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
    12
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
    13
and relocated users.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    14
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
    15
.br
416
f32b323fd347 man: Replaced unnecessary \(aq glyphs in man1/vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 411
diff changeset
    16
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
    17
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    18
Each
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    19
.I subcommand
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    20
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
    21
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
    22
Both forms are case sensitive.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    23
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    24
Most of the
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    25
.IR subcommand s
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    26
take one or more
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    27
.IR argument s.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    28
.\" -----------------------------------------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    29
.SH ARGUMENTS
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    30
.TP 12
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    31
.I address
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    32
The complete e\-mail address
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    33
.RI ( local\-part @ fqdn )
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    34
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
    35
.\" --------------------------
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    36
.TP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    37
.I destination
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    38
Is either an e\-mail
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    39
.I address
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    40
when used with
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    41
.IR "ALIAS SUBCOMMANDS" .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    42
Or a
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    43
.I fqdn
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    44
when used with
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    45
.IR "ALIASDOMAIN SUBCOMMANDS" .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    46
.\" --------------------------
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    47
.TP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    48
.I fqdn
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    49
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
    50
or alias domain.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    51
.\" --------------------------
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    52
.TP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    53
.I messages
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    54
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
    55
.B 0
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    56
(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
    57
.\" --------------------------
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    58
.TP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    59
.I option
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    60
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
    61
dot.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    62
For example:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    63
.IB misc . transport
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    64
.br
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    65
All configuration options are described in
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    66
.BR vmm.cfg (5).
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    67
.\" --------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    68
.TP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    69
.I service
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    70
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
    71
Supported services are:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    72
.BR imap ", " pop3 ", " sieve " and " smtp .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    73
.\" --------------------------
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    74
.TP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    75
.I storage
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    76
Specifies a quota limit in bytes.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    77
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
    78
.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
    79
(gigabytes).
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    80
.B 0
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    81
(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
    82
.\" --------------------------
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
    83
.TP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    84
.I transport
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    85
A transport for Postfix, written as:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    86
.IB transport :
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    87
or
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    88
.IB transport :\c
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    89
.IR nexthop .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    90
See
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    91
.BR transport (5)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    92
for more details.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    93
.\" -----------------------------------------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    94
.SH GENERAL SUBCOMMANDS
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    95
.SS configget (cg)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    96
.BI "vmm configget" " option"
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    97
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
    98
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
    99
configuration
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   100
.IR option .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   101
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   102
Example:
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   103
.PP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   104
.nf
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   105
.B vmm configget misc.crypt_sha512_rounds
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   106
misc.crypt_sha512_rounds = 5000
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   107
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   108
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   109
.SS configset (cs)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   110
.B vmm configset
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   111
.I option value
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   112
.PP
416
f32b323fd347 man: Replaced unnecessary \(aq glyphs in man1/vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 411
diff changeset
   113
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
   114
.I option
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   115
is the configuration option,
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   116
.I value
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   117
is the
416
f32b323fd347 man: Replaced unnecessary \(aq glyphs in man1/vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 411
diff changeset
   118
.IR option 's
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   119
new value.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   120
.IP Note:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   121
This subcommand will create a new
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   122
.I vmm.cfg
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   123
without any comments.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   124
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
   125
.IR vmm.cfg.bak .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   126
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   127
Example:
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   128
.PP
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   129
.nf
479
b33bdc0c3669 man1: Updated configuration related descriptions/examples,
Pascal Volk <user@localhost.localdomain.org>
parents: 478
diff changeset
   130
.B vmm configget domain.transport
b33bdc0c3669 man1: Updated configuration related descriptions/examples,
Pascal Volk <user@localhost.localdomain.org>
parents: 478
diff changeset
   131
domain.transport = dovecot:
b33bdc0c3669 man1: Updated configuration related descriptions/examples,
Pascal Volk <user@localhost.localdomain.org>
parents: 478
diff changeset
   132
.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
   133
.B vmm cg domain.transport
b33bdc0c3669 man1: Updated configuration related descriptions/examples,
Pascal Volk <user@localhost.localdomain.org>
parents: 478
diff changeset
   134
domain.transport = lmtp:unix:private/dovecot\-lmtp
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   135
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   136
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   137
.SS configure (cf)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   138
.B vmm configure
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   139
.RI [ section ]
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   140
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   141
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
   142
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   143
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
   144
square brackets.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   145
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
   146
displayed in square brackets.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   147
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
   148
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   149
If the optional argument
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   150
.I section
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   151
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
   152
displayed and will be configurable.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   153
The following sections are available:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   154
.RS
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   155
.TP 10
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   156
.B account
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   157
Account settings
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   158
.TP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   159
.B bin
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   160
Paths to external binaries
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   161
.TP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   162
.B database
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   163
Database settings
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   164
.TP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   165
.B domain
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   166
Domain settings
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   167
.TP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   168
.B mailbox
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   169
Mailbox settings
36
8a9ce20d2569 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
   170
.TP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   171
.B misc
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   172
Miscellaneous settings
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   173
.RE
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   174
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   175
All configuration options are described in
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   176
.BR vmm.cfg (5).
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   177
.IP Note:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   178
This subcommand will create a new
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   179
.I vmm.cfg
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   180
without any comments.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   181
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
   182
.IR vmm.cfg.bak .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   183
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   184
Example:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   185
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   186
.nf
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   187
.B vmm configure mailbox
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   188
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
   189
416
f32b323fd347 man: Replaced unnecessary \(aq glyphs in man1/vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 411
diff changeset
   190
* Configuration section: `mailbox'
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   191
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
   192
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
   193
Enter new value for option subscribe [True]:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   194
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
   195
.fi
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   196
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   197
.SS getuser (gu)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   198
.BI "vmm getuser" " uid"
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   199
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   200
If only the
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   201
.I uid
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   202
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
   203
.B getuser
416
f32b323fd347 man: Replaced unnecessary \(aq glyphs in man1/vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 411
diff changeset
   204
will show the user's address.
410
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:
36
8a9ce20d2569 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
   207
.PP
8a9ce20d2569 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
   208
.nf
475
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   209
.B vmm getuser 79876
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   210
Account information
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   211
-------------------
475
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   212
        UID............: 79876
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   213
        GID............: 70704
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   214
        Address........: a.user@example.com
36
8a9ce20d2569 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 26
diff changeset
   215
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   216
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   217
.SS help (h)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   218
.B vmm help
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   219
.RI [ subcommand ]
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   220
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   221
Prints a list of available subcommands with a short description to stdout.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   222
When a
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   223
.I subcommand
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   224
was given, help for that
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   225
.I subcommand
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   226
will be displayed.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   227
After this
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   228
.B vmm
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   229
exits.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   230
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   231
.SS listdomains (ld)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   232
.B vmm listdomains
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   233
.RI [ pattern ]
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   234
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   235
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
   236
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
   237
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
   238
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
   239
.IR pattern .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   240
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   241
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
   242
and/or the end of the
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   243
.IR pattern .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   244
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   245
Example:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   246
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   247
.nf
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   248
.B vmm listdomains %example%
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   249
Matching domains
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   250
----------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   251
        [+] example.com
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   252
        [\-]     e.g.example.com
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   253
        [\-]     example.name
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   254
        [+] example.net
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   255
        [+] example.org
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   256
.fi
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   257
.\" ------------------------------------
473
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   258
.SS listpwschemes (lp)
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   259
.B vmm listpwschemes
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   260
.PP
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   261
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
   262
.I vmm.cfg
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   263
as value of the
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   264
.I misc.password_scheme
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   265
option.
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   266
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
   267
libc.
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   268
.br
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   269
When your Dovecot installation isn't too old, you will see additionally a
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   270
few usable encoding suffixes.
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   271
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
   272
.PP
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   273
Example:
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   274
.PP
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   275
.nf
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   276
.B vmm listpwschemes
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   277
Usable password schemes
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   278
-----------------------
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   279
        CRYPT SHA512-CRYPT LDAP-MD5 DIGEST-MD5 SHA256 SHA512 SSHA512
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   280
        SKEY SSHA NTLM RPA MD5-CRYPT HMAC-MD5 SHA1 PLAIN SHA CRAM-MD5
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   281
        SSHA256 MD5 LANMAN CLEARTEXT PLAIN-MD5 PLAIN-MD4 OTP SMD5
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   282
        SHA256-CRYPT
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   283
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   284
Usable encoding suffixes
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   285
------------------------
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   286
        .B64 .BASE64 .HEX
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   287
.fi
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   288
.\" ------------------------------------
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   289
.SS version (v)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   290
.B vmm version
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   291
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   292
Prints
416
f32b323fd347 man: Replaced unnecessary \(aq glyphs in man1/vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 411
diff changeset
   293
.BR vmm 's
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   294
version and copyright information to stdout.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   295
After this
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   296
.B vmm
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   297
exits.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   298
.\" -----------------------------------------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   299
.SH DOMAIN SUBCOMMANDS
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   300
.SS domainadd (da)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   301
.B vmm domainadd
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   302
.IR fqdn " [" transport ]
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   303
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   304
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
   305
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   306
If the optional argument
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   307
.I transport
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   308
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
   309
.RI ( domain.transport ") from " vmm.cfg .
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   310
The specified
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   311
.I transport
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   312
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
   313
.PP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   314
Configuration\-related behavior:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   315
.RS
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   316
.TP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   317
.I domain.auto_postmaster
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   318
When that option is set to
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   319
.BR true " (default) " vmm
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   320
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
   321
prompt for
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   322
.BI postmaster@ fqdn\c
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   323
\(aqs password.
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   324
.TP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   325
.I account.random_password
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   326
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
   327
.BR true ", " vmm
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   328
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
   329
print the generated postmaster password to stdout.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   330
.RE
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   331
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   332
Examples:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   333
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   334
.nf
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   335
.B vmm domainadd support.example.com 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
   336
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
   337
Enter new password:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   338
Retype new password:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   339
.B vmm cs account.random_password true
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   340
.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
   341
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
   342
Generated password: pLJUQ6Xg_z
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   343
.fi
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   344
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   345
.SS domaindelete (dd)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   346
.BI "vmm domaindelete " fqdn
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   347
.RB [ force ]
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   348
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   349
This subcommand deletes the domain specified by
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   350
.IR fqdn .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   351
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   352
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
   353
domain,
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   354
.B vmm
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   355
will abort the requested operation and show an error message.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   356
If you know, what you are doing, you can specify the optional keyword
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   357
.BR force .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   358
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   359
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
   360
.I vmm.cfg
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   361
and set the option
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   362
.I domain.force_deletion
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   363
to
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   364
.BR true .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   365
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   366
.SS domaininfo (di)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   367
.B vmm domaininfo
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   368
.IR fqdn \ [ details ]
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   369
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   370
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
   371
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   372
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
   373
.I details
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   374
can be specified.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   375
A possible
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   376
.I details
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   377
value can be one of the following five keywords:
62
869de537a020 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 59
diff changeset
   378
.RS
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   379
.TP 14
62
869de537a020 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 59
diff changeset
   380
.B accounts
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   381
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
   382
.TP
869de537a020 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 59
diff changeset
   383
.B aliasdomains
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   384
to list all assigned alias domain names
62
869de537a020 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 59
diff changeset
   385
.TP
869de537a020 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 59
diff changeset
   386
.B aliases
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   387
to list all available alias e\-mail addresses
62
869de537a020 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 59
diff changeset
   388
.TP
81
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   389
.B relocated
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   390
to list the e\-mail addresses of all relocated users
81
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   391
.TP
553
6f2c41c3c7d6 man: add 'catchall' to domaininfo
martin f. krafft <madduck@madduck.net>
parents: 552
diff changeset
   392
.B catchall
6f2c41c3c7d6 man: add 'catchall' to domaininfo
martin f. krafft <madduck@madduck.net>
parents: 552
diff changeset
   393
to list all catch\-all destinations
6f2c41c3c7d6 man: add 'catchall' to domaininfo
martin f. krafft <madduck@madduck.net>
parents: 552
diff changeset
   394
.TP
62
869de537a020 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 59
diff changeset
   395
.B full
64
432a037658a8 * 'vmm'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 62
diff changeset
   396
to list all information mentioned above
62
869de537a020 * 'VirtualMailManager/VirtualMailManager.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 59
diff changeset
   397
.RE
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   398
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   399
Example:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   400
.PP
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   401
.nf
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   402
.B vmm domaininfo sales.example.com
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   403
Domain information
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   404
------------------
475
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   405
        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
   406
        GID..............: 70708
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   407
        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
   408
        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
   409
        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
   410
        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
   411
        Alias Domains....: 0
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   412
        Accounts.........: 1
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   413
        Aliases..........: 0
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   414
        Relocated........: 0
553
6f2c41c3c7d6 man: add 'catchall' to domaininfo
martin f. krafft <madduck@madduck.net>
parents: 552
diff changeset
   415
        Catch-All Dests..: 1
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   416
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   417
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   418
.SS domainquota (dq)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   419
.B vmm domainquota
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   420
.IR "fqdn storage" " [" messages ]
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   421
.RB [ force ]
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   422
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   423
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
   424
the domain - not for the domain itself.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   425
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   426
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
   427
.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
   428
.PP
6a27c7529cd7 Change 'force' argument to reset user records for tid/ssid/qid
martin f. krafft <madduck@madduck.net>
parents: 533
diff changeset
   429
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
   430
has not been overridden. If you want to restore the default to all accounts,
6a27c7529cd7 Change 'force' argument to reset user records for tid/ssid/qid
martin f. krafft <madduck@madduck.net>
parents: 533
diff changeset
   431
you may pass the keyword
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   432
.BR force .
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   433
.br
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   434
When the argument
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   435
.I messages
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   436
was omitted the default number of messages
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   437
.B 0
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   438
(zero) will be applied.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   439
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   440
Example:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   441
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   442
.nf
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   443
.B vmm domainquota example.com 1g force
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   444
.fi
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   445
.\" ------------------------------------
473
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   446
.SS domainservices (ds)
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   447
.B vmm domainservices
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   448
.IR fqdn " [" "service ..." ]
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   449
.RB [ force ]
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   450
.PP
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   451
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
   452
the given
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   453
.I fqdn
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   454
\(em use this subcommand.
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   455
.PP
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   456
Each specified
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   457
.I service
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   458
will be enabled/usable.
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   459
All other services will be deactivated/unusable.
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   460
Possible service names are: 
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   461
.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
   462
.br
534
6a27c7529cd7 Change 'force' argument to reset user records for tid/ssid/qid
martin f. krafft <madduck@madduck.net>
parents: 533
diff changeset
   463
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
   464
been overridden. If you want to restore the default to all accounts, you may
6a27c7529cd7 Change 'force' argument to reset user records for tid/ssid/qid
martin f. krafft <madduck@madduck.net>
parents: 533
diff changeset
   465
pass the keyword
6a27c7529cd7 Change 'force' argument to reset user records for tid/ssid/qid
martin f. krafft <madduck@madduck.net>
parents: 533
diff changeset
   466
.BR force .
473
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   467
.\" ------------------------------------
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   468
.SS domaintransport (dt)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   469
.BI "vmm domaintransport" " fqdn transport"
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   470
.RB [ force ]
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
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
   473
.PP
534
6a27c7529cd7 Change 'force' argument to reset user records for tid/ssid/qid
martin f. krafft <madduck@madduck.net>
parents: 533
diff changeset
   474
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
   475
not been overridden. If you want to restore the default to all accounts, you
6a27c7529cd7 Change 'force' argument to reset user records for tid/ssid/qid
martin f. krafft <madduck@madduck.net>
parents: 533
diff changeset
   476
may pass the keyword
6a27c7529cd7 Change 'force' argument to reset user records for tid/ssid/qid
martin f. krafft <madduck@madduck.net>
parents: 533
diff changeset
   477
.BR force .
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   478
.PP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   479
Example:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   480
.PP
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   481
.nf
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   482
.B vmm domaintransport support.example.com dovecot:
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   483
.fi
545
47254b46c361 Document domainnote in manpages
martin f. krafft <madduck@madduck.net>
parents: 540
diff changeset
   484
.\" ------------------------------------
47254b46c361 Document domainnote in manpages
martin f. krafft <madduck@madduck.net>
parents: 540
diff changeset
   485
.SS domainnote (do)
47254b46c361 Document domainnote in manpages
martin f. krafft <madduck@madduck.net>
parents: 540
diff changeset
   486
.BI "vmm domainnote" " fqdn"
47254b46c361 Document domainnote in manpages
martin f. krafft <madduck@madduck.net>
parents: 540
diff changeset
   487
.RI [ note ]
47254b46c361 Document domainnote in manpages
martin f. krafft <madduck@madduck.net>
parents: 540
diff changeset
   488
.PP
47254b46c361 Document domainnote in manpages
martin f. krafft <madduck@madduck.net>
parents: 540
diff changeset
   489
With this subcommand, it is possible to attach a note to the specified
47254b46c361 Document domainnote in manpages
martin f. krafft <madduck@madduck.net>
parents: 540
diff changeset
   490
domain. Without an argument, an existing note is removed.
47254b46c361 Document domainnote in manpages
martin f. krafft <madduck@madduck.net>
parents: 540
diff changeset
   491
.PP
47254b46c361 Document domainnote in manpages
martin f. krafft <madduck@madduck.net>
parents: 540
diff changeset
   492
Example:
47254b46c361 Document domainnote in manpages
martin f. krafft <madduck@madduck.net>
parents: 540
diff changeset
   493
.PP
47254b46c361 Document domainnote in manpages
martin f. krafft <madduck@madduck.net>
parents: 540
diff changeset
   494
.nf
47254b46c361 Document domainnote in manpages
martin f. krafft <madduck@madduck.net>
parents: 540
diff changeset
   495
.B vmm do example.com Belongs to Robert
47254b46c361 Document domainnote in manpages
martin f. krafft <madduck@madduck.net>
parents: 540
diff changeset
   496
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   497
.\" -----------------------------------------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   498
.SH ALIAS DOMAIN SUBCOMMANDS
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   499
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
   500
subcommand
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   501
.BR domainadd .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   502
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
   503
available in the alias domain.
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   504
.br
475
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   505
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
   506
example.com.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   507
.PP
475
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   508
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
   509
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
   510
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
   511
users.
22
576a4709a44f * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 21
diff changeset
   512
.br
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   513
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
   514
queries in your
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   515
.I $config_directory/pgsql\-*.cf
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   516
configuration files.
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 aliasdomainadd (ada)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   519
.BI "vmm aliasdomainadd" " fqdn destination"
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   520
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   521
This subcommand adds the new alias domain
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   522
.RI ( fqdn )
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   523
to the
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   524
.I destination
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   525
domain that should be aliased.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   526
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   527
Example:
57
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   528
.PP
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   529
.nf
475
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   530
.B vmm aliasdomainadd example.net example.com
57
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   531
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   532
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   533
.SS aliasdomaindelete (add)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   534
.BI "vmm aliasdomaindelete" " fqdn"
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   535
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   536
Use this subcommand if the alias domain
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   537
.I fqdn
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   538
should be removed.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   539
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   540
Example:
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
.nf
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   543
.B vmm aliasdomaindelete e.g.example.com
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   544
.fi
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   545
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   546
.SS aliasdomaininfo (adi)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   547
.BI "vmm aliasdomaininfo" " fqdn"
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   548
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   549
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
   550
.I fqdn
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   551
is assigned to.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   552
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   553
Example:
57
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   554
.PP
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   555
.nf
475
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   556
.B vmm adi example.net
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   557
Alias domain information
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   558
------------------------
475
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   559
        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
   560
            * example.com
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   561
.fi
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   562
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   563
.SS aliasdomainswitch (ads)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   564
.BI "vmm aliasdomainswitch" " fqdn destination"
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   565
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   566
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
   567
.I fqdn
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   568
should be switched to another
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   569
.I destination
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   570
use this subcommand.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   571
.nf
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   572
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   573
Example:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   574
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   575
.B vmm aliasdomainswitch example.name example.org
57
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   576
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   577
.\" -----------------------------------------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   578
.SH ACCOUNT SUBCOMMANDS
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   579
.SS useradd (ua)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   580
.B vmm useradd
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   581
.IR address " [" password ]
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   582
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   583
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
   584
.IR address .
79
0ae7597eed11 * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 66
diff changeset
   585
.PP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   586
If the
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   587
.I password
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   588
is not provided,
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   589
.B vmm
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   590
will prompt for it interactively.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   591
When no
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   592
.I password
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   593
is provided and
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   594
.I account.random_password
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   595
is set to
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   596
.BR true ", " vmm
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   597
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
   598
has been created.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   599
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   600
Examples:
57
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   601
.PP
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   602
.nf
416
f32b323fd347 man: Replaced unnecessary \(aq glyphs in man1/vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 411
diff changeset
   603
.B vmm ua d.user@example.com \(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
   604
.B vmm useradd e.user@example.com
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   605
Enter new password:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   606
Retype new password:
57
38c42e09677a * 'man/de/man1/vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 37
diff changeset
   607
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   608
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   609
.SS userdelete (ud)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   610
.BI "vmm userdelete" " address"
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   611
.RB [ force ]
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   612
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   613
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
   614
.IR address .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   615
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   616
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
   617
.B vmm
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   618
will abort the requested operation and show an error message.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   619
To prevent this, specify the optional keyword
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   620
.BR force .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   621
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   622
.SS userinfo (ui)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   623
.B "vmm userinfo"
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   624
.IR address " [" details ]
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   625
.PP
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   626
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
   627
.IR address .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   628
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   629
If the optional argument
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   630
.I details
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   631
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
   632
Possible values for
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   633
.I details
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   634
are:
90
1734eb5101c6 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 81
diff changeset
   635
.RS
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   636
.TP 8
90
1734eb5101c6 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 81
diff changeset
   637
.B aliases
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   638
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
   639
.I address
90
1734eb5101c6 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 81
diff changeset
   640
.TP
1734eb5101c6 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 81
diff changeset
   641
.B du
416
f32b323fd347 man: Replaced unnecessary \(aq glyphs in man1/vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 411
diff changeset
   642
to display the disk usage of the user's mail directory.
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   643
In order to summarize the disk usage each time the this subcommand is
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   644
executed automatically, set
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   645
.I account.disk_usage
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   646
in your
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   647
.I vmm.cfg
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   648
to
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   649
.BR true .
90
1734eb5101c6 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 81
diff changeset
   650
.TP
1734eb5101c6 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 81
diff changeset
   651
.B full
1734eb5101c6 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 81
diff changeset
   652
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
   653
.RE
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   654
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   655
Example:
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   656
.PP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   657
.nf
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   658
.B vmm ui d.user@example.com
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   659
Account information
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   660
-------------------
475
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   661
        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
   662
        Name.............: None
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   663
        UID..............: 79881
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   664
        GID..............: 70704
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   665
        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
   666
        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
   667
        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
   668
        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
   669
        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
   670
        SMTP.............: disabled
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   671
        POP3.............: disabled
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   672
        IMAP.............: enabled
e321b764268e man1: Copied new formatted/translated command output into the examples.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 473
diff changeset
   673
        SIEVE............: enabled
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   674
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   675
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   676
.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
   677
.BI "vmm username" " address"
9a23043b0530 man: vmm.1: subcommand's name argument is optional now.
Pascal Volk <user@localhost.localdomain.org>
parents: 536
diff changeset
   678
.RI [ name ]
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   679
.PP
416
f32b323fd347 man: Replaced unnecessary \(aq glyphs in man1/vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 411
diff changeset
   680
The user's real
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   681
.I name
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   682
can be set/updated with this subcommand.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   683
.PP
536
c340ba4bd544 Allow username to take no argument to erase value
martin f. krafft <madduck@madduck.net>
parents: 534
diff changeset
   684
If no
c340ba4bd544 Allow username to take no argument to erase value
martin f. krafft <madduck@madduck.net>
parents: 534
diff changeset
   685
.I name
c340ba4bd544 Allow username to take no argument to erase value
martin f. krafft <madduck@madduck.net>
parents: 534
diff changeset
   686
is given, the value stored for the account is erased.
c340ba4bd544 Allow username to take no argument to erase value
martin f. krafft <madduck@madduck.net>
parents: 534
diff changeset
   687
.PP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   688
Example:
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   689
.PP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   690
.nf
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   691
.B vmm un d.user@example.com \(dqJohn Doe\(dq
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   692
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   693
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   694
.SS userpassword (up)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   695
.BI "vmm userpassword" " address"
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   696
.RI [ password ]
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   697
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   698
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
   699
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   700
If no
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   701
.I password
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   702
was provided,
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   703
.B vmm
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   704
will prompt for it interactively.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   705
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   706
Example:
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   707
.PP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   708
.nf
416
f32b323fd347 man: Replaced unnecessary \(aq glyphs in man1/vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 411
diff changeset
   709
.B vmm up d.user@example.com \(dqA |\(rs/|0r3 5ecur3 P4s5\(rs/\(rs/0rd?\(dq
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   710
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   711
.\" ------------------------------------
540
a8ee0328f908 Add user/domainnote commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 537
diff changeset
   712
.SS usernote (uo)
a8ee0328f908 Add user/domainnote commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 537
diff changeset
   713
.BI "vmm usernote" " address"
a8ee0328f908 Add user/domainnote commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 537
diff changeset
   714
.RI [ note ]
a8ee0328f908 Add user/domainnote commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 537
diff changeset
   715
.PP
a8ee0328f908 Add user/domainnote commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 537
diff changeset
   716
With this subcommand, it is possible to attach a note to the specified
a8ee0328f908 Add user/domainnote commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 537
diff changeset
   717
account. Without an argument, an existing note is removed.
a8ee0328f908 Add user/domainnote commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 537
diff changeset
   718
.PP
a8ee0328f908 Add user/domainnote commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 537
diff changeset
   719
Example:
a8ee0328f908 Add user/domainnote commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 537
diff changeset
   720
.PP
a8ee0328f908 Add user/domainnote commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 537
diff changeset
   721
.nf
a8ee0328f908 Add user/domainnote commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 537
diff changeset
   722
.B vmm uo d.user@example.com Only needed until end of May 2012
a8ee0328f908 Add user/domainnote commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 537
diff changeset
   723
.fi
a8ee0328f908 Add user/domainnote commands to manpages
martin f. krafft <madduck@madduck.net>
parents: 537
diff changeset
   724
.\" ------------------------------------
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   725
.SS userquota (uq)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   726
.BI "vmm userquota" " address storage"
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   727
.RI [ messages ]
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   728
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   729
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
   730
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   731
When the argument
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   732
.I messages
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   733
was omitted the default number of messages
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   734
.B 0
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   735
(zero) will be applied.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   736
.PP
533
2676dbf43e1c Change UI to accept 'default' to restore inherited values
martin f. krafft <madduck@madduck.net>
parents: 529
diff changeset
   737
Instead of
2676dbf43e1c Change UI to accept 'default' to restore inherited values
martin f. krafft <madduck@madduck.net>
parents: 529
diff changeset
   738
.I transport
565
a75923ce2842 VMM/cli/subcommands: Replaced the keyword `default' by `domain'.
Pascal Volk <user@localhost.localdomain.org>
parents: 554
diff changeset
   739
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
   740
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
   741
.PP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   742
Example:
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   743
.PP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   744
.nf
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   745
.B vmm userquota d.user@example.com 750m
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   746
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   747
.\" ------------------------------------
473
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   748
.SS userservices (us)
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   749
.B vmm userservices
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   750
.IR address " [" "service ..." ]
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   751
.PP
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   752
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
   753
.PP
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   754
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
   755
given
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   756
.IR address .
529
916b468cf994 man: Add examples for userservices
martin f. krafft <madduck@madduck.net>
parents: 520
diff changeset
   757
.PP
533
2676dbf43e1c Change UI to accept 'default' to restore inherited values
martin f. krafft <madduck@madduck.net>
parents: 529
diff changeset
   758
Instead of
2676dbf43e1c Change UI to accept 'default' to restore inherited values
martin f. krafft <madduck@madduck.net>
parents: 529
diff changeset
   759
.I transport
565
a75923ce2842 VMM/cli/subcommands: Replaced the keyword `default' by `domain'.
Pascal Volk <user@localhost.localdomain.org>
parents: 554
diff changeset
   760
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
   761
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
   762
.PP
529
916b468cf994 man: Add examples for userservices
martin f. krafft <madduck@madduck.net>
parents: 520
diff changeset
   763
Example:
574
9acf628bf0be man: Deleted erroneous placed backslash.
Pascal Volk <user@localhost.localdomain.org>
parents: 565
diff changeset
   764
.PP
529
916b468cf994 man: Add examples for userservices
martin f. krafft <madduck@madduck.net>
parents: 520
diff changeset
   765
.nf
916b468cf994 man: Add examples for userservices
martin f. krafft <madduck@madduck.net>
parents: 520
diff changeset
   766
.B vmm userservices d.user@example.com SMTP IMAP
473
9b9cccebccf0 man1: Removed obsolete commands and added new commands.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 432
diff changeset
   767
.\" ------------------------------------
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   768
.SS usertransport (ut)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   769
.BI "vmm usertransport" " address transport"
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   770
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   771
A different
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   772
.I transport
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   773
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
   774
.PP
533
2676dbf43e1c Change UI to accept 'default' to restore inherited values
martin f. krafft <madduck@madduck.net>
parents: 529
diff changeset
   775
Instead of
2676dbf43e1c Change UI to accept 'default' to restore inherited values
martin f. krafft <madduck@madduck.net>
parents: 529
diff changeset
   776
.I transport
565
a75923ce2842 VMM/cli/subcommands: Replaced the keyword `default' by `domain'.
Pascal Volk <user@localhost.localdomain.org>
parents: 554
diff changeset
   777
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
   778
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
   779
.PP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   780
Example:
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   781
.br
416
f32b323fd347 man: Replaced unnecessary \(aq glyphs in man1/vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 411
diff changeset
   782
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
   783
.BR dsync (1)
416
f32b323fd347 man: Replaced unnecessary \(aq glyphs in man1/vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 411
diff changeset
   784
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
   785
can tell Postfix to retry later.
66
995d538a6eb5 * 'VirtualMailManager/Account.py'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 64
diff changeset
   786
.PP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   787
.nf
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   788
.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
   789
# 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
   790
.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
   791
.fi
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   792
.\" -----------------------------------------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   793
.SH ALIAS SUBCOMMANDS
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   794
.SS aliasadd (aa)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   795
.BI "vmm aliasadd" " address destination ..."
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   796
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   797
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
   798
.I address
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   799
with one or more
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   800
.I destination
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   801
addresses.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   802
.PP
518
5ec2068d02af Enable interpolation of alias destinations
martin f. krafft <madduck@madduck.net>
parents: 516
diff changeset
   803
Within the destination address, the placeholders
5ec2068d02af Enable interpolation of alias destinations
martin f. krafft <madduck@madduck.net>
parents: 516
diff changeset
   804
.IR %n ,
5ec2068d02af Enable interpolation of alias destinations
martin f. krafft <madduck@madduck.net>
parents: 516
diff changeset
   805
.IR %d ,
5ec2068d02af Enable interpolation of alias destinations
martin f. krafft <madduck@madduck.net>
parents: 516
diff changeset
   806
and
5ec2068d02af Enable interpolation of alias destinations
martin f. krafft <madduck@madduck.net>
parents: 516
diff changeset
   807
.IR %=
5ec2068d02af Enable interpolation of alias destinations
martin f. krafft <madduck@madduck.net>
parents: 516
diff changeset
   808
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
   809
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
   810
domain\-specific destinations.
518
5ec2068d02af Enable interpolation of alias destinations
martin f. krafft <madduck@madduck.net>
parents: 516
diff changeset
   811
.PP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   812
Examples:
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   813
.PP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   814
.nf
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   815
.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
   816
.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
   817
.B vmm aa postmaster@example.com postmaster+%d@example.org
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   818
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   819
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   820
.SS aliasdelete (ad)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   821
.BI "vmm aliasdelete" " address"
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   822
.RI [ destination ]
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   823
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   824
Use this subcommand to delete the alias with the given
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   825
.IR address .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   826
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   827
If the optional
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   828
.I destination
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   829
address is given, only this
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   830
destination will be removed from the alias.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   831
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   832
Example:
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   833
.PP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   834
.nf
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   835
.B vmm ad support@example.com d.user@example.com
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   836
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   837
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   838
.SS aliasinfo (ai)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   839
.BI "vmm aliasinfo" " address"
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   840
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   841
Information about the alias with the given
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   842
.I address
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   843
can be displayed with this subcommand.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   844
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   845
Example:
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   846
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   847
.nf
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   848
.B vmm aliasinfo support@example.com
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   849
Alias information
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   850
-----------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   851
        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
   852
             * e.user@example.com
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   853
.fi
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   854
.\" -----------------------------------------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   855
.SH RELOCATED SUBCOMMANDS
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   856
.SS relocatedadd (ra)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   857
.BI "vmm relocatedadd" " address newaddress"
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   858
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   859
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
   860
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   861
.I address
416
f32b323fd347 man: Replaced unnecessary \(aq glyphs in man1/vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 411
diff changeset
   862
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
   863
.I newaddress
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   864
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
   865
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   866
Example:
23
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   867
.PP
d5ad5432e9eb * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 22
diff changeset
   868
.nf
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   869
.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
   870
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   871
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   872
.SS relocatedinfo (ri)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   873
.BI "vmm relocatedinfo " address
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   874
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   875
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
   876
.IR address .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   877
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   878
Example:
81
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   879
.PP
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   880
.nf
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   881
.B vmm relocatedinfo b.user@example.com
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   882
Relocated information
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   883
---------------------
416
f32b323fd347 man: Replaced unnecessary \(aq glyphs in man1/vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 411
diff changeset
   884
        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
   885
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   886
.\" ------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   887
.SS relocateddelete (rd)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   888
.BI "vmm relocateddelete " address
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   889
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   890
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
   891
.IR address .
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   892
.PP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   893
Example:
81
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   894
.PP
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   895
.nf
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   896
.B vmm relocateddelete b.user@example.com
81
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   897
.fi
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   898
.\" -----------------------------------------------------------------------
554
a93671970617 man: escape hyphens
martin f. krafft <madduck@madduck.net>
parents: 553
diff changeset
   899
.SH CATCH\-ALL SUBCOMMANDS
516
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
   900
.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
   901
.BI "vmm catchalladd" " fqdn destination ..."
516
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
   902
.PP
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
   903
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
   904
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
   905
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
   906
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
   907
.PP
554
a93671970617 man: escape hyphens
martin f. krafft <madduck@madduck.net>
parents: 553
diff changeset
   908
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
   909
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
   910
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
   911
.PP
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
   912
Example:
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
   913
.PP
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
   914
.nf
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
   915
.B vmm catchalladd example.com user@example.org
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
   916
.fi
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
   917
.\" ------------------------------------
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
   918
.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
   919
.BI "vmm catchallinfo " fqdn
516
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
   920
.PP
554
a93671970617 man: escape hyphens
martin f. krafft <madduck@madduck.net>
parents: 553
diff changeset
   921
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
   922
a domain.
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
   923
.PP
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
   924
Example:
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
   925
.PP
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
   926
.nf
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
   927
.B vmm catchallinfo example.com
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
   928
Catch-all information
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
   929
---------------------
520
a0a27688e616 man: Use example.com in catchallinfo example output.
Pascal Volk <user@localhost.localdomain.org>
parents: 518
diff changeset
   930
  Mail to unknown localparts 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
   931
         * user@example.org
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
   932
.fi
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
   933
.\" ------------------------------------
552
107f7a3be9f5 man: vmm1: Use `fqdn' instead of `domain' in catchall* descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 545
diff changeset
   934
.SS catchalldelete (cad)
107f7a3be9f5 man: vmm1: Use `fqdn' instead of `domain' in catchall* descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 545
diff changeset
   935
.BI "vmm catchalldelete " fqdn
516
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
   936
.RI [ destination ]
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
   937
.PP
554
a93671970617 man: escape hyphens
martin f. krafft <madduck@madduck.net>
parents: 553
diff changeset
   938
With this subcommand, catch\-all aliases defined for a domain can be
552
107f7a3be9f5 man: vmm1: Use `fqdn' instead of `domain' in catchall* descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 545
diff changeset
   939
removed, either all of them, or a single one if specified explicitly.
516
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
   940
.PP
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
   941
Example:
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
   942
.PP
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
   943
.nf
552
107f7a3be9f5 man: vmm1: Use `fqdn' instead of `domain' in catchall* descriptions.
Pascal Volk <user@localhost.localdomain.org>
parents: 545
diff changeset
   944
.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
   945
.fi
b2084e7f6854 Add catchall subcommands to manpages
martin f. krafft <madduck@madduck.net>
parents: 479
diff changeset
   946
.\" -----------------------------------------------------------------------
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   947
.SH FILES
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   948
.TP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   949
.I /root/vmm.cfg
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   950
will be used when found.
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   951
.TP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   952
.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
   953
will be used when the above file doesn't exist.
81
89b71a9abfcf * 'install.sh'
Pascal Volk <neverseen@users.sourceforge.net>
parents: 79
diff changeset
   954
.TP
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   955
.I /etc/vmm.cfg
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   956
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
   957
.\" -----------------------------------------------------------------------
21
6feb31787a66 * 'vmm.1'
Pascal Volk <neverseen@users.sourceforge.net>
parents:
diff changeset
   958
.SH SEE ALSO
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   959
.BR dsync (1),
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   960
.BR transport (5),
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   961
.BR vmm.cfg (5)
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   962
.\" -----------------------------------------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   963
.SH INTERNET RESOURCES
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   964
.TP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   965
Wiki
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   966
http://vmm.localdomain.org/
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   967
.TP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   968
Project site
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   969
http://sf.net/projects/vmm/
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   970
.TP
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   971
Bug tracker
477
86fa217cba11 man: Updated the URL of the bug tracker.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 475
diff changeset
   972
https://bitbucket.org/pvo/vmm/issues
410
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   973
.\" -----------------------------------------------------------------------
2bc9c36c1387 man/man1: Reworked/updated vmm.1.
Pascal Volk <neverseen@users.sourceforge.net>
parents: 162
diff changeset
   974
.SH COPYING
478
6278a7a2a476 Updated the author's e-mail address.
Pascal Volk <user@localhost.localdomain.org>
parents: 477
diff changeset
   975
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
   976
localhost.localdomain.org> and are licensed under the terms of the BSD
553
6f2c41c3c7d6 man: add 'catchall' to domaininfo
martin f. krafft <madduck@madduck.net>
parents: 552
diff changeset
   977
License.