# -*- coding: UTF-8 -*-# Copyright (c) 2012, Pascal Volk# See COPYING for distribution information.""" VirtualMailManager.cli.vmmhelp ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Virtual Mail Manager's command line help."""_=lambdamsg:msghelp_msgs={# TP: There are some words enclosed within angle brackets '<'word'>'. They# are used to indicate replaceable arguments. Please do not translate them.## The descriptions of subcommands may contain the both keywords 'domain'# and 'force', enclosed within single quotes. Please keep them as they are.## TP: description of subcommand configget'configget':(_("""This subcommand is used to display the actual valueof the given configuration <option>."""),),# TP: description of subcommand configset'configset':(_("""Use this subcommand to set or update a singleconfiguration option's value. <option> is the configuration option, <value>is the <option>'s new value."""),_("""Note: This subcommand will create a new vmm.cfg without any comments.Your current configuration file will be backed as vmm.cfg.bak."""),),# TP: description of subcommand configure'configure':(_("""Starts the interactive configuration for allconfiguration sections."""),_("""In this process the currently set value of each option will be displayedin square brackets. If no value is configured, the default value of eachoption will be displayed in square brackets. Press the return key, to acceptthe displayed value."""),_("""If the optional argument <section> is given, only the configurationoptions from the given section will be displayed and will be configurable.The following sections are available:"""),""" account, bin, database, domain, mailbox, misc""",_("""All configuration options are described in vmm.cfg(5)."""),_("""Note: This subcommand will create a new vmm.cfg without any comments.Your current configuration file will be backed as vmm.cfg.bak."""),),# TP: description of subcommand getuser'getuser':(_("""If only the <uid> is available, for example from processlist, the subcommand getuser will show the user's address."""),),# TP: description of subcommand listaddresses'listaddresses':(_("""This command lists all defined addresses.Addresses belonging to alias-domains are prefixed with a '-', addresses ofregular domains with a '+'. Additionally, the letters 'u', 'a', and 'r'indicate the type of each address: user, alias and relocated respectively.The output can be limited with an optional <pattern>."""),_("""To perform a wild card search, the % character can be used at the startand/or the end of the <pattern>."""),),# TP: description of subcommand listaliases'listaliases':(_("""This command lists all defined aliases. Aliasesbelonging to alias-domains are prefixed with a '-', addresses of regulardomains with a '+'. The output can be limited with an optional <pattern>."""),_("""To perform a wild card search, the % character can be used at the startand/or the end of the <pattern>."""),),# TP: description of subcommand listdomains'listdomains':(_("""This subcommand lists all available domains. Alldomain names will be prefixed either with `[+]', if the domain is a primarydomain, or with `[-]', if it is an alias domain name. The output can belimited with an optional <pattern>."""),_("""To perform a wild card search, the % character can be used at the startand/or the end of the <pattern>."""),),# TP: description of subcommand listpwschemes'listpwschemes':(_("""This subcommand lists all password schemes whichcould be used in the vmm.cfg as value of the misc.password_scheme option.The output varies, depending on the used Dovecot version and the system'slibc."""),_("""When your Dovecot installation isn't too old, you will see additionallya few usable encoding suffixes. One of them can be appended to the passwordscheme."""),),# TP: description of subcommand listrelocated'listrelocated':(_("""This command lists all defined relocated addresses.Relocated entries belonging to alias-domains are prefixed with a '-', addressesof regular domains with a '+'. The output can be limited with an optional<pattern>."""),_("""To perform a wild card search, the % character can be used at the startand/or the end of the <pattern>."""),),# TP: description of subcommand listusers'listusers':(_("""This command lists all user accounts. User accountsbelonging to alias-domains are prefixed with a '-', addresses of regulardomains with a '+'. The output can be limited with an optional <pattern>."""),_("""To perform a wild card search, the % character can be used at the startand/or the end of the pattern."""),),# TP: description of subcommand version'version':(_("""Prints vmm's version and copyright information to stdout.After this vmm exits."""),),# TP: description of subcommand domainadd'domainadd':(_("""Adds the new domain into the database and creates thedomain directory."""),_("""If the optional argument <transport> is given, it will override thedefault transport (domain.transport) from vmm.cfg. The specified <transport>will be the default transport for all new accounts in this domain."""),_("""Configuration-related behavior:"""),""" * domain.auto_postmaster""",_("""When that option is set to true (default) vmm will automatically createthe postmaster account for the new domain and prompt for postmaster@<fqdn>'spassword."""),""" * account.random_password""",_("""When the value of that option is also set to true, vmm will automaticallycreate the postmaster account for the new domain and print the generatedpostmaster password to stdout."""),),# TP: description of subcommand domaindelete'domaindelete':(_("""This subcommand deletes the domain specified by<fqdn>."""),_("""If there are accounts, aliases and/or relocated users assigned to thegiven domain, vmm will abort the requested operation and show an errormessage. If you know, what you are doing, you can specify the optional keyword'force'."""),_("""If you really always know what you are doing, edit your vmm.cfg and setthe option domain.force_deletion to true."""),),# TP: description of subcommand domaininfo'domaininfo':(_("""This subcommand shows some information about thegiven domain."""),_("""For a more detailed information about the domain the optional argument<details> can be specified. A possible <details> value can be one of thefollowing six keywords:"""),""" accounts, aliasdomains, aliases, catchall, relocated, full""",),# TP: description of subcommand domainquota'domainquota':(_("""This subcommand is used to configure a new quotalimit for the accounts of the domain - not for the domain itself."""),_("""The default quota limit for accounts is defined in the vmm.cfg(domain.quota_bytes and domain.quota_messages)."""),_("""The new quota limit will affect only those accounts for which the limithas not been overridden. If you want to restore the default to all accounts,you may pass the keyword 'force'. When the argument <messages> was omitted thedefault number of messages 0 (zero) will be applied."""),),# TP: description of subcommand domainservices'domainservices':(_("""To define which services could be used by theusers of the domain — with the given <fqdn> — use this subcommand."""),_("""Each specified <service> will be enabled/usable. All other serviceswill be deactivated/unusable. Possible <service> names are:"""),""" imap, pop3, sieve, smtp""",_("""The new service set will affect only those accounts for which the set hasnot been overridden. If you want to restore the default to all accounts, youmay pass the keyword 'force'."""),),# TP: description of subcommand domaintransport'domaintransport':(_("""A new transport for the indicated domain can beset with this subcommand."""),_("""The new transport will affect only those accounts for which the transporthas not been overridden. If you want to restore the default to all accounts,you may pass the keyword 'force'."""),),# TP: description of subcommand domainnote'domainnote':(_("""With this subcommand, it is possible to attach anote to the specified domain. Without an argument, an existing note isremoved."""),),# TP: description of subcommand aliasdomainadd'aliasdomainadd':(_("""This subcommand adds the new alias domain(<fqdn>) to the destination <domain> that should be aliased."""),),# TP: description of subcommand aliasdomaindelete'aliasdomaindelete':(_("""Use this subcommand if the alias domain<fqdn> should be removed."""),),# TP: description of subcommand aliasdomaininfo'aliasdomaininfo':(_("""This subcommand shows to which domain the aliasdomain <fqdn> is assigned to."""),),# TP: description of subcommand aliasdomainswitch'aliasdomainswitch':(_("""If the destination of the existing aliasdomain <fqdn> should be switched to another <destination> use thissubcommand."""),),# TP: description of subcommand useradd'useradd':(_("""Use this subcommand to create a new e-mail account forthe given <address>."""),_("""If the <password> is not provided, vmm will prompt for it interactively.When no <password> is provided and account.random_password is set to true, vmmwill generate a random password and print it to stdout after the account hasbeen created."""),),# TP: description of subcommand userdelete'userdelete':(_("""Use this subcommand to delete the account with thegiven <address>."""),_("""If there are one or more aliases with an identical destination address,vmm will abort the requested operation and show an error message. To preventthis, specify the optional keyword 'force'."""),),# TP: description of subcommand userinfo'userinfo':(_("""This subcommand displays some information about theaccount specified by <address>."""),_("""If the optional argument <details> is given some more information will bedisplayed. Possible values for <details> are:"""),""" aliases, du. full""",),# TP: description of subcommand username'username':(_("""The user's real <name> can be set/updated with thissubcommand."""),_("""If no <name> is given, the value stored for the account is erased."""),),# TP: description of subcommand userpassword'userpassword':(_("""The password of an account can be updated with thissubcommand."""),_("""If no <password> was provided, vmm will prompt for it interactively."""),),# TP: description of subcommand usernote'usernote':(_("""With this subcommand, it is possible to attach a noteto the specified account. Without an argument, an existing note isremoved."""),),# TP: description of subcommand userquota'userquota':(_("""This subcommand is used to set a new quota limit forthe given account."""),_("""When the argument <messages> was omitted the default number of messages0 (zero) will be applied."""),_("""Instead of <storage> pass the keyword 'domain' to remove theaccount-specific override, causing the domain's value to be in effect."""),),# TP: description of subcommand userservices'userservices':(_("""To grant a user access to the specified services,use this command."""),_("""All omitted services will be deactivated/unusable for the user with thegiven <address>."""),_("""Instead of <service> pass 'domain' to remove the account-specificoverride, causing the domain's value to be in effect."""),),# TP: description of subcommand usertransport'usertransport':(_("""A different <transport> for an account can bespecified with this subcommand."""),_("""Instead of <transport> pass 'domain' to remove the account-specificoverride, causing the domain's value to be in effect."""),),# TP: description of subcommand aliasadd'aliasadd':(_("""This subcommand is used to create a new alias<address> with one or more <destination> addresses."""),_("""Within the destination address, the placeholders '%n', '%d', and '%='will be replaced by the local part, the domain, or the email address with '@'replaced by '=' respectively. In combination with alias domains, this enablesdomain-specific destinations."""),),# TP: description of subcommand aliasdelete'aliasdelete':(_("""This subcommand is used to delete one or multiple<destination>s from the alias with the given <address>."""),_("""When no <destination> address was specified the alias with all itsdestinations will be deleted."""),),# TP: description of subcommand aliasinfo'aliasinfo':(_("""Information about the alias with the given <address>can be displayed with this subcommand."""),),# TP: description of subcommand relocatedadd'relocatedadd':(_("""A new relocated user can be created with thissubcommand."""),_("""<address> is the user's ex-email address, for exampleb.user@example.com, and <newaddress> points to the new email address wherethe user can be reached."""),),# TP: description of subcommand relocatedinfo'relocatedinfo':(_("""This subcommand shows the new address of therelocated user with the given <address>."""),),# TP: description of subcommand relocateddelete'relocateddelete':(_("""Use this subcommand in order to delete therelocated user with the given <address>."""),),# TP: description of subcommand catchalladd'catchalladd':(_("""This subcommand allows to specify destinationaddresses for a domain, which shall receive mail addressed to unknownlocal-parts within that domain. Those catch-all aliases hence "catch all" mailto any address in the domain (unless a more specific alias, mailbox orrelocated user exists)."""),_("""WARNING: Catch-all addresses can cause mail server flooding becausespammers like to deliver mail to all possible combinations of names, e.g.to all addresses between abba@example.org and zztop@example.org."""),),# TP: description of subcommand catchallinfo'catchallinfo':(_("""This subcommand displays information about catch-allaliases defined for the domain <fqdn>."""),),# TP: description of subcommand catchalldelete'catchalldelete':(_("""With this subcommand, catch-all aliases definedfor a domain can be removed, either all of them, or those <destination>s whichwere specified explicitly."""),),}del_