Commit 511a97d9 authored by sikeda's avatar sikeda
Browse files

[dev] Updating several documentation.

git-svn-id: https://subversion.renater.fr/sympa/branches/sympa-6.2-branch@11934 05aa8bb8-cd2b-0410-b1d7-8918dfa770ce
parent 8eaaea1e
......@@ -540,7 +540,7 @@ TBD.
Returns:
TBD.
Operation handle (L<LDAP::Search> object or such), or C<undef>.
=item do_query ( $query, $parameters, ... )
......@@ -553,7 +553,7 @@ TBD.
Returns:
TBD.
Statement handle (L<DBI::st> object or such), or C<undef>.
=item do_prepared_query ( $query, $parameters, ... )
......@@ -566,7 +566,7 @@ TBD.
Returns:
TBD.
Statement handle (L<DBI::st> object or such>, or C<undef>.
=item AS_DOUBLE ( $value )
......@@ -631,7 +631,7 @@ This may be used at inside of each driver class.
=head1 SEE ALSO
L<SDM>, L<Sympa::Database>, L<Sympa::DatabaseManager>.
L<Sympa::Database>, L<Sympa::DatabaseManager>.
=head1 HISTORY
......
......@@ -4607,6 +4607,6 @@ was initially written by Chris Hastie. It appeared on Sympa 4.2b.1.
(c) Chris Hastie 2004 - 2008.
Renamed and merged L<Sympa::Message> appeard on Sympa 6.2.0.
Renamed and merged L<Sympa::Message> appeard on Sympa 6.2.
=cut
......@@ -170,5 +170,5 @@ L<Sympa::Message::Plugin::FixEncoding> - An example module for message hook.
=head1 HISTORY
L<Sympa::Message::Plugin> appeared on Sympa 6.2.0.
L<Sympa::Message::Plugin> appeared on Sympa 6.2.
It was initially written by IKEDA Soji <ikeda@conversion.co.jp>.
......@@ -297,6 +297,6 @@ L<archived(8)>, L<Sympa::Message>.
=head1 HISTORY
L<Sympa::Spool::Archive> appeared on Sympa 6.2.0.
L<Sympa::Spool::Archive> appeared on Sympa 6.2.
=cut
......@@ -1128,7 +1128,7 @@ S<B<archived.pl> [ B<--foreground> ] [ B<--debug> ]>
=head1 DESCRIPTION
B<Archived> is a program which scan permanently the outgoing B<Sympa> spool
B<Archived> is a program which scan permanently the archive spool
and feeds the web archives, converting messages to the HTML format and
linking them. Original mails are also kept (in I<arctxt/> directory> for
later rebuilding of archives.
......
......@@ -1428,6 +1428,10 @@ ComitE<233> RE<233>seau des UniversitE<233>s
=back
As of Sympa 6.2b.4, it was splitted into three programs:
F<sympa.pl> command line utility, F<sympa_automatic.pl> daemon and
F<sympa_msg.pl> daemon.
=head1 BUGS
Report bugs to Sympa bug tracker.
......
......@@ -833,16 +833,12 @@ S<B<sympa_automatic.pl> [ B<-d, --debug> ] [ B<-f, --file>=I<another.sympa.conf>
=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.
Sympa_automatic.pl is a program which scans permanently the automatic creation
spool and processes each message.
If the list a message is bound for has not been there and list creation is
authorized, it will be created. Then the message is stored into incoming
message spool again and wait for processing by F<sympa_msg.pl>.
=head1 OPTIONS
......@@ -905,24 +901,16 @@ Print the version number.
F<--CONFIG--> main configuration file.
F<--piddir--/sympa-creation.pid> this file contains the process ID
F<--piddir--/sympa_automatic.pid> this file contains the process ID
of F<sympa_automatic.pl>.
=head1 AVAILABILITY
Latest version of B<Sympa> is available from L<http://www.sympa.org/>.
=head1 MORE DOCUMENTATION
The full documentation in HTML and PDF formats can be
found in L<http://www.sympa.org/manual/>.
=head1 SEE ALSO
The mailing lists (with web archives) can be accessed at
L<http://listes.renater.fr/sympa/lists/informatique/sympa>.
L<sympa.conf(5)>, L<sympa(1)>, L<sympa_msg(8)>.
=head1 HISTORY
This program was originally written by:
F<sympa.pl> was originally written by:
=over 4
......@@ -936,13 +924,8 @@ ComitE<233> RE<233>seau des UniversitE<233>s
=back
=head1 BUGS
Report bugs to Sympa bug tracker.
See L<http://www.sympa.org/tracking>.
=head1 SEE ALSO
L<sympa.conf(5)>, L<sympa_msg(8)>.
As of Sympa 6.2b.4, it was splitted into three programs:
F<sympa.pl> command line utility, F<sympa_automatic.pl> daemon and
F<sympa_msg.pl> daemon.
=cut
......@@ -2150,20 +2150,20 @@ S<B<sympa_msg.pl> [ B<-d, --debug> ] [ B<-f, --file>=I<another.sympa.conf> ]>
=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.
Sympa_msg.pl is a program which scans permanently the incoming message spool
and processes each message.
Messages bound for the lists and authorized sending are modified as neccesity
and at last stored into digest spool, archive spool and bulk spool.
Those bound for command addresses are interpreted and appropriate actions are
taken.
Those bound for listmasters or list admins are forwarded to them.
=head1 OPTIONS
F<sympa_msg.pl> may run with following options in general.
Sympa_msg.pl follows the usual GNU command line syntax,
with long options starting with two dashes (C<-->). A summary of
options is included below.
=over 4
......@@ -2236,24 +2236,19 @@ Print the version number.
F<--CONFIG--> main configuration file.
F<--piddir--/sympa.pid> this file contains the process ID
F<--piddir--/sympa_msg.pid> this file contains the process ID
of F<sympa_msg.pl>.
=head1 AVAILABILITY
Latest version of B<Sympa> is available from L<http://www.sympa.org/>.
=head1 MORE DOCUMENTATION
=head1 SEE ALSO
The full documentation in HTML and PDF formats can be
found in L<http://www.sympa.org/manual/>.
L<sympa.conf(5)>, L<sympa(1)>.
The mailing lists (with web archives) can be accessed at
L<http://listes.renater.fr/sympa/lists/informatique/sympa>.
L<archived(8)>, L<bulk(8)>, L<bounced(8)>, L<sympa_automatic(8)>,
L<task_manager(8)>.
=head1 HISTORY
This program was originally written by:
F<sympa.pl> was originally written by:
=over 4
......@@ -2267,20 +2262,8 @@ ComitE<233> RE<233>seau des UniversitE<233>s
=back
=head1 BUGS
Report bugs to Sympa bug tracker.
See L<http://www.sympa.org/tracking>.
=head1 SEE ALSO
L<sympa.conf(5)>, L<sympa(1)>.
L<archived(8)>, L<bulk(8)>, L<bounced(8)>, L<sympa_automatic(8)>,
L<task_manager(8)>.
L<sendmail(8)>, L<alias_manager(8)>.
L<wwsympa(8)>, L<sympa_soap_server(8)>.
As of Sympa 6.2b.4, it was splitted into three programs:
F<sympa.pl> command line utility, F<sympa_automatic.pl> daemon and
F<sympa_msg.pl> daemon.
=cut
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