aboutsummaryrefslogtreecommitdiffstats
path: root/README
blob: 9d7e697df7a7f5a3818807cdf5cc28f3ceaaee65 (plain)
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
			 fetchmail README

fetchmail is a free, full-featured, robust, well-documented remote
mail retrieval and forwarding utility intended to be used over
on-demand TCP/IP links (such as SLIP or PPP connections).  It
retrieves mail from remote mail servers and forwards it to your local
(client) machine's delivery system, so it can then be be read by
normal mail user agents such as elm(1) or Mail(1).

fetchmail supports standard all mail-retrieval protocols in use on the
Internet: POP2, POP3 (including POP3 with RFC1938 one-time passwords),
RPOP, APOP, KPOP, all flavors of IMAP (including IMAP4rev1 with
RFC1731 Kerberos v4 authentication), and ESMTP ETRN.

The fetchmail code was developed under Linux, but has also been
extensively tested under 4.4BSD, AIX, HP-UX versions 9 and 10, 
SunOS, Solaris, NEXTSTEP, OSF 3.2.  

It should be readily portable to other Unix variants (it uses GNU
autoconf).  It has also been ported to QNX; to build under QNX, see
the header comments in the Makefile.  It is reported to build and run
under AmigaOS.

See the distribution files FEATURES for a full list of features, NEWS
for detailed information on recent changes and NOTES for design notes.

The fetchmail code appears to be stable and free of bugs affecting
normal operation (that is, retrieving from POP3 or IMAP in single-drop
mode and forwarding via SMTP to sendmail).  It will probably undergo
substantial change only if and when support for a new retrieval
protocol or authentication mode is added.

You can easily fetch the latest version of fetchmail via FTP from the
following FTP directory:

	ftp://ftp.ccil.org/pub/esr/fetchmail

Or you can get it from the fetchmail home page:

	http://www.ccil.org/~esr/fetchmail

Enjoy!

							-- esr
200; background-color: #fff0f0 } /* Literal.String.Delimiter */ .highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */ .highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */ .highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */ .highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */ .highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */ .highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */ .highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */ .highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */ .highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */ .highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */ .highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */ .highlight .vc { color: #336699 } /* Name.Variable.Class */ .highlight .vg { color: #dd7700 } /* Name.Variable.Global */ .highlight .vi { color: #3333bb } /* Name.Variable.Instance */ .highlight .vm { color: #336699 } /* Name.Variable.Magic */ .highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id='rpm2lsm.1'>
<refmeta>
<refentrytitle>rpm2lsm</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv id='name'>
<refname>rpm2lsm</refname>
<refpurpose>generate Linux Software Map entries from RPMs</refpurpose>
</refnamediv>
<refsynopsisdiv id='synopsis'>

<cmdsynopsis>
  <command>rpm2lsm</command>
  <arg choice='opt'>-a <replaceable>author</replaceable></arg>
  <arg choice='opt'>-k <replaceable>keywords</replaceable></arg>
  <arg choice='opt'>-p <replaceable>platforms</replaceable></arg>
  <arg choice='opt'>-m <replaceable>maintainer</replaceable></arg>
  <arg choice='plain'><replaceable>rpmfile</replaceable></arg>
</cmdsynopsis>

</refsynopsisdiv>

<refsect1 id='description'><title>DESCRIPTION</title>
<para>This tool extracts tag information from an RPM file to generate a
Linux Software Map (version 3) entry on standard output.  Command-line
switches support adding LSM fields that have no equivalents in RPMs.
Here are the field-generation rules:</para>
<variablelist remap='TP'>
<varlistentry>
<term>Title:</term>
<listitem>
<para>Taken straight from the RPM Name field.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Version:</term>
<listitem>
<para>Taken straight from the RPM Version field.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Entered-Date:</term>
<listitem>
<para>LSM-generation time in YYYY-MM-DD format.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Description:</term>
<listitem>
<para>Taken straight from the RPM Description field.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Keywords:</term>
<listitem>
<para>Taken from the value of the <option>-k</option> command-line option.
If no such option is given, it is omitted.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Author:</term>
<listitem>
<para>Taken from the value of the <option>-a</option> command-line
option.  If no such option is given, it looks for an AUTHORS file in
the current directory (GNU convention) and uses that.  If no AUTHORS
file is present, your email addess and full name from the password
file</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Maintained-By:</term>
<listitem>
<para>Taken from the value of the <option>-m</option> command-line
option.  If that was not given, taken from the RPM Packager field.  
If that was not given, fill in the Author name.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Primary-Site:</term>
<listitem>
<para>The first (site) line is taken from the RPM URL field.  Second
and subsequent lines list tarballs and RPMs that match on name, version
number, and release number with the RPM algument.  For each file,
size in 1K blocks is filled in.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Alternate-Site:</term>
<listitem>
<para>This field is not generated.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Original-Site:</term>
<listitem>
<para>This field is not generated.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Platforms:</term>
<listitem>
<para>Taken from the value of the <option>-p</option> command-line option.
If no such option is given, 'All' is filled in.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Copying-Policy:</term>
<listitem>
<para>Taken straight from the RPM License field.</para>
</listitem>
</varlistentry>
</variablelist>

<para>These are all the fields supported in LSM version 3.  You can see the 
<ulink url='http://ibiblio.org/pub/Linux/LSM-TEMPLATE'>
LSM template
</ulink>
for full details.</para>
</refsect1>

<refsect1 id='author'><title>AUTHOR</title>
<para>Eric S. Raymond <email>esr@thyrsus.com</email>.
For updates, see <ulink url="http://www.catb.org/~esr/software.html">
http://www.catb.org/~esr/software.html</ulink>.</para>
</refsect1>

<refsect1 id='see_also'><title>SEE ALSO</title>
<para><citerefentry><refentrytitle>rpm</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
</refsect1>
</refentry>