/usr/share/doc/mailutils-doc/mailutils.html/Statements.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 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 5.2, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Mailutils Manual: Statements</title>

<meta name="description" content="GNU Mailutils Manual: Statements">
<meta name="keywords" content="GNU Mailutils Manual: Statements">
<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="conf_002dsyntax.html#conf_002dsyntax" rel="up" title="conf-syntax">
<link href="Paths.html#Paths" rel="next" title="Paths">
<link href="Comments.html#Comments" rel="prev" title="Comments">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
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.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Statements"></a>
<div class="header">
<p>
Next: <a href="Paths.html#Paths" accesskey="n" rel="next">Paths</a>, Previous: <a href="Comments.html#Comments" accesskey="p" rel="prev">Comments</a>, Up: <a href="conf_002dsyntax.html#conf_002dsyntax" accesskey="u" rel="up">conf-syntax</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="Statements-1"></a>
<h4 class="subsubsection">3.2.1.2 Statements</h4>
<a name="index-statements_002c-configuration-file"></a>
<a name="index-configuration-file-statements"></a>
<a name="index-statement_002c-simple"></a>
<a name="index-simple-statements"></a>
<p>A <em>simple statement</em> consists of a keyword and value
separated by any amount of whitespace.  Simple statement is terminated
with a semicolon (&lsquo;<samp>;</samp>&rsquo;).
</p>
<p>The following is a simple statement:
</p>
<div class="example">
<pre class="example">standalone yes;
pidfile /var/run/pop3d.pid;
</pre></div>

<p>A <em>keyword</em> begins with a letter and may contain letters,
decimal digits, underscores (&lsquo;<samp>_</samp>&rsquo;) and dashes (&lsquo;<samp>-</samp>&rsquo;).
Examples of keywords are: &lsquo;<samp>expression</samp>&rsquo;, &lsquo;<samp>output-file</samp>&rsquo;.
</p>
<p>A <em>value</em> can be one of the following:
</p>
<dl compact="compact">
<dt>number</dt>
<dd><p>A number is a sequence of decimal digits.
</p>
<a name="boolean-value"></a></dd>
<dt>boolean</dt>
<dd><a name="index-boolean-value"></a>
<p>A boolean value is one of the following: &lsquo;<samp>yes</samp>&rsquo;, &lsquo;<samp>true</samp>&rsquo;,
&lsquo;<samp>t</samp>&rsquo; or &lsquo;<samp>1</samp>&rsquo;, meaning <em>true</em>, and &lsquo;<samp>no</samp>&rsquo;,
&lsquo;<samp>false</samp>&rsquo;, &lsquo;<samp>nil</samp>&rsquo;, &lsquo;<samp>0</samp>&rsquo; meaning <em>false</em>.
</p>  
</dd>
<dt>unquoted string</dt>
<dd><a name="index-string_002c-unquoted"></a>
<p>An unquoted string may contain letters, digits, and any of the
following characters: &lsquo;<samp>_</samp>&rsquo;, &lsquo;<samp>-</samp>&rsquo;, &lsquo;<samp>.</samp>&rsquo;, &lsquo;<samp>/</samp>&rsquo;,
&lsquo;<samp>@</samp>&rsquo;, &lsquo;<samp>*</samp>&rsquo;, &lsquo;<samp>:</samp>&rsquo;.
</p>
</dd>
<dt>quoted string</dt>
<dd><a name="index-quoted-string"></a>
<a name="index-string_002c-quoted"></a>
<a name="index-escape-sequence"></a>
<p>A quoted string is any sequence of characters enclosed in
double-quotes (&lsquo;<samp>&quot;</samp>&rsquo;).  A backslash appearing within a quoted
string introduces an <em>escape sequence</em>, which is replaced
with a single character according to the following rules:
</p>
<div class="float"><a name="backslash_002dinterpretation"></a>

<table>
<tr><td width="30%">Sequence</td><td width="50%">Replaced with</td></tr>
<tr><td width="30%">\a</td><td width="50%">Audible bell character (<acronym>ASCII</acronym> 7)</td></tr>
<tr><td width="30%">\b</td><td width="50%">Backspace character (<acronym>ASCII</acronym> 8)</td></tr>
<tr><td width="30%">\f</td><td width="50%">Form-feed character (<acronym>ASCII</acronym> 12)</td></tr>
<tr><td width="30%">\n</td><td width="50%">Newline character (<acronym>ASCII</acronym> 10)</td></tr>
<tr><td width="30%">\r</td><td width="50%">Carriage return character (<acronym>ASCII</acronym> 13)</td></tr>
<tr><td width="30%">\t</td><td width="50%">Horizontal tabulation character (<acronym>ASCII</acronym> 9)</td></tr>
<tr><td width="30%">\v</td><td width="50%">Vertical tabulation character (<acronym>ASCII</acronym> 11)</td></tr>
<tr><td width="30%">\\</td><td width="50%">A single backslash (&lsquo;<samp>\</samp>&rsquo;)</td></tr>
<tr><td width="30%">\&quot;</td><td width="50%">A double-quote.</td></tr>
</table>
<div class="float-caption"><p><strong>Table 3.1: </strong>Backslash escapes</p></div></div>
<p>In addition, the sequence &lsquo;<samp>\<var>newline</var></samp>&rsquo; is removed from
the string.  This allows to split long strings over several
physical lines, e.g.:
</p>
<div class="example">
<pre class="example">&quot;a long string may be\
 split over several lines&quot;
</pre></div>

<p>If the character following a backslash is not one of those specified
above, the backslash is ignored and a warning is issued.
</p>
<p>Two or more adjacent quoted strings are concatenated, which gives
another way to split long strings over several lines to improve
readability.  The following fragment produces the same result as the
example above:
</p>
<div class="example">
<pre class="example">&quot;a long string may be&quot;
&quot; split over several lines&quot;
</pre></div>

<a name="here_002ddocument"></a></dd>
<dt>Here-document</dt>
<dd><a name="index-here_002ddocument"></a>
<p>A <em>here-document</em> is a special construct that allows to introduce
strings of text containing embedded newlines.  
</p>
<p>The <code>&lt;&lt;<var>word</var></code> construct instructs the parser to read all
the following lines up to the line containing only <var>word</var>, with
possible trailing blanks.  Any lines thus read are concatenated
together into a single string.  For example:
</p>
<div class="example">
<pre class="example">&lt;&lt;EOT
A multiline
string
EOT
</pre></div>

<p>The body of a here-document is interpreted the same way as a
double-quoted string, unless <var>word</var> is preceded by a backslash
(e.g.  &lsquo;<samp>&lt;&lt;\EOT</samp>&rsquo;) or enclosed in double-quotes, in which case
the text is read as is, without interpretation of escape sequences.
</p>
<p>If <var>word</var> is prefixed with <code>-</code> (a dash), then all leading
tab characters are stripped from input lines and the line containing
<var>word</var>.  Furthermore, if <code>-</code> is followed by a single space,
all leading whitespace is stripped from them.  This allows to indent
here-documents in a natural fashion.  For example:
</p>
<div class="example">
<pre class="example">&lt;&lt;- TEXT
    The leading whitespace will be
    ignored when reading these lines.
TEXT
</pre></div>

<p>It is important that the terminating delimiter be the only token on
its line.  The only exception to this rule is allowed if a
here-document appears as the last element of a statement.  In this
case a semicolon can be placed on the same line with its terminating 
delimiter, as in: 
</p>
<div class="example">
<pre class="example">help-text &lt;&lt;-EOT
        A sample help text.
EOT;
</pre></div>

<a name="list-values"></a></dd>
<dt>list</dt>
<dd><a name="index-list"></a>
<p>A <em>list</em> is a comma-separated list of values.  Lists are
enclosed in parentheses.  The following example shows a statement
whose value is a list of strings:
</p>
<div class="example">
<pre class="example">alias (test,null);
</pre></div>

<p>In any case where a list is appropriate, a single value is allowed
without being a member of a list: it is equivalent to a list with a
single member.  This means that, e.g.
</p>
<div class="example">
<pre class="example">alias test;
</pre></div>

<p>is equivalent to
</p>
<div class="example">
<pre class="example">alias (test);
</pre></div>
</dd>
</dl>

<a name="index-statement_002c-block"></a>
<a name="index-block-statement"></a>
<p>A <em>block statement</em> introduces a logical group of 
statements.  It consists of a keyword, followed by an optional value,
and a sequence of statements enclosed in curly braces, as shown in
the example below:
</p>
<div class="example">
<pre class="example">server srv1 {
  host 10.0.0.1;
  community &quot;foo&quot;;
}
</pre></div>

<p>The closing curly brace may be followed by a semicolon, although
this is not required.
</p>
<hr>
<div class="header">
<p>
Next: <a href="Paths.html#Paths" accesskey="n" rel="next">Paths</a>, Previous: <a href="Comments.html#Comments" accesskey="p" rel="prev">Comments</a>, Up: <a href="conf_002dsyntax.html#conf_002dsyntax" accesskey="u" rel="up">conf-syntax</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:2.99.98-2 / usr / share / doc / mailutils-doc / mailutils.html / Statements.html
