summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org.ua>2005-03-12 20:53:03 +0000
committerSergey Poznyakoff <gray@gnu.org.ua>2005-03-12 20:53:03 +0000
commitb81c839194e7f24524f7d9a27dadc10cb5d03d80 (patch)
treef27174ba99c5c696b09e79871013d2bb81f315cb
parentabaaf6eac80c868b53fbd8f83ac70d5e87798366 (diff)
downloadmailutils-b81c839194e7f24524f7d9a27dadc10cb5d03d80.tar.gz
mailutils-b81c839194e7f24524f7d9a27dadc10cb5d03d80.tar.bz2
Updated
-rw-r--r--ChangeLog8
-rw-r--r--README46
-rw-r--r--README-alpha125
3 files changed, 162 insertions, 17 deletions
diff --git a/ChangeLog b/ChangeLog
index 3fba7c60a..40b652af1 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,13 @@
2005-03-12 Sergey Poznyakoff
+ * README: Updated. Switch to outline mode.
+ * README-alpha: Updated. Switch to outline mode.
+ * mailbox/mutil.c: Minor indentation fix
+ * mailbox/pop/pop3_sendline.c: Do not redefine _GNU_SOURCE
+ * mailbox/nntp/nntp_sendline.c: Likewise
+
+2005-03-12 Sergey Poznyakoff
+
* lib/mailcap.c: New file. Routines for displaying MIME
messages.
* lib/Makefile.am: Added mailcap.c
diff --git a/README b/README
index f58bf18d6..7b9cb4327 100644
--- a/README
+++ b/README
@@ -1,6 +1,9 @@
This is the GNU Mailutils package
=================================
+* Introduction
+==============
+
This package contains a series of useful mail clients, servers, and
libraries. These are the primary mail utilities of the GNU system.
@@ -21,8 +24,8 @@ COPYING.LESSER, COPYING and doc/texinfo/COPYING.DOC.
This software is part of the GNU Project and belongs to the Free Software
Foundation.
-Why use this package?
-=====================
+* Why use this package?
+=======================
This package started off to try and handle large mailbox files more
gracefully then current POP3 servers did. While it handles this task,
@@ -31,11 +34,11 @@ without any real effort on your part. Also, if a new format is added
at a later date, your program will support that new format
automatically as soon as it is compiled against the new library.
-This server is also released as part of Debian, so you should expect
+This package is also released as part of Debian, so you should expect
it to compile cleanly on all the platforms supported there.
-How to install
-==============
+* How to install
+================
Please see the INSTALL file in this directory for the generic instructions
on how to use configure. The following short summary describes the mailutils-
@@ -242,9 +245,18 @@ features:
Disables support for authentication using virtual
mail domains.
+Several environment variables affect the configuration. Currently,
+the only mailutils-specific variable is DEFAULT_CUPS_CONFDIR. It
+sets the location of CUPS (Common UNIX Printing System) configuration
+directory, which is needed for `mimeview' utility. By default, this
+location is $sysconfdir/cups. On most sites, however, it may be
+reasonable to set it to /etc/cups, e.g.:
+
+ ./configure DEFAULT_CUPS_CONFDIR=/etc/cups ...
+
-Where to report BUGS
-====================
+* Where to report BUGS
+======================
Please report any bugs to <bug-mailutils@gnu.org>. We encourage sysadmins
who will be using this package to subscribe to this list by sending an email
@@ -252,3 +264,23 @@ to <bug-mailutils-request@gnu.org> with the word `subscribe' in the body of
the message. Another way to subscribe is by visiting
http://mail.gnu.org/mailman/listinfo/bug-mailutils.
+* Copyright information:
+
+Copyright (C) 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
+
+ Permission is granted to anyone to make or distribute verbatim copies
+ of this document as received, in any medium, provided that the
+ copyright notice and this permission notice are preserved,
+ thus giving the recipient permission to redistribute in turn.
+
+ Permission is granted to distribute modified versions
+ of this document, or of portions of it,
+ under the above conditions, provided also that they
+ carry prominent notices stating who last changed them.
+
+
+Local Variables:
+mode: outline
+paragraph-separate: "[ ]*$"
+version-control: never
+End:
diff --git a/README-alpha b/README-alpha
index a28472dbf..2e7967e5b 100644
--- a/README-alpha
+++ b/README-alpha
@@ -1,26 +1,131 @@
This is the GNU mailutils package.
+This document describes the actions needed to build the pre-release
+or CVS version of the package. See end of file for copying conditions.
+
+* Introduction
This is a *pre-release* version, and not ready for production use yet. If you
are taking source from CVS, you will need to have libtool, automake, and
-autoconf installed to help contribute. The script autogen.sh is provided to
-help autoconfigure mailutils from the cvs src. After you run
-autogen.sh, there should be a file 'INSTALL' with (generic)
-installation instructions.
+autoconf installed to help contribute. See the chapter `Building' for the
+detailed instructions. The script autogen.sh is provided to help
+autoconfigure mailutils from the cvs src. After you run autogen.sh,
+there should be a file 'INSTALL' with (generic) installation instructions.
+Package-specific installation instructions are set forth in the file
+README.
+
+Please, note that the accompanying documentation may be inaccurate or
+incomplete. The ChangeLog file is the authoritative documentation of
+all recent changes.
Report bugs to <bug-mailutils@gnu.org>
-To get this information from CVS issue the following commands:
+* Checking Out the Sources
-cvs -d :pserver:anoncvs@subversions.gnu.org:/cvsroot/mailutils login
+The following instructions apply if you wish to obtain sources from
+the CVS repository:
-Press enter when prompted for a password.
+To checkout the source tree from CVS issue the following command:
-cvs -d :pserver:anoncvs@subversions.gnu.org:/cvsroot/mailutils checkout mailutils
+CVS_RSH=ssh \
+ cvs -d :ext:anoncvs@savannah.gnu.org:/cvsroot/mailutils checkout mailutils
+
+Make sure SSHv2 is used.
This will give you read-only access. If you think you need write access,
contact the mailing list.
-In order to build this you will need to call the auto* tools with
-the right arguments, see or run autogen.sh.
+* Building
+
+In order to build this you will first need to have right versions of
+autotools. At the time of this writing these are:
+
+ Package Version (>=)
+ ======== ============
+ automake 1.8.5
+ autoconf 2.59
+ libtool 1.5.8
+ gettext 0.14.1
+
+To prepare the package for building run autogen.sh. Then run
+./configure with the desired options (See INSTALL and README for
+the detailed instructions). Finally, run make.
+
+* Debugging
+
+To enable additional debugging information, configure the package with
+--enable-debug option.
+
+Unless you compile mailutils statically, you will need to run following
+command to debug a utility:
+
+ libtool --mode execute gdb UTILITY-NAME
+
+Sometimes it is impossible or inconvenient to start a utility from the
+debugger. In this case, use --HANG option, which is supported by any
+of the mailutils programs. The option instructs the program to sleep
+for a given number of seconds (3600 by default) right after startup.
+For example, to debug `mimeview' utility, run
+
+ mimeview --HANG [OTHER-OPTIONS]
+
+Then switch to another terminal, get the PID of the ivoked utility
+and attach to it using gdb:
+
+ gdb mimeview PID
+
+Once in gdb, issue the following command
+
+ set _argp_hang=0
+
+Now set your breakpoints and proceed as usual.
+
+* Importing gnulib files
+
+Mailutils imports several source files from gnulib. These go mainly to
+the conventional library libmailutils (directory lib/), but several of them
+are incorporated into the main library libmailbox (directory mailbox/).
+The imported sources are kept in the CVS repository to avoid using eventually
+unstable versions appearing in the main gnulib CVS. Once in a time we
+update the sources. The update procedure is quite straightforward:
+change to the root directory of the mailutils tree and run `gnulib-sync'
+script:
+
+ $ cd mailutils
+ $ scripts/gnulib-sync $HOME/src/gnulib
+
+The script takes a single argument: name of the directory with the
+copy of gnulib source tree (see http://savannah.gnu.org/projects/gnulib
+for information on how to obtain gnulib sources). After incorporating
+the files, gnulib-sync leaves in the current directory two files named
+gnulib.changelog and gnulib.cvs. The file gnulib.changelog contains the
+entry to be prepended to ChangeLog, the file gnulib.cvs is a shell script
+with the commands necessary to incorporate all the changes into CVS.
+
+If you need to add more gnulib modules to mailutils, add their names
+to gnulib.modules file, following the instructions in its heading
+comment. Please avoid placing modules in :mailbox section, as this
+may lead to unwanted name clashes when linking user programs with
+libmailbox.
+
+* Copyright information:
+
+Copyright (C) 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
+
+ Permission is granted to anyone to make or distribute verbatim copies
+ of this document as received, in any medium, provided that the
+ copyright notice and this permission notice are preserved,
+ thus giving the recipient permission to redistribute in turn.
+
+ Permission is granted to distribute modified versions
+ of this document, or of portions of it,
+ under the above conditions, provided also that they
+ carry prominent notices stating who last changed them.
+
+
+Local Variables:
+mode: outline
+paragraph-separate: "[ ]*$"
+version-control: never
+End:

Return to:

Send suggestions and report system problems to the System administrator.