• NAME
• SYNOPSIS
• DESCRIPTION
• USAGE
• OPTIONS
  • -i, --input folder
  • -o, --output directory
  • -n, --name title
  • -t, --templates directory
  • -r --refresh
  • -v --reverse
  • --nolurker
  • --thread-context context_style
  • --lurker-context context_style
  • --class class
• AUTHORS
• COPYRIGHT
• SEE ALSO

NAME

mariachi - All dancing mail archive generator

SYNOPSIS

 mariachi [ OPTIONS ]

DESCRIPTION

Mariachi is a mail archive generator, much like mhonarc or pipermail. It differs in a few important ways:

Its name is Juan

It uses the Template Toolkit.

This is a made up list

USAGE

You can write a config file to save yourself some trouble - mariachi first looks in /usr/local/mariachi/mariachi.conf and then ~/.mariachi.

An example config file might look like

    refresh
    input  = ~/mail
    output = ~/public_html/mymail/

For more information about the configuration file format, consult AppConfig

You don't have to supply everything (as long as the required options are then passed on the command line).

Options on the command line override options in the config files.

OPTIONS

-i, --input folder

The source mail folder

-o, --output directory

Name of the directory to write output to

-n, --name title

What to use in the title of the mailing lists

-t, --templates directory

Add additional directories to scan in looking for templates

Defaults to /usr/local/mariachi/templates

Any values supplied will be added to the head of that list.

-r --refresh

Refreshes individual message pages and other indexes even if mariachi believes this is not necessary. This is usually only needed if you change the templates (typically to update the style of a page).

-v --reverse

By default, mariachi renders the most recent messages on the first page of the archive, and later messages later on in the archive. This flag reverses this behaviour, placing the earliest messages on the first page of the archive.

--nolurker

Disable lurker output

--thread-context context_style

Controls the amount of context to show with a message in thread view.

Legal values for context_style are first_line, first_paragraph, first_sentence, and the empty string (the default).

--lurker-context context_style

See thread-context

--class class

Specifies using a class other than Mariachi to do the rendering.

AUTHORS

This code was written as part of the Siesta project and includes code from:

Richard Clamp <richardc@unixbeard.net>

Simon Wistow <simon@thegestalt.org>

Tom Insam <tom@jerakeen.org>

Mark Fowler <mark@twoshortplanks.com>

More information about the Siesta project can be found online at http://siesta.unixbeard.net/

COPYRIGHT

Copyright 2003 The Siesta Project

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO

Mail::Thread, Mariachi