.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Mail::LMLM 3"
.TH Mail::LMLM 3 "2007-03-07" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Mail::LMLM \- List of Mailing Lists Manager
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Mail::LMLM;
.Ve
.PP
.Vb 9
\&    my $renderer =
\&        Mail::LMLM->new(
\&            'extra-classes' => \e%extra_mailing_list_classes,
\&            title => "List of the Foo Mailing Lists",
\&            headline => "Foo Mailing Lists",
\&            lists => \e@lists,
\&            prolog =>  \e&prolog,
\&            epilog => \e&epilog,
\&        );
.Ve
.PP
.Vb 1
\&    $renderer->render();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The Mail::LMLM module allows users to easily manage \s-1HTML\s0 directories of
mailing lists of various mailing list managers and hosts.
.PP
To use it create a new module of type Mail::LMLM with a new method, while 
initializing it with the list of mailing lists (in order of listing), and 
other parameters. Then, invoke the \fIrender()\fR function to create the \s-1HTML\s0
files within the current directory.
.PP
Following is a listing of the parameters
.Sh "title and headline"
.IX Subsection "title and headline"
title is what will be displayed in the document inside the <title>
tag. headline is the headline of the main page.
.Sh "prolog and epilog"
.IX Subsection "prolog and epilog"
prolog is a callback for a function that will be called with the Mail::LMLM
handle and its appropriate rendering back-end when the main's page prologue
(that comes before the listing itself) is to be displayed. epilog is the
same for the text after the listing itself. Here is an example for it:
.PP
.Vb 4
\&    sub prolog
\&    {
\&        my $self = shift;
\&        my $main_r = shift;
.Ve
.PP
.Vb 6
\&        $main_r->para( "This is a list of the mailing-lists which are affiliated " .
\&            "with the Israeli Group of Linux Users (IGLU). It includes such " . 
\&            "information as how to subscribe/unsubscribe, posting address, " . 
\&            "posting guidelines, the address of the mailing-list owner, the " . 
\&            "mailing-list's homepage and the online messages archive."
\&        );
.Ve
.PP
.Vb 4
\&        $main_r->start_para();
\&        $main_r->text("If you have any comments, suggestions or additions " . 
\&            "regarding the information contained here, don't hesitate to " . 
\&            "contact the maintainer of these pages at the following e-mail: ");
.Ve
.PP
.Vb 3
\&        $main_r->email_address("shlomif", "vipe.technion.ac.il");
\&        $main_r->end_para();
\&}
.Ve
.PP
For more information on how to interface with the renderer consult 
the HTML::LMLM::Render reference page.
.Sh "extra-classes"
.IX Subsection "extra-classes"
This is a reference to a hash whose keys are extra IDs for mailing lists 
classes, and its values are either the namespace of the Perl module that
implements this class, or a subroutine that creates a new class like that.
.PP
This class would be better be sub-classed from one of the classes that
ship with Mail::LMLM. To see examples of how to sub\-class, consult the examples
section of the Mail::LMLM distribution.
.Sh "lists"
.IX Subsection "lists"
This is a reference to an array of hash references that contain the 
information for the mailing lists. The fields available here are:
.IP "id" 8
.IX Item "id"
The identifier of the mailing list that will be used as the base name
for its \s-1HTML\s0 page.
.IP "class" 8
.IX Item "class"
The class of the mailing list that determines its type. Available built-in
classes are: \fBegroups\fR (A Yahoo-Groups mailing list), \fBezmlm\fR (an Ezmlm-based
mailing list), \fBlistar\fR (a Listar-based mailing list), \fBlistserv\fR (
a Listserv-based mailing list), \fBmailman\fR (a mailman based mailing list),
\&\fBmajordomo\fR (a majordomo-based mailing list).
.IP "group_base" 8
.IX Item "group_base"
The group base that appears before the host.
.IP "title" 8
.IX Item "title"
The title that will be displayed at the head of the page.
.IP "hostname" 8
.IX Item "hostname"
The hostname of the mailing list address.
.IP "homepage" 8
.IX Item "homepage"
The homepage \s-1URL\s0 of the mailing list.
.IP "description" 8
.IX Item "description"
The description of the mailing list, to be presented in its page.
.Sp
This can be an handle/Mail::LMLM::Render callback.
.IP "guidelines" 8
.IX Item "guidelines"
The posting guidelines for the mailing list.
.IP "online_archive" 8
.IX Item "online_archive"
A \s-1URL\s0 or a Mail::LMLM::Render callback for displaying the online archive of
the mailing list.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.Sh "\fIinitialize()\fP"
.IX Subsection "initialize()"
Called on behalf of the constructor to initialize the module. For internal
use only.
.ie n .Sh "my $lmlm = Mail::LMLM\->new(%params)"
.el .Sh "my \f(CW$lmlm\fP = Mail::LMLM\->new(%params)"
.IX Subsection "my $lmlm = Mail::LMLM->new(%params)"
Initializes a new module with \f(CW%params\fR.
.Sh "$lmlm\->\fIrender()\fP"
.IX Subsection "$lmlm->render()"
Renders the pages.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Mail::LMLM::Render,1
.SH "AUTHOR"
.IX Header "AUTHOR"
Shlomi Fish, <http://www.shlomifish.org/>
.SH "LICENSE"
.IX Header "LICENSE"
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
\&\*(L"Software\*(R"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
.PP
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
.PP
\&\s-1THE\s0 \s-1SOFTWARE\s0 \s-1IS\s0 \s-1PROVIDED\s0 \*(L"\s-1AS\s0 \s-1IS\s0\*(R", \s-1WITHOUT\s0 \s-1WARRANTY\s0 \s-1OF\s0 \s-1ANY\s0 \s-1KIND\s0,
\&\s-1EXPRESS\s0 \s-1OR\s0 \s-1IMPLIED\s0, \s-1INCLUDING\s0 \s-1BUT\s0 \s-1NOT\s0 \s-1LIMITED\s0 \s-1TO\s0 \s-1THE\s0 \s-1WARRANTIES\s0 \s-1OF\s0
\&\s-1MERCHANTABILITY\s0, \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0 \s-1AND\s0 \s-1NONINFRINGEMENT\s0.
\&\s-1IN\s0 \s-1NO\s0 \s-1EVENT\s0 \s-1SHALL\s0 \s-1THE\s0 \s-1AUTHOR\s0 \s-1BE\s0 \s-1LIABLE\s0 \s-1FOR\s0 \s-1ANY\s0 \s-1CLAIM\s0, \s-1DAMAGES\s0 \s-1OR\s0 \s-1OTHER\s0
\&\s-1LIABILITY\s0, \s-1WHETHER\s0 \s-1IN\s0 \s-1AN\s0 \s-1ACTION\s0 \s-1OF\s0 \s-1CONTRACT\s0, \s-1TORT\s0 \s-1OR\s0 \s-1OTHERWISE\s0,
\&\s-1ARISING\s0 \s-1FROM\s0, \s-1OUT\s0 \s-1OF\s0 \s-1OR\s0 \s-1IN\s0 \s-1CONNECTION\s0 \s-1WITH\s0 \s-1THE\s0 \s-1SOFTWARE\s0 \s-1OR\s0 \s-1THE\s0 \s-1USE\s0 \s-1OR\s0
\&\s-1OTHER\s0 \s-1DEALINGS\s0 \s-1IN\s0 \s-1THE\s0 \s-1SOFTWARE\s0.
.PP
(This is the \s-1MIT\s0 X11 License).