/usr/share/doc/mailutils-doc/mailutils.html/Common-Options.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Published by the Free Software Foundation,
51 Franklin Street, Fifth Floor
Boston, MA 02110-1301, USA

Copyright (C) 1999-2004, 2008-2012, 2014-2016 Free Software
Foundation, Inc.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2 or
any later version published by the Free Software Foundation; with no
Invariant Sections, no Front-Cover, and no Back-Cover texts.
A copy of the license is included in the section entitled "GNU Free
Documentation License". -->
<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Mailutils Manual: Common Options</title>

<meta name="description" content="GNU Mailutils Manual: Common Options">
<meta name="keywords" content="GNU Mailutils Manual: Common Options">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Function-Index.html#Function-Index" rel="index" title="Function Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="command-line.html#command-line" rel="up" title="command line">
<link href="configuration.html#configuration" rel="next" title="configuration">
<link href="Option-Basics.html#Option-Basics" rel="prev" title="Option Basics">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en">
<a name="Common-Options"></a>
<div class="header">
<p>
Previous: <a href="Option-Basics.html#Option-Basics" accesskey="p" rel="prev">Option Basics</a>, Up: <a href="command-line.html#command-line" accesskey="u" rel="up">command line</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Options-That-are-Common-for-All-Utilities_002e"></a>
<h4 class="subsection">3.1.2 Options That are Common for All Utilities.</h4>

<p>All GNU Mailutils programs understand a common subset of options.
</p>
<dl compact="compact">
<dd><a name="index-help_002c-_002d_002dhelp-option_002c-described"></a>
</dd>
<dt><samp>-?</samp></dt>
<dt><samp>--help</samp></dt>
<dd><p>Display a short summary of the command line options understood by
this utilities, along with a terse description of each.
</p>
<p>The output of this option consists of three major parts.  First, a
usage synopsis is displayed.  For example:
</p>
<div class="example">
<pre class="example">Usage: sieve [OPTION...] SCRIPT
GNU sieve -- a mail filtering tool
</pre></div>

<p>The first line tells that the <code>sieve</code> utility takes any
number of options (brackets indicate optional part) and a single
mandatory argument (&lsquo;<samp>SCRIPT</samp>&rsquo;).  The second lines summarizes the
purpose of the utility.
</p>
<p>Following this header is an option summary.  It consists of two
columns:
</p>
<pre class="verbatim">  -c, --compile-only         Compile script and exit
  -d, --debug[=FLAGS]        Debug flags
  -e, --email=ADDRESS        Override user email address
</pre>

<p>The leftmost column contains a comma-separated list of option
names.  Short options are listed first.  The options are ordered
alphabetically.  Arguments, if any, are specified after the last
option name in the list, so that, e.g. the option &lsquo;<samp>-e</samp>&rsquo; in the
example above requires an argument: &lsquo;<samp>-e ADDRESS</samp>&rsquo;.  Optional
arguments are enclosed in square brackets, as in <samp>--debug</samp>
option in the example above.
</p>
<p>The rightmost column contains a short description of the option
purpose. 
</p>
<p>The last part of <samp>--help</samp> output contains some additional
notices and lists the email address for reporting bugs.
</p>
<a name="index-usage_002c-_002d_002dusage-option_002c-described"></a>
</dd>
<dt><samp>--usage</samp></dt>
<dd><p>Display a short summary of options.  In the contrast to the
<samp>--help</samp> option, only option names and arguments
are printed, without any textual description.  For example:
</p>
<div class="example">
<pre class="example">Usage: sieve [-cv?V] [--compile-only] [--debug[=FLAGS]]
             [--email=ADDRESS] SCRIPT
</pre></div>
</dd>
</dl>

<p>The exact formatting of the output produced by these two options is
configurable.  See <a href="Usage-Vars.html#Usage-Vars">Usage Vars</a>, for a detailed descriptions of it.
</p>
<dl compact="compact">
<dd><a name="index-version_002c-_002d_002dversion-option_002c-described"></a>
</dd>
<dt><samp>-V</samp></dt>
<dt><samp>--version</samp></dt>
<dd><p>Print program version and exit.
</p>
<a name="index-show_002dconfig_002doptions_002c-_002d_002dshow_002dconfig_002doptions-option_002c-described"></a>
</dd>
<dt><samp>--show-config-options</samp></dt>
<dd><p>Show configuration options used when compiling the package.  You can
use this option to verify if support for a particular mailbox format
or other functionality is compiled in the binary.  The output of this
option is intended to be both machine-readable and understandable by
humans.
</p></dd>
</dl>

<p>The following command line options affect parsing of configuration
files.  Here we provide a short summary, the next section will
describe them in detail.
</p>
<dl compact="compact">
<dd><a name="index-config_002dfile_002c-_002d_002dconfig_002dfile-option_002c-introduced"></a>
</dd>
<dt><samp>--config-file=<var>file</var></samp></dt>
<dd><p>Load this configuration file, instead of the default.
</p>
<a name="index-config_002dhelp_002c-_002d_002dconfig_002dhelp-option_002c-introduced"></a>
</dd>
<dt><samp>--config-help</samp></dt>
<dd><p>Show configuration file summary.
</p>
<a name="index-config_002dlint_002c-_002d_002dconfig_002dlint-option_002c-introduced"></a>
</dd>
<dt><samp>--config-lint</samp></dt>
<dd><p>Check configuration file syntax and exit
</p>
<a name="index-config_002dverbose_002c-_002d_002dconfig_002dverbose-option_002c-introduced"></a>
</dd>
<dt><samp>--config-verbose</samp></dt>
<dd><p>Verbosely log parsing of the configuration files.
</p>
<a name="index-no_002dsite_002dconfig_002c-_002d_002dno_002dsite_002dconfig-option_002c-introduced"></a>
</dd>
<dt><samp>--no-site-config</samp></dt>
<dd><p>Do not load site-wide configuration file.
</p>
<a name="index-no_002duser_002dconfig_002c-_002d_002dno_002duser_002dconfig-option_002c-introduced"></a>
</dd>
<dt><samp>--no-user-config</samp></dt>
<dd><p>Do not load user configuration file.
</p>
<a name="index-no_002dconfig_002c-_002d_002dno_002dconfig-option_002c-introduced"></a>
</dd>
<dt><samp>--no-config</samp></dt>
<dd><p>Don&rsquo;t load site-wide and user configuration files.
</p>
<a name="index-set_002c-_002d_002dset-option_002c-introduced"></a>
</dd>
<dt><samp>--set=<var>path</var>=<var>value</var></samp></dt>
<dd><p>Set configuration variable.  See <a href="Paths.html#the-_002d_002dset-option">the --set option</a>.
</p></dd>
</dl>

<hr>
<div class="header">
<p>
Previous: <a href="Option-Basics.html#Option-Basics" accesskey="p" rel="prev">Option Basics</a>, Up: <a href="command-line.html#command-line" accesskey="u" rel="up">command line</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>
mailutils-doc 1:3.1.1-1 / usr / share / doc / mailutils-doc / mailutils.html / Common-Options.html
