home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 25 / nopv25.iso / 029A / ANESTH.ZIP / SFFAM.DOC < prev    next >
Encoding:
Text File  |  1996-09-06  |  15.7 KB  |  384 lines

  1.  
  2.                                  SF-FAM v2.17
  3.               Spitfire File Area Manager
  4.                               from Fifth Dimension
  5.  
  6. This program is Copyright 1993-1996 by David Pontius.
  7. The freeware version of the program may be distributed freely,
  8. however the source code remains the property of the author.
  9.  
  10. INTRODUCTION
  11. ============
  12. SF-FAM is a file manager for the Spitfire Bullitin Board.
  13. It fully supports file sharing.
  14. It fully supports Spitfire defined CD-ROM file areas, and file areas
  15.             not defined by Spitfire.
  16. REQUIRED: SF 3.5+, DOS 3.x or above
  17. Once registered, all updates are FREE!!!
  18. The registration validation is done by Brian Pirie's 
  19.     Registration Key System for C Programmers.
  20.  
  21. WHO TO CONTACT FOR TECHNICAL SUPPORT
  22. ======================================
  23. Internet:           pontius@azstarnet.com
  24.                     http://www.azstarnet.com/~pontius/
  25.  
  26. Fax:                (520)747-5415
  27.                 
  28. Address:            Fifth Dimension
  29.                     P.O. Box 18956
  30.                     Tucson, Az 85731
  31.  
  32. Latest version:     Buffalo Creek's BBS (515)225-8496
  33.                     ftp://ftp.azstarnet.com/pub/users/pontius/
  34.             http://www.azstarnet.com/~pontius/
  35.                                                        
  36.                             
  37. INSTALLATION
  38. ============
  39. To install SF-FAM, you may put the required files in any directory.
  40. The required files are:
  41.     SFFAM.EXE - main executable
  42.     SFFAM.HLP - text help file
  43.     SFFAM.NDX - index help file
  44.  
  45.     COMMAND LINE PARAMETERS:
  46.     ------------------------
  47.     SFFAM /C : runs configure ( see setup below )
  48.     SFFAM /DIR= : Directory containing SFNODE.DAT/SFFAREA.DAT.
  49.                         This will override the SFNODE.DAT/SFFAREA.DAT 
  50.                     directory in SFFAM.DAT.
  51.                         Example: SFFAM /DIR=C:\SF2
  52.                             /C      Runs configuration.
  53.     /DIR=   Directory to SFNODE.DAT/SFFAREA.DAT
  54.     /BBS=   Filename of external file areas. Does not need
  55.             to be SFFAM.BBS.
  56.     /VA     Verify sizes in all areas. (CD-ROMS will be skipped if
  57.             disabled in the configuration)
  58.     /V#     Vefify sizes in area # only. Example. SFFAM /V3 will verify
  59.             this sizes in area 3 and update it if necessary.
  60.     /HA     Make headers for all areas.
  61.     /H#     Make header for area # only. Example. SFFAM /H2 will create
  62.             a header for area 2 only.
  63.     /SAA    Sort Ascending date, all areas.
  64.     /SFA    Sort Filename, all areas.
  65.     /SDA    Sort Descending date, all areas.
  66.     /SA#    Sort Ascending date, area #. Ex. SFFAM /SA3
  67.     /SF#    Sort Filename, area #. Ex. SFFAM /SF10
  68.     /SD#    Sort Descending date, area #. Ex. SFFAM /SD5
  69.  
  70.     In addition, you may run several paramaters at once.
  71.  
  72.     Example:
  73.     SFFAM /V5 /HA /DIR=C:\SUBSF /H1 /SFA
  74.  
  75.     This would first verify the sizes in area 5. The SF directory would
  76.     be the directory defined in SFFAM.DAT. It would then make headers
  77.     for all the file areas. It then switches to the C:\SUBSF directory,
  78.     then makes a header for area 1. It then Sorts all the areas in defined
  79.     in C:\SUBSF by filename.
  80.  
  81.     The first directory used will be the one defined in SFFAM.DAT, unless 
  82.     the first paramter is /DIR=.
  83.     A /DIR= is valid until changed by another /DIR=.
  84.  
  85.         All command line parameters are case insensitive.
  86.  
  87.     SETUP:
  88.     ------
  89.     To configure up SF-FAM, just type SFFAM. If the SFFAM.DAT file is
  90.     not found, one will be created.
  91.         
  92.     GENERAL CONFIGURATION:
  93.     ----------------------
  94.     Registration Code:
  95.         This will be sent to you after you register SF-FAM.
  96.     Direct video writes:
  97.         TRUE allows writes directly to video RAM,
  98.         FALSE will use the computer's video BIOS.
  99.             While TRUE should work in almost all cases, if you
  100.             experience video problems, you may want to set this
  101.             to FALSE.  This will most often occur when multi-tasking.
  102.     CDROM on Global Options:
  103.         If set to FALSE, CD-ROM areas will not be processed if a global
  104.         command is issued. i.e. Global Sort  
  105.     Swap to EMS/XMS when shelling to DOS:
  106.         TRUE will enable EMS/XMS swaps.
  107.         FALSE will force SF-FAM to swap to disk when shelling to DOS.
  108.     Lines of file_id.diz to use: 
  109.         Sets the number of lines SF-FAM will use when reading the file_id.diz
  110.         in a file. 0 will turn off this feature. Range is 0 to 99. ARJ, ZIP,
  111.         LZH, and .SDN files are supported.
  112.     Temp directory:
  113.         REQUIRED: 
  114.         This is the directory SF-FAM uses to swap to disk, and also to
  115.         put the FILE_ID.DIZ . This can be set to a RAM disk for best results.
  116.             ***Set this even if you have EMS/XMS swapping enabled. If there
  117.                         is not enough memory, SF-FAM will automatically switch to
  118.                         disk swapping.
  119.     Sort Preference:
  120.         This is used when adding and moving files only. SF-FAM will
  121.         add in this sort order. Files moved will be added to the new
  122.         area in this order. Options are:
  123.         Sort by filename
  124.         Sort by date, ascending( low to high )
  125.         Sort by date, descending( high to low )
  126.     Puts overlays in EMS/Extended memory:
  127.         This will put SF-FAM overlays in EMS or extended memory if available.
  128.         Setting this to true will increase speed.
  129.  
  130.     EXTERNAL PROGRAMS:
  131.     ------------------
  132.     You can configure up to 10 external programs. 
  133.         For a shell to DOS simply use COMSPEC. This will be converted
  134.         to the COMSPEC environment variable.
  135.         
  136.         You may use +f as a command line parameter. It will be converted
  137.         to the path/filename of the the current highlighted file.
  138.         ex. 'zipmgr +f' is converted to 'zipmgr C:\NEWUP\ALLFILES.ZIP
  139.  
  140.         A colon will cause SF-FAM to change to the download drive and
  141.         path of the current file area. The program will most likely need
  142.         to be in your path.
  143.         ex. ':SHEZ'
  144.  
  145.         You may run .exe, .com, or .bat files.
  146.  
  147.         The external program information is saved in SFFAM.EXT.
  148.  
  149.     COLORS:
  150.     -------
  151.     You can easily change the default colors used in SF-FAM. The possible
  152.     background and foreground colors are shown on the top half of the
  153.     screen.
  154.     The toggles are shown in the bottom half. To change a colors, simply
  155.     press the corresponding letter, and it will toggle through all 
  156.     available colors. 
  157.  
  158.     Input Fields: Any window that you need to type in something.
  159.     Stats Field: The field at the top showing number of files, etc.
  160.     SFFILES-Normal: The filename and description, when it is not highlighted.
  161.     SFFILES-Hilite: The filename and description, when it is highlighted.
  162.     Error windows: Any window which displays some type of error.
  163.     Status windows: Any window which is just there to let you know the
  164.         program hasn't stopped.
  165.     Help windows: The online help,accessible with F1.
  166.     General hilite: The color used to highlight items, such as the A,B,C,
  167.         in the configuration.
  168.  
  169. That's all there is to it.
  170. To run SF-FAM, simply type SFFAM.
  171.  
  172. NOTE: SFFAM.DAT, SFFAM.HLP, and SFFAM.NDX must be in the current directory.
  173.     
  174. CD-ROMS
  175. =======
  176. SF-FAM will check in the SFFAREA.DAT for any CD-ROM areas. It will then
  177. check the SFNODE.DAT for the Spitfire Display directory. 
  178. The file list for the CD-ROM area is expected to be in the display 
  179. directory with the filename of SFFILES.x, where x is the file area.
  180. For further information, please see your Spitfire manual.
  181.  
  182. FA?.TXT
  183. =======
  184. SF 3.5 supports multiple download paths using a file called FA?.TXT, located
  185. in the Spitfire home directory. SF-FAM supports this file in all operations.
  186.  
  187. EXTERNAL AREAS
  188. ===============
  189. SF-FAM will check for a file called SFFAM.BBS. This file defines file
  190. areas not defined in Spitfire. This is primarily for use with CDROM doors,
  191. however, it may be used in any area.
  192.  
  193. Each external file area is defined with 3 lines.
  194. SFFAM.BBS must be created by you if you wish to use it.
  195.  
  196.     Line 1 is the File Description. It must be less than 40 characters.
  197.     Line 2 is the Download Path. It must be less than 60 characters.
  198.     Line 3 is the Path and Filename of the Filelist. It must be less than
  199.         74 characters. The filelist MUST be in SFFILES.BBS format.
  200.  
  201.     example:
  202.  
  203.     The Super CD Games Area
  204.     f:\files\games
  205.     d:\rom\list1.bbs
  206.     LotsaFiles CD-ROM Utilities
  207.     g:\files\util
  208.     d:\rom\lotsutil.5
  209.  
  210. You may also give this file a different name and load it only with a 
  211. command line parameter. 
  212.     Example: Rename SFFAM.BBS to CDROMS.BBS.
  213.                 It will only be loaded you you type
  214.                 SFFAM /BBS=CDROMS.BBS
  215.  
  216. FILE AREA PICK
  217. ==============
  218. This first screen you will see is the list of file areas on the BBS.
  219. Your options are:
  220.  
  221.     <ENTER> - goto this file area
  222.     <ESC>   - exit SF-FAM
  223.     <Alt-H>    - On-line help
  224.     V       - Verify the sizes of all files in all areas.  The file size
  225.                     in SFFILES.BBS will be checked against the file size of the
  226.                     actual file.  If it is different, the file size in
  227.                     SFFILES.BBS will be updated and saved.  The location of the 
  228.                     commas is also checked, and updated if necessary.
  229.     S       - Sort. This will allow you to sort all file areas by either
  230.                     Filename or Ascending Date( low to high ) or Descending date
  231.                     ( high to low ).
  232.     H       - Create headers for the SFFILES.BBS in all areas.
  233.     T       - Search for selected Text in all file areas.
  234.     B       - Change location of the SFFAREA/SFFNODE.DAT. Great for 
  235.                     sub-boards.
  236.     C       - Run Configuration.
  237.     E       - Run File Area Editor.
  238.     <UpArr> - Moves cursor up one.
  239.     <DnArr> - Moves cursor down one.
  240.     <PgUp>  - Moves cursor up one page.
  241.     <PgDn>  - Moves cursor down one page.
  242.     <Home>  - Moves to top of list.
  243.     <End>   - Moves to bottom of list.
  244.  
  245. SFFILES.BBS DISPLAY
  246. ===================
  247. This will display your files in the SFFILES.BBS.  It supports multi-line
  248. descriptions, up to five lines. All references to SFFILES.BBS include
  249. the SFFILES.x for Spitfire defined CD-ROM areas and the filelist defined
  250. in SFFAM.BBS.
  251. If the SFFILES.BBS does not exist, you will be asked if you want to
  252. create it.
  253.  
  254. Your options are:
  255.  
  256.     <space> - tags/untags file.  <ENTER> will do the same.
  257.     Alt-T   - tags all files in area.
  258.     Alt-U   - untags all files in area.
  259.     <ESC>   - exit file area.  If changes have been made, you will be asked
  260.                     if you want to save them.
  261.     <Alt-H>    - On-line help.
  262.     A       - checks download directory for any files not in SFFILES.BBS.
  263.                     If found you will be asked if you want to add them to 
  264.                     SFFILES.BBS.  If you select yes, the edit screen will appear.
  265.                     After you are done editing, the file will be added to the
  266.                     end of the list. <SEE ALSO: E - edit file description>
  267.                 You may delete the file by pressing 'd' at the add prompt.
  268.                 NOTE: SFFILES.BBS, SFFILES.BAK and SFFILES.OLD are skipped.
  269.     C       - will copy the file under the cursor to any drive/directory.
  270.                     Do not use this to move a file to another file area. That 
  271.                     should be done using the Move command.
  272.     Alt-C   - will copy all tagged files to any drive/directory.
  273.     D       - will delete the file under the cursor from both SFFILES.BBS
  274.                     and from the disk.  You will be asked to confirm the delete.
  275.     Alt-D   - will  delete all tagged files from both SFFILES.BBS and from
  276.                     the disk.  You will be asked to confirm each delete.
  277.     E       - Edit file description.  This will allow you to change the
  278.                     File name, file size, file date, and file description of the
  279.                     file under the cursor.
  280.                     
  281.                     EDIT KEYS
  282.                     ---------
  283.                     CTRL-L-ARROW: Go to previous word
  284.                     CTRL-R-ARROW: Go to next word
  285.                     HOME: Beginning of field
  286.                     END: End of field
  287.                     DOWN/UP ARROW: Next/Previous field
  288.                     R-ARROW/L-ARROW: Move cursor right/left one position
  289.                     INS: Insert space at current cursor position
  290.                     DEL: Delete character at current cursor position
  291.                     ESC: Exits, and if anything has changed, prompts you to save
  292.                     changes.
  293.     F       - Use the file_id.diz in this file for the description. The
  294.                     editing window will be brought up.
  295.     Alt-F   - Use the file_id.diz in the tagged files for the description.
  296.     H       - Create a header for this area.
  297.     K       - mark this file with current or actual file date.
  298.     Alt-K   - mark all tagged files with current or actual file date.
  299.     M       - move file under cursor to new file area.  The file on disk
  300.                     and in the SFFILES.BBS will be moved to the new file area.
  301.                     The file will be added in sort order to the new SFFILES.BBS.
  302.                     If the new SFFILES.BBS does not exist, you will be asked if
  303.                     you want to create it.
  304.     Alt-M   - move tagged files to new file area.  The files on disk and
  305.                     in the SFFILES.BBS will be moved to the new file area and
  306.                     added in sort order to the new SFFILES.BBS. If the new 
  307.                     SFFILES.BBS does not exist, you will be asked if you want to
  308.                     create it.
  309.     N       - rename the file. This will rename both the file in SFFILES.BBS
  310.                     and the file on disk.
  311.     O       - move files offline. This will move the file to the selected
  312.                     drive/directory. OFFLINE will be marked( right justified ) in
  313.                     the file size field.
  314.     Alt-O   - move tagged files offline.  This will moved the tagged files
  315.                     to the selected drive/directory. OFFLINE will be marked
  316.                     ( right justified ) in the file size field.
  317.     R       - remove file from SFFILES.BBS.  This will NOT delete the file 
  318.                     from disk.  This is handy if you want to have a file
  319.                     for download, but not let everyone know about it.  You will
  320.                     be asked to confirm the removal.
  321.     Alt-R   - remove tagged files.  This will NOT delete the files from 
  322.                     disk.  You will be asked to confirm each removal.
  323.     S       - sort files.  This will sort the files in the current file
  324.                     area by File name or File date( asending or desending).
  325.     T       - text search.  This will search all files and descriptions
  326.                     in the area for a text string.  Case does not matter.
  327.     V       - verify file sizes and file exists.  If the file size of the
  328.                     actual file is different that the size in SFFILES.BBS, the
  329.                     size in SFFILES.BBS will be automatically updated.  If a file
  330.                     is in SFFILES.BBS, but not on disk, you will be asked if you
  331.                     want to remove the file from SFFILES.BBS.  The prompt will
  332.                     display the filename, file size, file date, and first line
  333.                     of the description.  If a file is OFFLINE, press 'O' and the 
  334.                     file will be marked offline.
  335.     X       - Xtra Options. This will switch between the two option screens.
  336.                     All options are available no matter which screen is showing.
  337.     Ctrl-D  - run DOS program. This will bring up a menu of up to 10 
  338.                     external program to run. For more information, see the 
  339.                     configuration information above. SF-FAM swaps almost
  340.                     completely out of memory on this option.
  341.     F1-F10  - This immediately run one of the DOS programs above.
  342.                     Alt-F1 is the first program, Alt-F2 is the second, etc.
  343.     Alt F1-
  344.     Alt F10 - Run external programs on tagged files.
  345.     Ctrl-S  - save SFFILES.BBS. This does not exit the file area.
  346.  
  347. -----------
  348. NOTES:
  349.     Anytime changes are made to the file area, you will be asked if you 
  350.     want to save SFFILES.BBS before exiting.  If you made a big mistake,
  351.     don't worry about it.
  352.  
  353.     There are some exceptions, however:
  354.         
  355.         If you move a file, the file on disk is moved immediately, and the
  356.         SFFILES.BBS in the new file area is updated immediately.  The 
  357.         current SFFILES.BBS is not updated until you use CTRL-S, or exit
  358.         the area.
  359.  
  360.         If you delete a file, the file on disk is deleted immediately, but
  361.         again, the SFFILES.BBS will not be updated until you save it.
  362.         If you rename a file, it will be renamed immediately on disk.
  363.  
  364. FILE AREA EDITOR
  365. ================
  366. This editor is almost an exact copy of the editor in Spitfire. 
  367. The only difference is the BBS directory can be changed. Great for
  368. sub-boards.
  369.  
  370.     For details, please see the section "CONFIGURING FILE AREA RECORDS"
  371.     in your Spitfire manual.
  372.  
  373. MEMORY NOTES
  374. ============
  375. When shelling to DOS, SF-FAM uses Ralf Brown's SPAWNO utility to swap almost
  376. completely out of memory.
  377.  
  378. COPYRIGHT INFORMATION
  379. =====================
  380. Spitfire is Copyright Buffalo Creek Software, 1987-1993
  381. SPAWNO is Copyright Ralf Brown, 1992
  382. Registration Key System for C Programmers is Copyright Brian Pirie, 1992
  383. SFFAM is Copyright David Pontius 1993-1996
  384.