/usr/share/doc/vmm/html/howto.html is in vmm-doc 0.6.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Using vmm — vmm 0.6.2 documentation</title>
<link rel="stylesheet" href="_static/pyramid.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.6.2',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within vmm 0.6.2 documentation"
href="_static/opensearch.xml"/>
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="vmm 0.6.2 documentation" href="index.html" />
<link rel="next" title="General subcommands" href="howto/general_subcommands.html" />
<link rel="prev" title="Upgrading to vmm 0.5.x" href="upgrade/0.4.x-0.5.html" />
<!--[if lte IE 6]>
<link rel="stylesheet" href="_static/ie6.css" type="text/css" media="screen" charset="utf-8" />
<![endif]-->
</head>
<body role="document">
<div class="header" role="banner">
<div class="logo">
<a href="index.html">
<img class="logo" src="_static/vmm_logo.png" alt="Logo"/>
</a>
</div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="howto/general_subcommands.html" title="General subcommands"
accesskey="N">next</a></li>
<li class="right" >
<a href="upgrade/0.4.x-0.5.html" title="Upgrading to vmm 0.5.x"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">vmm 0.6.2 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="using-vmm">
<h1>Using vmm<a class="headerlink" href="#using-vmm" title="Permalink to this headline">¶</a></h1>
<p>vmm is the easy to use command-line tool of the Virtual Mail Manager.
It allows you to simply and quickly administer your mail server.
The general command syntax looks like:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>vmm subcommand [argument …]
</pre></div>
</div>
<p>Each subcommand has both a long and a short form.
Both forms are case sensitive.
The subcommands are categorized by their functionality:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="howto/general_subcommands.html">General subcommands</a></li>
<li class="toctree-l1"><a class="reference internal" href="howto/manage_domains.html">Managing domains</a></li>
<li class="toctree-l1"><a class="reference internal" href="howto/manage_alias_domains.html">Managing alias domains</a></li>
<li class="toctree-l1"><a class="reference internal" href="howto/manage_accounts.html">Managing accounts</a></li>
<li class="toctree-l1"><a class="reference internal" href="howto/manage_alias_addresses.html">Managing alias addresses</a></li>
<li class="toctree-l1"><a class="reference internal" href="howto/manage_catch-all_addresses.html">Managing catch-all addresses</a></li>
<li class="toctree-l1"><a class="reference internal" href="howto/manage_relocated_users.html">Managing relocated users</a></li>
</ul>
</div>
<p>Most of the <em>subcommand</em>s take one or more <em>argument</em>s.</p>
<div class="section" id="arguments">
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline">¶</a></h2>
<dl class="docutils">
<dt>address</dt>
<dd>The complete e-mail address (<em>local-part</em>@<em>fqdn</em>) of an user account,
alias address or relocated user.</dd>
<dt>destination</dt>
<dd>Is either an e-mail address when used with
<a class="reference internal" href="howto/manage_alias_addresses.html"><span class="doc">Alias subcommands</span></a>.
Or a <em>fqnd</em> when used with
<a class="reference internal" href="howto/manage_alias_domains.html"><span class="doc">Alias domain subcommands</span></a>.</dd>
<dt>fqdn</dt>
<dd>The fully qualified domain name – without the trailing dot – of a domain
or alias domain.</dd>
<dt>messages</dt>
<dd>An integer value which specifies a quota limit in number of messages.
<strong>0</strong> (zero) means unlimited - no quota limit for the number of messages.</dd>
<dt>option</dt>
<dd>Is the name of a configuration option, prefixed with the section name and
a dot.
For example: <em>misc</em><strong>.</strong><em>transport</em>
All configuration options are described in <em class="manpage">vmm.cfg(5)</em>.</dd>
<dt>service</dt>
<dd>The name of a service, commonly used with Dovecot.
Supported services are: <strong>imap</strong>, <strong>pop3</strong>, <strong>sieve</strong> and <strong>smtp</strong>.</dd>
<dt>storage</dt>
<dd>Specifies a quota limit in bytes.
One of the following prefixes can be appended to the integer value:
<strong>b</strong> (bytes), <strong>k</strong> (kilobytes), <strong>M</strong> (megabytes) or <strong>G</strong> (gigabytes).
<strong>0</strong> (zero) means unlimited - no quota limit in bytes.</dd>
<dt>transport</dt>
<dd>A transport for Postfix, written as: <em>transport</em><strong>:</strong> or
<em>transport</em><strong>:</strong><em>nexthop</em>.
See <em class="manpage">transport(5)</em> for more details.</dd>
</dl>
</div>
<div class="section" id="files">
<h2>Files<a class="headerlink" href="#files" title="Permalink to this headline">¶</a></h2>
<p><strong class="command">vmm</strong> reads its configuration data from <code class="file docutils literal"><span class="pre">vmm.cfg</span></code>.</p>
<dl class="docutils">
<dt><code class="file docutils literal"><span class="pre">/root/vmm.cfg</span></code></dt>
<dd>will be used when found.</dd>
<dt><code class="file docutils literal"><span class="pre">/usr/local/etc/vmm.cfg</span></code></dt>
<dd>will be used when the above file doesn’t exist.</dd>
<dt><code class="file docutils literal"><span class="pre">/etc/vmm.cfg</span></code></dt>
<dd>will be used when none of the both above mentioned files exists.</dd>
</dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Using vmm</a><ul>
<li><a class="reference internal" href="#arguments">Arguments</a></li>
<li><a class="reference internal" href="#files">Files</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="upgrade/0.4.x-0.5.html"
title="previous chapter">Upgrading to vmm 0.5.x</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="howto/general_subcommands.html"
title="next chapter">General subcommands</a></p>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="howto/general_subcommands.html" title="General subcommands"
>next</a></li>
<li class="right" >
<a href="upgrade/0.4.x-0.5.html" title="Upgrading to vmm 0.5.x"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">vmm 0.6.2 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2017 - 2014, Pascal Volk.
</div>
</body>
</html>
|