This is mairix-el.info, produced by makeinfo version 5.2 from
mairix-el.texi.

Copyright © 2008–2015 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.3 or any later version published by the Free Software
     Foundation; with no Invariant Sections, with the Front-Cover Texts
     being “A GNU Manual”, and with the Back-Cover Texts as in (a)
     below.  A copy of the license is included in the section entitled
     “GNU Free Documentation License”.

     (a) The FSF’s Back-Cover Text is: “You have the freedom to copy and
     modify this GNU manual.”
INFO-DIR-SECTION Emacs network features
START-INFO-DIR-ENTRY
* Mairix: (mairix-el).          Emacs interface to the Mairix mail indexer.
END-INFO-DIR-ENTRY


File: mairix-el.info,  Node: Top,  Next: About,  Up: (dir)

mairix.el—Mairix interface for Emacs
************************************

Mairix is a tool for indexing and searching words in locally stored
mail.  It was written by Richard Curnow and is licensed under the GPL.

   ‘mairix.el’ is an interface to the mairix search engine.  It allows
you to call mairix with a search term, easily create searches based on
the currently displayed mail, save regularly used searches in your
‘.emacs’ for future use and lets you call mairix for updating the
database.

   Copyright © 2008–2015 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.3 or any later version published by the Free Software
     Foundation; with no Invariant Sections, with the Front-Cover Texts
     being “A GNU Manual”, and with the Back-Cover Texts as in (a)
     below.  A copy of the license is included in the section entitled
     “GNU Free Documentation License”.

     (a) The FSF’s Back-Cover Text is: “You have the freedom to copy and
     modify this GNU manual.”

* Menu:

* About::                       About the mairix search engine and mairix.el.
* Configuring mairix::          How to configure mairix.
* Setting up the mairix interface:: Set up mairix.el.
* Using::                       List of interactive functions
* Extending::                   Support your favorite mail reader!
* GNU Free Documentation License::  The license for this documentation.


File: mairix-el.info,  Node: About,  Next: Configuring mairix,  Prev: Top,  Up: Top

1 About mairix and mairix.el
****************************

Mairix is a tool for indexing and searching words in locally stored
mail.  It was written by Richard Curnow and is licensed under the GPL.
Mairix comes with most popular GNU/Linux distributions, but it also runs
under Windows (with cygwin), Mac OS X and Solaris.  The homepage can be
found at <http://www.rpcurnow.force9.co.uk/mairix/index.html>

   Though mairix might not be as flexible as other search tools like
swish++ or namazu, it has the prime advantage of being incredibly fast.
On current systems, it can easily search through headers and message
bodies of thousands and thousands of mails in well under a second.
Building the database necessary for searching might take a minute or
two, but only has to be done once fully.  Afterwards, the updates are
done incrementally and therefore are really fast, too.  Additionally,
mairix is very easy to set up.

   Mairix presents the search results by either populating a _virtual_
maildir/MH folder with symlinks which point to the “real” message files,
or if mbox is used, it creates a new mbox file which contains copies of
the found messages.

   ‘mairix.el’ is an interface to the mairix search engine.  It allows
you to call mairix with a search term, easily create searches based on
the currently displayed mail, save regularly used searches in your
‘.emacs’ for future use and lets you call mairix for updating the
database.  It also lets you easily create search queries using graphical
widgets, similar to a customization buffer.

   Currently, ‘mairix.el’ is only tested with mbox output together with
RMail, Gnus, or VM as the Emacs mail program.  However, it should also
work with Maildir or MH, and it should be very easy to integrate other
Emacs mail programs into ‘mairix.el’ (*note Extending::).

   If you use Gnus with maildir or MH, you should really use the native
Gnus back end ‘nnmairix’ instead, since it is more tightly integrated
into Gnus and has more features.


File: mairix-el.info,  Node: Configuring mairix,  Next: Setting up the mairix interface,  Prev: About,  Up: Top

