Import ezmlm-idx 0.40

[ezmlm] / ezmlmsubrc.5

diff --git a/ezmlmsubrc.5 b/ezmlmsubrc.5
new file mode 100644 (file)
index 0000000..c32ad33
--- /dev/null
+++ b/ezmlmsubrc.5
@@ -0,0 +1,79 @@
+.TH ezmlmsubrc 5
+.SH NAME
+ezmlmsubrc \- set up a minimal sublist
+.SH SYNOPSIS
+.B ezmlm-make
+.B \-C ezmlmsubrc
+.B -options
+.I dir dot local host
+.SH DESCRIPTION
+.B ezmlmglrc
+instructs
+.B ezmlm-make(1)
+to create
+.I dir
+and files within it to support the
+.I local\fB@\fIhost
+sublist. The sublist handles bounces, but not subscriptions. It is intended
+for creation of sublists that are part of an SQL database supported distributed
+ezmlm list. For creation of regular sublists, use
+.B ezmlm-make(1)
+with
+.BR ezmlmrc(5) .
+.SH "REQUIRED SWITCHES"
+While these switches can be omitted, the list will not function unless they
+are specified.
+.TP
+.B \-3\fI mainlocal
+Local name of the main list for which this list is a sublist. If the sublist
+is a sublist for digests,
+.I mainlocal
+should refer to the mail list, i.e. stripped of ``-digest''. This is required
+in order for the bounce texts to refer to the correct archive. Use the
+.B \-d
+switch!
+.TP
+.B \-4\fI mainhost
+Host name of the main list for which this list is a sublist.
+.TP
+.B \-6\fI host:port:user:pass:db:table
+SQL connect info. Specifies the host and port to connect to, the user/password
+to use, the database name, and the root table name.
+The host defaults to ``localhost'', the database and table to ``ezmlm''. The
+port default is the default for the particular SQL server type used. For
+sublists disseminating a digest, ``table'' will end in ``_digest''.
+.SH OPTIONS
+.TP
+.B \-d
+This sublist is a sublist of a digest list.
+The
+.B \-3
+argment used should be the local name of the main list, rather than
+the digest list, i.e. the terminal ``-digest'' should be stripped.
+.TP
+.B \-5\fI owner
+The address to which to redirect mail send to
+.IR local-\fBowner@\fIhost .
+The default is the owner address for the main list.
+.SH USAGE
+A common task is to create both a sublist for the main list and a sublist
+for the corresponding digest. Note that the local list names are given
+as is, whereas the main list name always refers to the main list itself
+(and not its digest). The main list is  ``mainloc@mainhost'', the local
+sublist is ``me-sub1@myhost''; the main digest is ``mainloc-digest@mainhost''
+and the local digest sublist is ``me-sub1-digest@myhost''.
+
+.EX
+ezmlm-make -Cezmlmsubrc -3 mainloc -4 mainhost -6 mainhost::user:pw:db:tab
+~/DIR ~me/.qmail-sub1 me-sub1 myhost
+.EE
+
+.EX
+ezmlm-make -Cezmlmsubrc -d -3 mainloc -4 mainhost -6 mainhost::user:pw:db:tab
+\-d ~/DIR ~me/.qmail-sub1-digest me-sub1-digest myhost
+.EE
+.SH "SEE ALSO"
+ezmlm-make(1),
+ezmlm(5),
+ezmlmrc(5)
+