courier-imap: add makeimapaccess wrapper, man page.

6 files changed, 109 insertions, 9 deletions

diff --git a/imap/.gitignore b/imap/.gitignore
index 3687d22..2c8f7fa 100644
--- a/imap/.gitignore
+++ b/imap/.gitignore
@@ -27,6 +27,10 @@
 /mkimapdcert.8.in
 /mkimapdcert.html
 /mkimapdcert.html.in
+/makeimapaccess.8
+/makeimapaccess.8.in
+/makeimapaccess.html
+/makeimapaccess.html.in
 /mkpop3dcert
 /mkpop3dcert.8
 /mkpop3dcert.8.in
diff --git a/imap/Makefile.am b/imap/Makefile.am
index 4510f36..23f4df4 100644
--- a/imap/Makefile.am
+++ b/imap/Makefile.am
@@ -1,5 +1,5 @@
 #
-# Copyright 1998 - 2008 Double Precision, Inc.  See COPYING for
+# Copyright 1998 - 2015 Double Precision, Inc.  See COPYING for
 # distribution information.
 
 AM_CPPFLAGS=@CPPAUTH@
@@ -8,12 +8,14 @@ BUILT_SOURCES=README.proxy
 
 DISTCLEANFILES=imapd.pam pop3d.pam imapd.cnf pop3d.cnf
 CLEANFILES=imapd.8 imapd.html mkimapdcert.html mkimapdcert.8 \
+	makeimapaccess.html makeimapaccess.8 \
 	mkdhparams.html mkdhparams.8 \
 	courierpop3d.html courierpop3d.8 mkpop3dcert.html mkpop3dcert.8
 
 EXTRA_DIST=testsuite testsuite.txt smaptestsuite smaptestsuite.txt \
 	BUGS BUGS.html README README.html imapd.authpam \
 	pop3d.authpam system-auth.authpam system-auth2.authpam\
+	makeimapaccess.8.in makeimapaccess.html.in \
 	imapd.html.in imapd.8.in \
 	mkdhparams.html.in mkdhparams.8.in \
 	mkimapdcert.html.in mkimapdcert.8.in \
@@ -26,6 +28,7 @@ noinst_SCRIPTS=mkimapdcert mkpop3dcert mkdhparams
 noinst_PROGRAMS=imaplogin imapd pop3login pop3d
 
 noinst_DATA=imapd.8 imapd.html imapd.cnf pop3d.cnf \
+	makeimapaccess.html makeimapaccess.8 \
 	mkdhparams.html mkdhparams.8 \
 	mkimapdcert.html mkimapdcert.8 \
 	mkpop3dcert.html mkpop3dcert.8 \
@@ -105,6 +108,12 @@ imapd.html: imapd.html.in
 imapd.8: imapd.8.in
 	./config.status --file=imapd.8
 
+makeimapaccess.html: makeimapaccess.html.in
+	./config.status --file=makeimapaccess.html
+
+makeimapaccess.8: makeimapaccess.8.in
+	./config.status --file=makeimapaccess.8
+
 mkdhparams.html: mkdhparams.html.in
 	./config.status --file=mkdhparams.html
 
@@ -137,6 +146,13 @@ imapd.8.in: imapd.sgml ../docbook/sgml2man
 	../docbook/sgml2man imapd.sgml imapd.8.in
 	mv imapd.8 imapd.8.in
 
+makeimapaccess.html.in: makeimapaccess.sgml ../docbook/sgml2html
+	../docbook/sgml2html makeimapaccess.sgml makeimapaccess.html.in
+
+makeimapaccess.8.in: makeimapaccess.sgml ../docbook/sgml2man
+	../docbook/sgml2man makeimapaccess.sgml makeimapaccess.8.in
+	mv makeimapaccess.8 makeimapaccess.8.in
+
 mkdhparams.html.in: mkdhparams.sgml ../docbook/sgml2html
 	../docbook/sgml2html mkdhparams.sgml mkdhparams.html.in
 
diff --git a/imap/configure.ac b/imap/configure.ac
index f37b8be..df67887 100644
--- a/imap/configure.ac
+++ b/imap/configure.ac
@@ -1,7 +1,7 @@
 dnl Process this file with autoconf to produce a configure script.
 dnl
 dnl
-dnl Copyright 1998 - 2013 Double Precision, Inc.  See COPYING for
+dnl Copyright 1998 - 2015 Double Precision, Inc.  See COPYING for
 dnl distribution information.
 
 AC_INIT(courier-imap, 4.16.0, [courier-users@lists.sourceforge.net])
