This file is indexed.

/usr/share/doc/mailutils-doc/mailutils.html/Usage-Vars.html is in mailutils-doc 1:3.4-1.

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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
<!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-2017 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.5, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Usage Vars (GNU Mailutils Manual)</title>

<meta name="description" content="Usage Vars (GNU Mailutils Manual)">
<meta name="keywords" content="Usage Vars (GNU Mailutils Manual)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<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="index.html#Top" rel="up" title="Top">
<link href="GNU-FDL.html#GNU-FDL" rel="next" title="GNU FDL">
<link href="Authors-of-get_005fdate.html#Authors-of-get_005fdate" rel="prev" title="Authors of get_date">
<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="Usage-Vars"></a>
<div class="header">
<p>
Next: <a href="GNU-FDL.html#GNU-FDL" accesskey="n" rel="next">GNU FDL</a>, Previous: <a href="Date-Input-Formats.html#Date-Input-Formats" accesskey="p" rel="prev">Date Input Formats</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</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="Configuring-Help-Summary"></a>
<h2 class="appendix">Appendix C Configuring Help Summary</h2>

<p>Running <code><var>prog</var> --help</code> displays the short usage summary
for <var>prog</var> utility (see <a href="Common-Options.html#Common-Options">Common Options</a>).  This summary is
organized by <em>groups</em> of semantically close options.  The options
within each group are printed in the following order: a short option,
eventually followed by a list of corresponding long option names,
followed by a short description of the option.  For example, here is an
excerpt from the actual <kbd>sieve --help</kbd> output:
</p>
<pre class="verbatim">  -c, --compile-only         Compile script and exit
  -d, --debug[=FLAGS]        Debug flags
  -e, --email=ADDRESS        Override user email address
</pre>
<a name="index-ARGP_005fHELP_005fFMT_002c-environment-variable"></a>
<p>The exact visual representation of the help output is configurable via
<code>ARGP_HELP_FMT</code> environment variable.  The value of this variable
is a comma-separated list of <em>format variable</em> assignments.  There
are two kinds of format variables.  An <em>offset variable</em> keeps the
offset of some part of help output text from the leftmost column on
the screen.  A <em>boolean</em> variable is a flag that toggles some
output feature on or off.  Depending on the type of the corresponding
variable, there are two kinds of assignments:
</p>
<dl compact="compact">
<dt>Offset assignment</dt>
<dd>
<p>The assignment to an offset variable has the following syntax:
</p>
<div class="smallexample">
<pre class="smallexample"><var>variable</var>=<var>value</var>
</pre></div>

<p>where <var>variable</var> is the variable name, and <var>value</var> is a
numeric value to be assigned to the variable.
</p>
</dd>
<dt>Boolean assignment</dt>
<dd>
<p>To assign <code>true</code> value to a variable, simply put this variable name.  To
assign <code>false</code> value, prefix the variable name with &lsquo;<samp>no-</samp>&rsquo;.  For
example:
</p>
<div class="smallexample">
<pre class="smallexample"># Assign <code>true</code> value:
dup-args
# Assign <code>false</code> value:
no-dup-args
</pre></div>
</dd>
</dl>

<p>Following variables are declared:
</p>
<dl>
<dt><a name="index-dup_002dargs"></a>Help Output: <em>boolean</em> <strong>dup-args</strong></dt>
<dd><p>If true, arguments for an option are shown with both short and long
options, even when a given option has both forms, for example:
</p>
<div class="smallexample">
<pre class="smallexample">  -e ADDRESS, --email=ADDRESS        Override user email address
</pre></div>

<p>If false, then if an option has both short and long forms, the
argument is only shown with the long one, for example:
</p>
<div class="smallexample">
<pre class="smallexample">  -e, --email=ADDRESS        Override user email address
</pre></div>

<p>and a message indicating that the argument is applicable to both
forms is printed below the options.  This message can be disabled
using <code>dup-args-note</code> (see below).
</p>
<p>The default is false.
</p></dd></dl>

<dl>
<dt><a name="index-dup_002dargs_002dnote"></a>Help Output: <em>boolean</em> <strong>dup-args-note</strong></dt>
<dd><p>If this variable is true, which is the default, the following notice
is displayed at the end of the help output:
</p>
<blockquote>
<p>Mandatory or optional arguments to long options are also mandatory or
optional for any corresponding short options.
</p></blockquote>

<p>Setting <code>no-dup-args-note</code> inhibits this message.  Normally, only
one of variables <code>dup-args</code> or <code>dup-args-note</code> should be set.
</p></dd></dl>

