home *** CD-ROM | disk | FTP | other *** search
/ The CIA World Factbook 1992 / k3bimage.iso / sel / 02 / 0022 / fixbbs.doc < prev    next >
Encoding:
Text File  |  1991-12-02  |  16.1 KB  |  435 lines

  1.  
  2.  
  3.            FIXBBS - a FILES.BBS maintenance utility for GT Sysops
  4.  
  5.  
  6.            Revision history
  7.  
  8.         24/4/90  - v3.20 - add multiple timeout dates
  9.                          - add ZIPDATE option
  10.        
  11.         22/4/90  - v3.17 - minor bugfix for SETFBBS
  12.  
  13.         20/4/90  - v3.16 - add "word highlight"
  14.                          - fix minor display bugs
  15.                          - fix new files problem
  16.                          - fix descr problem
  17.  
  18.         20/4/90  - v3.15 - fix comment bug
  19.                          - fix "word wrap"
  20.                          - add timeout date select
  21.                          - add offline total option
  22.                          - fix directory check
  23.                          - add multiline descriptions on prompt
  24.  
  25.            v3.10 11/4/90  - Add colours for NEW files
  26.                           - add "timeout" for New files
  27.                           - fix date bug(s)
  28.                           - add OFFLINE option
  29.                           - fix various minor nasties
  30.                           - add more colour options
  31.                           - fix space check bug
  32.                           - made comment char configurable
  33.  
  34.            v3.02 24/3/90  - cater for new FILES.BBS format
  35.                           - add color to menus
  36.                           - seperate configuration program
  37.                           - add Total Files: line
  38.                           - improved menus
  39.                           - add /N parameter
  40.                           - Fix bugs in v3.00
  41.  
  42.            v2.01 24/12/89 - Cosmetic fix
  43.                           - Fix command stack bug with < 20 file areas
  44.  
  45.            v2.00 13/12/89 - Add sort overrides
  46.                           - Add Dest change on "process"
  47.                           - Modify GTDIR parsing
  48.                           - add area # to heading
  49.                           - fix multiple listing bug
  50.                           - add "validate after edit option"
  51.                           - add SHELL to DOS
  52.                           - increase NEW files
  53.                           - add file # stacking
  54.  
  55.            v1.92 12/11/89 - Fix bug in BATCH mode if bulletins
  56.                             ignored
  57.  
  58.            v1.90  5/11/89 - Add command stacking
  59.                           - Add "ignore bulletins"
  60.  
  61.            v1.80  1/11/89 - Rewrite validate for speed increse
  62.                           - Minor cosmetic bugfix
  63.                           - Add /A parameter
  64.  
  65.            v1.72 22/10/89 - Add check for destination room
  66.                           - Add check for NO FILES.BBS
  67.                           - Add L)ist command
  68.                           - Add support for 4DOS
  69.  
  70.            v1.71 21/10/89 - Add command aliases
  71.                           - Add selection at pause line
  72.                           - Add subdirectory verification
  73.                           - Add interactive "mark offline" prompt
  74.  
  75.            v1.60 18/10/89 - first NON-BETA release
  76.            v1.00-v1.50    - BETA test code
  77.  
  78.  
  79.                           WHAT DOES IT DO?
  80.  
  81.    This program is for maintenance of your files.bbs and cbs
  82.  
  83.    some features -
  84.  
  85.   1) automatically creates files.cbs when validating the .bbs
  86.  
  87.   2) picks up the REAL file date and time during validation
  88.  
  89.   3) allows you to break a files.bbs into "sub-groups" and sorts within
  90.      sub-group.
  91.  
  92.      A "sub- group" is defined as a series of filenames between 2 comment
  93.      entries or between a comment entry and the end of the file
  94.  
  95.      A comment entry is an empty line OR a line with a space in column 1
  96.      and NOT a multi-line comment (see multi-line comments).
  97.  
  98.   4) batch mode operation - no need for macro commands - simply put a /B
  99.      on the command line and FIXBBS will validate ALL the areas defined in
  100.      your GTDIR.BBS (or the list of files you designate).
  101.  
  102.   5) If a new file (not in the files.bbs) is found FIXBBS will, if in
  103.      interactive mode, prompt for a file description. If in batch mode
  104.      it will supply a default description of "No description entered at
  105.      upload". The upload date will be set to the current date
  106.  
  107.   6) if you have a special "key line" in your files.bbs FIXBBS will insert
  108.      all NEW files (those moved/copied to the area or those NOT in the
  109.      files.bbs when validating) to a position after the "key line".
  110.  
  111.      The key line has the following format -
  112.      " New files at"
  113.       followed by TWO blank lines.
  114.  
  115.       *NOTE* - the "N" of new MUST start in column 2!!!!
  116.  
  117.       FIXBBS will append the current date to the key line and insert all
  118.       new file descriptions after it (the insert is actually done
  119.       between the two blank lines).
  120.  
  121.   7) sort files by DATE or FILENAME in either ascending or descending
  122.      order
  123.  
  124.   8) optionally forces the current date into moved/copied files
  125.  
  126.   9) optionally adds an archive comment to moved/copied ZIP, ARC, or PAK
  127.      files
  128.  
  129.   10) FIXBBS allows you to have MULTIPLE LINE COMMENTS on any file.
  130.  
  131.   11) If you are using the 4DOS command shell, FIXBBS will optionally
  132.       generate the DESCRIPT.ION hidden file that contains the
  133.       descriptions displayed by the 4DOS dir command using the
  134.       decriptions in the FILES.BBS
  135.  
  136.   12) FIXBBS can be configured to IGNORE your system bulletins in the
  137.       DEFAULT directory.
  138.  
  139.   13) If you have "     Total Files:" in columns 1-17 of ANY line in
  140.       your FILES.BBS this will be replaced by the TOTAL number of files
  141.       and total size of files in the area (exculding files.bbs etc).
  142.  
  143.       *NOTE* the format of this line is CRITICAL - columns 1-5 MUST be
  144.       spaces, ONLY the initial letters can be uppercase and there MUST
  145.       be a colon at the end!!!
  146.  
  147.   14) In v3.10 (and later) there is a NEW "key line" -
  148.  
  149.       " Files older than xx days"
  150.  
  151.       Again the format is CRITICAL - the "F" *MUST* start in Col 2. and
  152.       there must be TWO blank lines after it to denote the "sub-group".
  153.  
  154.       When a NEW file is older than the number of days specified by xx
  155.       it will be moved to between the 2 blank lines.
  156.  
  157.       FIXBBS supports up to 10 "Files older than" lines - HOWEVER they
  158.       MUST be in ascending order! e.g.
  159.  
  160.  Files older than 7 days
  161.  
  162.  
  163.  Files older than 14 days
  164.  
  165.  
  166.  Files older than 21 days
  167.  
  168.   15) if you add a list of words to the end of  your FIXBBS.CFG
  169.       and one of them is found in a file description it will be highlighted.
  170.  
  171.       The words are NOT case-sensitive.
  172.  
  173.       *NOTE* this feature works on WHOLE words ONLY!!!
  174.       e.g. putting "cat" the FIXBBS.CFG will ONLY match with "CAT" not
  175.       "catalog" or any word which contains the FIXBBS.CFG word
  176.  
  177.  
  178.   16) with v3.20 the facility has been added to look inside ZIP ARC PAK
  179.   and LZH files and set the date of the entire archive to the oldest or
  180.   newest date of any file INSIDE the archive. This NORMALLY is only done
  181.   on MOVED files but can be enabled for ALL files by the use of the /Z
  182.   command line parameter.
  183.  
  184.                        PROGRAM REQUIREMENTS
  185.  
  186.   FIXBBS is BIG!! - you will probably need at LEAST 300k to run it.
  187.   This is mainly due to the fact that it calls the various archive
  188.   programs (PAK, ZIP, ARC) and your choice of editor.
  189.  
  190.   You will also need to have your GTPATH set and a valid GTDIR.BBS in
  191.   the GTPATH directory.
  192.  
  193.   All archive programs, and your editor, must be in the DOS path.
  194.  
  195.   FIXBBS will create a FIXBBS.CFG in your GTPATH - DO NOT alter this
  196.   file!
  197.  
  198. ********************  W A R N I N G   W A R N I N G  *******************
  199.  
  200.  
  201.    DO NOT USE *ANY* OTHER PROGRAM TO VALIDATE YOUR FILES.BBS AFTER USING
  202.    THIS PROGRAM!!
  203.  
  204.    DOING SO WILL DESTROY *ALL* YOUR HARD WORK AS OTHER PROGRAMS WILL NOT
  205.    RECOGNISE THE FORMATTING CONVENTIONS USED BY FIXBBS AND WILL REMOVE
  206.    COMMENT LINES ETC.
  207.  
  208.  
  209.                         PROGRAM LIMITATIONS
  210.  
  211.   There are some INBUILT limitations to FIXBBS. These are -
  212.  
  213.             maximum of 800 lines per FILES.BBS
  214.             maximum of 800 files per move/copy/erase operation
  215.             maximum of 200 file areas
  216.  
  217.  *NOTE* - the figures quoted above are MAXIMUMS!! - depending on how
  218.  long your file descriptions, comments etc. are you may NOT be able to
  219.  get the 800 line figure.
  220.  
  221.  
  222.  **NOTE** - If you are using DOS4.xx the "Check Diskspace on Move"
  223.             option may not work!
  224.                       COMMAND-LINE PARAMETERS
  225.  
  226.   FIXBBS has FOUR optional command-line parameters (REGISTERED users only)
  227.  
  228.             /B - Batch mode.
  229.  
  230.                  If FIXBBS is run with this parameter it will validate
  231.                  ALL file areas as defined in your list of file areas
  232.                  (normally the GTDIR.BBS).
  233.  
  234.             /Axxxxxxxx.yyy - use a different list for the file areas.
  235.  
  236.                  If this parameter is used FIXBBS will use the file
  237.                  named xxxxxxxx.yyy as the list of files it will work
  238.                  with. The file must be in the same format as the
  239.                  GTMDIR.BBS (that is contain a list of drive\pathnames)
  240.                  and must be located in the GTPATH.
  241.                  If not specified the list defaults to the GTDIR.BBS.
  242.  
  243.  
  244.             /N - no CBS creation
  245.  
  246.                  If specified NO FILES.CBS file will be created/updated
  247.  
  248.             /Z - update ALL compressed files with the internal dates
  249.                 *WARNING* this option will cause a MARKED SLOWDOWN in
  250.                 the operation of FIXBBS. ONLY USE IT IF YOU *HAVE TO*
  251.  
  252.  
  253.                             RUNNING FIXBBS
  254.  
  255.  
  256.   The program is fairly self-explanatory but a few aspects of operation
  257.   need to be elaborated on.
  258.  
  259.             MENU SELECTION.
  260.  
  261.             At the Main Menu and the Move sub-menu you may use either
  262.             the number or first letter of the selection you desire.
  263.  
  264.             Note that "Q" and "X" are internal aliases for "R".
  265.  
  266.             COMMAND STACKING.
  267.  
  268.             For safety purposes MOST commands are NOT stackable - this
  269.             is to prevent accidental erasure/moving of files. However,
  270.             there are FIVE commands that MAY be stacked -
  271.  
  272.                     1) you can stack an area number after the
  273.                        C)hange Area command
  274.  
  275.                     2) you can stack an area number after the
  276.                        S)ource Area selection command
  277.  
  278.                     3) similarly you can stack an area number after the
  279.                        D)estination Area command
  280.  
  281.                     4) you can  stack a line number after the
  282.                        L)ist area - the listing will start from the
  283.                        specified line.
  284.  
  285.                     5) a SERIES of file numbers may be stacked in the
  286.                        move/copy/erase command. Numbers are separated by
  287.                        any NON-numeric character, with the exception of
  288.                        the "-" character which is used to designate a
  289.                        range of numbers to mark/unmark.
  290.  
  291.                        e.g.
  292.  
  293.                        5,7,8,11-15 would mark files 5 7 8 11 12 13 14 15
  294.  
  295.                        Overlapping ranges WILL cause strange effects
  296.  
  297.                        e.g.
  298.  
  299.                        1-4 3-7 will NOT mark files 1 2 3 4 5 6 7
  300.                        but will mark files 1 2 5 6 7!!
  301.  
  302.                        The reason for this is that the 1-4 DOES mark
  303.                        files 1 2 3 4 but the 3-7 toggles files 3 4 and
  304.                        marks files 5 6 and 7.
  305.  
  306.                        (remember the the mark/unmark is a toggle - if
  307.                        you mark a file TWICE the second mark negates the
  308.                        first)
  309.  
  310.             If an out of range value is specified it will be ignored.
  311.  
  312.  
  313.             ARCHIVE COMMENT. (REGISTERED users only)
  314.  
  315.             The Archive comment will be added to ANY ZIP, ARC, or PAK
  316.             file that is moved to another area.
  317.  
  318.             If the FIRST TWO characters of the archive comment are
  319.             "=F" (no quotes and uppercase F) the characters following the
  320.             =F are treated as the Drive\path\filename.ext of a file that
  321.             contains the archive comment.
  322.  
  323.             EDITOR NAME.
  324.  
  325.             This entry defines the NAME of the editor you wish to use
  326.             for your FILES.BBS. *NOTE* your editor MUST be capable of
  327.             accepting the filename to be edited as a command-line
  328.             parameter.
  329.  
  330.             FIXBBS will automatically create a FILES.CBS when
  331.             you exit from the edit function. Also, if required, FIXBBS
  332.             will validate the area.
  333.  
  334.             NEW FILES. (REGISTERED users only)
  335.  
  336.             If a special keyline is included in your FILES.BBS FIXBBS
  337.             will handle all NEW files (those currently not in the
  338.             FILES.BBS) in a special way -
  339.  
  340.             FIXBBS will append your REGISTERED NAME and the current date to
  341.             the key line and insert all new file descriptions after it.
  342.  
  343.             The key line has the following format -
  344.             " New files at"
  345.             followed by TWO blank lines.
  346.  
  347.             *NOTE* - the "N" of new MUST start in column 2!!!!
  348.  
  349.              The TWO blank lines are used to define a SUB-GROUP within
  350.              the FILES.BBS.
  351.  
  352.              To convert a NEW file entry to a normal entry simply move
  353.              it to the appropriate area somewhere else in your FILES.BBS
  354.              with the Edit function.
  355.  
  356.              MULTI-LINE COMMENTS. (REGISTERED users only)
  357.  
  358.              Any file may now have more than one comment line associated
  359.              with it. These multi-line comments are identified by the
  360.              presence of a period (.) in column 26 of the FILES.BBS.
  361.  
  362.              All lines with a period are "glued" to the preceding file
  363.              entry (which must NOT have a continuation mark!). A
  364.              multi-line file may be manipulated (moved/copied/deleted)
  365.              by FIXBBS as if it were a single entry.
  366.  
  367.              *NOTE* this "gluing" does NOT apply to EDITING a FILES.BBS
  368.              - use the "block move" command of your editor to accomplish this.
  369.  
  370.              OFFLINE FILES.
  371.  
  372.              If an asterisk (*) is placed in column 26 of the FILES.BBS
  373.              no check is made for the presence of the file in the
  374.              directory.
  375.  
  376.              IGNORE BULLETINS.
  377.  
  378.              If the "ignore bulletins" mode is selected in the
  379.              configuration FIXBBS will NOT check for the presence of the
  380.              system bulletins in the FILES.BBS.
  381.  
  382.              A system bulletin is defined as a file with a file name of
  383.              1 through 99 and either NO extension or an extension of
  384.              .CBS.
  385.  
  386.              *NOTE* if IGNORE mode is used and there ARE existing
  387.              descriptions in the FILES.BBS FIXBBS will NOT remove the
  388.              description - this will have to be done manually, but no
  389.              NEW descriptions will be generated.
  390.  
  391.  
  392.              VALIDATE AFTER EDIT.
  393.  
  394.              Normally FIXBBS will NOT validate a FILES.BBS that you have
  395.              edited but merely re-writes the FILES.BBS/CBS.
  396.              You can, however, elect to have FULL validation performed
  397.              after an edit (as a safety measure).
  398.  
  399.                                 REGISTRATION.
  400.  
  401.             This program MUST be registered to be fully operational.
  402.             Batch mode, multi-line comments, new file maintenance,
  403.             alternate area lists, and archive commenting are disabled
  404.             in unregistered copies.
  405.  
  406.             Please read the enclosed README.NOW file for registration
  407.             information.
  408.  
  409.  
  410.                          FURTHER INFORMATION.
  411.  
  412.                 May be obtained from the author -
  413.  
  414.                            Ken Thompson
  415.                            164 Lyons Rd.
  416.                           Drummoyne N.S.W.
  417.                        Sydney Australia 2047
  418.  
  419.                           +61-2-81-4751
  420.  
  421.                  or I may be contacted via my BBS
  422.  
  423.  
  424.                          The Black Hole
  425.                       GT Net/Node 302/003
  426.  
  427.              Modem  +61-2-719-8161 (9600 CRASH!able)
  428.              Modem  +61-2-819-6971 (2400 NO CRASH!mail)
  429.              Modem  +61-2-719-8491 (2400 NO CRASH!mail)
  430.  
  431.  
  432.  
  433.  
  434.  
  435.