1 # -*- coding: UTF-8 -*-

     2 # Copyright (c) 2012, Pascal Volk

     3 # See COPYING for distribution information.

     4 """

     5     VirtualMailManager.cli.vmmhelp

     6     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

     7 

     8     Virtual Mail Manager's command line help.

     9 """

    10 

    11 _ = lambda msg: msg

    12 

    13 help_msgs = {

    14 # TP: There are some words enclosed within angle brackets '<'word'>'. They

    15 # are used to indicate replaceable arguments. Please do not translate them.

    16 #

    17 # The descriptions of subcommands may contain the both keywords 'domain'

    18 # and 'force', enclosed within single quotes. Please keep them as they are.

    19 #

    20     # TP: description of subcommand configget

    21     'configget': (_("""This subcommand is used to display the actual value

    22 of the given configuration <option>."""),),

    23     # TP: description of subcommand configset

    24     'configset': (_("""Use this subcommand to set or update a single

    25 configuration option's value. <option> is the configuration option, <value>

    26 is the <option>'s new value."""),

    27 _("""Note: This subcommand will create a new vmm.cfg without any comments.

    28 Your current configuration file will be backed as vmm.cfg.bak."""),),

    29     # TP: description of subcommand configure

    30     'configure': (_("""Starts the interactive configuration for all

    31 configuration sections."""),

    32 _("""In this process the currently set value of each option will be displayed

    33 in square brackets. If no value is configured, the default value of each

    34 option will be displayed in square brackets. Press the return key, to accept

    35 the displayed value."""),

    36 _("""If the optional argument <section> is given, only the configuration

    37 options from the given section will be displayed and will be configurable.

    38 The following sections are available:

    39 """),

    40 """    account, bin, database, domain, mailbox, misc""",

    41 _("""All configuration options are described in vmm.cfg(5)."""),

    42 _("""Note: This subcommand will create a new vmm.cfg without any comments.

    43 Your current configuration file will be backed as vmm.cfg.bak."""),),

    44     # TP: description of subcommand getuser

    45     'getuser': (_("""If only the <uid> is available, for example from process

    46 list, the subcommand getuser will show the user's address."""),),

    47     # TP: description of subcommand listaddresses

    48     'listaddresses': (_("""This command lists all defined addresses.

    49 Addresses belonging to alias-domains are prefixed with a '-', addresses of

    50 regular domains with a '+'. Additionally, the letters 'u', 'a', and 'r'

    51 indicate the type of each address: user, alias and relocated respectively.

    52 The output can be limited with an optional <pattern>."""),

    53 _("""To perform a wild card search, the % character can be used at the start

    54 and/or the end of the <pattern>."""),),

    55     # TP: description of subcommand listaliases

    56     'listaliases': (_("""This command lists all defined aliases. Aliases

    57 belonging to alias-domains are prefixed with a '-', addresses of regular

    58 domains with a '+'. The output can be limited with an optional <pattern>."""),

    59 _("""To perform a wild card search, the % character can be used at the start

    60 and/or the end of the <pattern>."""),),

    61     # TP: description of subcommand listdomains

    62     'listdomains': (_("""This subcommand lists all available domains. All

    63 domain names will be prefixed either with `[+]', if the domain is a primary

    64 domain, or with `[-]', if it is an alias domain name. The output can be

    65 limited with an optional <pattern>."""),

    66 _("""To perform a wild card search, the % character can be used at the start

    67 and/or the end of the <pattern>."""),),

    68     # TP: description of subcommand listpwschemes

    69     'listpwschemes': (_("""This subcommand lists all password schemes which

    70 could be used in the vmm.cfg as value of the misc.password_scheme option.

    71 The output varies, depending on the used Dovecot version and the system's

    72 libc."""),

    73 _("""When your Dovecot installation isn't too old, you will see additionally

    74 a few usable encoding suffixes. One of them can be appended to the password

    75 scheme."""),),

    76     # TP: description of subcommand listrelocated

    77     'listrelocated': (_("""This command lists all defined relocated addresses.

    78 Relocated entries belonging to alias-domains are prefixed with a '-', addresses

    79 of regular domains with a '+'. The output can be limited with an optional

    80 <pattern>."""),

    81 _("""To perform a wild card search, the % character can be used at the start

    82 and/or the end of the <pattern>."""),),

    83     # TP: description of subcommand listusers

    84     'listusers': (_("""This command lists all user accounts. User accounts

    85 belonging to alias-domains are prefixed with a '-', addresses of regular

    86 domains with a '+'. The output can be limited with an optional <pattern>."""),

    87 _("""To perform a wild card search, the % character can be used at the start

    88 and/or the end of the pattern."""),),

    89     # TP: description of subcommand version

    90     'version': (_("""Prints vmm's version and copyright information to stdout.

    91 After this vmm exits."""),),

    92     # TP: description of subcommand domainadd

    93     'domainadd': (_("""Adds the new domain into the database and creates the

    94 domain directory."""),

    95 _("""If the optional argument <transport> is given, it will override the

    96 default transport (domain.transport) from vmm.cfg. The specified <transport>

    97 will be the default transport for all new accounts in this domain."""),

    98 _("""Configuration-related behavior:"""),

    99 """ * domain.auto_postmaster""",

   100 _("""When that option is set to true (default) vmm will automatically create

   101 the postmaster account for the new domain and prompt for postmaster@<fqdn>'s

   102 password."""),

   103 """ * account.random_password""",

   104 _("""When the value of that option is also set to true, vmm will automatically

   105 create the postmaster account for the new domain and print the generated

   106 postmaster password to stdout."""),),

   107     # TP: description of subcommand domaindelete

   108     'domaindelete': (_("""This subcommand deletes the domain specified by

   109 <fqdn>."""),

   110 _("""If there are accounts, aliases and/or relocated users assigned to the

   111 given domain, vmm will abort the requested operation and show an error

   112 message. If you know, what you are doing, you can specify the optional keyword

   113 'force'."""),

   114 _("""If you really always know what you are doing, edit your vmm.cfg and set

   115 the option domain.force_deletion to true."""),),

   116     # TP: description of subcommand domaininfo

   117     'domaininfo': (_("""This subcommand shows some information about the

   118 given domain."""),

   119 _("""For a more detailed information about the domain the optional argument

   120 <details> can be specified. A possible <details> value can be one of the

   121 following six keywords:"""),

   122 """    accounts, aliasdomains, aliases, catchall, relocated, full""",),

   123     # TP: description of subcommand domainquota

   124     'domainquota': (_("""This subcommand is used to configure a new quota

   125 limit for the accounts of the domain - not for the domain itself."""),

   126 _("""The default quota limit for accounts is defined in the vmm.cfg

   127 (domain.quota_bytes and domain.quota_messages)."""),

   128 _("""The new quota limit will affect only those accounts for which the limit

   129 has not been overridden. If you want to restore the default to all accounts,

   130 you may pass the keyword 'force'. When the argument <messages> was omitted the

   131 default number of messages 0 (zero) will be applied."""),),

   132     # TP: description of subcommand domainservices

   133     'domainservices': (_("""To define which services could be used by the

   134 users of the domain — with the given <fqdn> — use this subcommand."""),

   135 _("""Each specified <service> will be enabled/usable. All other services

   136 will be deactivated/unusable. Possible <service> names are:"""),

   137 """    imap, pop3, sieve, smtp""",

   138 _("""The new service set will affect only those accounts for which the set has

   139 not been overridden. If you want to restore the default to all accounts, you

   140 may pass the keyword 'force'."""),),

   141     # TP: description of subcommand domaintransport

   142     'domaintransport': (_("""A new transport for the indicated domain can be

   143 set with this subcommand."""),

   144 _("""The new transport will affect only those accounts for which the transport

   145 has not been overridden. If you want to restore the default to all accounts,

   146 you may pass the keyword 'force'."""),),

   147     # TP: description of subcommand domainnote

   148     'domainnote': (_("""With this subcommand, it is possible to attach a

   149 note to the specified domain. Without an argument, an existing note is

   150 removed."""),),

   151     # TP: description of subcommand aliasdomainadd

   152     'aliasdomainadd': (_("""This subcommand adds the new alias domain

   153 (<fqdn>) to the destination <domain> that should be aliased."""),),

   154     # TP: description of subcommand aliasdomaindelete

   155     'aliasdomaindelete': (_("""Use this subcommand if the alias domain

   156 <fqdn> should be removed."""),),

   157     # TP: description of subcommand aliasdomaininfo

   158     'aliasdomaininfo': (_("""This subcommand shows to which domain the alias

   159 domain <fqdn> is assigned to."""),),

   160     # TP: description of subcommand aliasdomainswitch

   161     'aliasdomainswitch': (_("""If the destination of the existing alias

   162 domain <fqdn> should be switched to another <destination> use this

   163 subcommand."""),),

   164     # TP: description of subcommand useradd

   165     'useradd': (_("""Use this subcommand to create a new e-mail account for

   166 the given <address>."""),

   167 _("""If the <password> is not provided, vmm will prompt for it interactively.

   168 When no <password> is provided and account.random_password is set to true, vmm

   169 will generate a random password and print it to stdout after the account has

   170 been created."""),),

   171     # TP: description of subcommand userdelete

   172     'userdelete': (_("""Use this subcommand to delete the account with the

   173 given <address>."""),

   174 _("""If there are one or more aliases with an identical destination address,

   175 vmm will abort the requested operation and show an error message. To prevent

   176 this, specify the optional keyword 'force'."""),),

   177     # TP: description of subcommand userinfo

   178     'userinfo': (_("""This subcommand displays some information about the

   179 account specified by <address>."""),

   180 _("""If the optional argument <details> is given some more information will be

   181 displayed. Possible values for <details> are:"""),

   182 """    aliases, du. full""",),

   183     # TP: description of subcommand username

   184     'username': (_("""The user's real <name> can be set/updated with this

   185 subcommand."""),

   186 _("""If no <name> is given, the value stored for the account is erased."""),

   187 ),

   188     # TP: description of subcommand userpassword

   189     'userpassword': (_("""The password of an account can be updated with this

   190 subcommand."""),

   191 _("""If no <password> was provided, vmm will prompt for it interactively."""),

   192 ),

   193     # TP: description of subcommand usernote

   194     'usernote': (_("""With this subcommand, it is possible to attach a note

   195 to the specified account. Without an argument, an existing note is

   196 removed."""),),

   197     # TP: description of subcommand userquota

   198     'userquota': (_("""This subcommand is used to set a new quota limit for

   199 the given account."""),

   200 _("""When the argument <messages> was omitted the default number of messages

   201 0 (zero) will be applied."""),

   202 _("""Instead of <storage> pass the keyword 'domain' to remove the

   203 account-specific override, causing the domain's value to be in effect."""),),

   204     # TP: description of subcommand userservices

   205     'userservices': (_("""To grant a user access to the specified services,

   206 use this command."""),

   207 _("""All omitted services will be deactivated/unusable for the user with the

   208 given <address>."""),

   209 _("""Instead of <service> pass 'domain' to remove the account-specific

   210 override, causing the domain's value to be in effect."""),),

   211     # TP: description of subcommand usertransport

   212     'usertransport': (_("""A different <transport> for an account can be

   213 specified with this subcommand."""),

   214 _("""Instead of <transport> pass 'domain' to remove the account-specific

   215 override, causing the domain's value to be in effect."""),),

   216     # TP: description of subcommand aliasadd

   217     'aliasadd': (_("""This subcommand is used to create a new alias

   218 <address> with one or more <destination> addresses."""),

   219 _("""Within the destination address, the placeholders '%n', '%d', and '%='

   220 will be replaced by the local part, the domain, or the email address with '@'

   221 replaced by '=' respectively. In combination with alias domains, this enables

   222 domain-specific destinations."""),),

   223     # TP: description of subcommand aliasdelete

   224     'aliasdelete': (_("""This subcommand is used to delete one or multiple

   225 <destination>s from the alias with the given <address>."""),

   226 _("""When no <destination> address was specified the alias with all its

   227 destinations will be deleted."""),),

   228     # TP: description of subcommand aliasinfo

   229     'aliasinfo': (_("""Information about the alias with the given <address>

   230 can be displayed with this subcommand."""),),

   231     # TP: description of subcommand relocatedadd

   232     'relocatedadd': (_("""A new relocated user can be created with this

   233 subcommand."""),

   234 _("""<address> is the user's ex-email address, for example

   235 b.user@example.com, and <newaddress> points to the new email address where

   236 the user can be reached."""),),

   237     # TP: description of subcommand relocatedinfo

   238     'relocatedinfo': (_("""This subcommand shows the new address of the

   239 relocated user with the given <address>."""),),

   240     # TP: description of subcommand relocateddelete

   241     'relocateddelete': (_("""Use this subcommand in order to delete the

   242 relocated user with the given <address>."""),),

   243     # TP: description of subcommand catchalladd

   244     'catchalladd': (_("""This subcommand allows to specify destination

   245 addresses for a domain, which shall receive mail addressed to unknown

   246 local-parts within that domain. Those catch-all aliases hence "catch all" mail

   247 to any address in the domain (unless a more specific alias, mailbox or

   248 relocated user exists)."""),

   249 _("""WARNING: Catch-all addresses can cause mail server flooding because

   250 spammers like to deliver mail to all possible combinations of names, e.g.

   251 to all addresses between abba@example.org and zztop@example.org."""),),

   252     # TP: description of subcommand catchallinfo

   253     'catchallinfo': (_("""This subcommand displays information about catch-all

   254 aliases defined for the domain <fqdn>."""),),

   255     # TP: description of subcommand catchalldelete

   256     'catchalldelete': (_("""With this subcommand, catch-all aliases defined

   257 for a domain can be removed, either all of them, or those <destination>s which

   258 were specified explicitly."""),),

   259 }

   260 

   261 del _