<dl>
<dt><a name="index-short_002dopt_002dcol"></a>Help Output: <em>offset</em> <strong>short-opt-col</strong></dt>
<dd><p>Column in which short options start.  Default is 2.
</p>
<div class="smallexample">
<pre class="smallexample">$ <kbd>sieve --help|grep ADDRESS</kbd>
  -e, --email=ADDRESS        Override user email address
$ <kbd>ARGP_HELP_FMT=short-opt-col=6 sieve --help|grep ARCHIVE</kbd>
      -e, --email=ADDRESS        Override user email address
</pre></div>
</dd></dl>

<dl>
<dt><a name="index-long_002dopt_002dcol"></a>Help Output: <em>offset</em> <strong>long-opt-col</strong></dt>
<dd><p>Column in which long options start.  Default is 6.  For example:
</p>
<div class="smallexample">
<pre class="smallexample">$ <kbd>sieve --help|grep ADDRESS</kbd>
  -e, --email=ADDRESS        Override user email address
$ <kbd>ARGP_HELP_FMT=long-opt-col=16 sieve --help|grep ADDRESS</kbd>
  -e,           --email=ADDRESS        Override user email address
</pre></div>
</dd></dl>

<dl>
<dt><a name="index-doc_002dopt_002dcol"></a>Help Output: <em>offset</em> <strong>doc-opt-col</strong></dt>
<dd><p>Column in which <em>doc options</em> start.  A doc option isn&rsquo;t actually
an option, but rather an arbitrary piece of documentation that is
displayed in much the same manner as the options.  For example, in
the output of <code>folder --help</code>:
</p>
<pre class="verbatim">Usage: folder [OPTION...] [action] [msg]
GNU MH folder
  Actions are:
      --list                 List the contents of the folder stack
  ...
</pre>
<p>the string &lsquo;<samp>Actions are:</samp>&rsquo; is a doc option.  Thus, if you set
<kbd>ARGP_HELP_FMT=doc-opt-col=6</kbd> the above part of the help output
will look as follows:
</p>
<pre class="verbatim">Usage: folder [OPTION...] [action] [msg]
GNU MH folder
      Actions are:
      --list                 List the contents of the folder stack
  ...
</pre></dd></dl>

<dl>
<dt><a name="index-opt_002ddoc_002dcol"></a>Help Output: <em>offset</em> <strong>opt-doc-col</strong></dt>
<dd><p>Column in which option description starts.  Default is 29.
</p>
<div class="smallexample">
<pre class="smallexample">$ <kbd>sieve --help|grep ADDRESS</kbd>
  -e, --email=ADDRESS        Override user email address
$ <kbd>ARGP_HELP_FMT=opt-doc-col=19 sieve --help|grep ADDRESS</kbd>
  -e, --email=ADDRESS   Override user email address
$ <kbd>ARGP_HELP_FMT=opt-doc-col=9 sieve --help|grep -i ADDRESS</kbd>
  -e, --email=ADDRESS
         Override user email address
</pre></div>

<p>Notice, that the description starts on a separate line if
<code>opt-doc-col</code> value is too small.
</p></dd></dl>

<dl>
<dt><a name="index-header_002dcol"></a>Help Output: <em>offset</em> <strong>header-col</strong></dt>
<dd><p>Column in which <em>group headers</em> are printed.  A group header is a
descriptive text preceding an option group.  For example, in the
following text:
</p>
<pre class="verbatim"> Sieve options
  -I, --includedir=DIR       Append directory DIR to the
                             list of include directories
</pre><p>the text &lsquo;<samp>Sieve options</samp>&rsquo; is a group header.
</p>
<p>The default value is 1.
</p></dd></dl>

<dl>
<dt><a name="index-usage_002dindent"></a>Help Output: <em>offset</em> <strong>usage-indent</strong></dt>
<dd><p>Indentation of wrapped usage lines.  Affects <samp>--usage</samp>
output.  Default is 12.
</p></dd></dl>

<dl>
<dt><a name="index-rmargin"></a>Help Output: <em>offset</em> <strong>rmargin</strong></dt>
<dd><p>Right margin of the text output.  Used for wrapping.
</p></dd></dl>

<hr>
<div class="header">
<p>
Next: <a href="GNU-FDL.html#GNU-FDL" accesskey="n" rel="next">GNU FDL</a>, Previous: <a href="Date-Input-Formats.html#Date-Input-Formats" accesskey="p" rel="prev">Date Input Formats</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</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>