mdw@git.distorted.org.uk Git - ezmlm/blob - ezmlmsubrc.5

   1 .TH ezmlmsubrc 5
   2 .SH NAME
   3 ezmlmsubrc \- set up a minimal sublist
   4 .SH SYNOPSIS
   5 .B ezmlm-make
   6 .B \-C ezmlmsubrc
   7 .B -options
   8 .I dir dot local host
   9 .SH DESCRIPTION
  10 .B ezmlmglrc
  11 instructs
  12 .B ezmlm-make(1)
  13 to create
  14 .I dir
  15 and files within it to support the
  16 .I local\fB@\fIhost
  17 sublist. The sublist handles bounces, but not subscriptions. It is intended
  18 for creation of sublists that are part of an SQL database supported distributed
  19 ezmlm list. For creation of regular sublists, use
  20 .B ezmlm-make(1)
  21 with
  22 .BR ezmlmrc(5) .
  23 .SH "REQUIRED SWITCHES"
  24 While these switches can be omitted, the list will not function unless they
  25 are specified.
  26 .TP
  27 .B \-3\fI mainlocal
  28 Local name of the main list for which this list is a sublist. If the sublist
  29 is a sublist for digests,
  30 .I mainlocal
  31 should refer to the mail list, i.e. stripped of ``-digest''. This is required
  32 in order for the bounce texts to refer to the correct archive. Use the
  33 .B \-d
  34 switch!
  35 .TP
  36 .B \-4\fI mainhost
  37 Host name of the main list for which this list is a sublist.
  38 .TP
  39 .B \-6\fI host:port:user:pass:db:table
  40 SQL connect info. Specifies the host and port to connect to, the user/password
  41 to use, the database name, and the root table name.
  42 The host defaults to ``localhost'', the database and table to ``ezmlm''. The
  43 port default is the default for the particular SQL server type used. For
  44 sublists disseminating a digest, ``table'' will end in ``_digest''.
  45 .SH OPTIONS
  46 .TP
  47 .B \-d
  48 This sublist is a sublist of a digest list.
  49 The
  50 .B \-3
  51 argment used should be the local name of the main list, rather than
  52 the digest list, i.e. the terminal ``-digest'' should be stripped.
  53 .TP
  54 .B \-5\fI owner
  55 The address to which to redirect mail send to
  56 .IR local-\fBowner@\fIhost .
  57 The default is the owner address for the main list.
  58 .SH USAGE
  59 A common task is to create both a sublist for the main list and a sublist
  60 for the corresponding digest. Note that the local list names are given
  61 as is, whereas the main list name always refers to the main list itself
  62 (and not its digest). The main list is  ``mainloc@mainhost'', the local
  63 sublist is ``me-sub1@myhost''; the main digest is ``mainloc-digest@mainhost''
  64 and the local digest sublist is ``me-sub1-digest@myhost''.
  65
  66 .EX
  67 ezmlm-make -Cezmlmsubrc -3 mainloc -4 mainhost -6 mainhost::user:pw:db:tab
  68 ~/DIR ~me/.qmail-sub1 me-sub1 myhost
  69 .EE
  70
  71 .EX
  72 ezmlm-make -Cezmlmsubrc -d -3 mainloc -4 mainhost -6 mainhost::user:pw:db:tab
  73 \-d ~/DIR ~me/.qmail-sub1-digest me-sub1-digest myhost
  74 .EE
  75 .SH "SEE ALSO"
  76 ezmlm-make(1),
  77 ezmlm(5),
  78 ezmlmrc(5)
  79