2 Configuring mairix
********************

Setting up mairix is easy: simply create a ‘.mairixrc’ file with (at
least) the following entries:

     # Your mail base folder
     base=~/Mail

   This is the base folder for your mails.  All the following
directories, except the one for the database, are relative to this base
folder.

     mbox = ... your mbox files which should be indexed ...
     maildir= ... your maildir folders which should be indexed ...
     mh= ... your nnml/mh folders which should be indexed ...

   Specify all your maildir/nnml folders and mbox files (relative to the
base directory!)  you want to index with mairix.  Use colons to separate
different files.  See the man-page for ‘mairixrc’ for details.

     mformat = mbox
     database = ... location of database file ...

   This chooses ‘mbox’ as the output format for the mairix search
results.  Currently, this is the supported format by mairix.el, but
technically it should be possible to also use maildir or mh; it’s just
not tested (yet).

   You should make sure that you don’t accidentally index the search
results produced by mairix.  This can be done by pointing
‘mairix-file-path’ to a directory which is surely not indexed by mairix.
Another possibility is to use something like

     omit = mairix*

   in the ‘.mairixrc’ file, and prefix every search file you use with
“mairix”.

     database = /home/user/.mairixdatabase

   This specifies the name of the database file.  Note that this is not
relative to the ‘base’ folder.

   See the man page for ‘mairixrc’ for details and further options,
especially regarding wildcard usage, which may be a little different
than you are used to.

   Now simply call ‘mairix’ to create the index for the first time.
Note that this may take a few minutes, but every following index will do
the updates incrementally and hence is very fast.


File: mairix-el.info,  Node: Setting up the mairix interface,  Next: Using,  Prev: Configuring mairix,  Up: Top

3 Setting up the mairix interface
*********************************