@@ -125,12 +125,12 @@ AC_SYS_LARGEFILE
 
 AC_CACHE_CHECK([for socklen_t],
 	sox_cv_hassocklen_t,
- 
+
 AC_COMPILE_IFELSE([
 AC_LANG_SOURCE( [
 #include <sys/types.h>
 #include <sys/socket.h>
- 
+
 socklen_t sl_t;
 ],[
 	accept(0, 0, &sl_t);
@@ -138,9 +138,9 @@ socklen_t sl_t;
 	sox_cv_hassocklen_t=yes,
 	sox_cv_hassocklen_t=no)
 )
- 
+
 socklen_t="int"
- 
+
 if test $sox_cv_hassocklen_t = yes
 then
 	:
diff --git a/imap/imapd.dist.in b/imap/imapd.dist.in
index 269fdd6..08ecd69 100644
--- a/imap/imapd.dist.in
+++ b/imap/imapd.dist.in
@@ -73,16 +73,22 @@ PIDFILE=@piddir@/imapd.pid
 
 TCPDOPTS="-nodnslookup -noidentlookup"
 
+##NAME: ACCESSFILE:0
+#
+# IMAP access file.
+
+IMAPACCESSFILE=@sysconfdir@/imapaccess
+
 ##NAME: LOGGEROPTS:0
 #
-# courierlogger(1) options.                                        
+# courierlogger(1) options.
 #
 
 LOGGEROPTS="-name=imapd"
 
 ##NAME: DEFDOMAIN:0
 #
-# Optional default domain. If the username does not contain the         
+# Optional default domain. If the username does not contain the
 # first character of DEFDOMAIN, then it is appended to the username.
 # If DEFDOMAIN and DOMAINSEP are both set, then DEFDOMAIN is appended
 # only if the username does not contain any character from DOMAINSEP.
diff --git a/imap/makeimapaccess.sgml b/imap/makeimapaccess.sgml
new file mode 100644
index 0000000..92e480a
--- /dev/null
+++ b/imap/makeimapaccess.sgml
@@ -0,0 +1,73 @@
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
+<!-- Copyright 1998 - 2009 Double Precision, Inc.  See COPYING for -->
+<!-- distribution information. -->
+<refentry>
+  <info><author><firstname>Sam</firstname><surname>Varshavchik</surname><contrib>Author</contrib></author><productname>Courier Mail Server</productname></info>
+
+  <refmeta>
+    <refentrytitle>makeimapaccess</refentrytitle>
+    <manvolnum>8</manvolnum>
+    <refmiscinfo>Double Precision, Inc.</refmiscinfo>
+  </refmeta>
+
+  <refnamediv>
+    <refname>makeimapaccess</refname>
+    <refpurpose>Build IMAP server access file</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <cmdsynopsis sepchar=" ">
+      <command>makeimapaccess</command>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>DESCRIPTION</title>
+
+    <para>
+      <command>makeimapaccess</command> rebuilds the contents of the
+      <filename>@sysconfdir@/imapaccess.dat</filename> database from the
+      contents of the
+      files in the <filename>@sysconfdir@/imapaccess</filename> directory.
+      When the
+      <command>imapd</command> script starts <command>couriertcpd</command>,
+      the script specifies the
+      <filename>@sysconfdir@/imapaccess.dat</filename> file to control
+      access to
+      the <application>Courier</application> mail server's
+      IMAP daemon. The <command>makeimapaccess</command> script
+      must be
+      run before any changes in the <filename>@sysconfdir@/imapaccess</filename>
+      directory take effect.</para>
+
+    <para>
+      The
+      <ulink url="couriertcpd.html"><citerefentry><refentrytitle>couriertcpd</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> manual page
+      describes the general format of the access file.</para>
+
+
+    <refsect2>
+      <title>The <filename>imapaccess</filename> configuration file</title>
+
+      <para>
+	The
+	<ulink url="couriertcpd.html"><citerefentry><refentrytitle>couriertcpd</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink> manual page
+	describes the generic format of the access file.
+	The access file specifies
+	what should be done with connections from defined IP address ranges.
+	The basic choices are to accept or reject the connection.
+	Also, the generic format of the access file allows arbitrary environment
+	variables to be set based on the connection's remote IP address,
+	however the IMAP server does not use any special environment variables
+	on its own.
+      </para>
+    </refsect2>
+  </refsect1>
+
+  <refsect1>
+    <title>SEE ALSO</title>
+    <para>
+      <ulink url="couriertcpd.html"><citerefentry><refentrytitle>couriertcpd</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink>.
+    </para>
+  </refsect1>
+</refentry>
diff --git a/tcpd/couriertcpd.sgml b/tcpd/couriertcpd.sgml
index d65a835..d6c0fac 100644
--- a/tcpd/couriertcpd.sgml
+++ b/tcpd/couriertcpd.sgml
@@ -459,7 +459,8 @@ considered to be experimental.</para>
     <para>
 The access file is a binary database file that's usually created by a
 script, such as
-<ulink url="makesmtpaccess.html"><citerefentry><refentrytitle>makesmtpaccess</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink>,
+<ulink url="makesmtpaccess.html"><citerefentry><refentrytitle>makesmtpaccess</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink>, or
+<ulink url="makeimapaccess.html"><citerefentry><refentrytitle>makeimapaccess</refentrytitle><manvolnum>8</manvolnum></citerefentry></ulink>,
 from one or more plain text
 files. Blank lines in the text file are ignored. Lines that start with the #
 character are also ignored.</para>