home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / INTERNET / SEX100.ZIP / SEXPIRE.DOC < prev   
Text File  |  1992-11-19  |  14KB  |  406 lines
  1.  
  2. SEXPIRE  v1.00  (C) Copyright 1992 Pillar Communications
  3. --------------------------------------------------------
  4.  
  5. ** CONTENTS
  6.  
  7.          I Introduction
  8.         II Installation
  9.        III Command Line Options
  10.         IV Expire Log
  11.          V Forum File
  12.         VI Expire File
  13.        VII License
  14.       VIII Author Info
  15.  
  16.  
  17. ** INTRODUCTION
  18.  
  19. SEXPIRE is a DOS Waffle utility that provides custom news expiration based 
  20. on the age of articles.  (SEXPIRE owes its existence to Chris Winemiller 
  21. please read AUTHOR INFO for more information)
  22.  
  23. o  Features 
  24.  
  25.    - EXPIRE FILE allows expiration of files other than news.
  26.  
  27.    - Statistics logging (waffle/admin/expire).
  28.  
  29.    - Support for DEFAULT and FORUM lines in forum files.
  30.  
  31.    - Can leave one article in each newsgroup regardless of
  32.      expire setting (keeps the message counters from getting reset).
  33.  
  34.    - No registration fees (please read LICENSE (section VII)).
  35.  
  36.  
  37. ** INSTALLATION 
  38.  
  39. Installation is very simple while still allowing many options to suit 
  40. your unique flavor of Waffle system.  It is assumed that the user is
  41. reasonably familiar with Waffle.
  42.  
  43. o  Getting Started
  44.  
  45.    Copy SEXPIRE.COM onto your system drive.  Anywhere will be fine
  46.    as long as you provide a full pathname when invoking SEXPIRE or 
  47.    it is in the path. The best place to put SEXPIRE.COM is in the 
  48.    "waffle/bin" directory.
  49.  
  50. o  Executing SEXPIRE
  51.  
  52.    This is a matter of preference.  SEXPIRE can be run as many times
  53.    and as often as you feel necessary.  Some suggested ways to 
  54.    execute SEXPIRE:
  55.  
  56.    - in waffle/bin/poll.bat (before uucico)
  57.  
  58.    - in waffle/bin/uushell (after uucico)
  59.  
  60.    - in waffle/system/schedule 
  61.  
  62.    NOTE: If your news spool is kept close to capacity it would be a 
  63.    good idea to add the SEXPIRE command line in your "POLL.BAT" so as 
  64.    to free as much space before polling.
  65.  
  66. o  Choosing Command Line Options
  67.  
  68.    By default SEXPIRE will search through the news spool and expire 
  69.    all articles that are 72 hours (3 days) or older unless there is
  70.    only one article left in a newsgroup in which case it will be 
  71.    ignored (see the "-d" flag in COMMAND LINE OPTIONS (section III)).
  72.  
  73.    As you are installing SEXPIRE you may want to start by invoking it
  74.    with the command line:
  75.  
  76.       SEXPIRE -n
  77.  
  78.    This will allow you to see how SEXPIRE works without it actually
  79.    removing files.  You can then add other options and see how they
  80.    will fit in with your configuration and then remove the "-n" when
  81.    you are satisfied that things are working to your satisfaction.
  82.  
  83. o  Forum File Configuration
  84.  
  85.    The most important thing to know about setting up your forum files
  86.    is the "/mexp" flag.  This flag is used like most other Waffle
  87.    forum flags.  To set a default expire of 6 days for all newsgroups
  88.    in the current forum file, add the following line near the top of
  89.    the forums file:
  90.  
  91.       DEFAULT /mexp=144
  92.  
  93.    The argument given to the "/mexp" flag is the number of hours before
  94.    an article should be expired.  So in the example above the expire is
  95.    set for 6 days which given 24 hours in a day we have 24 X 6 = 144.
  96.  
  97.    The "/mexp" flag can also be specified on a per newsgroup basis. 
  98.    Any "/mexp" flag for a newsgroup will override the default expire
  99.    for that newsgroup only.
  100.  
  101.    NOTE: For more information see FORUM FILE (section V).
  102.  
  103. o  Expire File Configuration
  104.   
  105.    When a an EXPIRE FILE is given on the command line, each directory
  106.    listed in the file is treated as a news directory and the files
  107.    contained are expired based on the current options set. The "DEFAULT"
  108.    and "FORUM" line work the same as they do in a regular FORUM FILE.
  109.  
  110.    NOTE: Please read EXPIRE FILE (section VI) before using an EXPIRE FILE.
  111.  
  112.  
  113. ** COMMAND LINE OPTIONS
  114.  
  115.    SEXPIRE provides several command line options to help customize it
  116.    to your personal expiring needs.  All flags are optional and must use 
  117.    a "-" as the flag character (flags may be used in any combination).
  118.  
  119. o  Usage
  120.  
  121.    SEXPIRE [-a -d -e <expire_file> -n -t -h -v]
  122.  
  123. o  Flag "-a"
  124.  
  125.    Consider all files in each newsgroup directory for deletion. By 
  126.    default SEXPIRE only considers files whose names consist of only 
  127.    numerals (0-9) and no filename extension.
  128.  
  129.    NOTE: This option has *no* effect on an EXPIRE FILE.  All files are
  130.    taken into consideration for an EXPIRE FILE directory.
  131.  
  132. o  Flag "-d"
  133.  
  134.    Consider the last numerical filename in each directory for expiration.  
  135.    The default is to leave the last file in a directory with a filename 
  136.    that consists of only numerals (0-9) and no filename extension   
  137.    regardless of the current expire time. It is not necessary to do this 
  138.    as Waffle will compensate, but it does allows your system to maintain 
  139.    the sequential numbering of news articles instead of reseting to zero.  
  140.  
  141.    NOTE: This option has *no* effect on an EXPIRE FILE.  All files are
  142.    taken into consideration for an EXPIRE FILE directory.
  143.  
  144. o  Flag "-e"
  145.  
  146.    Use an EXPIRE FILE. The name of the EXPIRE FILE must directly follow
  147.    this flag.  This file contains name of directories whose files should
  148.    be considered for expiration (more than one "-e" may be specified).
  149.  
  150. o  Flag "-h"
  151.  
  152.    Displays COMMAND LINE OPTIONS.
  153.  
  154. o  Flag "-n"
  155.  
  156.    Do *not* delete files.  SEXPIRE will report the files that should be 
  157.    deleted and all related statistics but will not delete any files. 
  158.  
  159. o  Flag "-t" 
  160.  
  161.    Display expiration times for each newsgroup.  The default is to *not*
  162.    display the current expire times for each newsgroup.
  163.  
  164. o  Flag "-v"
  165.  
  166.    Displays AUTHOR INFO.
  167.  
  168.  
  169. ** EXPIRE LOG
  170.  
  171.    When SEXPIRE completes its task it writes a line to the "waffle/admin
  172.    /expire" file.  This may be viewed inside of Waffle by users with
  173.    appropriate privileges by the command "SHOW EXPIRE".  The format of 
  174.    this file is as follows:
  175.  
  176.    16-Nov-92  08:13:16 08:13:20 |  237.4 / 42  | -d -a -e c:\expdir.lst -t
  177.    ---------  -----------------    -----   --    -------------------------   
  178.           |                   |      |      |      |
  179.           +----------------+  |      |      |      |
  180.                            |  |      |      |      |
  181.    date                   -+  |      |      |      |
  182.    start and end time     ----+      |      |      |
  183.    kilobytes deleted      -----------+      |      |
  184.    files deleted          ------------------+      |
  185.    command line arguments -------------------------+
  186.  
  187.  
  188. ** FORUM FILE
  189.  
  190.    The Waffle forum files are where SEXPIRE looks to see what newsgroups
  191.    need to be expired and what the expire time needs to be.
  192.  
  193. o  "/mexp"
  194.  
  195.    The format is "/mexp=xx" where "xx" is the number of hours that files 
  196.    will be retained.  If no "/mexp" lines are encountered then the default
  197.    of 72 hours will be used.
  198.  
  199.    If "/mexp" appears on a "DEFAULT" or "FORUM" line then the expire time
  200.    will apply to all of the following newsgroups until changed with a later
  201.    "DEFAULT" or "FORUM" line.  If "/mexp" appears on a newsgroup line the 
  202.    current default expire time is overidden by the new value for the current 
  203.    newsgroup only.
  204.    
  205. o  "/dir" 
  206.  
  207.    SEXPIRE recognizes the Waffle "/dir" flag when used with newsgroups
  208.    and on "DEFAULT" and "FORUM" lines so optional directories *can* be
  209.    used.  
  210.  
  211. o  Example Forum File
  212.  
  213.    Here is an example FORUM FILE /waffle/system/usenet:
  214.  
  215.    # ------------------------- START OF USENET FILE ------------------------
  216.    # This file names the location and characteristics of various Usenet
  217.    # newsgroups that are carried here.
  218.    #
  219.    # Use /dir to specify the root of the directory tree containing
  220.    # the news. (Useful only for DOS Waffle systems.)
  221.    #
  222.    # Waffle's /keep attribute isn't used. Instead, use the /mexp
  223.    # attribute to cause news to expire according to its age.
  224.  
  225.    DEFAULT /sig=sig /dir=c:/news /name="[Newsgroup %N]" /spy=monitor
  226.  
  227.    # Set default expiration to 4 days (/mexp=96 hours).  Other values are
  228.    # set as desired.
  229.  
  230.    DEFAULT /mexp=96
  231.    DEFAULT /type=USENET /new=1 /post=1 /read=0
  232.  
  233.    comp.bbs.waffle
  234.  
  235.    # Note: The Expire program will read the /dir directive; it knows
  236.    # that the alt.msdos.programmer newsgroup is in the directory named
  237.    # c:/news/alt/msdos/programr.
  238.  
  239.    alt.msdos.programmer       /dir=c:/news/alt/msdos/programr
  240.  
  241.    # IBM binaries are important, so let's keep them around for 7 days
  242.    # (168 hours) in comp.binaries.ibm.pc
  243.  
  244.    comp.binaries.ibm.pc       /mod /mexp=168
  245.  
  246.    # The comp.binaries.ibm.pc.d newsgroup is expired at the most recent
  247.    # default value (96 hours, or 4 days).
  248.  
  249.    comp.binaries.ibm.pc.d
  250.  
  251.    # Set default expirations for the following control groups.  Entries
  252.    # will be kept for about a month.
  253.  
  254.    DEFAULT /mexp=720
  255.  
  256.    # Things that we are fed but do not carry get shoved into "junk".
  257.    # If things get placed in junk often, something is wrong.  Let's
  258.    # expire its articles after 2 days (48 hours).
  259.  
  260.    junk            /post=9 /mexp=48
  261.  
  262.    # /spy without arguments sets the "monitor" group as a destination
  263.    # for copies of any posts originating locally..  (expired after 720
  264.    # hours, which is the most recent default value).
  265.  
  266.    monitor            /post=0 /spy
  267.  
  268.    # You *MUST* have a "control" group. Right now we don't do a whole
  269.    # lot of control messages processing in the DOS version, though.
  270.    # (Also expired after 720 hours.)
  271.  
  272.    control            /post=0
  273.  
  274.    # ------------------------- END OF USENET FILE ------------------------
  275.  
  276.  
  277. ** EXPIRE FILE
  278.  
  279.    An expire file allows you to have files in directories other than
  280.    the news directories expired based on age.  
  281.  
  282.    NOTE: The "-d" and "-a" COMMAND LINE OPTIONS have no effect on an
  283.    expire file.  All files are considered for expiration.
  284.  
  285. o  Expire File Format
  286.  
  287.    The following may be contained in an EXPIRE FILE:
  288.  
  289.    - A blank line.
  290.         All blank lines are ignored.
  291.    - A comment line. 
  292.         The comment line must begin with a '#' character.  All comments
  293.         are ignored.
  294.    - A "DEFAULT" line. 
  295.         The first word must be "DEFAULT" (upper or lower case).  The
  296.         only valid flags following a "DEFAULT" line is "/mexp" or 
  297.         "/exclude".
  298.    - A directory line. 
  299.         Must specify the full pathname of one directory optionally 
  300.         followed by the "/exclude" or "/mexp" flags.
  301.  
  302. o  "/mexp"
  303.  
  304.    The format is "/mexp=xx" where "xx" is the number of hours that files 
  305.    will be retained.  If no "mexp" lines are encountered then the default
  306.    of 72 hours will be used.
  307.  
  308.    If "/mexp" appears on a "DEFAULT" line then the expire time will apply 
  309.    to all of the following directories until changed with a later
  310.    "DEFAULT" line.  If "/mexp" appears on a directory line then the 
  311.    current default expire time is overidden by the new value for the 
  312.    current directory only.
  313.    
  314.  
  315. o  "/exclude"
  316.  
  317.    The format is "/exclude=file,file,..." where "file" is the name of
  318.    a file that SEXPIRE should ignore.  The "/exclude" lines should
  319.    contain no spaces and list filenames that are separated by commas.
  320.  
  321.    If "/exclude" appears on a "DEFAULT" line then the files specified 
  322.    will be ignored until changed with a later "DEFAULT" line.  If
  323.    "/exclude" appears on a directory line then the current default
  324.    "/exclude" will be overidden by the new "/exclude" value for the
  325.    current directory only.
  326.  
  327.    NOTE: No wildcard characters are recognized.
  328.  
  329.    To specify that no files should be excluded after "DEFAULT" line
  330.    that include a "/exclude", use "/exclude=" which specifies that
  331.    *no* files should be excluded.
  332.  
  333. o Example Expire File
  334.  
  335.    # ------------------------- START OF EXPDIRS FILE ------------------------
  336.    #<--- This '#' character must be in column 1 of the file!
  337.    #
  338.    # This is an expire file.  It names directories which the expire
  339.    # program will consider for expiration AFTER all Waffle news groups have
  340.    # been considered.
  341.  
  342.    # Let's set some defaults.  Unless otherwise specified, let's retain
  343.    # files for 168 hours (1 week), and NEVER get rid of files named
  344.    # "readme.txt" or "notouch.me".  (Note: file names are NOT case sensitive.)
  345.  
  346.    DEFAULT /mexp=168 /exclude=readme.txt,notouch.me
  347.  
  348.    c:/misc
  349.  
  350.    # Waffle's outbox and /user/uucp directories fill up quickly, so
  351.    # let's expire their files after 24 hours.  Also, we want to get rid
  352.    # of all files, but don't change the current defaults for /exclude.
  353.  
  354.    DEFAULT /mexp=24
  355.    e:/spool/outbox /exclude=
  356.    e:/user/uucp /exclude=
  357.  
  358.    # Allow users to retain their files for 2 weeks (336 hrs), and then let's
  359.    # delete them.  But never get rid of files like the signature files and
  360.    # a few others.
  361.  
  362.    DEFAULT /mexp=336 /exclude=join,sig,mailsig,waffle
  363.    c:/user/kilgore
  364.    c:/user/narc
  365.    c:/user/boomer
  366.  
  367.    # ------------------------- END OF EXPDIRS FILE ------------------------
  368.  
  369.  
  370. ** LICENSE 
  371.  
  372.    SEXPIRE may be used free of charge on any system that is using a registered 
  373.    version of WAFFLE.  SEXPIRE may be used on an unregistered system for the 
  374.    duration of the WAFFLE trial period as set forth in the documentation 
  375.    distributed with WAFFLE.              
  376.  
  377.  
  378. ** AUTHOR INFO
  379.  
  380.    Send all inquiries, bug reports and donations to:                           
  381.  
  382. o  Email Address
  383.  
  384.    kilgore@obelisk.pillar.com
  385.    kilgore@wuntvor.pillar.com
  386.    kilgore@obelisk.okc.ok.us
  387.    ...!obelisk!kilgore
  388.  
  389. o  Postal Address
  390.  
  391.    Pillar Communications                                      
  392.    Stan Hall                                                 
  393.    918 Duncan Drive                                         
  394.    Oklahoma City, Ok 73107 USA                             
  395.  
  396. o  Original Author
  397.  
  398.    SEXPIRE is based on a program (cwexp104.zip) by 
  399.  
  400.       Chris Winemiller (cwinemil@keys.lonestar.org).  
  401.  
  402.    I would like to thank Chris for this wonderful program and for 
  403.    providing source so that I could bring you this new and improved 
  404.    expire program.  Much of the source and tidbits of the documentation 
  405.    are taken directly from Chris's program (I hope he doesn't mind :-).
  406.