
                             
                                    
                        
                               
                                       
                             

                                Version 3.0
                        Documentation Revision 1.0
                                April  1995

Ŀ
  Introduction  


FilePro is a utility to interface file distribution echoes with Searchlight
BBS.   If  you  are at the end of the chain in a file distribution network,
FilePro can actually automate the entire  process  without  the  bother  of
installing  a  .tic processor. It imports the files into the BBS file areas
and searches the file archive for an  extended  description  file.  FilePro
will  also  optionally  post  an  announcement for each file in a specified
subboard.  It will also optionally post daily, weekly, monthly, and  yearly
statistics reports.  FilePro will support up to 10 archivers.

Ŀ
  How File Echoes Work  


If  you  have joined a file echo, then you probably have a fairly good idea
what happens.  For every file you receive, you also receive  a  *.tic  file
associated  with  it.   This  *.tic  file contains information that FilePro
uses, such as file name, file area and description.

Ŀ
  Execution  


Three programs make up the FilePro package.  They  are  TicUtil,  FPConfig,
and  of  course,  FilePro.   TicUtil  reads  the  *.tic files and creates a
FILES.DAT file in the FilePro directory.  Every  time  TicUtil  is  run  it
appends  its data to this file.  This allows it to be run many times before
FilePro is actually run.  FPConfig is the  configuration  program  for  the
entire  package.   FilePro  is  the file importer, announcement poster, and
statistics tabulator.

Ŀ
  FilePro.EXE  


FilePro has two optional parameters.  To see a summary of  the  parameters,
type "FILEPRO.EXE ?" at the command line.

  /DEBUG

    When FilePro is run in debug mode, it will pause after processing  each
    file  so you can view the result individually.  Also, when run in debug
    mode,  FilePro  will not delete the FILES.DAT file, allowing you to run
    it again.

  /NOSWAP

    Normally FilePro will swap most of itself out of memory when running an
    archiver.   This  frees  up more memory for the archiver (which usually
    require a lot).  There seems to be some  incompatibility  when  running
    some  archivers while FilePro is swapped out of memory under OS/2 Warp.
    If you experience any errors while running  FilePro  under  OS/2  Warp,
    you may need to include the /NOSWAP  parameter.   This  will  typically
    require more memory for the archiver, but  should  not  be  much  of  a
    problem under OS/2 Warp.

When FilePro is executed, it divides the screen into two sections.  The top
section  displays  information  about  the  file  that  is  currently being
processed.  The bottom section is a window that shows any archiver  output.
The screen looks similar to this.


      ͻ
                           FilePro Pro v3.0                       
                   Copyright 1994, 1995 Darrell Davis             
      ĺ
                                                                  
       Area Tag   :                Area Name:                     
                                                                  
       Comment    :                                               
                                                                  
       File Name  :                File Size:                     
                                                                  
       Description:                                               
                                                                  
       Desc File  :                                               
                                                                  
      ͼ




Ŀ
  TicUtil.EXE  


TicUtil has one required parameter and two optional ones.  To see a summary
of the parameters, type "TICUTIL.EXE ?" at the command line.

  TICK

    This parameter tells TicUtil to process *.tic files.

  -p<path to inbound files>

    This parameter tells TicUtil where to find the  *.tic  files.   If this
    parameter is not used, TicUtil will use the Inbound Directory specified
    in FPConfig (explained later).

  -m

    This parameter tells  TicUtil  to move the  actual files to their final
    directories.   This is used if you do not run any other file processing
    software.   This  also  tells  TicUtil  to delete the *.tic files after
    they are no longer needed.  This is also called "stand-alone" mode.

Ŀ
  FPConfig.EXE  


Simply  execute  FPConfig  from the directory where all of the FilePro data
files are to be located.  The main menu has six sub menus.

 General Config
  This  menu  is  used  to  specify  the various directories and files that
  FilePro will use.

 Area Manager
  This menu is used to create, edit, and delete file echo areas.

 Archivers
  This menu is used to create, edit, and delete archivers.

 Reports
  This menu is  used  to  configure  daily,  weekly,  monthly,  and  yearly
  reports.

 Descriptions
  This  menu  is  used  to  configure the extended descriptions in the file
  areas.

 Exit
  This option is used to quit FPConfig.  You may also hit ESC at  the  main
  menu to quit.

  Ŀ
    SubMenus  
  

General Config 

 Inbound Directory
   This is the DOS  directory  where  incoming  file  echo  files  and  the
   associated *.tic files are stored.  This field is used by TicUtil.

 Temp Directory
   This is a DOS directory that FilePro may use to store  temporary  files.
   The default is a directory named TEMP under the FilePro home directory.

 Log File
  This is the name of any DOS file where FilePro will  log status and error
  messages.  The default is filepro.log in the FilePro home directory.

 Path To CONFIG.SL2
   This  is  the path to a CONFIG.SL2 file. This must be a node that is not
   in use when FilePro is in operation.

 Path To AutoAdd
   This is the path to the AutoAdd program. If  this  program  is  present,
   TicUtil will automatically add new file echoes and file areas the  first
   time  a  file  is  received in the area.  Additionally, FPConfig can use
   AutoAdd  to add new subboards and file areas when needed. This field may
   be left blank.

Area Manager 

  The  Area  Manager  is  the most complex part of FPConfig.  This is where
  each file echo is configured.  The left and right arrow keys are used  to
  scan each file area.  The insert key is used  to  add  a  new  area,  the
  delete key is used to delete an area, the enter key is used to  edit  the
  current  area,  and  the F2 key is used to copy an area.  Since many file
  echoes may  share the same data, FPConfig uses Default Classes (explained
  later).   The  F4  key  is  used to present a scrollable list of all file
  areas.  Each file area has the following fields:

 Area Tag
   This is the network name for the file area.  Some examples are BACKBONE,
   SDS_FRONT, and SL_FDN.

 Area Name
   This is the  name  of  the  corresponding  BBS  file  area.   Note  that
   different areas can share the same BBS file area.

 Comment
  This field is displayed in the log, and on the FilePro screen when a file
  in this area is being processed.

 Announcement
   Set  this to YES is you want a file arrival announcement posted in a BBS
   subboard.  Set it to NO to skip announcements for this file area.

 Subboard
   This is the name of a BBS subboard where  announcements  for  this  file
   area will be posted.  Note that if this field is set to MAIL, a  private
   announcement  is  sent  to  the  person  specified in the To: Field.  If
   Announcement  is  set  to  YES,  then  this  field  is  mandatory.    If
   Announcement is set to NO, then this field is ignored.

 To: Field
   This is to whom announcements will be addressed.  Some examples are All,
   Anyone, or Sysop.

 Subject: Field
   This text will be used as the subject for the announcement.  You can use
   the parameter %F to represent the file name. If using this parameter, be
   aware that the actual subject field  on  a  message  is  limited  to  40
   characters and expansion of the variable  might  cause  the  anticipated
   subject line to be truncated.

 From: Field
   This  text  will  be  used  in the From field of the announcement.  Some
   examples are Sysop, FilePro, or File Manager.

 Header File
   This  field  is used to specify any DOS text file that will be placed in
   the  announcement  BEFORE the file description.  Searchlight color codes
   may be used to enhance the announcement. (optional)

 Footer File
   This field is used to specify any DOS text file that will be  placed  in
   the  announcement  AFTER  the  file description. Searchlight color codes
   may be used to enhance the announcement. (optional)

 Password
   This field is used to specify a default password for all  new  files  in
   this area.  (optional)

Statistics 

  The bottom of the screen will display Daily, Weekly, Monthly, and  Yearly
  statistics for each file area.  These  statistics  are  included  in  the
  generated reports (explained later).

Default Classes 

  When  inserting  a  new area, a list of the Default Classes is presented.
  When one is chosen, the data from the Default Class is used as a template
  for the new area.  The F3 key is used to edit the Default Classes.  Every
  field from the Default Class template is used in the new file area.  When
  using a Default Class, you will only need to specify the Area Tag of  the
  new area. If you choose to use the AutoAdd utility with FilePro, you must
  setup a Default Class called AUTOADD to handle the automatic addition  to
  the Area Manager.

Archivers 

  Up to ten archivers can be specified for FilePro.   The  information  for
  the  archivers  is store in the ARCHIVERS.CFG  file.   A  sample  one  is
  included.  Each archiver has the following three fields:

 Extension
   A  DOS  file  extension that is used to determine if the file is a known
   archive.  Some examples are ZIP, ARJ, and LZH.

 Name
   An executable file that unarchiver files with the above extension.  Some
   examples are PKUNZIP.EXE and ARJ.EXE.  The unarchiver program must be in
   the DOS path.

 Parameters
   The command line parameters passed to the archiver.  Use %1 to  indicate
   the archive name and %2 to indicate the file to be extracted.

Reports 

  Four different reports can  be  created  by  FilePro.   They  are  Daily,
  Weekly, Monthly, and Yearly.  If any reports are implemented, then it  is
  suggested  that  FilePro  be  run  at  least  once a day.  Each report is
  optional and independent.  To implement a report, simply  set  its  field
  (Daily Report, Weekly Report, Monthly  Report,  Yearly  Report)  to  YES.
  Each report has the following five fields:

 Subboard
   This is the name of a BBS subboard where the report will be posted. Note
   that  if  this  field  is  set  to MAIL, a private report is sent to the
   person specified in the To Field.

 All Areas
   If this field is set to Yes, then the report will include areas that had
   no traffic during the time period.

 To: Field
   This is to whom the report will be addressed.  Some  examples  are  All,
   Anyone, or Sysop.

 Subject: Field
   This text will be used as the subject for the report.

 From: Field
   This  text  will be used in the From field of the report.  Some examples
   are Sysop, FilePro, or File Manager.

Descriptions 

  This  section  determines  how   FilePro   will   format   the   extended
  descriptions.  Two types of extended  description  files  are  supported,
  FILE_ID.DIZ and DESC.SDI files.

 Description Format
   There  are three ways FilePro can format the extended description.  This
   format will apply to both announcements, and the file listing.

    Normal
      FilePro simply reads the extended description file as it  is  already
      formatted.

    Right Half
      FilePro reformats the extended description to line up under the short
      description  in   the   file   list.    It   automatically   performs
      word-wrapping.  This generates a very clean  display,  but  takes  up
      more lines.

    Wide
      FilePro  reformats  the  extended  description  to take up the entire
      width   of   the   available   space.   It   automatically   performs
      word-wrapping. This method uses the fewest lines possible.

  Strip High ASCII
    Some extended description files use high ASCII characters to draw boxes
    and borders around the description.  If FilePro reformats the  extended
    description  (Right  Half or Wide) these boxes and borders tend to mess
    up  the  file  listing. If this field is set to YES, FilePro will strip
    any   high  ASCII  characters  from  the  extended  description  before
    reformatting.

  Description Color
   This field is used to set the color that will be  used  to  display  the
   extended descriptions in the announcements.

Ŀ
  FILES.BAD  


FilePro will create a text file listing any file it could not process.   To
re-process these files,  check your  log file for the reason the file could
not be processed and  correct the problem.   Then rename the FILES.BAD file
to FILES.DAT and re-run FilePro.

Ŀ
  Sample Batch Files  


The following is a sample batch file to run TicUtil  and  FilePro in stand-
alone mode.   You  may  need  to  change  the  paths to match those on your
system.

  cd\filepro
  ticutil.exe tick -pc:\inbound -m
  filepro.exe

The  following  is  a sample  batch file to run  TicUtil, a file processing
program of your choice,  and FilePro.   You may need to change the paths to
match those on your system.

  cd\filepro
  ticutil.exe tick -pc:\inbound
  cd\fileprog
  fileprog.exe
  cd\filepro
  filepro.exe

Ŀ
  Converting From Previous Versions  


The FilePro package includes a program Convert which can be used to convert
a PDRoach v1.x AREAS.CFG file to a FilePro v3.0 AREAS.DAT file.  Simply run
CONVERT.EXE from the command line and follow the instructions.

Ŀ
  Registration  


The  unregistered  demo  of  FilePro  is  limited to 5 file areas.  This is
sufficient to carry the entire SL_FDN and should  be  sufficient  to  fully
test  the  functionality  of FilePro.  Note, this program is not shareware,
not freeware, and not crippled, it is a demo.   If  you  wish  to  register
FilePro please refer to the FILEPRO.REG file included with the archive.

Ŀ
  Technical Support  


The  official  technical  support BBS for FilePro is The Summit Searchlight
BBS which can be reached at (814)886-2563 at speeds from 1200 to 28800 with
v.34.  Address any technical support questions to the sysop,  Richard  Lis.
In  addition,  technical  support  questions can be answered in the FIDOnet
SEARCHLIGHT echo, as well as the SL_NET SL_SYSOP and SL_DOOR echoes.

Ŀ
  Credits  


  Documentation Revision 1.0 by Richard Lis

  FilePro v3.0
  Copyright 1993, 1994, 1995 Darrell Davis

  FPConfig v3.0
  Copyright 1994, 1995 Darrell Davis

  TicUtil v3.0
  Copyright 1994, 1995 Darrell Davis

  Created with PDMenu v1.0
  Copyright 1993, 1994, 1995 Darrell Davis

  Created with SearchLight Programmer's Library
  Portions Copyright (c) 1994 SearchLight Software

The programs in the FilePro package are based on programs in the now
retired PDRoach (Copyright 1993, 1994 Darrell Davis) package.
