Goal: manpages Author: Mathieu Parent Upstream status: Should be submitted upstream Index: b/bin/kolab_smtpdpolicy.in =================================================================== --- a/bin/kolab_smtpdpolicy.in +++ b/bin/kolab_smtpdpolicy.in @@ -1,28 +1,113 @@ #!perl -## COPYRIGHT -## --------- -## -## See AUTHORS file -## -## -## LICENSE -## ------- -## -## 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 2 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, write to the Free Software -## Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. -## +=head1 NAME + +kolab_smtpdpolicy - Kolab SMTP policy + +=head1 SYNOPSIS + +B [B<-v>] + +=head1 DESCRIPTION + +kolabdelegated Postfix SMTPD policy server for Kolab. This server implements +various policies for Kolab: + +1) Only authenticated users can use sender @$domain + +2) Some distribution lists are only available to authenticated users + +Logging is sent to syslogd. + +How it works: each time a Postfix SMTP server process is started +it connects to the policy service socket, and Postfix runs one +instance of this PERL script. By default, a Postfix SMTP server +process terminates after 100 seconds of idle time, or after serving +100 clients. Thus, the cost of starting this PERL script is smoothed +out over time. + +To run this from /etc/postfix/master.cf: + + policy unix - n n - - spawn + user=kolab-n argv=/usr/bin/perl /usr/libexec/postfix/kolab_smtpdpolicy + +To use this from Postfix SMTPD, use in /etc/postfix/main.cf: + + smtpd_recipient_restrictions = + ... + reject_unauth_destination + check_policy_service unix:private/policy + ... + smtpd_sender_restrictions = + ... + check_policy_service unix:private/policy + ... + +NOTE: specify check_policy_service AFTER reject_unauth_destination +or else your system can become an open relay. + +To test this script by hand, execute kolab_smtpdpolicy, optionally +with the option -v to print debugging output. +Example for OpenPKG based installations: + + # su - kolab + $ /kolab/etc/kolab/kolab_smtpdpolicy -v + +Each query is a bunch of attributes. Order does not matter, and +the demo script uses only a few of all the attributes shown below: + + request=smtpd_access_policy + protocol_state=RCPT + protocol_name=SMTP + helo_name=some.domain.tld + queue_id=8045F2AB23 + sender=foo@bar.tld + recipient=bar@foo.tld + client_address=1.2.3.4 + client_name=another.domain.tld + instance=123.456.7 + sasl_method=plain + sasl_username=you + sasl_sender= + size=12345 + [empty line] + +The policy server script will answer in the same style, with an +attribute list followed by a empty line: + + action=DUNNO + [empty line] + + +=head1 OPTIONS AND ARGUMENTS + +=over 8 + +=item B<-v> + +=back + +=head1 COPYRIGHT AND AUTHORS + +See AUTHORS file + +=head1 LICENSE + +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 2, 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 can view the GNU General Public License, online, at the GNU +Project's homepage; see . + +=cut + ## $Revision: 1.1 $ use strict; @@ -35,76 +120,6 @@ use Socket; use Kolab::Util; -# -# Usage: kolab_smtpdpolicy [-v] -# -# kolabdelegated Postfix SMTPD policy server for Kolab. This server implements -# various policies for Kolab: -# -# 1) Only authenticated users can use sender @$domain -# 2) Some distribution lists are only available to authenticated users -# -# Logging is sent to syslogd. -# -# How it works: each time a Postfix SMTP server process is started -# it connects to the policy service socket, and Postfix runs one -# instance of this PERL script. By default, a Postfix SMTP server -# process terminates after 100 seconds of idle time, or after serving -# 100 clients. Thus, the cost of starting this PERL script is smoothed -# out over time. -# -# To run this from /etc/postfix/master.cf: -# -# policy unix - n n - - spawn -# user=kolab-n argv=/usr/bin/perl /usr/libexec/postfix/kolab_smtpdpolicy -# -# To use this from Postfix SMTPD, use in /etc/postfix/main.cf: -# -# smtpd_recipient_restrictions = -# ... -# reject_unauth_destination -# check_policy_service unix:private/policy -# ... -# smtpd_sender_restrictions = -# ... -# check_policy_service unix:private/policy -# ... -# -# NOTE: specify check_policy_service AFTER reject_unauth_destination -# or else your system can become an open relay. -# -# To test this script by hand, execute kolab_smtpdpolicy, optionally -# with the option -v to print debugging output. -# Example for OpenPKG based installations: -# -# # su - kolab -# $ /kolab/etc/kolab/kolab_smtpdpolicy -v -# -# Each query is a bunch of attributes. Order does not matter, and -# the demo script uses only a few of all the attributes shown below: -# -# request=smtpd_access_policy -# protocol_state=RCPT -# protocol_name=SMTP -# helo_name=some.domain.tld -# queue_id=8045F2AB23 -# sender=foo@bar.tld -# recipient=bar@foo.tld -# client_address=1.2.3.4 -# client_name=another.domain.tld -# instance=123.456.7 -# sasl_method=plain -# sasl_username=you -# sasl_sender= -# size=12345 -# [empty line] -# -# The policy server script will answer in the same style, with an -# attribute list followed by a empty line: -# -# action=DUNNO -# [empty line] -# # # Syslogging options for verbose mode and for fatal errors. Index: b/bin/kolabdcachetool.in =================================================================== --- a/bin/kolabdcachetool.in +++ b/bin/kolabdcachetool.in @@ -1,5 +1,48 @@ #!perl +=head1 NAME + +kolabdcachetool - Kolab cache tool + +=head1 SYNOPSIS + +B I I + +=head1 OPTIONS AND ARGUMENTS + +=over 8 + +=item I + +one of `mbox' or `gyard' (i.e. the cache to operate on) + +=item I + +one of `list', `delete' or `flush' (i.e. the function to perform on CACHE) + +=back + +=head1 COPYRIGHT AND AUTHORS + +Stuart Bingë and others (see AUTHORS file) + +=head1 LICENSE + +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 2, 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 can view the GNU General Public License, online, at the GNU +Project's homepage; see . + +=cut + use strict; use Getopt::Long; use DB_File; Index: b/bin/kolabpasswd.in =================================================================== --- a/bin/kolabpasswd.in +++ b/bin/kolabpasswd.in @@ -1,30 +1,49 @@ #!perl -# The kolabpasswd script is used for changing the manager password on a Kolab Server. -# In multi-location Kolab setups the script must be run on each individual host -# seperately. -# After changing the manager password it is highly recommended to restart -# the Kolab server. -# In the future this utility may be enhanced to allow to change the passwords of -# normal users and special system accounts. - -## Copyright (c) 2004 Erfrakon -## -## (c) 2004 Tassilo Erlewein -## (c) 2004 Martin Konold -## -## 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 2, 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 can view the GNU General Public License, online, at the GNU -## Project's homepage; see . +=head1 NAME + +kolabpasswd - Kolab password tool. + +=head1 SYNOPSIS + +B + +=head1 DESCRIPTION + +The kolabpasswd script is used for changing the manager password on a Kolab Server. +In multi-location Kolab setups the script must be run on each individual host +seperately. + +After changing the manager password it is highly recommended to restart +the Kolab server. + +In the future this utility may be enhanced to allow to change the passwords of +normal users and special system accounts. + +=head1 COPYRIGHT AND AUTHORS + +Copyright (c) 2004 Erfrakon + +Copyright (c) 2004 Tassilo Erlewein + +Copyright (c) 2004 Martin Konold + +=head1 LICENSE + +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 2, 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 can view the GNU General Public License, online, at the GNU +Project's homepage; see . + +=cut use Term::ReadKey; use IO::File; Index: b/bin/kolabquotareport.in =================================================================== --- a/bin/kolabquotareport.in +++ b/bin/kolabquotareport.in @@ -1,23 +1,43 @@ #!perl -## -## Copyright (c) 2004 Klarälvdalens Datakonsult AB -## -## Writen by Steffen Hansen -## -## 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 2, 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 can view the GNU General Public License, online, at the GNU -## Project's homepage; see . -## +=head1 NAME + +kolabquotareport - Kolab quota report tool + +=head1 SYNOPSIS + +B [B<-d>] + +=head1 OPTIONS AND ARGUMENTS + +=over 8 + +=item B<-d> + +=back + +=head1 COPYRIGHT AND AUTHORS + +Copyright (c) 2004 Klarälvdalens Datakonsult AB + +Writen by Steffen Hansen + +=head1 LICENSE + +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 2, 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 can view the GNU General Public License, online, at the GNU +Project's homepage; see . + +=cut ## Local variables: ## mode: perl Index: b/bin/kolabquotawarn.in =================================================================== --- a/bin/kolabquotawarn.in +++ b/bin/kolabquotawarn.in @@ -1,23 +1,43 @@ #!perl -## -## Copyright (c) 2004 Klarälvdalens Datakonsult AB -## -## Written by Steffen Hansen -## -## 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 2, 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 can view the GNU General Public License, online, at the GNU -## Project's homepage; see . -## +=head1 NAME + +kolabquotawarn - Kolab quota warn tool + +=head1 SYNOPSIS + +B [B<-d>] + +=head1 OPTIONS AND ARGUMENTS + +=over 8 + +=item B<-d> + +=back + +=head1 COPYRIGHT AND AUTHORS + +Copyright (c) 2004 Klarälvdalens Datakonsult AB + +Writen by Steffen Hansen + +=head1 LICENSE + +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 2, 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 can view the GNU General Public License, online, at the GNU +Project's homepage; see . + +=cut ## Local variables: ## mode: perl Index: b/sbin/kolab_bootstrap.in =================================================================== --- a/sbin/kolab_bootstrap.in +++ b/sbin/kolab_bootstrap.in @@ -1,14 +1,49 @@ #!perl -# (c) 2004-2005 Steffen Hansen -# (c) 2003,2004 Tassilo Erlewein -# (c) 2003-2005 Martin Konold -# (c) 2003 Achim Frank -# -# This program is Free Software under the GNU General Public License (>=v2). -# Read the file COPYING that comes with this packages for details. +=head1 NAME -# kolab_bootstrap Version 0.93 +kolab_bootstrap - Kolab bootstrap tool + +=head1 SYNOPSIS + +B [B<-b>] [B<-f>] + +=head1 OPTIONS AND ARGUMENTS + +=over 8 + +=item B<-b> + +=item B<-f> + +=back + +=head1 COPYRIGHT AND AUTHORS + +Copyright (c) 2004-2005 Steffen Hansen + +Copyright (c) 2003,2004 Tassilo Erlewein + +Copyright (c) 2003-2005 Martin Konold + +Copyright (c) 2003 Achim Frank + +=head1 LICENSE + +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 2, 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 can view the GNU General Public License, online, at the GNU +Project's homepage; see . + +=cut use strict; use vars qw($opt_b $opt_f); Index: b/sbin/kolab_upgrade.in =================================================================== --- a/sbin/kolab_upgrade.in +++ b/sbin/kolab_upgrade.in @@ -1,9 +1,33 @@ #!perl -# (c) 2005 Steffen Hansen -# -# This program is Free Software under the GNU General Public License (>=v2). -# Read the file COPYING that comes with this packages for details. +=head1 NAME + +kolab_upgrade - Kolab upgrade tool + +=head1 SYNOPSIS + +B + +=head1 COPYRIGHT AND AUTHORS + +Copyright (c) 2005 Steffen Hansen + +=head1 LICENSE + +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 2, 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 can view the GNU General Public License, online, at the GNU +Project's homepage; see . + +=cut use Term::ReadKey; use Kolab; Index: b/sbin/kolabcheckperm.in =================================================================== --- a/sbin/kolabcheckperm.in +++ b/sbin/kolabcheckperm.in @@ -1,11 +1,35 @@ #!perl -# (c) 2004 Klaralvdalens Datakonsult AB -# -# Written by Steffen Hansen -# -# This program is Free Software under the GNU General Public License (>=v2). -# Read the file COPYING that comes with this packages for details. +=head1 NAME + +kolabcheckperm - Kolab permission checking tool + +=head1 SYNOPSIS + +B + +=head1 COPYRIGHT AND AUTHORS + +Copyright (c) 2004 Klaralvdalens Datakonsult AB + +Written by Steffen Hansen + +=head1 LICENSE + +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 2, 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 can view the GNU General Public License, online, at the GNU +Project's homepage; see . + +=cut use strict; use Kolab; Index: b/sbin/kolabconf.in =================================================================== --- a/sbin/kolabconf.in +++ b/sbin/kolabconf.in @@ -1,28 +1,52 @@ #!perl -## COPYRIGHT -## --------- -## -## See AUTHORS file -## -## -## LICENSE -## ------- -## -## 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 2 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, write to the Free Software -## Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. -## +=head1 NAME + +kolabconf - Kolab configuration tool + +=head1 SYNOPSIS + +B [B<-d>] [B<-n>] [B<-h>] + +=head1 OPTIONS AND ARGUMENTS + +=over 8 + +=item B<-d> + +(debug) to print out the current config. + +=item B<-n> + +(noreload) to skip reloading services after changing configuration. + +=item B<-h> + +(help) to get this text. + +=back + +=head1 COPYRIGHT AND AUTHORS + +See AUTHORS file + +=head1 LICENSE + +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 2, 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 can view the GNU General Public License, online, at the GNU +Project's homepage; see . + +=cut + ## $Revision: 1.1 $ use 5.008; Index: b/sbin/kolabd.in =================================================================== --- a/sbin/kolabd.in +++ b/sbin/kolabd.in @@ -1,30 +1,46 @@ #!perl -## -## Copyright (c) 2004 Klaraelvdalens Datakonsult AB -## Copyright (c) 2003 Code Fusion cc -## -## Writen by Stuart Bing? -## Portions based on work by the following people: -## -## (c) 2003 Tassilo Erlewein -## (c) 2003 Martin Konold -## (c) 2003 Achim Frank -## -## -## 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 2, 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 can view the GNU General Public License, online, at the GNU -## Project's homepage; see . -## +=head1 NAME + +kolabd - Kolab daemon + +=head1 SYNOPSIS + +B + +=head1 COPYRIGHT AND AUTHORS + +Copyright (c) 2004 Klaraelvdalens Datakonsult AB + +Copyright (c) 2003 Code Fusion cc + +Writen by Stuart Bing? + +Portions based on work by the following people: + +Copyright (c) 2003 Tassilo Erlewein + +Copyright (c) 2003 Martin Konold + +Copyright (c) 2003 Achim Frank + + +=head1 LICENSE + +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 2, 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 can view the GNU General Public License, online, at the GNU +Project's homepage; see . + +=cut # # Module prefixes in the logs: