VirtualMailManager/cli/clihelp.py
author Pascal Volk <user@localhost.localdomain.org>
Thu, 27 Sep 2012 20:20:49 +0000
changeset 620 ca882a1ff90b
parent 618 d8736bb80bdc
child 621 d8b60e53334f
permissions -rw-r--r--
po: Updated Dutch translation (translated by Erwin Poeze).
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     1
# -*- coding: UTF-8 -*-
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     2
# Copyright (c) 2012, Pascal Volk
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     3
# See COPYING for distribution information.
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     4
"""
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     5
    VirtualMailManager.cli.vmmhelp
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     6
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     7
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     8
    Virtual Mail Manager's command line help.
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     9
"""
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    10
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    11
_ = lambda msg: msg
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    12
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
    13
help_msgs = {
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
    14
# TP: There are some words enclosed within angle brackets '<'word'>'. They
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
    15
# are used to indicate replaceable arguments. Please do not translate them.
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
    16
#
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
    17
# The descriptions of subcommands may contain the both keywords 'domain'
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
    18
# and 'force', enclosed within single quotes. Please keep them as they are.
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
    19
#
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
    20
    # TP: description of subcommand configget
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
    21
    'configget': (_(u"""This subcommand is used to display the actual value
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
    22
of the given configuration <option>."""),),
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
    23
    # TP: description of subcommand configset
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    24
    'configset': (_(u"""Use this subcommand to set or update a single
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    25
configuration option's value. <option> is the configuration option, <value>
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    26
is the <option>'s new value."""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    27
_(u"""Note: This subcommand will create a new vmm.cfg without any comments.
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    28
Your current configuration file will be backed as vmm.cfg.bak."""),),
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
    29
    # TP: description of subcommand configure
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    30
    'configure': (_(u"""Starts the interactive configuration for all
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    31
configuration sections."""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    32
_(u"""In this process the currently set value of each option will be displayed
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    33
in square brackets. If no value is configured, the default value of each
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    34
option will be displayed in square brackets. Press the return key, to accept
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    35
the displayed value."""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    36
_(u"""If the optional argument <section> is given, only the configuration
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    37
options from the given section will be displayed and will be configurable.
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    38
The following sections are available:
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    39
"""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    40
"""    account, bin, database, domain, mailbox, misc""",
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    41
_(u"""All configuration options are described in vmm.cfg(5)."""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    42
_(u"""Note: This subcommand will create a new vmm.cfg without any comments.
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    43
Your current configuration file will be backed as vmm.cfg.bak."""),),
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
    44
    # TP: description of subcommand getuser
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    45
    'getuser': (_(u"""If only the <uid> is available, for example from process
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    46
list, the subcommand getuser will show the user's address."""),),
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
    47
    # TP: description of subcommand listdomains
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    48
    'listdomains': (_(u"""This subcommand lists all available domains. All
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    49
domain names will be prefixed either with `[+]', if the domain is a primary
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    50
domain, or with `[-]', if it is an alias domain name. The output can be
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    51
limited with an optional <pattern>."""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    52
_(u"""To perform a wild card search, the % character can be used at the start
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    53
and/or the end of the <pattern>."""),),
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
    54
    # TP: description of subcommand listpwschemes
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    55
    'listpwschemes': (_(u"""This subcommand lists all password schemes which
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    56
could be used in the vmm.cfg as value of the misc.password_scheme option.
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    57
The output varies, depending on the used Dovecot version and the system's
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    58
libc."""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    59
_(u"""When your Dovecot installation isn't too old, you will see additionally
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    60
a few usable encoding suffixes. One of them can be appended to the password
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    61
scheme."""),),
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
    62
    # TP: description of subcommand version
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    63
    'version': (_(u"""Prints vmm's version and copyright information to stdout.
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    64
After this vmm exits."""),),
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
    65
    # TP: description of subcommand domainadd
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    66
    'domainadd': (_(u"""Adds the new domain into the database and creates the
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    67
domain directory."""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    68
_(u"""If the optional argument <transport> is given, it will override the
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    69
default transport (domain.transport) from vmm.cfg. The specified <transport>
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    70
will be the default transport for all new accounts in this domain."""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    71
_(u"""Configuration-related behavior:"""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    72
u""" * domain.auto_postmaster""",
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    73
_(u"""When that option is set to true (default) vmm will automatically create
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    74
the postmaster account for the new domain and prompt for postmaster@<fqdn>'s
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    75
password."""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    76
u""" * account.random_password""",
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    77
_(u"""When the value of that option is also set to true, vmm will automatically
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    78
create the postmaster account for the new domain and print the generated
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    79
postmaster password to stdout."""),),
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
    80
    # TP: description of subcommand domaindelete
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    81
    'domaindelete': (_(u"""This subcommand deletes the domain specified by
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    82
<fqdn>."""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    83
_(u"""If there are accounts, aliases and/or relocated users assigned to the
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    84
given domain, vmm will abort the requested operation and show an error
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    85
message. If you know, what you are doing, you can specify the optional keyword
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    86
'force'."""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    87
_(u"""If you really always know what you are doing, edit your vmm.cfg and set
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    88
the option domain.force_deletion to true."""),),
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
    89
    # TP: description of subcommand domaininfo
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    90
    'domaininfo': (_(u"""This subcommand shows some information about the
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    91
given domain."""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    92
_(u"""For a more detailed information about the domain the optional argument
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    93
<details> can be specified. A possible <details> value can be one of the
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    94
following six keywords:"""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    95
"""    accounts, aliasdomains, aliases, catchall, relocated, full""",),
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
    96
    # TP: description of subcommand domainquota
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    97
    'domainquota': (_(u"""This subcommand is used to configure a new quota
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    98
limit for the accounts of the domain - not for the domain itself."""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    99
_(u"""The default quota limit for accounts is defined in the vmm.cfg
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   100
(domain.quota_bytes and domain.quota_messages)."""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   101
_(u"""The new quota limit will affect only those accounts for which the limit
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   102
has not been overridden. If you want to restore the default to all accounts,
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   103
you may pass the keyword 'force'. When the argument <messages> was omitted the
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   104
default number of messages 0 (zero) will be applied."""),),
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
   105
    # TP: description of subcommand domainservices
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   106
    'domainservices': (_(u"""To define which services could be used by the
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   107
users of the domain — with the given <fqdn> — use this subcommand."""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   108
_(u"""Each specified <service> will be enabled/usable. All other services
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   109
will be deactivated/unusable. Possible <service> names are:"""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   110
u"""    imap, pop3, sieve, smtp""",
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   111
_(u"""The new service set will affect only those accounts for which the set has
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   112
not been overridden. If you want to restore the default to all accounts, you
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   113
may pass the keyword 'force'."""),),
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
   114
    # TP: description of subcommand domaintransport
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   115
    'domaintransport': (_(u"""A new transport for the indicated domain can be
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   116
set with this subcommand."""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   117
_(u"""The new transport will affect only those accounts for which the transport
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   118
has not been overridden. If you want to restore the default to all accounts,
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   119
you may pass the keyword 'force'."""),),
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
   120
    # TP: description of subcommand domainnote
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   121
    'domainnote': (_(u"""With this subcommand, it is possible to attach a
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   122
note to the specified domain. Without an argument, an existing note is
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   123
removed."""),),
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
   124
    # TP: description of subcommand aliasdomainadd
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   125
    'aliasdomainadd': (_(u"""This subcommand adds the new alias domain
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   126
(<fqdn>) to the destination <domain> that should be aliased."""),),
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
   127
    # TP: description of subcommand aliasdomaindelete
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   128
    'aliasdomaindelete': (_(u"""Use this subcommand if the alias domain
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   129
<fqdn> should be removed."""),),
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
   130
    # TP: description of subcommand aliasdomaininfo
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   131
    'aliasdomaininfo': (_(u"""This subcommand shows to which domain the alias
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   132
domain <fqdn> is assigned to."""),),
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
   133
    # TP: description of subcommand aliasdomainswitch
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   134
    'aliasdomainswitch': (_(u"""If the destination of the existing alias
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   135
domain <fqdn> should be switched to another <destination> use this
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   136
subcommand."""),),
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
   137
    # TP: description of subcommand useradd
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   138
    'useradd': (_(u"""Use this subcommand to create a new e-mail account for
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   139
the given <address>."""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   140
_(u"""If the <password> is not provided, vmm will prompt for it interactively.
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   141
When no <password> is provided and account.random_password is set to true, vmm
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   142
will generate a random password and print it to stdout after the account has
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   143
been created."""),),
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
   144
    # TP: description of subcommand userdelete
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   145
    'userdelete': (_(u"""Use this subcommand to delete the account with the
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   146
given <address>."""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   147
_(u"""If there are one or more aliases with an identical destination address,
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   148
vmm will abort the requested operation and show an error message. To prevent
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   149
this, specify the optional keyword 'force'."""),),
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
   150
    # TP: description of subcommand userinfo
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   151
    'userinfo': (_(u"""This subcommand displays some information about the
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   152
account specified by <address>."""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   153
_(u"""If the optional argument <details> is given some more information will be
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   154
displayed. Possible values for <details> are:"""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   155
u"""    aliases, du. full""",),
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
   156
    # TP: description of subcommand username
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   157
    'username': (_(u"""The user's real <name> can be set/updated with this
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   158
subcommand."""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   159
_(u"""If no <name> is given, the value stored for the account is erased."""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   160
),
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
   161
    # TP: description of subcommand userpassword
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   162
    'userpassword': (_(u"""The password of an account can be updated with this
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   163
subcommand."""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   164
_(u"""If no <password> was provided, vmm will prompt for it interactively."""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   165
),
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
   166
    # TP: description of subcommand usernote
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   167
    'usernote': (_(u"""With this subcommand, it is possible to attach a note
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   168
to the specified account. Without an argument, an existing note is
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   169
removed."""),),
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
   170
    # TP: description of subcommand userquota
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   171
    'userquota': (_(u"""This subcommand is used to set a new quota limit for
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   172
the given account."""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   173
_(u"""When the argument <messages> was omitted the default number of messages
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   174
0 (zero) will be applied."""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   175
_(u"""Instead of <storage> pass the keyword 'domain' to remove the
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   176
account-specific override, causing the domain's value to be in effect."""),),
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
   177
    # TP: description of subcommand userservices
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   178
    'userservices': (_(u"""To grant a user access to the specified services,
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   179
use this command."""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   180
_(u"""All omitted services will be deactivated/unusable for the user with the
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   181
given <address>."""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   182
_(u"""Instead of <service> pass 'domain' to remove the account-specific
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   183
override, causing the domain's value to be in effect."""),),
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
   184
    # TP: description of subcommand usertransport
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   185
    'usertransport': (_(u"""A different <transport> for an account can be
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   186
specified with this subcommand."""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   187
_(u"""Instead of <transport> pass 'domain' to remove the account-specific
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   188
override, causing the domain's value to be in effect."""),),
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
   189
    # TP: description of subcommand aliasadd
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   190
    'aliasadd': (_(u"""This subcommand is used to create a new alias
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   191
<address> with one or more <destination> addresses."""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   192
_(u"""Within the destination address, the placeholders '%n', '%d', and '%='
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   193
will be replaced by the local part, the domain, or the email address with '@'
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   194
replaced by '=' respectively. In combination with alias domains, this enables
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   195
domain-specific destinations."""),),
618
d8736bb80bdc VMM: {alias,catchall}delete: Accept multiple destinations.
Pascal Volk <user@localhost.localdomain.org>
parents: 609
diff changeset
   196
    # TP: description of subcommand aliasdelete
d8736bb80bdc VMM: {alias,catchall}delete: Accept multiple destinations.
Pascal Volk <user@localhost.localdomain.org>
parents: 609
diff changeset
   197
    'aliasdelete': (_(u"""This subcommand is used to delete one or multiple
d8736bb80bdc VMM: {alias,catchall}delete: Accept multiple destinations.
Pascal Volk <user@localhost.localdomain.org>
parents: 609
diff changeset
   198
<destination>s from the alias with the given <address>."""),
d8736bb80bdc VMM: {alias,catchall}delete: Accept multiple destinations.
Pascal Volk <user@localhost.localdomain.org>
parents: 609
diff changeset
   199
_(u"""When no <destination> address was specified the alias with all its
d8736bb80bdc VMM: {alias,catchall}delete: Accept multiple destinations.
Pascal Volk <user@localhost.localdomain.org>
parents: 609
diff changeset
   200
destinations will be deleted."""),),
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
   201
    # TP: description of subcommand aliasinfo
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   202
    'aliasinfo': (_(u"""Information about the alias with the given <address>
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   203
can be displayed with this subcommand."""),),
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
   204
    # TP: description of subcommand relocatedadd
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   205
    'relocatedadd': (_(u"""A new relocated user can be created with this
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   206
subcommand."""),
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   207
_(u"""<address> is the user's ex-email address, for example
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   208
b.user@example.com, and <newaddress> points to the new email address where
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   209
the user can be reached."""),),
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
   210
    # TP: description of subcommand relocatedinfo
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   211
    'relocatedinfo': (_(u"""This subcommand shows the new address of the
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   212
relocated user with the given <address>."""),),
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
   213
    # TP: description of subcommand relocateddelete
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   214
    'relocateddelete': (_(u"""Use this subcommand in order to delete the
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   215
relocated user with the given <address>."""),),
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
   216
    # TP: description of subcommand catchalladd
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   217
    'catchalladd': (_(u"""This subcommand allows to specify destination
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   218
addresses for a domain, which shall receive mail addressed to unknown
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   219
local-parts within that domain. Those catch-all aliases hence "catch all" mail
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   220
to any address in the domain (unless a more specific alias, mailbox or
608
0ed93eb8b364 VMM: Corrected/updated some msgids.
Pascal Volk <user@localhost.localdomain.org>
parents: 606
diff changeset
   221
relocated user exists)."""),
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   222
_(u"""WARNING: Catch-all addresses can cause mail server flooding because
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   223
spammers like to deliver mail to all possible combinations of names, e.g.
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   224
to all addresses between abba@example.org and zztop@example.org."""),),
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
   225
    # TP: description of subcommand catchallinfo
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   226
    'catchallinfo': (_(u"""This subcommand displays information about catch-all
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   227
aliases defined for the domain <fqdn>."""),),
609
56ec275911f2 Added a few comments for the Translation Project.
Pascal Volk <user@localhost.localdomain.org>
parents: 608
diff changeset
   228
    # TP: description of subcommand catchalldelete
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   229
    'catchalldelete': (_(u"""With this subcommand, catch-all aliases defined
618
d8736bb80bdc VMM: {alias,catchall}delete: Accept multiple destinations.
Pascal Volk <user@localhost.localdomain.org>
parents: 609
diff changeset
   230
for a domain can be removed, either all of them, or those <destination>s which
d8736bb80bdc VMM: {alias,catchall}delete: Accept multiple destinations.
Pascal Volk <user@localhost.localdomain.org>
parents: 609
diff changeset
   231
were specified explicitly."""),),
606
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   232
}
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   233
ab97727357a4 VMM/cli: Activated help subcommand.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
   234
del _