a

directadmin-1.62.4/scripts/packages/majordomo-1.94.5/Doc/man/digest.man

@@ -0,0 +1,396 @@
+
+
+
+     ddddiiiiggggeeeesssstttt((((1111))))                 UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                 ddddiiiiggggeeeesssstttt((((1111))))
+
+
+
+     NNNNAAAAMMMMEEEE
+          digest - receive a file for a digest, or create and mail a
+          digest
+
+     SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
+          ddddiiiiggggeeeesssstttt ----rrrr||||RRRR||||mmmm||||pppp ----CCCC ----llll _m_a_j_o_r_d_o_m_o-_l_i_s_t_n_a_m_e _r_e_c_i_p_i_e_n_t
+
+          ddddiiiiggggeeeesssstttt ----rrrr||||RRRR||||mmmm||||pppp [ ----cccc _c_o_n_f_i_g_u_r_a_t_i_o_n-_f_i_l_e ]
+
+     AAAAVVVVAAAAIIIILLLLAAAABBBBIIIILLLLIIIITTTTYYYY
+          Provided with distributions of Majordomo.
+
+     DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
+          The digest script is a perl script which automates the
+          management of digests of electronic mail.  It can be run in
+          a standalone configuration or as part of Majordomo.
+
+          It requires two directories: a work directory and an archive
+          directory.  Incoming email messages are held in the work
+          directory until they are collected into a digest.  The
+          digests are created and stored in the archive directory.
+
+          Incoming email messages are given numerical names starting
+          with ``001'' and are numbered in order of arrival.  The
+          digests are named according to volume and number.  For
+          example, the filename ``v01.n028'' indicates volume 1,
+          number 28 of the digest.
+
+          It should be noted that digest needs a configuration file to
+          define all of its operating parameters.  If no such file is
+          specified, digest will use the file.
+
+          Several aspects of digest configuration determine how and
+          when a digest is created.  A digest can be created at
+          regular intervals (as long as there are incoming messages)
+          or whenever certain configurable conditions are met.  These
+          conditions are:  how large the digest can be (in
+          characters), how long the digest can be (in lines), and how
+          old the messages in the digest can be (in days).
+
+     OOOOPPPPTTTTIIIIOOOONNNNSSSS
+          ----rrrr        Receive an email message via standard input and
+                    place the file into the working directory.  If any
+                    one of the conditions for digest creation are met,
+                    create and mail a digest.  These conditions are
+                    the same as those described under option ----pppp....
+
+          ----RRRR        Similar to ----rrrr,,,, except that it will not create a
+                    digest.  It simply places the message in the work
+                    directory and stops.
+
+          ----mmmm        If there are any numbered files in the working
+
+
+
+     Page 1                                          (printed 9/23/96)
+
+
+
+
+
+
+     ddddiiiiggggeeeesssstttt((((1111))))                 UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                 ddddiiiiggggeeeesssstttt((((1111))))
+
+
+
+                    directory, create and mail a digest.  Store the
+                    digest in the archive directory.  This is the
+                    option used by majordomo's mkdigest command.
+
+          ----pppp        Conditionally creates a digest.  If any one of the
+                    conditions for digest creation are met, the digest
+                    is created and sent.  There are three conditions,
+                    which are connected to three limits:  the digest
+                    size in characters, the digest length in lines,
+                    and the age of the oldest message in days.  If one
+                    of the files is older than the age limit, a digest
+                    is created.  If the sum of the messages exceeds
+                    either of the size limits, a digest is created.
+                    The size limit in characters must be configured;
+                    the other two limits are optional.
+
+          ----cccc ccccoooonnnnffffiiiigggguuuurrrraaaattttiiiioooonnnn----ffffiiiilllleeee
+                    Use the parameters defined in _c_o_n_f_i_g_u_r_a_t_i_o_n-_f_i_l_e.
+
+          ----CCCC        Read the majordomo configuration file (either
+                    /etc/majordomo.cf or ~majordomo/majordomo.cf) and
+                    the configuration file for the Majordomo list
+                    specified in the ----llll option to define operational
+                    parameters.  If both ----CCCC and ----cccc options are
+                    specified (not recommended) only the ----CCCC option
+                    will be used.
+
+          ----llll mmmmaaaajjjjoooorrrrddddoooommmmoooo----lllliiiissssttttnnnnaaaammmmeeee
+                    This option is ignored if used without the ----CCCC
+                    option. Specifies the Majordomo email list.
+
+     OOOOPPPPEEEERRRRAAAANNNNDDDDSSSS
+          rrrreeeecccciiiippppiiiieeeennnntttt Email recipient of the digest.  This operand is
+                    ignored if used without the ----CCCC option.  It
+                    specifies one of the system mail aliases created
+                    for the Majordomo list named in the ----llll option.
+
+     MMMMAAAAJJJJOOOORRRRDDDDOOOOMMMMOOOO DDDDIIIIGGGGEEEESSSSTTTT CCCCOOOONNNNFFFFIIIIGGGGUUUURRRRAAAATTTTIIIIOOOONNNN
+          When used as a part of Majordomo, digest takes these
+          parameters from mmmmaaaajjjjoooorrrrddddoooommmmoooo....ccccffff (either /etc/majordomo.cf or
+          ~majordomo/majordomo.cf):
+
+          $$$$lllliiiissssttttddddiiiirrrr - the location of the mailing lists
+          $$$$ddddiiiiggggeeeesssstttt____wwwwoooorrrrkkkk____ddddiiiirrrr - parent directory for the digests' work
+          directories
+          $$$$ffffiiiilllleeeeddddiiiirrrr - parent directory for archive directories
+          $$$$ffffiiiilllleeeeddddiiiirrrr____ssssuuuuffffffffiiiixxxx - an optional identifier (may be the null
+          string)
+
+          Incoming messages for $$$$lllliiiissssttttnnnnaaaammmmeeee----ddddiiiiggggeeeesssstttt will be held in
+          $$$$ddddiiiiggggeeeesssstttt____wwwwoooorrrrkkkk____ddddiiiirrrr////$$$$lllliiiissssttttnnnnaaaammmmeeee----ddddiiiiggggeeeesssstttt....
+
+
+
+
+     Page 2                                          (printed 9/23/96)
+
+
+
+
+
+
+     ddddiiiiggggeeeesssstttt((((1111))))                 UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                 ddddiiiiggggeeeesssstttt((((1111))))
+
+
+
+          Digests will be stored in $$$$ffffiiiilllleeeeddddiiiirrrr////$$$$lllliiiissssttttnnnnaaaammmmeeee----
+          ddddiiiiggggeeeesssstttt$$$$ffffiiiilllleeeeddddiiiirrrr____ssssuuuuffffffffiiiixxxx....
+
+          The list's configuration file will be $$$$lllliiiissssttttddddiiiirrrr////$$$$lllliiiissssttttnnnnaaaammmmeeee----
+          ddddiiiiggggeeeesssstttt....ccccoooonnnnffffiiiigggg....
+
+          Examples of these values are given in below.
+
+          The list's configuration file contains several digest
+          parameters that are not yet implemented and/or should NOT be
+          changed from their defaults (blank): ddddiiiiggggeeeesssstttt____aaaarrrrcccchhhhiiiivvvveeee,,,,
+          ddddiiiiggggeeeesssstttt____rrrrmmmm____ffffooooooootttteeeerrrr,,,, ddddiiiiggggeeeesssstttt____rrrrmmmm____ffffrrrroooonnnntttteeeerrrr,,,, ddddiiiiggggeeeesssstttt____wwwwoooorrrrkkkk____ddddiiiirrrr....
+
+          The parameters which specifically deal with digest creation
+          and maintenance are:
+
+          ddddiiiiggggeeeesssstttt____nnnnaaaammmmeeee - the title of the digest
+          ddddiiiiggggeeeesssstttt____vvvvoooolllluuuummmmeeee - volume number
+          ddddiiiiggggeeeesssstttt____iiiissssssssuuuueeee - issue number
+          ddddiiiiggggeeeesssstttt____mmmmaaaaxxxxddddaaaayyyyssss - age limit in days for oldest message in the
+          digest
+          ddddiiiiggggeeeesssstttt____mmmmaaaaxxxxlllliiiinnnneeeessss - maximum number of lines in a digest
+          mmmmaaaaxxxxlllleeeennnnggggtttthhhh - maximum number of characters in a digest
+          mmmmeeeessssssssaaaaggggeeee____ffffrrrroooonnnntttteeeerrrr - text prepended to the digest
+          mmmmeeeessssssssaaaaggggeeee____ffffooooooootttteeeerrrr - text appended to the digest
+
+          The last three parameters are also used in the configuration
+          of an ordinary (non-digest) Majordomo list.
+
+          Each digest begins with the a line containing the
+          ddddiiiiggggeeeesssstttt____nnnnaaaammmmeeee,,,, ccccuuuurrrrrrrreeeennnntttt ddddaaaatttteeee,,,, ddddiiiiggggeeeesssstttt____vvvvoooolllluuuummmmeeee aaaannnndddd ddddiiiiggggeeeesssstttt____iiiissssssssuuuueeee....
+
+          A blank line follows, and then the text from the
+          mmmmeeeessssssssaaaaggggeeee____ffffrrrroooonnnntttteeeerrrr,,,, if any.  The message fronter may contain
+          the token, which will be replaced by the subject lines from
+          the messages in the digest.
+
+          The text in the mmmmeeeessssssssaaaaggggeeee____ffffooooooootttteeeerrrr,,,, if any, will be appended to
+          the digest.
+
+          To embed a blank line in the mmmmeeeessssssssaaaaggggeeee____ffffooooooootttteeeerrrr or
+          mmmmeeeessssssssaaaaggggeeee____ffffrrrroooonnnntttteeeerrrr,,,, put a `-' as the first and ONLY character
+          on the line.  To preserve whitespace at the beginning of a
+          line, put a `-' on the line before the whitespace to be
+          preserved.  To put a literal `-' at the beginning of a line,
+          double it.
+
+          Both message_footer and message_fronter may also use the
+          tokens and which will be expanded to, respectively: the name
+          of the current list, the sender as taken from the from line,
+          and the current version of Majordomo.
+
+
+
+
+     Page 3                                          (printed 9/23/96)
+
+
+
+
+
+
+     ddddiiiiggggeeeesssstttt((((1111))))                 UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                 ddddiiiiggggeeeesssstttt((((1111))))
+
+
+
+          Examples of the aliases usually used with the digest are
+          given in below.
+
+          The list owner can prompt Majordomo to build a digest by
+          sending the command
+
+          mkdigest _d_i_g_e_s_t-_n_a_m_e [ _d_i_g_e_s_t-_p_a_s_s_w_o_r_d ]
+
+          to majordomo either via email or from cron.  The cron
+          command has the format:
+
+          echo mkdigest _d_i_g_e_s_t-_n_a_m_e [ _d_i_g_e_s_t-_p_a_s_s_w_o_r_d ] | mail
+          majordomo@domain.com
+
+     SSSSTTTTAAAANNNNDDDDAAAALLLLOOOONNNNEEEE DDDDIIIIGGGGEEEESSSSTTTT CCCCOOOONNNNFFFFIIIIGGGGUUUURRRRAAAATTTTIIIIOOOONNNN
+          The Majordomo distribution comes with a ``digest''
+          subdirectory.  The sample configuration file is called
+          firewalls-digest.cf.  A file in this format must be used if
+          digest is invoked in standalone configuration.
+
+          If no configuration file is specified when digest is
+          invoked, it looks for a file named that must be in the same
+          format as the example file.
+
+          The configuration file defines the email addresses of the
+          sender and recipient of the digest. It also locates the work
+          and archive directories, the digest's size limit, and the
+          names of the files that contain the digest's volume, number,
+          header and footer.
+
+          The easiest way to configure a standalone digest is to copy
+          the five files (firewalls-digest.*) and edit them to taste.
+
+          Incoming mail is piped to digest with the ----rrrr option. This
+          can be done from some mail-reading programs, through the
+          command line, or via mail aliases similar to those found in
+          below.
+
+     EEEEXXXXAAAAMMMMPPPPLLLLEEEESSSS
+          1. Example values from ////eeeettttcccc////mmmmaaaajjjjoooorrrrddddoooommmmoooo....ccccffff::::
+
+          $$$$lllliiiissssttttddddiiiirrrr ==== ````````uuuussssrrrr////llllooooccccaaaallll////mmmmaaaaiiiillll////lllliiiissssttttssss'''''''';;;;
+          $$$$ddddiiiiggggeeeesssstttt____wwwwoooorrrrkkkk____ddddiiiirrrr ==== ````````uuuussssrrrr////llllooooccccaaaallll////mmmmaaaaiiiillll////ddddiiiiggggeeeesssstttt'''''''';;;;
+          $$$$ffffiiiilllleeeeddddiiiirrrr ==== ````````lllliiiissssttttddddiiiirrrr'''''''';;;;
+          $$$$ffffiiiilllleeeeddddiiiirrrr____ssssuuuuffffffffiiiixxxx ````````aaaarrrrcccchhhhiiiivvvveeee'''''''';;;;
+
+          If our digest's name is banjo-digest, the work directory
+          will be /usr/local/mail/digest/banjo-digest; the archive
+          directory will be /usr/local/mail/lists/banjo-
+          digest.archive.  Note that these are names of directories,
+          not files.
+
+
+
+
+     Page 4                                          (printed 9/23/96)
+
+
+
+
+
+
+     ddddiiiiggggeeeesssstttt((((1111))))                 UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                 ddddiiiiggggeeeesssstttt((((1111))))
+
+
+
+          2. Typical aliases for Majordomo digests:
+
+          Usually a Majordomo digest is associated to a regular (non-
+          digest) list.  The digest's name is the regular listname
+          plus ``-digest''.  The list ``banjo'' will have the digest
+          ``banjo-digest''.
+
+          bbbbaaaannnnjjjjoooo----ddddiiiiggggeeeesssstttt----aaaapppppppprrrroooovvvvaaaallll:::: kkkkeeeevvvviiiinnnnkkkk
+          bbbbaaaannnnjjjjoooo----ddddiiiiggggeeeesssstttt----oooouuuuttttggggooooiiiinnnngggg:::: ::::iiiinnnncccclllluuuuddddeeee::::////uuuussssrrrr////llllooooccccaaaallll////lllliiiissssttttssss////bbbbaaaannnnjjjjoooo----
+          ddddiiiiggggeeeesssstttt
+          oooowwwwnnnneeeerrrr----bbbbaaaannnnjjjjoooo----ddddiiiiggggeeeesssstttt----oooouuuuttttggggooooiiiinnnngggg:::: kkkkeeeevvvviiiinnnnkkkk
+          bbbbaaaannnnjjjjoooo----ddddiiiiggggeeeessssttttiiiiffffyyyy:::: ````````||||uuuussssrrrr////mmmmaaaajjjjoooorrrrddddoooommmmoooo////wwwwrrrraaaappppppppeeeerrrr ddddiiiiggggeeeesssstttt ----rrrr ----CCCC ----llll
+          bbbbaaaannnnjjjjoooo----ddddiiiiggggeeeesssstttt bbbbaaaannnnjjjjoooo----ddddiiiiggggeeeesssstttt----oooouuuuttttggggooooiiiinnnngggg''''''''
+          bbbbaaaannnnjjjjoooo----ddddiiiiggggeeeesssstttt:::: bbbbaaaannnnjjjjoooo
+
+          Note that mail to ``banjo-digest'' is routed to the regular
+          list.  The ``digestify'' alias must be added to the regular
+          list's outgoing alias:
+
+          bbbbaaaannnnjjjjoooo----oooouuuuttttggggooooiiiinnnngggg:::: ::::iiiinnnncccclllluuuuddddeeee::::////uuuussssrrrr////llllooooccccaaaallll////lllliiiissssttttssss////bbbbaaaannnnjjjjoooo,,,,bbbbaaaannnnjjjjoooo----
+          ddddiiiiggggeeeessssttttiiiiffffyyyy
+
+     NNNNOOOOTTTTEEEESSSS
+          The volume number does not change automatically; it must be
+          incremented manually.
+
+          For testing/debugging purposes there is a ``hidden'' option
+          ----dddd that creates the digest as /tmp/testdigest.nnn (where _n_n_n
+          is the current digest number).  Since it is for testing and
+          debugging purposes, it does not mail the digest, it does not
+          place the digest in the archive directory, and it does not
+          update the digest number.
+
+     EEEEXXXXIIIITTTT SSSSTTTTAAAATTTTUUUUSSSS
+          The following exit values are returned:
+
+          0000         Successful completion.
+
+          >>>>0000        An error occurred.
+
+     FFFFIIIILLLLEEEESSSS
+          ////eeeettttcccc////aaaalllliiiiaaaasssseeeessss
+          ////eeeettttcccc////mmmmaaaajjjjoooorrrrddddoooommmmoooo....ccccffff
+
+     SSSSEEEEEEEE AAAALLLLSSSSOOOO
+          mmmmaaaajjjjoooorrrrddddoooommmmoooo((((8888))))
+
+     AAAAUUUUTTTTHHHHOOOORRRR
+          The digest script was written by Brent Chapman
+          <brent@GreatCircle.COM>.  It is available with distributions
+          of Majordomo via anonymous FTP from FTP.GreatCircle.COM, in
+          the directory pub/majordomo.  This man page was written by
+
+
+
+     Page 5                                          (printed 9/23/96)
+
+
+
+
+
+
+     ddddiiiiggggeeeesssstttt((((1111))))                 UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV                 ddddiiiiggggeeeesssstttt((((1111))))
+
+
+
+          Kevin Kelleher <fury@world.std.com>.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+     Page 6                                          (printed 9/23/96)
+
+
+