path: root/man/mailsync.1

.\" This file is part of Puszcza extensions to Mailman -*- nroff -*-
.\" Copyright (C) 2014-2015 Sergey Poznyakoff
.\"  
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program.  If not, see <http://www.gnu.org/licenses/>.
.TH MAILSYNC 1 "April 9, 2015" "MAILSYNC"
.SH NAME
mailsync - synchronize Mailman archives with html
.SH SYNOPSIS
\fBmailsync\fR\
 [\fB\-dhnr\fR]\
 [\fB\-c\fR \fIFILE\fR]\
 [\fB\-\-config\fR]\
 [\fB\-\-debug\fR]\
 [\fB\-\-dry\-run\fR]\
 [\fB\-\-help\fR]\
 [\fB\-\-reset\fR]
.SH DESCRIPTION
Converts Mailman archives into HTML format and indexes new messages.
It uses
.BR mhonarc (1),
for conversion and
.BR mknmz (1)
for indexing.
.PP
All necessary settings are defined in the configuration file
\fB/etc/mailsync.conf\fR.  Alternative location can be given using the
\fB\-c\fR (\fB\-\-config\fR) command line option.
.PP
The file consists of sections and statements.  Sections are declared
using the following syntax:
.PP
.EX
[\fINAME\fR]
.EE
.PP
where \fINAME\fR stands for section name.  Statements have the form:
.PP
.EX
\fIkeyword\fR = \fIvalue\fR
.EE
.PP
Leading and trailing whitespace is ignored in both cases.  Any amount
of whitespace is allowed at either side of the \fB=\fR sign in
statements.  Empty lines are ignored.  Comments start with a \fB#\fR
sign and continue to the end of the line on which it appears.
.PP
The \fB[core]\fR section must be present and must contain the following 
statements:
.TP
.BI "base_url = " URL
Base URL of the archive list page.
.TP
.BI "rootdir = " DIR
Pathname of the root directory.  It is used as a directory of
reference for all relative file names defined in other statements.
.TP
.BI "etcdir = " DIR
Name of the
.BR mhonarc (1)
configuration directory.
.TP
.BI "indexrootdir = " DIR
Root directory for Namazu indexes.  Index files for each particular
list will be stored in a subdirectory named after the corresponding
list.
.TP
.BI "mboxrootdir = " DIR
Directory where Mailman archives are stored.  The archive for list
\fIX\fR is stored in file
.IB mboxrootdir / X .mbox/ X .mbox
.TP
.BR "htmlrootdir = " DIR
Root directory for HTML version of archives.
.PP
The following statement is optional:
.TP
.BI "listfile = " FILE
If present, names of the lists to process will be taken from
\fIFILE\fR.  That file should list each name on a separate line.
Emtpy lines and comments (\fB#\fR) are allowed.
.PP
Unless \fBlistfile\fR is defined, \fBmailsync\fR will attempt to fetch
the names of lists to process from Savane MySQL database.  To access
it, the program uses settings from the \fB[mysql]\fR section:
.TP
.BI "host = " HOSTNAME
Name of host to connect to.  Default: localhost via a UNIX socket
.TP
.BI "user = " NAME
Name of the user to authenticate as.  The user must have \fBSELECT\fR
privilege on table \fBmail_group_list\fR.
.TP
.BI "passwd = " STRING
Password to authenticate with. Default: no password.
.TP
.BI "db = " NAME
Name of the database to use. Default: empty.
.TP
.BI "port = " NUMBER
TCP port of MySQL server, if differs from the default (3306).
.TP
.BI "unix_socket = " PATH
Location of UNIX socket file.
.TP
.BI "connect_timeout = " NUMBER
Connection timeout in seconds.
.TP
.BI "init_command = " STRING
Initial command to issue to server upon connection. Default: empty.
.TP
.BI "read_default_file = " FILE
MySQL configuration file to read.
.TP
.BI "read_default_group = " NAME
Name of the group to read from the configuration file.  Default:
\fBclient\fR.
.TP
.BI "use_unicode = " BOOL
Whether to use unicode.
.TP
.BI "charset = " NAME
Name of the character set to use.
.SH OPTIONS
.TP
.BR \-d ", " \-\-debug
Print additional diagnostics.
.TP
.BR \-n ", " \-\-dry\-run
Do nothing, print what would have been done.
.TP
\fB\-c\fR, \fB\-\-config=\fIFILE\fR
Read configuration from \fIFILE\fR.
.TP
.BR \-r ", " \-\-reset
Reset list state before processing.  Normally lists are indexed
incrementally.  With this option, they will be rescanned and all
messages reindexed.
.TP
.BI \-h ", " \-\-help
Show a summary of command line options.
.SH "SEE ALSO"
\fB<http://www.gnu.org/software/mailman/>\fR,
.BR mhonarc (1),
.BR mknmz (1),
.BR namazu (1).
.SH BUGS
Command lines for invoking \fBmhonarc\fR and \fBmknmz\fR are hardcoded.
.SH AUTHORS
Sergey Poznyakoff <gray@gnu.org>
.SH COPYRIGHT
Copyright \(co 2015 Sergey Poznyakoff
.br
.na
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
.br
.ad
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
.\" Local variables:
.\" eval: (add-hook 'write-file-hooks 'time-stamp)
.\" time-stamp-start: ".TH [A-Z_][A-Z0-9_.\\-]* [0-9] \""
.\" time-stamp-format: "%:B %:d, %:y"
.\" time-stamp-end: "\""
.\" time-stamp-line-limit: 20
.\" end: