home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / FLX112.ZIP / FILEX.DOC < prev    next >
Text File  |  1991-06-22  |  13KB  |  308 lines
  1.  
  2.                           FILEX Version 1.12
  3.                written by Bill Auclair, FidoNet 1:141/545
  4.              Copyright (C) 1990,1991 by XanSoft Development
  5.                           ALL RIGHTS RESERVED
  6.  
  7.  
  8.  
  9. DISCLAIMER-
  10.  
  11.      FILEX is guaranteed to do nothing more than decrease your hard
  12.      drive space by one files' worth.  The author shall not be held
  13.      liable for any damages resulting from the use or misuse of this
  14.      software program.  You are cautioned to use this program at your
  15.      own risk.
  16.  
  17.  
  18. DESCRIPTION-
  19.  
  20.      FILEX is a software program designed to facilitate the maintenance
  21.      of file areas on Opus<tm> v1.0x ,1.1x and other compatible BBSes.
  22.      It was written to be used with a companion utility, a file area
  23.      management program called VersaFAM.  Latest versions of both FILEX and
  24.      VersaFAM may be obtained from the author's BBS (FidoNet 1:141/545).
  25.  
  26.      FILEX is used to add new files to file areas.  Easily invoked from
  27.      the DOS command line, it transports specified files to target file
  28.      areas and automagically updates the list file for those areas,
  29.      optionally supplying a description to be used in the list file.
  30.  
  31.      FILEX fully supports the use of DOS wildcards * and ?, allowing
  32.      for mass additions of files to file areas.  FILEX can also be
  33.      invoked from a batch file, to handle the addition of periodic
  34.      files (FidoNews, nodediffs, etc.) into file areas.
  35.  
  36.      FILEX versions 1.07c and later now use an optional configuration file,
  37.      named FILEX.DAT.  FILEX.DAT can be used to exclude additional filenames
  38.      from update processing, and will be used for other purposes in future
  39.      updates.  When invoked, FILEX will look for FILEX.DAT in the directory
  40.      pointed to by the FILEX environmental variable.  If the FILEX variable
  41.      is not defined, FILEX will look for FILEX.DAT in the current directory.
  42.      If no FILEX.DAT file is found, processing continues normally.
  43.  
  44.      The use of DOS wildcards (*) and (?) is NOT supported when using the
  45.      EXCLUDE verb in FILEX.DAT.  A maximum of 256 filenames may be optionally
  46.      excluded from update processing.
  47.  
  48.      The QUIET configuration file verb may be used to disable the display of
  49.      individual filenames during FILEX processing, reducing program execution
  50.      time by 30 to 70 percent.
  51.  
  52.      List file names other than the default FILES.BBS are now supported by
  53.      FILEX.  If you wish to process a list file other than FILES.BBS, simply
  54.      enter the list file name after the LISTFILE verb in FILEX.DAT.
  55.  
  56.      The BIOS configuration verb can be used to choose between fast direct or
  57.      slower BIOS-based video output.  When redirecting output to a file or
  58.      printer, BIOS must be chosen in FILEX.DAT.
  59.  
  60.  
  61.      FILEX Version 1.12             - 2 -
  62.  
  63.      FILEX versions 1.05 and later now support the use of macros
  64.      within file descriptions.  The following description macros
  65.      are available:
  66.  
  67.        [DATE]    gives current date in MM/DD/YY format.
  68.        [TIME]    gives current time in HH:MM format.
  69.        [YEAR]    gives verbose listing of current year.
  70.        [MONTH]   gives verbose listing of current month.
  71.        [DAY]     gives verbose listing of current day of the week.
  72.        [0]-[127] sets OEC (Opus Embedded Code) text colors
  73.        [B]       enables blinking
  74.  
  75.  
  76.      To solve problems being experienced by some sysops using other utilities
  77.      which require the use of the [] bracket characters, FILEX versions 1.12
  78.      and above now accept alternate use of soft brace {} characters in macros.
  79.      This will hopefully eliminate problems with FILEX erroneously interpreting
  80.      anything enclosed in brackets as macro information.  Usage of BRACES or 
  81.      BRACKETS can be specified in the FILEX.DAT configuration file.
  82.  
  83.  
  84.  
  85. OEC COLOR CODES-
  86.  
  87.      FILEX versions 1.05 and later now support the use of macro OEC
  88.      (Opus Embedded Codes) to change the color of file description text.
  89.      The key for these macros can be displayed by typing FILEX COLOR at
  90.      the DOS command line, then pressing ENTER.  Output can also be redirected
  91.      to a printer or file if needed, using the DOS > redirection symbol.
  92.  
  93.  
  94.      Inserting a [B] after any macros will cause the text to blink when
  95.      the OEC codes are interpreted.  Blinking will continue until another
  96.      color code is encountered.
  97.  
  98.  
  99.  
  100.  
  101.  
  102. INSTALLATION-
  103.  
  104.      FILEX should ideally be installed in a subdirectory included in
  105.      your DOS PATH statement.  This will ensure that the program can
  106.      be executed no matter which subdirectory you happen to be in.
  107.  
  108.  
  109.  
  110.      FILEX Version 1.12            - 3 -
  111.  
  112. OPERATION-
  113.  
  114.      FILEX accepts the following command line syntax:
  115.  
  116.      ------------------------------------------------------------------
  117.      FILEX [<source path>] [<target path>] [<description>]
  118.      ------------------------------------------------------------------
  119.  
  120.      EXAMPLES
  121.  
  122.      Suppose you have the file PACMAN.ARC in subdirectory
  123.      C:\TEST.  You want to add this file to a file area using
  124.      subdirectory C:\FILE\GAMES, with a suitable description.  The
  125.      command line syntax used for this example is shown below:
  126.  
  127.  
  128.      ------------------------------------------------------------------
  129.      FILEX c:\test\pacman.arc c:\file\games PAC_MAN_Arcade_Game
  130.      ------------------------------------------------------------------
  131.      Note the use of underscores between the words in the description.
  132.      Underscores MUST be used, or the description will not be correctly
  133.      interpreted by the FILEX command line parser.
  134.  
  135.      Suppose you've gotten in a bunch of programming files, all with
  136.      .ZIP extensions, that you'd like to transfer to your Programming
  137.      file area.  You don't care about file area descriptions, you'll
  138.      use VersaFAM to fill them in later. You just need them included
  139.      in the list file with a "generic" description.  The command line
  140.      syntax used for this example is shown below:
  141.  
  142.  
  143.  
  144.      ------------------------------------------------------------------
  145.      FILEX c:\test\*.zip c:\file\program
  146.      ------------------------------------------------------------------
  147.      This transfers all files in C:\TEST with a .ZIP extension to
  148.      C:\FILE\PROGRAM, updating C:\FILE\PROGRAM\FILES.BBS.  When a
  149.      description is not supplied on the command line, FILEX defaults
  150.      to a description of "<Description Unavailable>" for all files.
  151.  
  152.      If the directory from which FILEX is invoked and the target
  153.      subdirectory are the same, the target subdirectory need not be
  154.      specified on the command line:
  155.  
  156.  
  157.  
  158.      FILEX Version 1.12              - 4 -
  159.  
  160.      ------------------------------------------------------------------
  161.      FILEX *.arc
  162.      ------------------------------------------------------------------
  163.      will add all files in C:\FILE\MUSIC with an .ARC extension to
  164.      C:\FILE\MUSIC\FILES.BBS, supplying a generic description, if FILEX
  165.      is called from C:\FILE\MUSIC.  If a non-generic description is to
  166.      be supplied to the files in this example, the hyphen (-) character
  167.      should be used as a "placeholder" to indicate that the current and
  168.      target subdirectories are the same:
  169.  
  170.  
  171.  
  172.      ------------------------------------------------------------------
  173.      FILEX *.arc - New_Music_Files
  174.      ------------------------------------------------------------------
  175.      will add all files in C:\FILE\MUSIC with an .ARC extension to
  176.      C:\FILE\MUSIC\FILES.BBS, using the description supplied on the
  177.      command line, if FILEX is called from C:\FILE\MUSIC.
  178.  
  179.  
  180.  
  181.      ------------------------------------------------------------------
  182.      FILEX fnews???.* d:\newsletr FidoNews,_rec'd_[DATE]_at_[TIME]
  183.      ------------------------------------------------------------------
  184.      will add any existing FidoNews files to D:\NEWSLETR\FILES.BBS,
  185.      using macros to insert a date/time stamp corresponding to when
  186.      the file was processed.
  187.  
  188.  
  189.  
  190.      ------------------------------------------------------------------
  191.      FILEX blah.exe c:\newstuff [15][B]New_Files_[3]as_of_[DATE]
  192.      ------------------------------------------------------------------
  193.      will add the file BLAH.EXE to C:\NEWSTUFF\FILES.BBS, with the words
  194.      "New Files" blinking white in the description, and the rest of the
  195.      line shown in non-blinking cyan.
  196.  
  197.  
  198.  
  199.  
  200.      When FILEX is run, the first thing it does is check each target
  201.      file against files already listed in the list file for the target
  202.      subdirectory.  If it finds the target file(s) already listed
  203.      in the list file, it does NOT add the target file(s).  If the specified
  204.      list file is not found in the target subdirectory, one is created.
  205.  
  206.      Based on feedback from users, use of the FILEX.OPS log file has been
  207.      discontinued in FILEX versions 1.08 and later.  The FILEX environmental
  208.      variable may still be used to point to the FILEX.DAT file.
  209.      A typical environmental variable listing is shown below:
  210.  
  211.  
  212.                             set FILEX=c:\utility
  213.  
  214.  
  215.  
  216.      FILEX Version 1.12            - 5 -
  217.  
  218.  
  219. NON-PROCESSABLE FILES-
  220.  
  221.      Certain file names and extensions are ignored by FILEX when it is
  222.      processing target files.  These filenames include:
  223.  
  224.                               DIR.BBS
  225.                               DIR.BAK
  226.                               FILES.BBS
  227.                               FILES.BAK
  228.                               FILEX.DAT
  229.                               FILEX.EXE
  230.                               COMn
  231.                               LPTn
  232.                               PRN
  233.                               CON
  234.                               SCRN
  235.                               NUL
  236.  
  237.  
  238.  
  239.  
  240. REVISION HISTORY-
  241.  
  242.      1/4/90:     Version 1.03
  243.                  First public non-beta release
  244.  
  245.      3/22/90:    Version 1.05
  246.                  Added description macros [DATE],[TIME],[YEAR],[MONTH],
  247.                  [DAY],[0] thru [15] and [B].  Also added support for
  248.                  the FILEX environment variable, and changed FILEX.OPS
  249.                  log file to append, rather than rewrite the log file
  250.                  each time the program is run.
  251.  
  252.      7/4/90:     Version 1.06
  253.                  Fixed bug that caused FILEX to duplicate existing file
  254.                  entries when those entries did not have a file
  255.                  extension.  Changed blank padding between filenames
  256.                  and descriptions from 1 space to 2 spaces, in order to
  257.                  conform with Opus/Maximus norms.  Increased list file
  258.                  read capacity to 1024 lines to conform with VersaFAM
  259.                  file area manager specifications.
  260.  
  261.      11/28/90:   Version 1.07a (beta)
  262.                  Fixed a glitch that was generating "Invalid Command Line"
  263.                  errors for those running 4DOS by replacing the " placeholder
  264.                  character with the hyphen (-) character instead.
  265.  
  266.  
  267.  
  268.      FILEX Version 1.12                 - 6 -
  269.  
  270.      12/5/90:    Version 1.07b (beta)
  271.                  Revised handling of filename string to avoid duplication of
  272.                  FILES.BBS info when processing lowercase filenames.
  273.  
  274.      12/29/90:   Version 1.07c (beta)
  275.                  Added FILEX.DAT configuration file, with EXCLUDE verb, to
  276.                  allow users to specify additional filenames to be excluded
  277.                  from processing.
  278.  
  279.       1/13/91:   Version 1.07d (beta)
  280.                  Added code to configuration file routines to change TAB
  281.                  characters to spaces when encountered.
  282.  
  283.       2/24/91:   Version 1.08
  284.                  Added QUIET configuration file verb and functions.  Added
  285.                  variable listfile name option.  Removed FILEX.OPS log file
  286.                  option.  Added BIOS configuration file verb.  Generally
  287.                  cleaned up code, optimizing for speed.
  288.  
  289.       6/22/91:   Version 1.12
  290.                  Cleaned up come problems experienced with some undocumented
  291.                  beta versions.  Expanded support of OEC text/background color
  292.                  codes from 15 to 127 color combinations.  Added color code
  293.                  chart subroutine to executable file.  Added BRACES/BRACKETS
  294.                  configuration verbs to FILEX.DAT configuration file.  Cut down
  295.                  on code size, squashed a few bugs and tightened things up.
  296.  
  297.  
  298.      Please address all comments, criticisms and bug reports to:
  299.  
  300.                             Bill Auclair
  301.                             1:141/545.0
  302.  
  303.      Thanks a lot.  Hope you get as much enjoyment out of this program
  304.      as I got in bringing it to you....
  305.  
  306.      6/22/91
  307.      Bill Auclair
  308.