basic_pop3_auth: Add man(8) documentation

diff --git a/helpers/basic_auth/POP3/Makefile.am b/helpers/basic_auth/POP3/Makefile.am
index db5a1ac95ab9a8e9a5d26f50d2cdcd484cfbedc7..f29163cb4ef15aaac427bf6333ee0aa85b77a41d 100644 (file)
--- a/helpers/basic_auth/POP3/Makefile.am
+++ b/helpers/basic_auth/POP3/Makefile.am
@@ -8,8 +8,16 @@
 include $(top_srcdir)/src/Common.am
 
 libexec_SCRIPTS        = basic_pop3_auth
-EXTRA_DIST = basic_pop3_auth.pl.in required.m4
-CLEANFILES += basic_pop3_auth
+man_MANS= basic_pop3_auth.8
+EXTRA_DIST= \
+       basic_pop3_auth.8 \
+       basic_pop3_auth.pl.in \
+       required.m4
 
 basic_pop3_auth: basic_pop3_auth.pl.in
        $(subst_perlshell)
+
+basic_pop3_auth.8: basic_pop3_auth
+       pod2man basic_pop3_auth basic_pop3_auth.8
+
+CLEANFILES += basic_pop3_auth basic_pop3_auth.8

diff --git a/helpers/basic_auth/POP3/basic_pop3_auth.pl.in b/helpers/basic_auth/POP3/basic_pop3_auth.pl.in
index 97055978ed7987a3c7ece8abce9c80a932c99790..3f755ee9559d11589c5186da57951e4c0c4678b9 100755 (executable)
--- a/helpers/basic_auth/POP3/basic_pop3_auth.pl.in
+++ b/helpers/basic_auth/POP3/basic_pop3_auth.pl.in
@@ -1,32 +1,85 @@
 #!@PERL@
-##
-## Copyright (C) 1996-2014 The Squid Software Foundation and contributors
-##
-## Squid software is distributed under GPLv2+ license and includes
-## contributions from numerous individuals and organizations.
-## Please see the COPYING and CONTRIBUTORS files for details.
-##
-
-# POP3 authenticator for Squid
-# Copyright (C) 2006 Henrik Nordstrom <henrik@henriknordstrom.net>
-#
-# 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., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
-# 
-# Change log:
-#   2006-12-10 henrik  Initial revision
-#
+
+use strict;
+use Pod::Usage;
+use Getopt::Long;
+
+=pod
+
+=head1 NAME
+
+ basic_pop3_auth - POP3 authenticator for Squid
+
+=head1 SYNOPSIS
+
+ basic_pop3_auth server
+
+=head1 DESCRIPTION
+
+B<basic_pop3_auth> authenticates user credentials against a POP3 server.
+
+=head1 OPTIONS
+
+The only option this helper takes is the name of the POP3 server to validate against.
+
+=head1 AUTHOR
+
+This program was written by I<Henrik Nordstrom <henrik@henriknordstrom.net>>
+
+This manual was written by I<Amos Jeffries <squid3@treenet.co.nz>>
+
+=head1 COPYRIGHT
+
+ * Copyright (C) 1996-2014 The Squid Software Foundation and contributors
+ *
+ * Squid software is distributed under GPLv2+ license and includes
+ * contributions from numerous individuals and organizations.
+ * Please see the COPYING and CONTRIBUTORS files for details.
+
+ # Copyright (C) 2006 Henrik Nordstrom <henrik@henriknordstrom.net>
+ #
+ # 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., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
+ # 
+ # Change log:
+ #   2006-12-10        henrik  Initial revision
+ #
+
+=head1 QUESTIONS
+
+Questions on the usage of this program can be sent to the I<Squid Users mailing list <squid-users@squid-cache.org>>
+
+=head1 REPORTING BUGS
+
+Bug reports need to be made in English.
+See http://wiki.squid-cache.org/SquidFaq/BugReporting for details of what you need to include with your bug report.
+
+Report bugs or bug fixes using http://bugs.squid-cache.org/
+
+Report serious security bugs to I<Squid Bugs <squid-bugs@squid-cache.org>>
+
+Report ideas for new improvements to the I<Squid Developers mailing list <squid-dev@squid-cache.org>>
+
+=head1 SEE ALSO
+
+squid (8), GPL (7),
+
+The Squid FAQ wiki http://wiki.squid-cache.org/SquidFaq
+
+The Squid Configuration Manual http://www.squid-cache.org/Doc/config/
+
+=cut
 
 use Net::POP3;
 $|=1;

diff --git a/helpers/basic_auth/POP3/required.m4 b/helpers/basic_auth/POP3/required.m4
index 38bccf297ac6dcb40b130c867167bbd0d0012fa8..7c3f6816eaf62e572e85e6421b4289e6f5fafcbd 100755 (executable)
--- a/helpers/basic_auth/POP3/required.m4
+++ b/helpers/basic_auth/POP3/required.m4
@@ -5,4 +5,6 @@
 ## Please see the COPYING and CONTRIBUTORS files for details.
 ##
 
-BUILD_HELPER="POP3"
+if test "x$PERL" != "x" -a "x$POD2MAN" != "x"; then
+  BUILD_HELPER="POP3"
+fi