/usr/share/doc/mailutils-doc/mailutils.html/frm-and-from.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: frm and from</title>

<meta name="description" content="GNU Mailutils Manual: frm and from">
<meta name="keywords" content="GNU Mailutils Manual: frm and from">
<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="Programs.html#Programs" rel="up" title="Programs">
<link href="mail.html#mail" rel="next" title="mail">
<link href="Debugging-Categories.html#Debugging-Categories" rel="prev" title="Debugging Categories">
<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="frm-and-from"></a>
<div class="header">
<p>
Next: <a href="mail.html#mail" accesskey="n" rel="next">mail</a>, Previous: <a href="debugging.html#debugging" accesskey="p" rel="prev">debugging</a>, Up: <a href="Programs.html#Programs" accesskey="u" rel="up">Programs</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="frm-and-from-_002d_002d_002d-List-Headers-from-a-Mailbox"></a>
<h3 class="section">3.4 <code>frm</code> and <code>from</code> &mdash; List Headers from a Mailbox</h3>
<table class="cartouche" border="1"><tr><td>
<div align="center"><strong>Editor&rsquo;s note:</strong>
</div><p>The information in this node may be obsolete or
otherwise inaccurate.  This message will disappear, once this node revised.
</p></td></tr></table>

<p>GNU mailutils provides two commands for listing messages in a mailbox.
These are <code>from</code> and <code>frm</code>.
</p>
<p>The behavior of both programs is affected by the following
configuration file statements:
</p>
<table>
<thead><tr><th width="30%">Statement</th><th width="60%">Reference</th></tr></thead>
<tr><td width="30%">debug</td><td width="60%">See <a href="Debug-Statement.html#Debug-Statement">Debug Statement</a>.</td></tr>
<tr><td width="30%">tls</td><td width="60%">See <a href="TLS-Statement.html#TLS-Statement">TLS Statement</a>.</td></tr>
<tr><td width="30%">mailbox</td><td width="60%">See <a href="Mailbox-Statement.html#Mailbox-Statement">Mailbox Statement</a>.</td></tr>
<tr><td width="30%">locking</td><td width="60%">See <a href="Locking-Statement.html#Locking-Statement">Locking Statement</a>.</td></tr>
</table>

<a name="frm"></a>
<h4 class="subheading"><code>frm</code></h4>
<a name="index-frm"></a>

<p>The <code>frm</code> utility outputs a header information of
the selected messages in a mailbox.  By default, <code>frm</code> reads 
user&rsquo;s system mailbox and outputs the contents of <code>From</code> and
<code>Subject</code> headers for each message.  If a folder is specified in
the command line, the program reads that folder rather than the default
mailbox.
</p>
<p>The following command line options alter the behavior of the program:
</p>
<dl compact="compact">
<dt><samp>-d</samp></dt>
<dt><samp>--debug</samp></dt>
<dd><p>Enable debugging output.
</p></dd>
<dt><samp>-f <var>string</var></samp></dt>
<dt><samp>--field <var>string</var></samp></dt>
<dd><p>Display the header named by <var>string</var> instead of <code>From</code>
<code>Subject</code> pair.
</p></dd>
<dt><samp>-l</samp></dt>
<dt><samp>--to</samp></dt>
<dd><p>Include the contents of <code>To</code> header to the output.  The output field
order is then: <code>To</code> <code>From</code> <code>Subject</code>.
</p></dd>
<dt><samp>-n</samp></dt>
<dt><samp>--number</samp></dt>
<dd><p>Prefix each line with corresponding message number.
</p></dd>
<dt><samp>-Q</samp></dt>
<dt><samp>--Quiet</samp></dt>
<dd><p>Be very quiet.  Nothing is output except error messages.  This is useful
in shell scripts where only the return status of the program is
important.
</p></dd>
<dt><samp>-q</samp></dt>
<dt><samp>--query</samp></dt>
<dd><p>Print a message only if there are unread messages in the mailbox.
</p></dd>
<dt><samp>-S</samp></dt>
<dt><samp>--summary</samp></dt>
<dd><p>Print a summary line.
</p></dd>
<dt><samp>-s <var>attr</var></samp></dt>
<dt><samp>--status <var>attr</var></samp></dt>
<dd><p>Only display headers from messages with the given status.
<var>Attr</var> may be one of the following: &lsquo;<samp>new</samp>&rsquo;, &lsquo;<samp>read</samp>&rsquo;,
&lsquo;<samp>unread</samp>&rsquo;.  It is sufficient to specify only first letter of
an <var>attr</var>.  Multiple <samp>-s</samp> options are allowed.
</p></dd>
<dt><samp>-t</samp></dt>
<dt><samp>--align</samp></dt>
<dd><p>Tidy mode.  In this mode <code>frm</code> tries to preserve the alignment of
the output fields.  It also enables the use of BIDI algorithm for
displaying subject lines that contain text in right-to-left
orientation (such as Arabic or Hebrew).
</p></dd>
</dl>

<a name="from"></a>
<h4 class="subheading"><code>from</code></h4>
<a name="index-from"></a>

<p>The <code>from</code> utility displays sender and subject of each message
in a mailbox.  By default, it reads the user&rsquo;s system mailbox.  If the
program is given a single argument, it is interpreted as a name of the
user whose mailbox is to be read.  Obviously, permissions are required
to access that user&rsquo;s mailbox, so such invocations may be used only
by superuser.
</p>
<p>The option <samp>-f</samp> (<samp>--file</samp>) instructs <code>from</code> to read
the given mailbox.
</p>
<p>The full list of options, supported by <code>from</code> follows:
</p>
<dl compact="compact">
<dt><samp>-c</samp></dt>
<dt><samp>--count</samp></dt>
<dd><p>Prints only a count of messages in the mailbox and exit.
</p>
</dd>
<dt><samp>-d</samp></dt>
<dt><samp>--debug</samp></dt>
<dd><p>Prints additional debugging output.
</p>
</dd>
<dt><samp>-s <var>string</var></samp></dt>
<dt><samp>--sender=<var>string</var></samp></dt>
<dd><p>Prints only mail whose &lsquo;<samp>From:</samp>&rsquo; headers contain the supplied string.
</p><table class="cartouche" border="1"><tr><td>
<div align="center"><strong>Editor&rsquo;s note:</strong>
</div><p>Probably, this should test envelopes as well.
</p></td></tr></table>
<p><!-- /@w -->
</p>
</dd>
<dt><samp>-f <var>url</var></samp></dt>
<dt><samp>--file=<var>url</var></samp></dt>
<dd><p>Examine mailbox from the given <var>url</var>.
</p></dd>
</dl>

<hr>
<div class="header">
<p>
Next: <a href="mail.html#mail" accesskey="n" rel="next">mail</a>, Previous: <a href="debugging.html#debugging" accesskey="p" rel="prev">debugging</a>, Up: <a href="Programs.html#Programs" accesskey="u" rel="up">Programs</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 / frm-and-from.html
