Commit 54877e56 authored by salaun's avatar salaun
Browse files

[Jerome Marant] New feature: change sympa man page to POD format Add archived,...

[Jerome Marant] New feature: change sympa man page to POD format Add archived, bounced and alias_manager man pages

git-svn-id: https://subversion.renater.fr/sympa/trunk@443 05aa8bb8-cd2b-0410-b1d7-8918dfa770ce
parent 9c6c7326
......@@ -98,7 +98,7 @@ NLSDIR = $(DIR)/nls
LOG_SOCKET_TYPE = "unix"
#endif
all: checkcpan sources languages checkperl
all: checkcpan sources languages checkperl man
rpm: build_rh_rpm build_mdk_rpm
......@@ -120,7 +120,7 @@ checkperl:
echo "#############################################################################"; \
fi
sources:
sources: src/Makefile src/queue.c src/bouncequeue.c
@echo "Making src"
(cd src && echo "making in src..." && \
$(MAKE) SH='${SH}' CC='${CC}' CFLAGS='${CFLAGS}' PERL='${PERL}' \
......@@ -139,6 +139,11 @@ doc: doc/sympa.tex
CONFIG='${CONFIG}' WWSCONFIG='${WWSCONFIG}' \
USER='${USER}' GROUP='${GROUP}');
man: doc/man8/Makefile
@echo "Making man"
(cd doc/man8 && echo "making in doc/man8/..." && \
$(MAKE) SYMPA_VERSION='$(SYMPA_VERSION)');
languages:
@echo "Making nls"
(cd nls && echo "making in nls..." && \
......@@ -201,7 +206,7 @@ installsample:
installman:
mkdir -p $(DESTDIR)$(MANDIR)
mkdir -p $(DESTDIR)$(MANDIR)/man8
@for manfile in sympa.8 ; do \
@for manfile in sympa.8 archived.8 bounced.8 alias_manager.8; do \
echo "Installing man file man8/$$manfile..."; \
( \
cd doc/man8 ; \
......
## Available catalogues (languages)
MAN8 = archived.8 bounced.8 alias_manager.8 sympa.8
.SUFFIXES: .8 .pod
.8: .pod
.pod.8:
rm -f $@
pod2man -s 8 -r $(SYMPA_VERSION) $< $@
all: $(MAN8)
clean:
rm -f *.8
install:
echo "Please use the main Makefile for installing MAN Page."
newinstall: makedir
@for c in $(MAN8); do \
echo "Installing man pages...$(DESTDIR)$(MANDIR)/$$c"; \
cp $$c $(DESTDIR)$(MANDIR); \
done
makedir:
@if [ ! -d $(DESTDIR)$(MANDIR) ]; then \
echo "Creating required directory $(DESTDIR)$(MANDIR)"; \
mkdir -p $(DESTDIR)$(MANDIR); \
fi
=head1 NAME
alias_manager (or alias_manager.pl) - manage Sympa aliases
=head1 SYNOPSYS
S<B<alias_manager> B<add> I<listname> I<domain>>
S<B<alias_manager> B<del> I<listname> I<domain>>
=head1 DESCRIPTION
This manual page documents briefly the bounced command.
This manual page was written for the Debian GNU/Linux distribution
because the original program does not have a manual page.
Alias_manager is a program that helps in installing aliases for newly
created lists and deleting aliases for closed lists.
=head1 OPTIONS
=over 5
=item B<add> I<listname> I<domain>
Add the set of aliases for the mailing list I<listname> in the
domain I<domain>.
=item B<del> I<listname> I<domain>
Remove the set of aliases for the mailing list I<listname> in the
domain I<domain>.
=back
=head1 FILES
F</etc/aliases> sendmail aliases file.
=head1 MORE DOCUMENTATION
The full documentation in HTML and PostScript formats can be
found in F</usr/share/doc/sympa/html/>.
The mailing lists (with web archives) can be accessed at
http://listes.cru.fr/wws/lists/informatique/sympa.
=head1 AUTHORS
Serge Aumont
Comité Réseau des Universités
Olivier Salaün
Comité Réseau des Universités
Contact authors at <sympa-authors@cru.fr>
This manual page was written by Jérôme Marant <jerome.marant@IDEALX.org>
for the Debian GNU/Linux system (but may be used by others).
=head1 COPYRIGHT
Copyright E<169> 1997,1998,1999,2000,2001 Comité Réseau des Universités
Copyright E<169> 1997,1998,1999 Institut Pasteur & Christophe Wolfhugel
You may distribute this software under the terms of the GNU General
Public License Version 2 (L<http://www.gnu.org/copyleft/gpl.html>)
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1 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 can be found under
F</usr/share/common-licenses/FDL>
=head1 BUGS
Report bugs to <sympa-dev@cru.fr>.
=head1 SEE ALSO
L<sympa(1)>, L<sendmail(8)>.
\ No newline at end of file
=head1 NAME
archived (or archived.pl) - Mailing List Archiving Daemon for WWSympa
=head1 SYNOPSYS
S<B<archived> [ B<-F> ] [ B<-d, -dF> ]>
=head1 DESCRIPTION
This manual page documents briefly the archived command.
This manual page was written for the Debian GNU/Linux distribution
because the original program does not have a manual page.
Archived is a program which scan permanently the outgoing queue and
feeds the web archives, converting messages to the HTML format and
linking them.
The HTML conversion is achieved by the means of the MhOnArc program.
=head1 OPTIONS
These programs follow the usual GNU command line syntax,
with long options starting with two dashes (`-'). A summary of
options is included below.
=over 5
=item B<-F>
Do not detach TTY.
=item B<-d>, B<-dF>
Run the program in a debug mode.
=back
=head1 FILES
F</etc/sympa/wwsympa.conf> WWSympa configuration file.
F</var/spool/sympa/archived.pid> this file contains the process ID
of F<archived.pl>.
=head1 MORE DOCUMENTATION
The full documentation in HTML and PostScript formats can be
found in F</usr/share/doc/sympa/html/>.
The mailing lists (with web archives) can be accessed at
http://listes.cru.fr/wws/lists/informatique/sympa.
=head1 AUTHORS
Serge Aumont
Comité Réseau des Universités
Olivier Salaün
Comité Réseau des Universités
Contact authors at <sympa-authors@cru.fr>
This manual page was written by Jérôme Marant <jerome.marant@IDEALX.org>
for the Debian GNU/Linux system (but may be used by others).
=head1 COPYRIGHT
Copyright E<169> 1997,1998,1999,2000,2001 Comité Réseau des Universités
Copyright E<169> 1997,1998,1999 Institut Pasteur & Christophe Wolfhugel
You may distribute this software under the terms of the GNU General
Public License Version 2 (L<http://www.gnu.org/copyleft/gpl.html>)
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1 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 can be found under
F</usr/share/common-licenses/FDL>
=head1 BUGS
Report bugs to <sympa-dev@cru.fr>.
=head1 SEE ALSO
L<sympa(1)>, L<bounced(1)>, L<mhonarc(1)>, L<wwsympa.conf(5)>.
=head1 NAME
bounced (or bounced.pl) - Mailing List Bounce Processing Daemon for WWSympa
=head1 SYNOPSYS
S<B<bounced> [ B<-F> ] [ B<-d, -dF> ]>
=head1 DESCRIPTION
This manual page documents briefly the bounced command.
This manual page was written for the Debian GNU/Linux distribution
because the original program does not have a manual page.
Bounced is a program which scans permanently the bounce queue and
processes bounces (non-delivery messages), looking or bad addresses.
List owners will latter access bouces information via WWSympa.
=head1 OPTIONS
These programs follow the usual GNU command line syntax,
with long options starting with two dashes (`-'). A summary of
options is included below.
=over 5
=item B<-F>
Do not detach TTY.
=item B<-d>, B<-dF>
Run the program in a debug mode.
=back
=head1 FILES
F</etc/sympa/wwsympa.conf> WWSympa configuration file.
F</var/spool/sympa/bounced.pid> this file contains the process ID
of F<bounced.pl>.
=head1 MORE DOCUMENTATION
The full documentation in HTML and PostScript formats can be
found in F</usr/share/doc/sympa/html/>.
The mailing lists (with web archives) can be accessed at
http://listes.cru.fr/wws/lists/informatique/sympa.
=head1 AUTHORS
Serge Aumont
Comité Réseau des Universités
Olivier Salaün
Comité Réseau des Universités
Contact authors at <sympa-authors@cru.fr>
This manual page was written by Jérôme Marant <jerome.marant@IDEALX.org>
for the Debian GNU/Linux system (but may be used by others).
=head1 COPYRIGHT
Copyright E<169> 1997,1998,1999,2000,2001 Comité Réseau des Universités
Copyright E<169> 1997,1998,1999 Institut Pasteur & Christophe Wolfhugel
You may distribute this software under the terms of the GNU General
Public License Version 2 (L<http://www.gnu.org/copyleft/gpl.html>)
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1 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 can be found under
F</usr/share/common-licenses/FDL>
=head1 BUGS
Report bugs to <sympa-dev@cru.fr>.
=head1 SEE ALSO
L<sympa(1)>, L<archived(1)>, L<mhonarc(1)>, L<wwsympa.conf(5)>.
\ No newline at end of file
.TH SYMPA 8 "--SYMPA_VERSION--" "April 2001" "Sympa --SYMPA_VERSION--"
.SH NAME
Sympa \- a modern mailinglists manager
.SH SYNOPSIS
.B sympa.pl
[\fIOPTIONS\fR]\fR
.SH DESCRIPTION
\fBSympa\fR is scalable and highly customizable mailing list manager.
.\" Automatically generated by Pod::Man version 1.02
.\" Thu May 10 17:27:55 2001
.\"
.\" 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 Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.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.
.bd B 3
. \" 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 "sympa 8"
.TH sympa 8 "3.1.1" "2001-05-10" "User Contributed Perl Documentation"
.UC
.SH "NAME"
sympa (or sympa.pl) \- A Modern Mailing List Manager
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBsympa\fR\ [\ \fB\-d,\ \-\-debug\fR\ ]\ [\ \fB\-f,\ \-\-file\fR=\fIanother.sympa.conf\fR\ ]
[\ \fB\*(--import\fR=\fIlistname\fR\ ]\ [\ \fB\-k,\ \-\-keepcopy\fR=\fIdirectory\fR\ ]
[\ \fB\-l,\ \-\-lang\fR=\fIcatalog\fR\ ]\ [\ \fB\-m,\ \-\-mail\fR\ ]
[\ \fB\*(--dump\fR=\fIlistname\fR\ |\ \s-1ALL\s0]\ [\ \fB\-h,\ \-\-help\fR\ ]
[\ \fB\-v,\ \-\-version\fR\ ]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBSympa\fR is scalable and highly customizable mailing list manager.
It can cope with big lists (200,000 subscribers) and comes with
a complete (user and admin) Web interface. It is
internationalized, and supports the us, fr, de, es, it, fi, and
chinese locales. A scripting language allows you to extend the
behavior of commands. \fBSympa\fR can be linked to an LDAP directory
or an RDBMS to create dynamic mailing lists. \fBSympa\fR provides S/MIME
and HTTPS based authentication and encryption.
.TP
\fB\-d\fR, \fB\-\-debug\fR
Sets \fBSympa\fR in debug mode and keeps it attached to the terminal.
Debugging information is output to STDERR, along with standard
log information. Each function call is traced. Usefull while
reporting a bug.
.TP
\fB\-f\fR, \fB\-\-config\fR=\fIfile\fR
Forces \fBSympa\fR to use an alternative configuration file.
Default behavior is to use the configuration file as defined in the
Makefile.
.TP
\fB\-\-import\fR=\fIlist\fR
Import subscribers in the list. Data are read from STDIN.
behavior of commands. \fBSympa\fR can be linked to an \s-1LDAP\s0 directory
or an \s-1RDBMS\s0 to create dynamic mailing lists. \fBSympa\fR provides S/MIME
and \s-1HTTPS\s0 based authentication and encryption.
Sympa is a modern mailing-list manager. It supports a lot of useful
features.
.SH "OPTIONS"
.IX Header "OPTIONS"
.Ip "\fB\-d, \-\-debug\fR" 5
.IX Item "-d, --debug"
Enable debug mode.
.Ip "\fB\-f, \-\-file=\fR\fIanother.sympa.conf\fR" 5
.IX Item "-f, --file=another.sympa.conf"
Force Sympa to use an alternative configuration file instead
of \fI/etc/sympa/sympa.conf\fR.
.Ip "\fB\*(--import=\fR\fIlist\fR" 5
.IX Item "import=list"
Import subscribers in the list. Data are read from \s-1STDIN\s0.
The imported data should contain one entry per line : the first field
is an email address, the second (optional) field is the free form name.
Fields are spaces-separated.
.Sp
Sample :
.nf
## Data to be imported
## email gecos
john.steward@some.company.com John - accountant
mary.blacksmith@another.company.com Mary - secretary
.fi
.TP
\fB\-k\fR, \fB\-\-keepcopy\fR=\fIdirectory\fR
This option tells \fBSympa\fR to keep a copy of every incoming message,
.Sp
.Vb 4
\& ## Data to be imported
\& ## email gecos
\& john.steward@some.company.com John - accountant
\& mary.blacksmith@another.company.com Mary - secretary
.Ve
.Ip "\fB\-k, \-\-keepcopy=\fR\fIdirectory\fR" 5
.IX Item "-k, --keepcopy=directory"
This option tells Sympa to keep a copy of every incoming message,
instead of deleting them. `directory' is the directory to
store messages.
.TP
\fB\-l\fR, \fB\-\-lang\fR=\fIcatalogue\fR
Set this option to use a language catalog for \fBSympa\fR. The corresponding
catalog file `catalogue'.cat must be located in ~sympa/nls directory.
.TP
\fB\-\-lowercase\fR
Lowercases email addresses in database.
.TP
\fB\-m\fR, \fB\-\-mail\fR
\fBSympa\fR will log calls to sendmail, including recipients. Useful
for keeping track of each mail sent (log files may grow faster though).
.TP
\fB\-\-dump\fR=\fIlistname\fR | ALL
store messages.
.Ip "\fB\-l, \-\-lang=\fR\fIcatalog\fR" 5
.IX Item "-l, --lang=catalog"
Set this option to use a language catalog for Sympa. The corresponding
catalog file `catalogue'.cat must be located in \fI/usr/lib/sympa/nls\fR
directory.
.Ip "\fB\-m, \-\-mail\fR" 5
.IX Item "-m, --mail"
Sympa will log calls to sendmail, including recipients. This option is
useful for keeping track of each mail sent (log files may grow faster
though).
.Ip "\fB\*(--dump=\fR\fIlistname\fR | \s-1ALL\s0" 5
.IX Item "dump=listname | ALL"
Dumps subscribers of for `listname' list or all lists. Subscribers are
dumped in \fIsubscribers.db.dump\fR.
.TP
\fB-h\fR, \fB\-\-help\fR
Print this help
.TP
\fB-v\fR, \fB\-\-version\fR
Print version number
.PP
dumped in subscribers.db.dump.
.Ip "\fB\-h, \-\-help\fR" 5
.IX Item "-h, --help"
Print this help message.
.Ip "\fB\-v, \-\-version\fR" 5
.IX Item "-v, --version"
Print the version number.
.SH "FILES"
.TP
.I \fI--CONFDIR--/sympa.conf\fR main configuration file
.TP
.I \fI--PIDDIR--/sympa.pid\fR this file contains the process ID of \fIsympa.pl\fR
.SH AVAILABILITY
Latest version of \fBSympa\fR is available from
http://www.sympa.org
.SH AUTHORS
.TP
.IX Header "FILES"
\&\fI/etc/sympa/sympa.conf\fR main configuration file.
.PP
\&\fI/var/spool/sympa/sympa.pid\fR this file contains the process \s-1ID\s0
of \fIsympa.pl\fR.
.SH "AVAILABILITY"
.IX Header "AVAILABILITY"
Latest version of \fBSympa\fR is available from http://www.sympa.org.
.SH "MORE DOCUMENTATION"
.IX Header "MORE DOCUMENTATION"
The full documentation in \s-1HTML\s0 and PostScript formats can be
found in \fI/usr/share/doc/sympa/html/\fR.
.PP
The mailing lists (with web archives) can be accessed at
http://listes.cru.fr/wws/lists/informatique/sympa.
.SH "AUTHORS"
.IX Header "AUTHORS"
Serge Aumont
Comité Réseau des Universités
.TP
Comit Rseau des Universits
.PP
Olivier Salan
Comité Réseau des Universités
.TP
Comit Rseau des Universits
.PP
Contact authors at <sympa-authors@cru.fr>
.SH "REPORTING BUGS"
Report bugs to <sympa-dev@cru.fr>
.SH COPYRIGHT