Commit 7824f73f 7824f73fe496e399afb660631871ffa491c5f4e8 by Wojciech Polak

Update docs

* doc/texinfo/libmuauth.texi: Move to libmu_auth.texi
* doc/texinfo/libsieve.texi: Move to libmu_sieve.texi
1 parent 89d40411
%%comments:
Copyright (C) 1999,2000,2001,2002,2003,2004,2005,2006 Free Software Foundation, Inc.
Copyright (C) 1999,2000,2001,2002,2003,2004,2005,2006,2009 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
......@@ -12,8 +12,8 @@ Texts. A copy of the license is included in the file COPYING.
%%short-description: A set of libraries and programs for handling e-mail messages.
%%full-description:
GNU mailutils is a collection of mail-related utilities. At the
core of mailutils is libmailbox, a library which provides access
GNU Mailutils is a collection of mail-related utilities. At the
core of mailutils is libmailutils, a library which provides access
to various forms of mailbox files (including remote mailboxes via
popular protocols). It also provides support for parsing of RFC-2822
style messages and MIME support. The utilities, provided by
......@@ -26,11 +26,9 @@ Texts. A copy of the license is included in the file COPYING.
%%license: GPL
%%maintainer:
Jeff Bailey <jbailey@nisa.net>,
Alain Magloire <alainm@gnu.org>,
Sergey Poznyakoff <gray@Mirddin.farlep.net>
Sergey Poznyakoff <gray@gnu.org.ua>
%%updated: 5 Jul 2006
%%updated: 14 Feb 2009
%%keywords: mail, email, pop3, imap4, sieve, comsat, smtp, mh, maildir, movemail
......@@ -53,25 +51,24 @@ Texts. A copy of the license is included in the file COPYING.
Jeff Bailey <jbailey@gnu.org>,
Sam Roberts <sroberts@uniserve.com>,
Sean 'Shaleh' Perry <shaleh@debian.org>,
Sergey Poznyakoff <gray@Mirddin.farlep.net>,
Sergey Poznyakoff <gray@gnu.org.ua>,
Wojciech Polak <polak@gnu.org>
%%source-tarball: ftp://ftp.gnu.org/pub/gnu/mailutils/mailutils-1.0.tar.gz
%%source-tarball: ftp://ftp.gnu.org/pub/gnu/mailutils/mailutils-2.0.tar.gz
%%source-info: http://savannah.gnu.org/projects/mailutils
%%repository:
:pserver:anonymous@cvs.savannah.gnu.org:/cvsroot/mailutils co mailutils,
http://savannah.gnu.org/cvs/?group_id=36,
http://savannah.gnu.org/cgi-bin/viewcvs/mailutils/mailutils,
git clone git://git.savannah.gnu.org/mailutils.git,
http://savannah.gnu.org/git/?group=mailutils,
http://git.savannah.gnu.org/gitweb/?p=mailutils.git
%%source-language: C
%%weak-prerequisites: Guile 1.6.7, Libtool 1.4.2, GSASL 0.2.3, GnuTLS 1.0.18
%%version: 1.0 released on 07 Dec 2006
%%version: 2.0 released on 26 Dec 2008
%%bug-list: bug-mailutils@gnu.org bug-mailutils@gnu.org http://mail.gnu.org/mailman/listinfo/bug-mailutils
%%bug-list: bug-mailutils@gnu.org bug-mailutils@gnu.org http://lists.gnu.org/mailman/listinfo/bug-mailutils
%%entry-written-by: Sergey Poznyakoff <gray@gnu.org>
......
## Process this file with GNU Automake to create Makefile.in
## Copyright (C) 2001, 2002, 2003, 2004, 2006,
## 2007 Free Software Foundation, Inc.
## 2007, 2009 Free Software Foundation, Inc.
##
## GNU Mailutils is free software; you can redistribute it and/or
## modify it under the terms of the GNU General Public License as
......@@ -46,8 +46,8 @@ mailutils_TEXINFOS = \
imap4.texi\
iterator.texi\
libmu_scm.texi\
libmuauth.texi\
libsieve.texi\
libmu_auth.texi\
libmu_sieve.texi\
locker.texi\
mailbox.texi\
mailcap.texi\
......
@c This is part of the GNU Mailutils manual.
@c Copyright (C) 1999,2000,2001,2002,2003,2004,
@c 2007 Free Software Foundation, Inc.
@c 2007,2009 Free Software Foundation, Inc.
@c See file mailutils.texi for copying conditions.
@comment *******************************************************************
The functions from @file{libmailbox} library get user information from
the system user database. The library @file{libmuauth} extends this
functionality, allowing @file{libmailbox} functions to obtain
The functions from @file{libmailutils} library get user information from
the system user database. The library @file{libmu_auth} extends this
functionality, allowing @file{libmailutils} functions to obtain
information about a user from several places, like @sc{sql} database,
etc. The method used is described in detail in @ref{Auth Statement,
authentication}. This chapter contains a very succinct description of
......@@ -14,16 +14,16 @@ the underlying library mechanism.
@menu
* Data Types::
* Initializing libmuauth::
* Initializing libmu_auth::
* Module Creation and Destruction::
* Obtaining Authorization Information::
* Existing Modules::
* Using libmuauth in Your Programs::
* Using libmu_auth in Your Programs::
@end menu
@node Data Types
@subsection Data Types
@cindex libmuauth, data types
@cindex libmu_auth, data types
@deftp {Data Type} mu_auth_fp
......@@ -98,7 +98,7 @@ struct mu_auth_data @{
@deftp {Data Type} mu_auth_module
The @code{mu_auth_module} structure contains full information about a
libmuauth module. It is declared as follows:
libmu_auth module. It is declared as follows:
@smallexample
@group
......@@ -116,12 +116,12 @@ struct mu_auth_module @{
@end smallexample
@end deftp
@node Initializing libmuauth
@subsection Initializing @file{libmuauth}
@node Initializing libmu_auth
@subsection Initializing @file{libmu_auth}
@deftypefun void mu_auth_init (void)
This function registers the command line capability ``auth''. It must be
called after registering @file{libmuauth} modules and before calling
called after registering @file{libmu_auth} modules and before calling
@code{mu_agrp_parse()}. If an error occurs, this function prints
diagnostic message and aborts the program.
@end deftypefun
......@@ -150,7 +150,7 @@ Register the module defined by the @var{mod} argument.
@node Obtaining Authorization Information
@subsection Obtaining Authorization Information
@cindex libmuauth, obtaining authorization information
@cindex libmu_auth, obtaining authorization information
@deftypefun int mu_auth_runlist (list_t @var{flist}, struct mu_auth_data **@var{return_data}, void *@var{key}, void *@var{call_data});
The list is expected to contain @code{mu_auth_fp} pointers. Each of them
......@@ -183,20 +183,20 @@ Authenticate the user whose data are in @var{auth_data} using password
@node Existing Modules
@subsection Existing Modules
@cindex libmuauth modules
@cindex libmu_auth modules
@deftypefun int mu_auth_nosupport (struct mu_auth_data **@var{return_data}, void *@var{key}, void *@var{func_data}, void *@var{call_data});
The ``not-supported'' module. Always returns @code{ENOSYS}.
@end deftypefun
@defvar mu_auth_system_module
This module is always registered even if @file{libmuauth} is not linked.
This module is always registered even if @file{libmu_auth} is not linked.
It performs usual authentication using system user database
(@file{/etc/password} et al.)
@end defvar
@defvar mu_auth_generic_module
This module is always registered even if @file{libmuauth} is not linked.
This module is always registered even if @file{libmu_auth} is not linked.
Both its authorization handlers are @code{mu_auth_nosupport}. Its
authentication handler computes the MD5 or DES hash over the supplied
password with the seed taken from @code{passwd} member of its @var{key}
......@@ -228,13 +228,13 @@ module.
@end defvar
@node Using libmuauth in Your Programs
@subsection Using @file{libmuauth} in Your Programs
@cindex Using @file{libmuauth}
@cindex Linking with @file{libmuauth}
@cindex libmuauth, linking with
@node Using libmu_auth in Your Programs
@subsection Using @file{libmu_auth} in Your Programs
@cindex Using @file{libmu_auth}
@cindex Linking with @file{libmu_auth}
@cindex libmu_auth, linking with
To link your program against @file{libmuauth}, obtain loader arguments
To link your program against @file{libmu_auth}, obtain loader arguments
by running @command{mailutils-config} as follows:
@smallexample
......
@c This is part of the GNU Mailutils manual.
@c Copyright (C) 1999,2000,2001,2002,2003,2004,2006,
@c 2007 Free Software Foundation, Inc.
@c 2007,2009 Free Software Foundation, Inc.
@c See file mailutils.texi for copying conditions.
@comment *******************************************************************
@code{Libsieve} is GNU implementation of the mail filtering
@code{Libmu_sieve} is GNU implementation of the mail filtering
language Sieve. The library is built around a @dfn{Sieve Machine} --- an
abstract computer constructed specially to handle mail filtering tasks.
This computer has two registers: program counter and numeric accumulator;
......@@ -13,7 +13,7 @@ functions is provided for creating and destroying instances of Sieve
Machine, manipulating its internal data, compiling and executing a
sieve program.
The following is a typical scenario of using @code{libsieve}:
The following is a typical scenario of using @code{libmu_sieve}:
@enumerate
@item Application program creates the instance of sieve machine.
......@@ -664,7 +664,7 @@ Dump the disassembled code of the sieve machine @var{mach}.
@subsection Writing Loadable Commands
This section contains an example of how to write external loadable
commands for GNU libsieve.
commands for GNU libmu_sieve.
@smallexample
@include numaddr.inc
......
......@@ -337,10 +337,10 @@ Major differences between Mailutils MH and other MH implementations
Mailutils Libraries
* libmailbox:: The Core Library.
* libmuauth:: Auxiliary Library for Authenticating Users.
* libmailutils:: The Core Library.
* libmu_auth:: Auxiliary Library for Authenticating Users.
* libmu_scm:: Mailutils to Scheme Interface.
* libsieve:: GNU Implementation of Sieve Mail Filtering.
* libmu_sieve:: GNU Implementation of Sieve Mail Filtering.
Framework
......@@ -364,11 +364,11 @@ Framework
Authentication Library
* Data Types::
* Initializing libmuauth::
* Initializing libmu_auth::
* Module Creation and Destruction::
* Obtaining Authorization Information::
* Existing Modules::
* Using libmuauth in Your Programs::
* Using libmu_auth in Your Programs::
Mailutils to Scheme Interface
......@@ -521,22 +521,22 @@ automatically as soon as it is compiled against the new library.
@cindex Libraries
@menu
* libmailbox:: The Core Library.
* libmuauth:: Auxiliary Library for Authenticating Users.
* libmailutils:: The Core Library.
* libmu_auth:: Auxiliary Library for Authenticating Users.
* libmu_scm:: Mailutils to Scheme Interface.
* libsieve:: GNU Implementation of Sieve Mail Filtering.
* libmu_sieve:: GNU Implementation of Sieve Mail Filtering.
@end menu
@node libmailbox
@node libmailutils
@section Framework
@cindex Framework
@include framework.texi
@node libmuauth
@node libmu_auth
@section Authentication Library
@cindex Authentication Library
@cindex libmuauth
@include libmuauth.texi
@cindex libmu_auth
@include libmu_auth.texi
@node libmu_scm
@section Mailutils to Scheme Interface
......@@ -544,11 +544,11 @@ automatically as soon as it is compiled against the new library.
@cindex libmu_scm
@include libmu_scm.texi
@node libsieve
@node libmu_sieve
@section Sieve Library
@cindex Sieve Library
@cindex libsieve
@include libsieve.texi
@cindex libmu_sieve
@include libmu_sieve.texi
@node Sieve Language
@chapter Sieve Language
......
......@@ -6679,7 +6679,7 @@ $B(,5)\
@pindex mailutils-config
This program is designed for developers wishing to link their programs
against libmailbox. It allows to examine the particulars of the
against libmailutils. It allows to examine the particulars of the
current build of Mailutils and to get the command line parameters
necessary for compiling and linking an application with Mailutils
libraries.
......@@ -6710,14 +6710,14 @@ standard output the loader flags necessary to link a program against
Mailutils libraries.
When invoked without arguments, it produces the flags necessary to
link against the basic library of Mailutils: @file{libmailbox}.
link against the basic library of Mailutils: @file{libmailutils}.
Arguments may be given that alter this behavior. These are:
@table @samp
@item auth
Print flags to link against @file{libmuauth}, the library adding new
authentication methods to @file{libmailbox}.
Print flags to link against @file{libmu_auth}, the library adding new
authentication methods to @file{libmailutils}.
@item guile
Print flags to link against @file{libmu_scm}, the Guile interface
......
......@@ -131,7 +131,7 @@ text:
This results in the contents of file @file{myresponse.txt} being read
and interpreted as the contents of the multiline string.
GNU libsieve extends the described syntax as follows. If the keyword
GNU libmu_sieve extends the described syntax as follows. If the keyword
@code{text:} is immediately followed by a dash (@samp{-}), then all
leading tab characters are stripped from input lines and the line
containing delimiter (@samp{.}). This allows multiline strings within
......@@ -460,7 +460,7 @@ require "fileinto";
require "comparator-i;ascii-numeric";
@end smallexample
When processing arguments for @code{require} statement, GNU libsieve
When processing arguments for @code{require} statement, GNU libmu_sieve
uses the following algorithm:
@enumerate 1
......@@ -504,7 +504,7 @@ The value of @env{LTDL_LIBRARY_PATH} and @env{LD_LIBRARY_PATH} must be a
colon-separated list of absolute directories, for example,
@samp{"/usr/lib/mypkg:/lib/foo"}.
In any of these directories, @command{libsieve} first attempts to find
In any of these directories, @command{libmu_sieve} first attempts to find
and load the given filename. If this fails, it tries to append the
following suffixes to the file name:
......@@ -515,13 +515,13 @@ following suffixes to the file name:
platform, e.g., @samp{.so}, @samp{.sl}, etc.
@end enumerate
@item If the module is found, @command{libsieve} executes its
@item If the module is found, @command{libmu_sieve} executes its
initialization function (see below) and again looks up the name
in the symbol table. If found, search terminates successfully.
@item If either the module is not found, or the symbol wasn't
found after execution of the module initialization function,
search is terminated with an error status. @command{libsieve} then
search is terminated with an error status. @command{libmu_sieve} then
issues the following diagnostic message:
@smallexample
......@@ -533,7 +533,7 @@ source for the required action NAME is not available
@section Comparators
@cindex comparator, sieve
GNU libsieve supports the following built-in comparators:
GNU libmu_sieve supports the following built-in comparators:
@table @code
@item i;octet
......@@ -553,7 +553,7 @@ be explicitly required prior to use.
@section Tests
@cindex test, sieve
This section describes the built-in tests supported by GNU libsieve.
This section describes the built-in tests supported by GNU libmu_sieve.
In the discussion below the following macro-notations are used:
@table @var
......@@ -1130,7 +1130,7 @@ loadable modules that can be linked in at run time using the
@node Built-in Actions
@subsection Built-in Actions
The GNU libsieve supports the following built-in actions:
The GNU libmu_sieve supports the following built-in actions:
@itemize
@item stop
......@@ -1510,7 +1510,7 @@ This section summarizes the GNU extensions to the sieve language
@enumerate 1
@item Multiline strings syntax
GNU libsieve understands the following multiline string syntax:
GNU libmu_sieve understands the following multiline string syntax:
@smallexample
@group
......
#
# List of source files containing translatable strings.
# Copyright (C) 2002, 2003, 2004, 2005, 2008 Free Software Foundation, Inc.
# Copyright (C) 2002,2003,2004,2005,2008,2009 Free Software Foundation, Inc.
#
auth/ldap.c
auth/radius.c
auth/sql.c
auth/tls.c
comsat/action.c
comsat/oldcfg.c
comsat/comsat.c
......@@ -44,56 +39,58 @@ lib/tcpwrap.c
lib/xmalloc.c
lib/strexit.c
libargp/auth.c
libargp/cmdline.c
libargp/common.c
libargp/compat.c
libargp/gsasl.c
libargp/mu_argp.c
libargp/pam.c
libargp/radius.c
libargp/sieve.c
libargp/sql.c
libargp/tls.c
libargp/virtdomain.c
libcfg/acl.c
libcfg/auth.c
libcfg/common.c
libcfg/gsasl.c
libcfg/init.c
libcfg/ldap.c
libcfg/pam.c
libcfg/radius.c
libcfg/sieve.c
libcfg/sql.c
libcfg/tls.c
libcfg/virtdomain.c
libmu_argp/auth.c
libmu_argp/cmdline.c
libmu_argp/common.c
libmu_argp/compat.c
libmu_argp/gsasl.c
libmu_argp/mu_argp.c
libmu_argp/pam.c
libmu_argp/radius.c
libmu_argp/sieve.c
libmu_argp/sql.c
libmu_argp/tls.c
libmu_argp/virtdomain.c
libmu_auth/ldap.c
libmu_auth/radius.c
libmu_auth/sql.c
libmu_auth/tls.c
libmu_cfg/acl.c
libmu_cfg/auth.c
libmu_cfg/common.c
libmu_cfg/gsasl.c
libmu_cfg/init.c
libmu_cfg/ldap.c
libmu_cfg/pam.c
libmu_cfg/radius.c
libmu_cfg/sieve.c
libmu_cfg/sql.c
libmu_cfg/tls.c
libmu_cfg/virtdomain.c
libmu_sieve/actions.c
libmu_sieve/comparator.c
libmu_sieve/conf.c
libmu_sieve/prog.c
libmu_sieve/relational.c
libmu_sieve/require.c
libmu_sieve/runtime.c
libmu_sieve/sieve.l
libmu_sieve/sieve.y
libmu_sieve/tests.c
libmu_sieve/util.c
libmu_sieve/extensions/list.c
libmu_sieve/extensions/moderator.c
libmu_sieve/extensions/spamd.c
libmu_sieve/extensions/timestamp.c
libmu_sieve/extensions/vacation.c
libproto/imap/folder.c
libproto/mbox/mbox.c
libsieve/actions.c
libsieve/comparator.c
libsieve/extensions/list.c
libsieve/extensions/moderator.c
libsieve/extensions/spamd.c
libsieve/extensions/timestamp.c
libsieve/extensions/vacation.c
libsieve/actions.c
libsieve/comparator.c
libsieve/conf.c
libsieve/prog.c
libsieve/relational.c
libsieve/require.c
libsieve/runtime.c
libsieve/sieve.l
libsieve/sieve.y
libsieve/tests.c
libsieve/util.c
maidag/maidag.c
maidag/deliver.c
maidag/lmtp.c
......