First, put ‘mairix.el’ in your Emacs search path and put ‘(require
'mairix)’ into your ‘.emacs’ file.  Then, use ‘M-x customize-group
mairix RET’ to set your preferences for mairix.el.  The most important
items are _Mairix File Path_, _Mairix Search File_ and _Mairix Mail
Program_.  The latter specifies which mail program should be used to
display the mairix search results.  Currently, RMail, Gnus with mbox
files, and VM are supported.  If you use Gnus with maildir or mh, use
the native Gnus back end nnmairix instead.

   If you use another Emacs mail program which is not yet supported by
mairix.el, it is pretty easy to integrate it.  *Note Extending::, on how
to integrate it into mairix.el.

   Now you should be ready to go.  *Note Using::, for the available
commands.


File: mairix-el.info,  Node: Using,  Next: Extending,  Prev: Setting up the mairix interface,  Up: Top

4 Using mairix.el
*****************

There are currently no default key bindings for mairix.el, since those
should depend on the used mail program and I personally do not use
RMail, so I wouldn’t know which key bindings are reasonable.  I hope
some day this will change and ‘mairix.el’ will come with some good key
bindings for the different mail programs.  Feel free to send me your
suggestions.  Until then, define some bindings yourself.  Here’s a quick
and dirty solution with global key definitions I currently use, which
might or might not collide with some other modes.  Simply include them
in your ‘.emacs’ and adapt to your needs:

     (global-set-key (kbd "C-c C-o m") 'mairix-search)
     (global-set-key (kbd "C-c C-o w") 'mairix-widget-search)
     (global-set-key (kbd "C-c C-o u") 'mairix-update-database)
     (global-set-key (kbd "C-c C-o f") 'mairix-search-from-this-article)
     (global-set-key (kbd "C-c C-o t") 'mairix-search-thread-this-article)
     (global-set-key (kbd "C-c C-o b") 'mairix-widget-search-based-on-article)
     (global-set-key (kbd "C-c C-o s") 'mairix-save-search)
     (global-set-key (kbd "C-c C-o i") 'mairix-use-saved-search)
     (global-set-key (kbd "C-c C-o e") 'mairix-edit-saved-searches)

   Here’s a description of the available interactive functions:

‘mairix-search’
     Call mairix with a search query.  You will also be asked if you
     want to include whole threads.  The results are saved by mairix in
     the default mail file, which is set through the variable
     ‘mairix-search-file’, which again is prefixed by
     ‘mairix-file-path’.  The results will then be displayed with the
     chosen mail program.  The command used to call mairix is specified
     by the variable ‘mairix-command’, together with the options
     ‘mairix-search-options’.  The latter has the default “-F” for
     making searching faster.

‘mairix-widget-search’
     Creates a mairix query using graphical widgets.  Very handy if
     you’re not (yet) familiar with the mairix search syntax.  Just call
     it to see how it works.  You can then directly call mairix with the
     search term or save it for future use.  Since mairix allows almost
     arbitrary combinations of search commands (like “tc” for “to or
     cc”), you might want to include some other fields.  This can be
     easily done by modifying ‘mairix-widget-fields-list’.

‘mairix-widget-search-based-on-article’
     Create a mairix query using graphical widgets, but based on the
     currently displayed article, i.e., the available fields will be
     filled with the current header values.

‘mairix-search-from-this-article’
     Search messages from sender of the current article.  This is
     effectively a shortcut for calling ‘mairix-search’ with
     ‘f:current_from’.  If used with a prefix, include whole threads of
     the found messages.

‘mairix-search-thread-this-article’
     Search thread for the current article.  This is effectively a
     shortcut for calling ‘mairix-search’ with ‘m:msgid’ of the current
     article and enabled threads.

‘mairix-save-search’
     Save the last search for future use.  You will have to specify a
     name for the search and will then be asked if you want to save your
     saved searches in your ‘.emacs’.  If you answer with yes, the
     variable ‘mairix-saved-searches’ will be saved in the customize
     section of your ‘.emacs’.  You can also do this later by using
     ‘mairix-edit-saved-searches’.

‘mairix-use-saved-search’
     Call mairix with a previously saved search.  You will be asked for
     the name of the saved search (use ‘TAB’ for completion).

‘mairix-edit-saved-searches’
     Edit your current mairix searches.  This is a simple major mode for
     editing the contents of the variable ‘mairix-saved-searches’.  You
     can edit and delete searches and save them in your ‘.emacs’.  You
     can also use this mode to call mairix with one of the saved
     searches.  Additionally, you can specify a file name for mairix to
     use for a certain search instead of the default one.  This is
     useful if you want to open different searches at the same time, or
     if you want to regularly access certain searches without the need
     to call mairix.

‘mairix-edit-saved-searches-customize’
     Edit the variable ‘mairix-saved-searches’ in a normal customization
     buffer.  This function exists more or less for historic reasons,
     but maybe you like it.

‘mairix-update-database’
     Call mairix to update the database.  Mairix will be called with the
     options ‘mairix-update-options’; the default is “-F” and “-Q” to
     make updates as fast as possible.  Note that by using these
     options, absolutely no integrity checking is done.  If your
     database somehow gets corrupted, simply delete it and update.  If
     ‘mairix-synchronous-update’ is ‘nil’ (the default), mairix will be
     called in a subprocess so Emacs will still be usable while the
     update is done.


File: mairix-el.info,  Node: Extending,  Next: GNU Free Documentation License,  Prev: Using,  Up: Top

5 Extending mairix.el
*********************

Your favorite Emacs mail program is not supported?  Shame on me.  But it
is really easy to integrate other mail programs into mairix.el.  Just do
the following:

*Write a display function*
     Write a function that displays the mairix search results.  This
     function will be called from ‘mairix.el’ with the mail file/folder
     as the single argument.  For example, the function
     ‘mairix-rmail-display’ is currently used for RMail and
     ‘mairix-gnus-ephemeral-nndoc’ is used for Gnus.

*Write a get-header function*
     Write a function that retrieves a header from the currently active
     mail.  The single argument for this function is a string with the
     header name.  For examples, see ‘mairix-rmail-fetch-field’ and
     ‘mairix-gnus-fetch-field’ for RMail and Gnus, respectively.

*Integrate the functions into mairix.el*
     Add your mail program to the defcustom of ‘mairix-mail-program’.
     Then add the functions to ‘mairix-display-functions’ and
     ‘mairix-get-mail-header-functions’.

*Let me know...*
     ...so that I can eventually integrate it into future versions of
     mairix.el.

   And that’s it!


File: mairix-el.info,  Node: GNU Free Documentation License,  Prev: Extending,  Up: Top

Appendix A GNU Free Documentation License
*****************************************

                     Version 1.3, 3 November 2008

     Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
     <http://fsf.org/>

     Everyone is permitted to copy and distribute verbatim copies
     of this license document, but changing it is not allowed.

  0. PREAMBLE

     The purpose of this License is to make a manual, textbook, or other
     functional and useful document "free" in the sense of freedom: to
     assure everyone the effective freedom to copy and redistribute it,
     with or without modifying it, either commercially or
     noncommercially.  Secondarily, this License preserves for the
     author and publisher a way to get credit for their work, while not
     being considered responsible for modifications made by others.

     This License is a kind of “copyleft”, which means that derivative
     works of the document must themselves be free in the same sense.
     It complements the GNU General Public License, which is a copyleft
     license designed for free software.

     We have designed this License in order to use it for manuals for
     free software, because free software needs free documentation: a
     free program should come with manuals providing the same freedoms
     that the software does.  But this License is not limited to
     software manuals; it can be used for any textual work, regardless
     of subject matter or whether it is published as a printed book.  We
     recommend this License principally for works whose purpose is
     instruction or reference.

  1. APPLICABILITY AND DEFINITIONS

     This License applies to any manual or other work, in any medium,
     that contains a notice placed by the copyright holder saying it can
     be distributed under the terms of this License.  Such a notice
     grants a world-wide, royalty-free license, unlimited in duration,
     to use that work under the conditions stated herein.  The
     “Document”, below, refers to any such manual or work.  Any member
     of the public is a licensee, and is addressed as “you”.  You accept
     the license if you copy, modify or distribute the work in a way
     requiring permission under copyright law.

     A “Modified Version” of the Document means any work containing the
     Document or a portion of it, either copied verbatim, or with
     modifications and/or translated into another language.

     A “Secondary Section” is a named appendix or a front-matter section
     of the Document that deals exclusively with the relationship of the
     publishers or authors of the Document to the Document’s overall
     subject (or to related matters) and contains nothing that could
     fall directly within that overall subject.  (Thus, if the Document
     is in part a textbook of mathematics, a Secondary Section may not
     explain any mathematics.)  The relationship could be a matter of
     historical connection with the subject or with related matters, or
     of legal, commercial, philosophical, ethical or political position
     regarding them.

     The “Invariant Sections” are certain Secondary Sections whose
     titles are designated, as being those of Invariant Sections, in the
     notice that says that the Document is released under this License.
     If a section does not fit the above definition of Secondary then it
     is not allowed to be designated as Invariant.  The Document may
     contain zero Invariant Sections.  If the Document does not identify
     any Invariant Sections then there are none.

     The “Cover Texts” are certain short passages of text that are
     listed, as Front-Cover Texts or Back-Cover Texts, in the notice
     that says that the Document is released under this License.  A
     Front-Cover Text may be at most 5 words, and a Back-Cover Text may
     be at most 25 words.

     A “Transparent” copy of the Document means a machine-readable copy,
     represented in a format whose specification is available to the
     general public, that is suitable for revising the document
     straightforwardly with generic text editors or (for images composed
     of pixels) generic paint programs or (for drawings) some widely
     available drawing editor, and that is suitable for input to text
     formatters or for automatic translation to a variety of formats
     suitable for input to text formatters.  A copy made in an otherwise
     Transparent file format whose markup, or absence of markup, has
     been arranged to thwart or discourage subsequent modification by
     readers is not Transparent.  An image format is not Transparent if
     used for any substantial amount of text.  A copy that is not
     “Transparent” is called “Opaque”.

     Examples of suitable formats for Transparent copies include plain
     ASCII without markup, Texinfo input format, LaTeX input format,
     SGML or XML using a publicly available DTD, and standard-conforming
     simple HTML, PostScript or PDF designed for human modification.
     Examples of transparent image formats include PNG, XCF and JPG.
     Opaque formats include proprietary formats that can be read and
     edited only by proprietary word processors, SGML or XML for which
     the DTD and/or processing tools are not generally available, and
     the machine-generated HTML, PostScript or PDF produced by some word
     processors for output purposes only.

     The “Title Page” means, for a printed book, the title page itself,
     plus such following pages as are needed to hold, legibly, the
     material this License requires to appear in the title page.  For
     works in formats which do not have any title page as such, “Title
     Page” means the text near the most prominent appearance of the
     work’s title, preceding the beginning of the body of the text.

     The “publisher” means any person or entity that distributes copies
     of the Document to the public.

     A section “Entitled XYZ” means a named subunit of the Document
     whose title either is precisely XYZ or contains XYZ in parentheses
     following text that translates XYZ in another language.  (Here XYZ
     stands for a specific section name mentioned below, such as
     “Acknowledgements”, “Dedications”, “Endorsements”, or “History”.)
     To “Preserve the Title” of such a section when you modify the
     Document means that it remains a section “Entitled XYZ” according
     to this definition.

     The Document may include Warranty Disclaimers next to the notice
     which states that this License applies to the Document.  These
     Warranty Disclaimers are considered to be included by reference in
     this License, but only as regards disclaiming warranties: any other
     implication that these Warranty Disclaimers may have is void and
     has no effect on the meaning of this License.

  2. VERBATIM COPYING

     You may copy and distribute the Document in any medium, either
     commercially or noncommercially, provided that this License, the
     copyright notices, and the license notice saying this License
     applies to the Document are reproduced in all copies, and that you
     add no other conditions whatsoever to those of this License.  You
     may not use technical measures to obstruct or control the reading
     or further copying of the copies you make or distribute.  However,
     you may accept compensation in exchange for copies.  If you
     distribute a large enough number of copies you must also follow the
     conditions in section 3.

     You may also lend copies, under the same conditions stated above,
     and you may publicly display copies.

  3. COPYING IN QUANTITY

     If you publish printed copies (or copies in media that commonly
     have printed covers) of the Document, numbering more than 100, and
     the Document’s license notice requires Cover Texts, you must
     enclose the copies in covers that carry, clearly and legibly, all
     these Cover Texts: Front-Cover Texts on the front cover, and
     Back-Cover Texts on the back cover.  Both covers must also clearly
     and legibly identify you as the publisher of these copies.  The
     front cover must present the full title with all words of the title
     equally prominent and visible.  You may add other material on the
     covers in addition.  Copying with changes limited to the covers, as
     long as they preserve the title of the Document and satisfy these
     conditions, can be treated as verbatim copying in other respects.

     If the required texts for either cover are too voluminous to fit
     legibly, you should put the first ones listed (as many as fit
     reasonably) on the actual cover, and continue the rest onto
     adjacent pages.

     If you publish or distribute Opaque copies of the Document
     numbering more than 100, you must either include a machine-readable
     Transparent copy along with each Opaque copy, or state in or with
     each Opaque copy a computer-network location from which the general
     network-using public has access to download using public-standard
     network protocols a complete Transparent copy of the Document, free
     of added material.  If you use the latter option, you must take
     reasonably prudent steps, when you begin distribution of Opaque
     copies in quantity, to ensure that this Transparent copy will
     remain thus accessible at the stated location until at least one
     year after the last time you distribute an Opaque copy (directly or
     through your agents or retailers) of that edition to the public.

     It is requested, but not required, that you contact the authors of
     the Document well before redistributing any large number of copies,
     to give them a chance to provide you with an updated version of the
     Document.

  4. MODIFICATIONS

     You may copy and distribute a Modified Version of the Document
     under the conditions of sections 2 and 3 above, provided that you
     release the Modified Version under precisely this License, with the
     Modified Version filling the role of the Document, thus licensing
     distribution and modification of the Modified Version to whoever
     possesses a copy of it.  In addition, you must do these things in
     the Modified Version:

       A. Use in the Title Page (and on the covers, if any) a title
          distinct from that of the Document, and from those of previous
          versions (which should, if there were any, be listed in the
          History section of the Document).  You may use the same title
          as a previous version if the original publisher of that
          version gives permission.

       B. List on the Title Page, as authors, one or more persons or
          entities responsible for authorship of the modifications in
          the Modified Version, together with at least five of the
          principal authors of the Document (all of its principal
          authors, if it has fewer than five), unless they release you
          from this requirement.

       C. State on the Title page the name of the publisher of the
          Modified Version, as the publisher.

       D. Preserve all the copyright notices of the Document.

       E. Add an appropriate copyright notice for your modifications
          adjacent to the other copyright notices.

       F. Include, immediately after the copyright notices, a license
          notice giving the public permission to use the Modified
          Version under the terms of this License, in the form shown in
          the Addendum below.

       G. Preserve in that license notice the full lists of Invariant
          Sections and required Cover Texts given in the Document’s
          license notice.

       H. Include an unaltered copy of this License.

       I. Preserve the section Entitled “History”, Preserve its Title,
          and add to it an item stating at least the title, year, new
          authors, and publisher of the Modified Version as given on the
          Title Page.  If there is no section Entitled “History” in the
          Document, create one stating the title, year, authors, and
          publisher of the Document as given on its Title Page, then add
          an item describing the Modified Version as stated in the
          previous sentence.

       J. Preserve the network location, if any, given in the Document
          for public access to a Transparent copy of the Document, and
          likewise the network locations given in the Document for
          previous versions it was based on.  These may be placed in the
          “History” section.  You may omit a network location for a work
          that was published at least four years before the Document
          itself, or if the original publisher of the version it refers
          to gives permission.

       K. For any section Entitled “Acknowledgements” or “Dedications”,
          Preserve the Title of the section, and preserve in the section
          all the substance and tone of each of the contributor
          acknowledgements and/or dedications given therein.

       L. Preserve all the Invariant Sections of the Document, unaltered
          in their text and in their titles.  Section numbers or the
          equivalent are not considered part of the section titles.

       M. Delete any section Entitled “Endorsements”.  Such a section
          may not be included in the Modified Version.

       N. Do not retitle any existing section to be Entitled
          “Endorsements” or to conflict in title with any Invariant
          Section.

       O. Preserve any Warranty Disclaimers.

     If the Modified Version includes new front-matter sections or
     appendices that qualify as Secondary Sections and contain no
     material copied from the Document, you may at your option designate
     some or all of these sections as invariant.  To do this, add their
     titles to the list of Invariant Sections in the Modified Version’s
     license notice.  These titles must be distinct from any other
     section titles.

     You may add a section Entitled “Endorsements”, provided it contains
     nothing but endorsements of your Modified Version by various
     parties—for example, statements of peer review or that the text has
     been approved by an organization as the authoritative definition of
     a standard.

     You may add a passage of up to five words as a Front-Cover Text,
     and a passage of up to 25 words as a Back-Cover Text, to the end of
     the list of Cover Texts in the Modified Version.  Only one passage
     of Front-Cover Text and one of Back-Cover Text may be added by (or
     through arrangements made by) any one entity.  If the Document
     already includes a cover text for the same cover, previously added
     by you or by arrangement made by the same entity you are acting on
     behalf of, you may not add another; but you may replace the old
     one, on explicit permission from the previous publisher that added
     the old one.

     The author(s) and publisher(s) of the Document do not by this
     License give permission to use their names for publicity for or to
     assert or imply endorsement of any Modified Version.

  5. COMBINING DOCUMENTS

     You may combine the Document with other documents released under
     this License, under the terms defined in section 4 above for
     modified versions, provided that you include in the combination all
     of the Invariant Sections of all of the original documents,
     unmodified, and list them all as Invariant Sections of your
     combined work in its license notice, and that you preserve all
     their Warranty Disclaimers.

     The combined work need only contain one copy of this License, and
     multiple identical Invariant Sections may be replaced with a single
     copy.  If there are multiple Invariant Sections with the same name
     but different contents, make the title of each such section unique
     by adding at the end of it, in parentheses, the name of the
     original author or publisher of that section if known, or else a
     unique number.  Make the same adjustment to the section titles in
     the list of Invariant Sections in the license notice of the
     combined work.

     In the combination, you must combine any sections Entitled
     “History” in the various original documents, forming one section
     Entitled “History”; likewise combine any sections Entitled
     “Acknowledgements”, and any sections Entitled “Dedications”.  You
     must delete all sections Entitled “Endorsements.”

  6. COLLECTIONS OF DOCUMENTS

     You may make a collection consisting of the Document and other
     documents released under this License, and replace the individual
     copies of this License in the various documents with a single copy
     that is included in the collection, provided that you follow the
     rules of this License for verbatim copying of each of the documents
     in all other respects.

     You may extract a single document from such a collection, and
     distribute it individually under this License, provided you insert
     a copy of this License into the extracted document, and follow this
     License in all other respects regarding verbatim copying of that
     document.

  7. AGGREGATION WITH INDEPENDENT WORKS

     A compilation of the Document or its derivatives with other
     separate and independent documents or works, in or on a volume of a
     storage or distribution medium, is called an “aggregate” if the
     copyright resulting from the compilation is not used to limit the
     legal rights of the compilation’s users beyond what the individual
     works permit.  When the Document is included in an aggregate, this
     License does not apply to the other works in the aggregate which
     are not themselves derivative works of the Document.

     If the Cover Text requirement of section 3 is applicable to these
     copies of the Document, then if the Document is less than one half
     of the entire aggregate, the Document’s Cover Texts may be placed
     on covers that bracket the Document within the aggregate, or the
     electronic equivalent of covers if the Document is in electronic
     form.  Otherwise they must appear on printed covers that bracket
     the whole aggregate.

  8. TRANSLATION

     Translation is considered a kind of modification, so you may
     distribute translations of the Document under the terms of section
     4.  Replacing Invariant Sections with translations requires special
     permission from their copyright holders, but you may include
     translations of some or all Invariant Sections in addition to the
     original versions of these Invariant Sections.  You may include a
     translation of this License, and all the license notices in the
     Document, and any Warranty Disclaimers, provided that you also
     include the original English version of this License and the
     original versions of those notices and disclaimers.  In case of a
     disagreement between the translation and the original version of
     this License or a notice or disclaimer, the original version will
     prevail.

     If a section in the Document is Entitled “Acknowledgements”,
     “Dedications”, or “History”, the requirement (section 4) to
     Preserve its Title (section 1) will typically require changing the
     actual title.

  9. TERMINATION

     You may not copy, modify, sublicense, or distribute the Document
     except as expressly provided under this License.  Any attempt
     otherwise to copy, modify, sublicense, or distribute it is void,
     and will automatically terminate your rights under this License.

     However, if you cease all violation of this License, then your
     license from a particular copyright holder is reinstated (a)
     provisionally, unless and until the copyright holder explicitly and
     finally terminates your license, and (b) permanently, if the
     copyright holder fails to notify you of the violation by some
     reasonable means prior to 60 days after the cessation.

     Moreover, your license from a particular copyright holder is
     reinstated permanently if the copyright holder notifies you of the
     violation by some reasonable means, this is the first time you have
     received notice of violation of this License (for any work) from
     that copyright holder, and you cure the violation prior to 30 days
     after your receipt of the notice.

     Termination of your rights under this section does not terminate
     the licenses of parties who have received copies or rights from you
     under this License.  If your rights have been terminated and not
     permanently reinstated, receipt of a copy of some or all of the
     same material does not give you any rights to use it.

  10. FUTURE REVISIONS OF THIS LICENSE

     The Free Software Foundation may publish new, revised versions of
     the GNU Free Documentation License from time to time.  Such new
     versions will be similar in spirit to the present version, but may
     differ in detail to address new problems or concerns.  See
     <http://www.gnu.org/copyleft/>.

     Each version of the License is given a distinguishing version
     number.  If the Document specifies that a particular numbered
     version of this License “or any later version” applies to it, you
     have the option of following the terms and conditions either of
     that specified version or of any later version that has been
     published (not as a draft) by the Free Software Foundation.  If the
     Document does not specify a version number of this License, you may
     choose any version ever published (not as a draft) by the Free
     Software Foundation.  If the Document specifies that a proxy can
     decide which future versions of this License can be used, that
     proxy’s public statement of acceptance of a version permanently
     authorizes you to choose that version for the Document.

  11. RELICENSING

     “Massive Multiauthor Collaboration Site” (or “MMC Site”) means any
     World Wide Web server that publishes copyrightable works and also
     provides prominent facilities for anybody to edit those works.  A
     public wiki that anybody can edit is an example of such a server.
     A “Massive Multiauthor Collaboration” (or “MMC”) contained in the
     site means any set of copyrightable works thus published on the MMC
     site.

     “CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0
     license published by Creative Commons Corporation, a not-for-profit
     corporation with a principal place of business in San Francisco,
     California, as well as future copyleft versions of that license
     published by that same organization.

     “Incorporate” means to publish or republish a Document, in whole or
     in part, as part of another Document.

     An MMC is “eligible for relicensing” if it is licensed under this
     License, and if all works that were first published under this
     License somewhere other than this MMC, and subsequently
     incorporated in whole or in part into the MMC, (1) had no cover
     texts or invariant sections, and (2) were thus incorporated prior
     to November 1, 2008.

     The operator of an MMC Site may republish an MMC contained in the
     site under CC-BY-SA on the same site at any time before August 1,
     2009, provided the MMC is eligible for relicensing.

ADDENDUM: How to use this License for your documents
====================================================

To use this License in a document you have written, include a copy of
the License in the document and put the following copyright and license
notices just after the title page:

       Copyright (C)  YEAR  YOUR NAME.
       Permission is granted to copy, distribute and/or modify this document
       under the terms of the GNU Free Documentation License, Version 1.3
       or any later version published by the Free Software Foundation;
       with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
       Texts.  A copy of the license is included in the section entitled ``GNU
       Free Documentation License''.

   If you have Invariant Sections, Front-Cover Texts and Back-Cover
Texts, replace the “with…Texts.” line with this:

         with the Invariant Sections being LIST THEIR TITLES, with
         the Front-Cover Texts being LIST, and with the Back-Cover Texts
         being LIST.

   If you have Invariant Sections without Cover Texts, or some other
combination of the three, merge those two alternatives to suit the
situation.

   If your document contains nontrivial examples of program code, we
recommend releasing these examples in parallel under your choice of free
software license, such as the GNU General Public License, to permit
their use in free software.



Tag Table:
Node: Top864
Node: About2469
Node: Configuring mairix4583
Node: Setting up the mairix interface6614
Node: Using7595
Node: Extending12863
Node: GNU Free Documentation License14192

End Tag Table


Local Variables:
coding: utf-8
End:
