/usr/share/doc/mailutils-doc/mailutils.html/Commands.html is in mailutils-doc 1:2.99.99-1ubuntu2.
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 | <!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-2015 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.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Mailutils Manual: Commands</title>
<meta name="description" content="GNU Mailutils Manual: Commands">
<meta name="keywords" content="GNU Mailutils Manual: Commands">
<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="Syntax.html#Syntax" rel="up" title="Syntax">
<link href="Actions-Described.html#Actions-Described" rel="next" title="Actions Described">
<link href="Syntax.html#Syntax" rel="prev" title="Syntax">
<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="Commands"></a>
<div class="header">
<p>
Next: <a href="Actions-Described.html#Actions-Described" accesskey="n" rel="next">Actions Described</a>, Up: <a href="Syntax.html#Syntax" accesskey="u" rel="up">Syntax</a> [<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="Commands-1"></a>
<h4 class="subsection">4.2.1 Commands</h4>
<p>The basic syntax element is a <em>command</em>. It is defined as follows:
</p>
<div class="smallexample">
<pre class="smallexample"><var>command-name</var> [<var>tags</var>] <var>args</var>
</pre></div>
<p>where <var>command-name</var> is an identifier representing the name of the
command, <var>tags</var> is an optional list of <em>optional</em> or
<em>tagged arguments</em> and <var>args</var> is a list of <em>required</em> or
<em>positional arguments</em>.
</p>
<p>Positional arguments are literals delimited with whitespace. They
provide the command with the information necessary to its proper
functioning. Each command has a fixed number of positional arguments. It
is an error to supply more arguments to the command or to give it fewer
arguments than it accepts.
</p>
<p>Optional arguments allow to modify the behaviour of the command, like
command line options in UNIX do. They are a list of <em>tags</em>
(see <a href="Lexical-Structure.html#Lexical-Structure">Lexical Structure</a>) separated by whitespace. An optional
argument may have at most one parameter.
</p>
<p>Each command understands a set of optional arguments. Supplying it tags
that it does not understand results in an error.
</p>
<p>For example, consider the following command
</p>
<div class="smallexample">
<pre class="smallexample">header :mime :comparator "i;octet" ["to", "from"] "bug-mailutils@gnu.org"
</pre></div>
<p>Here, given that <code>header</code> takes two positional arguments:
<code>header</code> is command name, the list <code>["to", "from"]</code> is first
positional argument and the string <code>"bug-mailutils@gnu.org"</code> is second
positional argument. There are two optional arguments: <code>:mime</code> and
<code>:comparator</code>. The latter has a string <code>"i;octet"</code> as its
parameter.
</p>
</body>
</html>
|