Skip to content
GitLab
Commit 69c74ba2 authored by salaun's avatar salaun
Browse files

Changes: Complete pod files, adapt makefiles 


git-svn-id: https://subversion.renater.fr/sympa/trunk@444 05aa8bb8-cd2b-0410-b1d7-8918dfa770ce
parent 54877e56
Hide whitespace changes
Inline Side-by-side
Makefile
View file @ 69c74ba2
......@@ -157,7 +157,7 @@ checkcpan:
clean:
find . \( -name ".#*" -o -name "*~" -o -name ".*~" -o -name "#*#" \) -exec rm -f {} \;
@for i in src nls wwsympa src/etc/sample ;\
@for i in src nls wwsympa src/etc/sample;\
do \
(cd $$i && echo "making clean in $$i..." && \
$(MAKE) PERL='${PERL}' clean) || exit 1; \
......@@ -217,6 +217,10 @@ installman:
DESTDIR=$(DESTDIR); export DESTDIR; \
SYMPA_VERSION=$(SYMPA_VERSION); export SYMPA_VERSION; \
CONFDIR=$(CONFDIR); export CONFDIR; \
SENDMAIL_ALIASES=$(SENDMAIL_ALIASES); export SENDMAIL_ALIASES; \
MAILERPROGDIR=$(MAILERPROGDIR); export MAILERPROGDIR; \
PIDDIR=$(PIDDIR); export PIDDIR; \
SPOOLDIR=$(SPOOLDIR); export SPOOLDIR; \
PIDDIR=$(PIDDIR); export PIDDIR; \
$(PERL) ../../subst.pl $$manfile \
) ;\
......
doc/man8/Makefile
View file @ 69c74ba2
......@@ -7,7 +7,7 @@ MAN8 = archived.8 bounced.8 alias_manager.8 sympa.8
.pod.8:
rm -f $@
pod2man -s 8 -r $(SYMPA_VERSION) $< $@
pod2man --section=8 --center="sympa $(SYMPA_VERSION)" --lax --release=$(SYMPA_VERSION) $< $@
all: $(MAN8)
......
doc/man8/alias_manager.pod
View file @ 69c74ba2
......@@ -4,18 +4,17 @@ 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>>
S<B<alias_manager> B<add> | 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.
created lists and deleting aliases for closed lists.
Is is called by
I<wwsympa.fcgi> via the I<aliaswrapper>. Alias management is performed
by I<wwsympa.fcgi> only if it was setup in I<--CONFDIR--/wwsympa.conf>
(I<alias_manager> configuration parameter).
=head1 OPTIONS
......@@ -35,7 +34,7 @@ domain I<domain>.
=head1 FILES
F</etc/aliases> sendmail aliases file.
F<--SENDMAIL_ALIASES--> sendmail aliases file.
=head1 MORE DOCUMENTATION
......@@ -55,8 +54,8 @@ Olivier Sala
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).
This manual page was initially written by Jérôme Marant <jerome.marant@IDEALX.org>
for the Debian GNU/Linux system.
=head1 COPYRIGHT
......@@ -80,4 +79,7 @@ Report bugs to <sympa-dev@cru.fr>.
=head1 SEE ALSO
L<sympa(1)>, L<sendmail(8)>.
\ No newline at end of file
L<sympa(1)>, L<sendmail(8)>.
doc/man8/archived.pod
View file @ 69c74ba2
......@@ -8,16 +8,15 @@ 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
B<Archived> is a program which scan permanently the outgoing B<Sympa> spool and
feeds the web archives, converting messages to the HTML format and
linking them.
linking them. Original mails are also kept (in I<arctxt/> directory> for later rebuilding of
archives.
The HTML conversion is achieved by the means of the B<MhOnArc> program.
The HTML conversion is achieved by the means of the MhOnArc program.
Archives are accessed via B<wwsympa.fcgi>, which proposes access control ;
therefore archives should not be located in a public web directory.
=head1 OPTIONS
......@@ -39,9 +38,13 @@ Run the program in a debug mode.
=head1 FILES
F</etc/sympa/wwsympa.conf> WWSympa configuration file.
F<--SPOOLDIR--/outgoing/> outgoing Sympa directory.
F<--ETCBINDIR--/mhonarc-ressources> mhonarc ressource file
F<--CONFDIR--/wwsympa.conf> WWSympa configuration file.
F</var/spool/sympa/archived.pid> this file contains the process ID
F<--PIDDIR--/archived.pid> this file contains the process ID
of F<archived.pl>.
=head1 MORE DOCUMENTATION
......@@ -62,8 +65,8 @@ Olivier Sala
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).
This manual page was initially written by Jérôme Marant <jerome.marant@IDEALX.org>
for the Debian GNU/Linux system.
=head1 COPYRIGHT
......@@ -87,4 +90,8 @@ Report bugs to <sympa-dev@cru.fr>.
=head1 SEE ALSO
L<sympa(1)>, L<bounced(1)>, L<mhonarc(1)>, L<wwsympa.conf(5)>.
L<sympa(8)>, L<bounced(8)>, L<mhonarc(1)>, L<wwsympa.conf(5)>.
doc/man8/bounced.pod
View file @ 69c74ba2
......@@ -8,15 +8,12 @@ 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
Bounced is a program which scans permanently the bounce spool and
processes bounces (non-delivery messages), looking or bad addresses.
Bouncing addresses are tagged in database ; last bounce is kept for
each bvouncing address.
List owners will latter access bouces information via WWSympa.
List owners will latter access bounces information via WWSympa.
=head1 OPTIONS
......@@ -38,9 +35,13 @@ Run the program in a debug mode.
=head1 FILES
F</etc/sympa/wwsympa.conf> WWSympa configuration file.
F<--CONFDIR--/wwsympa.conf> WWSympa configuration file.
F<--MAILERPROGDIR--/bouncequeue> bounce spooler, referenced from sendmail alias file
F</var/spool/sympa/bounced.pid> this file contains the process ID
F<--SPOOLDIR--/bounce> incoming bounces directory
F<--PIDDIR--/bounced.pid> this file contains the process ID
of F<bounced.pl>.
=head1 MORE DOCUMENTATION
......@@ -61,8 +62,8 @@ Olivier Sala
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).
This manual page was initially written by Jérôme Marant <jerome.marant@IDEALX.org>
for the Debian GNU/Linux system.
=head1 COPYRIGHT
......@@ -86,4 +87,6 @@ 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
L<sympa(8)>, L<archived(8)>, L<mhonarc(1)>, L<wwsympa.conf(5)>.
doc/man8/sympa.8
View file @ 69c74ba2
.\" Automatically generated by Pod::Man version 1.02
.\" Thu May 10 17:27:55 2001
.\" Fri May 11 11:45:49 2001
.\"
.\" Standard preamble:
.\" ======================================================================
......@@ -138,7 +138,7 @@
.\" ======================================================================
.\"
.IX Title "sympa 8"
.TH sympa 8 "3.1.1" "2001-05-10" "User Contributed Perl Documentation"
.TH sympa 8 "3.1.1" "2001-05-11" "sympa 3.1.1"
.UC
.SH "NAME"
sympa (or sympa.pl) \- A Modern Mailing List Manager
......@@ -146,7 +146,7 @@ sympa (or sympa.pl) \- A Modern Mailing List Manager
.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\-l,\ \-\-lang\fR=\fIcatalog\fR\ ]\ [\ \fB\*(--lowercase\fR\ ]\ [\ \fB\-m,\ \-\-mail\fR\ ]
[\ \fB\*(--dump\fR=\fIlistname\fR\ |\ \s-1ALL\s0]\ [\ \fB\-h,\ \-\-help\fR\ ]
[\ \fB\-v,\ \-\-version\fR\ ]
.SH "DESCRIPTION"
......@@ -195,6 +195,9 @@ store messages.
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\*(--lowercase\fR" 5
.IX Item "lowercase"
Lowercases email addresses in database.
.Ip "\fB\-m, \-\-mail\fR" 5
.IX Item "-m, --mail"
Sympa will log calls to sendmail, including recipients. This option is
......@@ -248,4 +251,4 @@ Public License Version 2 (the section on "/www.gnu.org/copyleft/gpl.html" in the
Report bugs to <sympa-dev@cru.fr>.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIsympa.conf\fR\|(5), \fIsendmail\fR\|(8)
\&\fIsympa.conf\fR\|(5), \fIarchived\fR\|(8), \fIbounced\fR\|(8), \fIsendmail\fR\|(8), \fIalias_manager\fR\|(8)
doc/man8/sympa.pod 0 → 100644
View file @ 69c74ba2
=head1 NAME
sympa (or sympa.pl) - A Modern Mailing List Manager
=head1 SYNOPSIS
S<B<sympa> [ B<-d, --debug> ] [ B<-f, --file>=I<another.sympa.conf> ]>
S<[ B<--import>=I<listname> ] [ B<-k, --keepcopy>=I<directory> ]>
S<[ B<-l, --lang>=I<catalog> ] [ B<--lowercase> ] [ B<-m, --mail> ]>
S<[ B<--dump>=I<listname> | ALL] [ B<-h, --help> ]>
S<[ B<-v, --version> ]>
=head1 DESCRIPTION
B<Sympa> 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. B<Sympa> can be linked to an LDAP directory
or an RDBMS to create dynamic mailing lists. B<Sympa> provides S/MIME
and HTTPS based authentication and encryption.
Sympa is a modern mailing-list manager. It supports a lot of useful
features.
=head1 OPTIONS
=over 5
=item B<-d, --debug>
Enable debug mode.
=item B<-f, --file=>F<another.sympa.conf>
Force Sympa to use an alternative configuration file instead
of F</etc/sympa/sympa.conf>.
=item B<--import=>I<list>
Import subscribers in the list. Data are read from STDIN.
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.
Sample :
## Data to be imported
## email gecos
john.steward@some.company.com John - accountant
mary.blacksmith@another.company.com Mary - secretary
=item B<-k, --keepcopy=>F<directory>
This option tells Sympa to keep a copy of every incoming message,
instead of deleting them. `directory' is the directory to
store messages.
=item B<-l, --lang=>I<catalog>
Set this option to use a language catalog for Sympa. The corresponding
catalog file `catalogue'.cat must be located in F</usr/lib/sympa/nls>
directory.
=item B<--lowercase>
Lowercases email addresses in database.
=item B<-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).
=item B<--dump=>I<listname> | ALL
Dumps subscribers of for `listname' list or all lists. Subscribers are
dumped in subscribers.db.dump.
=item B<-h, --help>
Print this help message.
=item B<-v, --version>
Print the version number.
=back
=head1 FILES
F</etc/sympa/sympa.conf> main configuration file.
F</var/spool/sympa/sympa.pid> this file contains the process ID
of F<sympa.pl>.
=head1 AVAILABILITY
Latest version of B<Sympa> is available from http://www.sympa.org.
=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>
=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>)
=head1 BUGS
Report bugs to <sympa-dev@cru.fr>.
=head1 SEE ALSO
L<sympa.conf(5)>, L<archived(8)>, L<bounced(8)>, L<sendmail(8)>, L<alias_manager(8)>
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment