Beijing Paradise BBS Backup

home *** CD-ROM | disk | FTP | other *** search

/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / VFAM116.ZIP / VFAM.DOC < prev next >

Wrap

Text File | 1992-05-02 | 119.1 KB | 3,040 lines

▄ ▄▄ ▄▄ ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄ █ ██ ██ █ █ ██ ██ ▄▄▄▄▄ ▄▄▄▄ ▄▄▄▄ ▄▄▄ █ VersaFAM File Area Manager █ ██ ██ █▀▀▀▀ █▀▀██ █▀▀▀▀ █▀▀██ █ for Maximus <tm> and other █ ██▄ ▄██ █▄▄ █ ██ █▄▄▄ █▄▄██ █ Bulletin Board systems █ ██ ██ █▀▀ █▀██▀ ▀███ █▀▀██ █ █ ████ █▄▄▄▄ █ █▄ ▄▄███ █ ██ █ Written by: Bill Auclair █ ▀▀ ▀▀▀▀▀ ▀ ▀▀ ▀▀▀▀ ▀ ▀▀ █ FidoNet node # 1:141/545 █ ▄▄▄▄▄▄▄▄▄ ▄▄▄▄▄▄▄ ▄▄▄ ▄▄▄ █ Copyright 1992 by XanSoft █ ███▀▀▀▀▀▀ ███▀▀▀███ ████▄ ▄████ █ ALL RIGHTS RESERVED █ ███ ███ ███ ███▀█▄▄█▀███ █ █ ███▄▄▄ ███▄▄▄███ ███ ██ ███ █ Disk/EMS swapping routines █ ███▀▀▀ ███▀▀▀███ ███ ▀▀ ███ █ (C) 1988 TurboPower Software █ ███ ███ ███ ███ ███ █ █ ███ ███ ███ ███ ███ █ **************************** █ ███ ███ ███ ███ ███ █ V e r s i o n 1 . 1 6 █ █ **************************** ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀ VersaFAM File Area Manager - 1 - Version 1.16 Document outline and table of contents -------------------------------------- I. General Information a. Basic functions ................................... 3 b. External functions ................................ 3 c. Advanced functions ................................ 4 II. Setup a. Installing and configuring VersaFAM ............... 6 b. Configuration file verbs .......................... 8 III. Operation a. Starting VersaFAM ................................. 19 b. HELP screens ...................................... 20 c. 1st-level menu commands ........................... 20 d. 1st-level keystroke commands ...................... 24 e. 2nd-level menu commands ........................... 26 f. 2nd-level keystroke commands ...................... 33 g. 3rd-level menu commands ........................... 39 h. 3rd-level keystroke commands ...................... 42 i. The VersaFAM text editor .......................... 43 j. Using text templates .............................. 49 k. Using PINPOINT .................................... 50 l. Editing VFAM.DAT .................................. 50 m. Running VersaFAM remotely ......................... 51 IV. Reference a. VersaFAM utilities ................................ 52 b. Credits and copyrights ............................ 53 c. Registration ...................................... 53 d. About XanSoft Development ......................... 54 e. Appendix A: Menu and keystroke commands ........... 55 f. Appendix B: Color configuration codes ............. 56 g. Appendix C: OEC text/background color codes ....... 57 h. Appendix D: External function symbol codes ........ 58 i. Appendix E: Configuration file verbs .............. 59 j. Appendix F: Limits and defaults ................... 60 VersaFAM File Area Manager - 2 - Version 1.16 Disclaimer ---------- This software is provided "as is", without warranty of any kind, either expressed or implied, including but not limited to implied warranties of merchantability and fitness for a particular purpose. You are advised to use this program at your own risk. XanSoft Development, Inc. and/or Bill Auclair shall not be held liable for any damages, including lost data, lost profits, lost monies or other special, incidental or consequential damages arising from the use or inability to use VersaFAM. The VersaFAM program package may be freely distributed, providing the contents of the archive are kept intact, and the executable files are not modified in any way. Packing list ------------ Files included in the VFAM archive: VFAM.DOC The documentation you're reading FILEX.DOC FILEX program documentation REGISTER.DOC VFAM registration information VFAM.EXE The VersaFAM executable file VFAM.OVR Overlay file for VFAM.EXE FILEX.EXE The FILEX file update utility, v1.14 CBFSORT.EXE The CBFSORT listfile sort utility, v1.04 OEC2VFAM.EXE Converts OEC files to VersaFAM format, v1.02 VFADD.EXE The VFADD path import utility, v1.01 VFAM.DAT Sample VersaFAM configuration file VFAM.ICO Icon file for use with Windows 3.x FILEX.DAT Sample FILEX configuration file *.HDR Sample header files *.TPL Sample text template files GETVFAM.BAT A sample DOORWAY<tm> batch file GETVFAM.MNU A sample DOORWAY<tm> password file Compiler information -------------------- VersaFAM was written in Pascal with object extensions, and compiled using Borland International's Turbo Pascal 5.0 compiler. LZEXE file compressor --------------------- All executable files within the VersaFAM archive have been compacted using the LZEXE compression utility written by Fabrice Bellard. This results in as much as 60% reduction in file size, without any measurable degradation in performance. VersaFAM File Area Manager - 3 - Version 1.16 General description ------------------- VersaFAM is a file area manager for Maximus BBS and other compatible bulletin board systems using the FILES.BBS file listing format. VersaFAM was designed to optimize the efficiency of file management through the use of scrolling windows, single-keystroke commands and virtual screen data input, allowing sysops to manage file areas through the use of one integrated program, rather than several individual utilities. VersaFAM will support up to 256 separate file areas, with a maximum of 1024 text/file lines in each area. Each line can contain up to 127 characters, including OEC color control codes. Basic functions --------------- Used as a basic file area manager, VersaFAM can be used to hurl files and text from one file area to another, within and across drive partitions, with automatic update of list file contents in source and target subdirectories. Files may be duped (copied) to any valid directory. Files and descriptions can be erased from any subdirectory. Any of the above operations can be carried out on multiple files through use of the MARK function. File description information can be rearranged within a file area, either one line at a time, or in blocks in conjunction with the MARK function. File descriptions can be edited, files themselves can be renamed. All file lines within a file listing can be sorted alphabetically, while leaving text lines undisturbed. New files can be automatically adopted into file areas. A context-sensitive DOS shell has even been provided to allow single-keystroke entry to DOS subdirectories. External functions ------------------ External programs may be executed within VersaFAM, which will swap itself to disk or EMS (if available), and pass control to the called program. When the external program finishes its work, it will terminate and pass control back to VersaFAM. Some external routines have been "hard-coded" into VFAM-- the INDEX, PROBE, PACK, UNPACK and TEXT commands are examples of this. Up to ten additional external program calls may be specified by using the EXTFUNCxx verbs in the VFAM.DAT configuration file. Information on file names and paths at the current cursor position may be passed to external functions, to target these functions to specific files. An almost endless variety of graphics file viewers, virus detection programs, etc. can be set up for almost instant viewing or processing of any file in any file area. VersaFAM File Area Manager - 4 - Version 1.16 OEC text editor --------------- The VersaFAM text editor supports a subset of the OEC codes used to control text and background colors when file lists are displayed. Users can add, change, insert and delete file names, descriptions or text lines as desired. OEC text encode/decode can be toggled ON or OFF, depending on whether the user's setup supports it. Text templates -------------- Up to ten text "template" files may be defined for easy insertion anywhere within the body of a file list. This saves sysops the effort of having to create often-used text and graphics (such as area headings, special notes and bounding boxes) from scratch each time they are needed. User-configurable colors ------------------------ VersaFAM menus are almost totally color-customizable. Color values for blurb, border, highlights, error messages, directories, quantities, descriptions, non-OEC text and marked files can be specified in VFAM.DAT. PINPOINT and LOCATE ------------------- The PINPOINT and LOCATE functions are used to find text string information. PINPOINT makes it easy to find a specific directory on the 1st menu level, or when HURLing files to another directory. The LOCATE function is used to find filenames and/or description information from the 1st and 2nd menu levels. Archive utility support ----------------------- Full archive utility support is "hard-coded" into VersaFAM. Files archived in ARC, ARJ, LZH (old and new), PAK and ZIP formats can be viewed, extracted, edited and even updated using a few keystrokes. Archived text files can be viewed just as easily, using your favorite editor. VersaFAM File Area Manager - 5 - Version 1.16 Editing configuration file -------------------------- The VFAM.DAT configuration file can be edited from within VersaFAM by selecting the "EDIT VFAM.DAT" option on the 1st menu level. The configuration file is automatically re-read after editing, to implement any additions, deletions or changes made. CD-ROM support -------------- VersaFAM has the ability to store file listings in a directory other than where the listed files are physically located. This kind of functionality is needed when maintaining CD-ROM file areas, which cannot be written to. Multiple file lists may be stored within the same subdirectory, making for easy maintenance of file areas based on CD-ROM, WORM or other "read-only" technology. Disk free space indicator ------------------------- Disk free space can now be displayed for all drives through use of the F)ree function on 1st and 2nd-level menus. This functionality has been tested and found to work in multiple-drive environments like those found in networked systems. New files indicator ------------------- VFAM will flag any areas that have received new file entries, through use of the N)ew command on the 1st-level menu. This eliminates unnecessary entry and inspection of areas that do not contain new files. Memory-swapping routines ------------------------ VersaFAM makes use of special memory-swapping routines developed by Kim Kokkonen of TurboPower Software. When executing the OS shell or any of the external program functions, most of VersaFAM is intelligently swapped out to EMS or disk, leaving more memory to use while within the shell or external program. VersaFAM File Area Manager - 6 - Version 1.16 EMS memory usage ---------------- While VersaFAM will work perfectly well without expanded memory, it is recommended that approximately 150-175K of EMS memory be available for use. VersaFAM will operate much faster if it is able to swap to EMS, rather than to a slower hard disk drive. A compromise might be to specify a RAM disk as the Swap directory in the VFAM.DAT file. SHARE support ------------- DOS file sharing and locking is supported for all VFAM operations. VersaFAM will generate an error message if a list or other file it attempts to open is being written to by another application. Remote operation ---------------- VersaFAM can be run remotely, in conjunction with Marshall Dudley's DOORWAY<tm> program, or similar I/O redirection utilities. All local keyboard operations, including extended-keycode ALT, CTRL, SHIFT and function key combinations are fully supported in remote mode. Installing and configuring VFAM ------------------------------- Before using VersaFAM, copy the following files to a suitable subdirectory: VFAM.EXE- The VersaFAM executable file. VFAM.OVR- The VersaFAM overlay file. VFAM.DAT- The VersaFAM configuration file. FILEX.EXE- The FILEX file area update utility CBFSORT.EXE- The CBFSORT file area sort utility It is recommended that the subdirectory these files are placed in be included in the DOS path, so they are available at all times. VersaFAM File Area Manager - 7 - Version 1.16 The VFAM environmental variable ------------------------------- VersaFAM depends upon the use of a DOS environmental variable to maximize the ease of navigation through different drives and directories on your system. To create the VFAM environmental variable, add the following line to your AUTOEXEC.BAT file: SET VFAM=d:\path where d:\path is the drive and subdirectory in which the configuration file VFAM.DAT is located. VersaFAM will then always be able to find its configuration file, no matter where it is executed from. If the VFAM environmental variable is not present, VersaFAM will look for VFAM.DAT in the current directory. If a configuration file is not found, VersaFAM will terminate with an error message. VersaFAM command-line switches ------------------------------ The VersaFAM program can be executed from the DOS prompt using optional command-line switches, as in the following example: VFAM /M Two switch options are available: The /R switch specifies that VFAM is to be run remotely. For more information, see the section titled "Running VersaFAM Remotely". The /M switch provides special compilation and memory usage information after VFAM is exited. The VFAM.DAT configuration file ------------------------------- VFAM.DAT is the name of the ASCII text file that tells VersaFAM which program options have been chosen, and where file areas are located. VersaFAM cannot run without VFAM.DAT. VFAM.DAT should be edited to reflect your system's parameters. A simple text editor can be used for this purpose, or VersaFAM's own text editor may be used. If using an external editor, do not use fancy word processing programs to edit VFAM.DAT, as the extra codes they add may lead to unpredictable results when executing VersaFAM. VersaFAM File Area Manager - 8 - Version 1.16 Configuration file verbs ------------------------ Configuration verbs control the state of VersaFAM's various program options, and indicate where file area information can be found. Any text placed after a semicolon (;) is considered a comment, and is ignored when the configuration file is read. Configuration verbs can be commented out by placing a semicolon before them, as shown in the example below: ;Verb Comments, instructions and other information may be freely added to the VFAM.DAT file, as long as they are preceded by a semicolon. To activate an inactive verb, remove the semicolon preceding it. The following is a list of valid configuration file verbs, their parameters (if any), and a detailed explanation of their functions. NOTE: Angle brackets <> indicate that use of the enclosed parameter is mandatory, while hard brackets [] mean use of the enclosed parameter is optional. Backup <filename.ext> --------------------- Description- Allows the contents of a file list to be copied to another file in the same directory. Parameters- <filename.ext> specifies the name of the file to copy to. This information will be used in all read/write file areas. For read-only file areas, the name of the list file will automatically be used, with a .BAK extension. Comments- Backup can be used when experimenting with new software that might corrupt original list files, or before making any major changes to list file contents. Maximum length of <filename.ext> is 12 characters. VersaFAM File Area Manager - 9 - Version 1.16 BIOS ---- Description- Chooses slower, BIOS-based method of screen display, rather than the default direct screen writes. Comments- Use the BIOS verb if you are running a multitasker and having problems with screens "bleeding" from one partition to another. BIOS writes are significantly slower than direct writes, which may affect program performance negatively. BIOS writes are automatically used when operating VFAM remotely, regardless of whether the BIOS verb is used. Color <1> <2> <3> <4> <5> <6> <7> <8> <9> ----------------------------------------- Description- Allows configuration of text colors for various parts of the VersaFAM program. Parameters- Color parameters are entered as numbers. Valid color values range from 0 to 15, using the following key: 0 Black 8 Dark Gray 1 Blue 9 Light Blue 2 Green 10 Light Green 3 Cyan 11 Light Cyan 4 Red 12 Light Red 5 Magenta 13 Light Magenta 6 Brown 14 Yellow 7 Light Gray 15 White Color assignments to different program menus and functions depend on the order of parameters on the Color line: Parameter Affects -------------------------------------------------- 1 1st-level blurb 2 border 3 highlights 4 errors/warnings 5 1st-level directories 6 1st-level quantities (K) 7 1st-level descriptions 8 non-OEC (default) list text 9 marked text Comments- Colors will assume default values unless all 9 parameters are specified on the Color line. Color values may be used more than once. Text can be made to blink by adding 128 to the color value. VersaFAM File Area Manager - 10 - Version 1.16 ConvertList <filename.ext> -------------------------- Description- Specifies an optional utility to be used to convert FILES.BBS to another format. Leave commented if you work exclusively with a FILES.BBS-style list format. Parameters- <filename.ext> can be no more than 12 characters long, and should specify a program located on the DOS path. Comments- ConvertList is provided so 3rd-party developers can create routines to convert FILES.BBS to whatever unique format their BBS software requires. The current file list directory is passed as a parameter to the called utility, with all screen output directed to NUL. The ConvertList routine is called any time the FILES.BBS file is saved. DOSPassword <password> ---------------------- Description- Specifies the password to be used to gain access to DOS when operating VersaFAM remotely. Parameters- <password> is the actual text string to be used as a password. Comments- Passwords can be up to 15 characters long, and can contain spaces, punctuation and special characters. WARNING! If a password is not specified, remote access to DOS will be granted unconditionally! Editor <filename [.ext]> ------------------------ Description- Specifies a utility to be used to display or edit files at the current cursor position, using the T)ext command at the 2nd and 3rd menu levels. Parameters- The filename of the utility to be used *must* appear on the Editor line. Comments- The utility chosen must be available via the DOS path. The utility should be one in which the name of the target file can be specified as a parameter on the command line, as this data is passed to the program by VFAM. If an editor is not specified, Vernon Buerg's LIST<tm> utility is called by default. Maximum length of the Editor parameter is 12 characters. For related information, see the section on the RepackEditFile verb. VersaFAM File Area Manager - 11 - Version 1.16 ExtFuncxx <[d:\path\]filename[.ext]> [parameters] ------------------------------------------------- Description- Allows definition of full path and program information for external program functions. Parameters- xx denotes the external function number, from 1 to 10. Drive, path and extension information can optionally be specified, if the program is not located on the DOS path. Parameters used by the external program may also be included on the ExtFuncxx line. VersaFAM supports use of the following special characters, which pass information on the file at the cursor position to the ExtFuncxx line: @ = d:\path\filename.ext # = d:\path $ = filename.ext & = filename ^ = .ext An example ExtFuncxx line is shown below: ExtFunc1 d:\bbs\gronk.exe @ -L The example above executes the file GRONK.EXE in the D:\BBS directory, passing it drive, path, filename and extension information on the file at the current cursor position. The line ends with a "-L" command-line switch, presumably also used by the GRONK utility. Comments- NOTE: support for the "{" comment character has been removed from the VersaFAM external function screen. If you wish to see comments for external function entries, use the EDIT VFAM.DAT option to display the configuration file contents. Maximum length of ExtFunc parameters is 80 characters. InfoFile <d:\path\filename.ext> ------------------------------- Description- Full drive, path, filename and extension information for the file to be optionally added as an advertisement or "information" file to archives. Parameters- Full drive, path and file information must be specified on the InfoFile line. Comments- Maximum length of InfoFile parameters is 40 characters. VersaFAM File Area Manager - 12 - Version 1.16 ListFile <list filename> ------------------------ Description- The name of the file containing file list information. Parameters- The list file name is usually FILES.BBS, but may be specified as necessary. Comments- No drive/path information is required. This information is not used for "read-only" file areas, which obtain list filenames via the SysDir callouts for each area. Maximum length of <list filename> is 12 characters. ListHdr <d:\path\filename.ext> ------------------------------ Description- Full drive, path, filename and extension information describing the file to be used as a "header" file for each file area. Parameters- Full drive, path and file information must be specified on the ListHdr line. Comments- When creating a new file area, or if the file list for an area cannot be found, the file pointed to by the ListHdr verb is automatically appended to the beginning of the file list. The list file header can also optionally be inserted anywhere within the file list by pressing ALT/H at the 2nd-level menu. Maximum length of ListHdr parameters is 40 characters. NoEMS ----- Description- Tells VFAM not to use expanded (EMS) memory, even if it is available. Parameters- None. Comments- Use NoEMS when running other applications that use EMS memory, to eliminate contention between programs. This will force all swap operations (external program calls, OS shells, etc.) to swap to disk, which is much slower. Leave this verb commented "out", if possible. VersaFAM File Area Manager - 13 - Version 1.16 NoOEC ----- Description- Tells VFAM to turn off OEC color encode/decode functions. Parameters- None. Comments- Use NoOEC when running BBS software that does not support OEC background and text color codes. Text will then be displayed in the color chosen for "Non-OEC text" in the Color line of the VFAM.DAT file. OEC encode/decode can also be toggled by pressing CTRL/O at the 2nd menu level. OrphanDesc <text> ----------------- Description- Specifies the descriptive string to be appended to all orphan files detected by the PROBE command at the 1st menu level. PROBE utilizes an external program call to the FILEX file update utility. Parameters- <text> is passed to the FILEX command line for execution. Text information can include special FILEX codes for text and background colors, system times, days, dates, and other special features. Read the FILEX documentation for more information on features available. An example OrphanDesc line is shown below: OrphanDesc [14]Adopted_on_[DAY]_[DATE],_no_info_available This generates a line including the day and date of the adoption, displayed in yellow text on a black background. Comments- Note that the underscore (_) character must be used to simulate spaces between words. FILEX will filter this character out when executing the adoption request. Maximum length of <text> is 65 characters. VersaFAM File Area Manager - 14 - Version 1.16 Packer <filename> ----------------- Description- Specifies the utility to be used to compress DOS files. Parameters- <filename> is the name of the archiver to be used. The following are valid archiver choices: ARCA ARJ PAK PKZIP LHARC LHA LHSFX Comments- If a packer is not specified, ARCA is used by default. The specified utility must be available via the DOS path. Maximum length of <filename> is 8 characters. The LHSFX packer creates self-extracting (.EXE) archives, and can only be used on files previously archived with the LHA or LHARC archivers. RepackEditFile -------------- Description- Enables updating of archive files with new information after an editing operation has been performed using the V)iew and T)ext commands on the 2nd and 3rd menu levels. Parameters- None. Comments- Use of RepackEditFile assumes that an actual text *editor*, rather than a list utility, has been previously assigned to the Editor verb. This option can add considerable time to the editing process, and should be used only when necessary. Due to the limitations of the ARCA archiver, updating of ARCed files is not supported. Sound ----- Enables audible tones when certain VFAM functions are activated. Parameters- None. Comments- Leave this line commented if you don't want VersaFAM to beep when entering text edit mode, when renaming files, when missing files are encountered, when long file lines are found, or when certain program errors are detected. VersaFAM File Area Manager - 15 - Version 1.16 StatusLog <d:\path\filename.ext> -------------------------------- Description- Specifies the full drive, path, filename and extension of the file to be used to log VersaFAM operations. Parameters- Full drive, path and information must be specified on the StatusLog line. Comments- If the specified file exists, it is appended. If the file does not exist, it is created. If the path, filename or extension are invalid, VersaFAM aborts with an error message. If the StatusLog verb is left commented, no log is generated. Maximum length of StatusLog parameters is 40 characters. SwapDir <d:\path> ----------------- Description- Full drive and path information pointing to the place where VFAM's swap file (VFAM.$$$) will be stored during swapping operations. Parameters- Full drive and path information must be specified on the SwapDir line. Comments- If SwapDir is not specified, the location of the swap file defaults to the location specified by the VFAM environmental variable, or to the current directory. SwapDir is ignored if EMS memory is available for use during swapping operations. Maximum length of <d:\path> is 40 characters. NOTE: The area defined by SwapDir is also used as a temporary storage area for files during V)iew operations. VersaFAM File Area Manager - 16 - Version 1.16 SysDir<[list dir] <file dir> [!area description] ------------------------------------------------ Description- Information defining file areas, optional alternative list files and optional file area descriptions. Parameters- [list dir] specifies the full drive, path and filename information for a list file located in a directory other than where the physical files it describes are stored. <file dir> defines drive and path information for each area where files are located. [!area description] indicates the text description to be associated with the file area on 1st and 2nd menu levels. An example SysDir line for a "read/write" file area: SysDir c:\bbs\file\xanadu !XanSoft Development Files The line above directs VersaFAM to look for a list file and physical files in the directory C:\BBS\FILE\XANADU, and assigns the description "XanSoft Development Files" to the file area. An example SysDir line for a "read-only" file area: SysDir c:\cdrom\file1.bbs g:\xrated !X-Rated Files The line above tells VFAM that physical files for this area are located in the directory G:\XRATED (on a CD-ROM drive), while the list file for this area (FILE1.BBS) is located in hard disk directory C:\CDROM. The file area is assigned the title of "X-Rated Files". Comments- [list dir] should only be used when defining "read-only" file areas, such as those found on CD-ROM drives. Multiple list files for "read-only" areas can co-exist within the same directory, as long as they are named uniquely. Check to make sure your BBS software supports this functionality. File areas defined as "read-only" will disable certain operations (such as ERASE) that would attempt to write to or change the contents of the files in that area. <file dir> will utilize the information specified for the ListFile verb to point to a list file name in the directory where the physical files are located, providing [list dir] is not also specified. Using <file dir> without [list dir] makes a file area "read/write" capable, which is VersaFAM's default operating mode. All commands and functions are available in this mode. VersaFAM File Area Manager - 17 - Version 1.16 [!area description] assigns an optional text description to the file area in question. This description can be seen on 1st and 2nd level menus. NOTE: An exclamation mark (!) must precede the description, so that the SysDir line may be properly recognized and parsed by VersaFAM. A trailing backslash (\) is not required when specifying list directory or file directory information. Maximum length of SysDir parameters is 127 characters. Templatexx <d:\path\filename.ext> --------------------------------- Description- Describes the full drive, path, filename and extension information for files to be used as text templates. Parameters- xx denotes the text template number, from 1 to 10. Full drive, path, filename and extension information must be specified on the Templatexx line. Comments- Templates can be inserted anywhere within a list file by pressing CTRL/F1 through CTRL/F10 at the 2nd-level menu, depending on the template to be used. A maximum of 10 template files may be defined. Maximum length of Templatexx parameters is 80 characters. TextFlag <character> -------------------- Description- The identity of the ASCII character to use when padding the first column of a NON-FILE text line in text edit mode. Parameters- For a complete listing of characters acceptable for text padding operations, see the section titled "Approved characters". Comments- Text padding is done so BBS software won't try to interpret text-only lines as file information. If TextFlag is not specified, the default is "SPACE" (which VFAM translates to the ASCII 32 space character). Maximum length of TextFlag parameters is 5 characters. VersaFAM File Area Manager - 18 - Version 1.16 UnarcDir <d:\path> ------------------ Description- Specifies the full drive and path information for the directory to UNPACK files to. Parameters- Full drive and path information must be specified on the UnarcDir line. Comments- A trailing backslash (\) is not required when specifying drive/path information. Maximum length of <d:\path> is 40 characters. ZapDir <d:\path> ---------------- Description- Defines full drive and path information for the directory to be used as a ZAP directory (that is, an area where old, obsolete files are stored prior to archiving or deleting). Parameters- Full drive and path information must be specified on the ZapDir command line. Comments- The ZAP directory is automatically appended to the list of file areas on the 1st menu level. A trailing backslash (\) is not required. Maximum length of <d:\path> is 40 characters. VersaFAM File Area Manager - 19 - Version 1.16 Starting VersaFAM ----------------- VersaFAM is executed from the DOS command prompt by typing VFAM and pressing the ENTER key. This brings up the 1st-level menu. If the VFAM.DAT file has been configured correctly, you should see something like this: List File: Files.Bbs VersaFAM File Area Manager v1.16 ZAP Area: C:\Bbs\File\Zap by Bill Auclair, FidoNet 1:141/545.0 U n r e g i s t e r e d C o p y (C)1992 XanSoft. All Rights Reserved D i r e c t o r y I n f o A r e a D e s c r i p t i o n s C:\Bbs\File\Game Games C:\Bbs\File\Maxtoonz Tune files for Maximus BBS C:\Bbs\File\Mon Video drivers C:\Bbs\File\News Newsletters and text files C:\Bbs\File\Nodediff FidoNet nodediff updates C:\Bbs\File\Template VFAM text templates C:\Bbs\File\Virus Anti-virus files C:\Bbs\File\Zap For files to be deleted soon EDIT VFAM.DAT Change the VFAM configuration file Zap Backup Locate Index Probe OS Free New Quit Use cursor keys to change areas, or <space bar> to PINPOINT an area List File is the list file name as defined for the ListFile verb, or as taken from the SysDir line if the current area has been defined as "read-only". ZAP Area is the filename as defined for the ZapDir verb. The paths listed under Directory Info and the text listed under Descriptions are the current file area entries listed in VFAM.DAT. Edit the SysDir entries in VFAM.DAT to reflect your own setup. This can be done using an external text editor, or by moving the cursor highlight to EDIT VFAM.DAT on the 1st-level menu and pressing the ENTER key. Read the section titled "Editing VFAM.DAT" for more information on how to edit within VFAM. Menu commands for the 1st level are displayed at the bottom of the screen. VersaFAM File Area Manager - 20 - Version 1.16 Help screens ------------ Detailed help screens are available to the novice VersaFAM user by pressing the F1, F2 or F3 function keys anywhere within the program except the text editor. The F1 help screen lists undocumented keystroke commands not displayed on menu screens. The F2 help screen lists current external program assignments (if any) defined by the ExtFuncxx verbs in VFAM.DAT. The F3 help screen displays current text template assignments (if any) defined by the Templatexx verbs in VFAM.DAT. 1st-level menu commands ----------------------- First level menu commands are usually oriented more towards entire file areas than to specific filenames. System and general-purpose commands are also found on this menu level. Each command can be activated by typing its (highlighted) first letter on the keyboard. Backup ------ Description- The Backup command copies the list file in the current directory to another file in the same directory whose filename is specified by the Backup verb in VFAM.DAT. Parameters- None. Comments- Use Backup when experimenting with new programs that might corrupt file lists, or when making major modifications to file lists. Free ---- Description- Displays the amount of free disk space (in kilobytes) on every drive in your system. Parameters- None. Comments- The Free command can be used to check disk space availability when HURLing or COPYing files. Free supports up to 26 drive designations, and has been tested on a Novell Netware v3.11 local area network. Drives A and B (usually floppy disk drives) are excluded from Free operations. VersaFAM File Area Manager - 21 - Version 1.16 Index ----- Description- Alphanumerically sorts file information within file listings. Uses an external function call to the CBFSORT sorting utility. Parameters- Internal. Comments- All groupings and subgroupings of files within the list file are sorted. The position of text lines and descriptive headers is not changed. File lists of up to 1024 lines may be sorted in this manner. CBFSORT may also be used from DOS as a "stand-alone" sort utility. Locate <text> ------------- Description- Allows search and retrieval of filename or descriptive information within file lists. Parameters- <text> can be any ASCII character or combination of characters entered from the keyboard. Comments- LOCATE text searches are case-insensitive. If a text match is not found, the message "Match not found!" appears at the bottom of the 1st-level menu screen. If a text match is found, VersaFAM enters the 2nd-level menu and positions the highlight cursor at the line where the first match was found. NOTE: Searches are also position-sensitive. That is, any file area entries appearing above the cursor highlight on the 1st-level menu will NOT be searched! This functionality is provided to eliminate unnecessary re-searching of previous file areas when using LOCATE multiple times. VersaFAM File Area Manager - 22 - Version 1.16 New --- Description- Detects file areas to which new files have been added since the last time VersaFAM was used. Comments- VersaFAM uses list file size, rather than file dates, to determine if an area has been added to. This method was chosen to maintain compatibility with "true-date" archive datestamp adjusters like XanSoft's TIA, which might tend to sabotage the accuracy of new file indications using the date stamp method. To detect new files, VersaFAM creates a file named FILES.VFM in each file area. FILES.VFM contains information on the size of the file list when VersaFAM was last active. When the N)ew command is executed on the 1st menu level, VersaFAM gets the current size of each area's file list, and compares this with the value stored in FILES.VFM. If the current value is more than one byte larger than the FILES.VFM value, the area is flagged as having new files in it. An asterisk (*) is displayed in the kilobyte (K) counter column of the 1st menu level to indicate "new files" status. The FILES.VFM file is updated: 1. whenever a file list previously flagged as having new files is entered (2nd menu level). 2. whenever a file list is edited using the text editor. 3. whenever the contents of the list file are otherwise modified, such as during file ERASE or text DELete operations. When HURLing files from one file area to another, the FILES.VFM file in the target directory is NOT updated. This allows N)ew to be used after HURLing operations to provide a "New files" indication for any directories receiving newly-hurled files, allowing them to be identified for further processing. OS [remote password] -------------------- Description- Executes a DOS shell to whatever directory is highlighted on the 1st-level menu, or to the current directory at the 2nd or 3rd-level menus. Parameters- If operating remotely, users are first prompted for a password. Incorrect passwords force a return to whatever menu level OS was invoked from. No password is needed when operating locally. Comments- VersaFAM uses memory-swapping routines written by Kim Kokkonen of TurboPower Software. These routines maximize the amount of usable RAM in the shell by swapping most of VersaFAM to disk or EMS memory. Type "EXIT" and press the ENTER key to return to VersaFAM from the OS shell. VersaFAM File Area Manager - 23 - Version 1.16 Probe <filespec> ---------------- Description- Adopts orphan files using an external call to the FILEX file update utility. Parameters- <filespec> allows specification of the particular filenames and/or extensions to be adopted. The default is "*.*" (all files). Comments- FILEX is passed a command line by VersaFAM that instructs it to process any files in the current file area that meet the <filespec> criteria. If such files are found, their names are appended to the file list, along with the generic "adopted file" description defined for the OrphanDesc verb in VFAM.DAT. NOTE: Older versions of FILEX will no longer work properly with VersaFAM. For best results, make sure you are using the FILEX version supplied with this VFAM archive package. To make sure of this, run FILEX from DOS, without parameters. Newer versions of FILEX will identify the directory from which the program is being executed. The FILEX utility may also be executed as a stand-alone program from the DOS prompt. Quit ---- Description- Terminates the VersaFAM program and returns to the previous operating system or shell. Parameters- None. Comments- If a file area has been changed, its contents will automatically be saved before the Q)uit command is processed. Zap --- Description- Automatically erases all files in the directory referenced by the ZapDir verb in VFAM.DAT. Parameters- None. Comments- ZAP is a quick, easy way to remove old, obsolete files from the ZAP file area. The ZAP file list is updated, but any text or descriptive lines are left intact. VersaFAM File Area Manager - 24 - Version 1.16 1st-level key commands ---------------------- Because of limited space in menu displays, many of VersaFAM's available commands are referenced only in the HELP screens. Examples of this are the keystroke commands available throughout the program. Some commands require single keystrokes, while others specify double keystrokes. When a forward slash (/) is placed between two key references, it means that the first key should be held down while the other is pressed. The following keystroke commands are available at the 1st menu level: ALT/R ----- Description- This command zeroes the kilobyte (K) counters for all file areas at the 1st menu level. Parameters- None. Comments- ALT/R can be used to zero (K) counters prior to performing a N)ew files scan. (K) counter values will not be shown until after a file area has been entered (2nd menu level). Cursor keys ----------- Description- The cursor arrow keys, PgUp/PgDn keys, Home and End keys allow scrolling through the list of file areas at the 1st menu level. Parameters- None. Comments- Right and left arrow keys have no effect on the 1st menu level. Up and down arrow keys scroll up or down a line at a time. PgUp and PgDn keys scroll up or down a page at a time. Home scrolls to the top of the file area list, while End scrolls to the bottom of the list. ENTER ----- Description- The ENTER key allows access to the 2nd menu level. Parameters- None. Comments- The file list accessed depends on the position of the highlight cursor at the 1st menu level. VersaFAM File Area Manager - 25 - Version 1.16 F1 -- Description- Displays a program-wide listing of undocumented keystroke commands. Parameters- None. Comments- Help screens can be activated from 1st or 2nd menu levels. Press any key to return to the menu display. F2 -- Description- Displays a listing of current external function assignments, as defined by the ExtFuncxx verbs in VFAM.DAT. Parameters- None. Comments- Help screens can be activated from 1st or 2nd menu levels. Press any key to return to the menu display. F3 -- Description- Displays a listing of current text template assignments, as defined by the Templatexx verbs in VFAM.DAT. Parameters- None. Comments- Help screens can be activated from 1st or 2nd menu levels. Press any key to return to the menu display. VersaFAM File Area Manager - 26 - Version 1.16 2nd-level menu commands ----------------------- If the ENTER key is pressed while on a file area at the first menu level, the 2nd level display for that area is accessed. The 2nd-level display is the contents of the file list for the area, and should typically look something like this: List File: C:\Bbs\File\Xansoft\Files.Bbs Area Size: 1254285 Directory: C:\Bbs\File\Xansoft File Date: Area Name: XanSoft Development Ltd. files File Size: NON-FILE Work Area: C:\Test File Name: VersaFAM v1.16 ---------------------<INSERT>-------------------------------- Fine software products from XanSoft Development and Bill Auclair: ATL102.LZH Convert all archive types to LHARC FLX112.LZH FILEX file area update utility FROT200.LZH Randomly rotate BBS welcome screens and other files IPG.EXE Demo of XanSoft's Interactive Product Guide MID103.LZH BBSTunes add-on utility to identify mail connections MPI100.ZIP Message Packet Identifier, identifies Fido mail files PROCSIM.EXE Demo of XanSoft's procedural simulation products PSTUTOR.EXE How to use XanSoft's procedural simulations ------------------------------------------------------------[L1 ]-[C ] Erase Index Hurl Write Move Rename Dupe Locate View Text OS Pack Unpack Quit List File specifies the full drive, path and filename information for the current file list. Directory indicates the full drive and path information pointing to the current directory where files are located. Area Name gives a text description of the current file area. Work Area displays information previously specified in VFAM.DAT for the UnarcDir verb. Area Size shows the size (in bytes) of the current file area. File Date shows the date stamp of the file at the current cursor position. File Size shows the size (in bytes) of the file at the current cursor position. If the current line does not contain file information, File Size displays the label "NON-FILE". If the filename on the current line cannot be found in the DOS directory, File Size displays the label "MISSING". If a file line has previously been ERASEd, MARKed or HURLed, File Size displays the appropriate label. VersaFAM File Area Manager - 27 - Version 1.16 File Name shows the filename and extension of the file at the current cursor position. The counter boxes at the bottom right-hand corner of the display monitor file line information. The [L ] box displays the current line number of the file list being displayed. The [C ] box displays the current columnar position of the cursor during text editing operations. These boxes are updated with every cursor movement. Available menu commands are displayed at the bottom of the 2nd- level menu screen. Most 2nd-level menu commands are oriented toward specific filename or file description information within a file list. Each command can be activated by typing its (highlighted) first letter from the keyboard. The following menu commands are accessible at the 2nd menu level: Dupe <filename.ext> ------------------- Description- Copies a file to any valid subdirectory. Parameters- <filename.ext> is any valid DOS filename, 12 characters or less. Path information is not supported-- the file to be copied must exist within the current file area. Comments- The target directory does not have to be defined as a file area. D)upe does not update file list contents. If no files have been MARKed, the file at the current cursor position is copied. If one or more files has been MARKed, they are copied to the destination directory, regardless of cursor position. If the information for the file to be copied is in any way invalid, VersaFAM displays an error message and aborts the D)upe operation for that file. VersaFAM File Area Manager - 28 - Version 1.16 Erase <filename.ext> -------------------- Description- Erases a file from a file area. Parameters- <filename.ext> is any valid DOS filename, 12 characters or less. Comments- E)rase updates file list contents, removing all entries for the file(s) erased. If no files have been MARKed, the file at the current cursor position is erased. If one or more files has been MARKed, they are erased regardless of cursor position. If the file to be erased is missing or invalid in some way, VersaFAM displays an error message and aborts the E)rase operation for that file. Hurl <filename.ext> ------------------- Description- Transfers a file from the current file area to another file area. HURLing across drive partitions is supported. Parameters- <filename.ext> is any valid DOS filename, 12 characters or less. Comments- Both source and target directories must be defined as file areas using the SysDir verb in VFAM.DAT. H)url updates file list contents in both source and target file areas. If no files have been MARKed, the file at the current cursor position is HURLed. If one or more files have been marked, they are all HURLed to the target file area, regardless of cursor position. If the source and target directories are within the same drive partition, VersaFAM utilizes the DOS Rename function for fast file transfer. If source and target directories are on different drive partitions, VFAM uses a slightly less efficient "copy/verify/delete" methodology. VersaFAM File Area Manager - 29 - Version 1.16 Index ----- Description- Alphanumerically sorts file information within file listings. Uses an external function call to the CBFSORT sorting utility. Parameters- Internal. Comments- All groupings and subgroupings of files within the list file are sorted. The position of text lines and descriptive headers is not changed. File lists of up to 1024 lines may be sorted in this manner. CBFSORT may also be used from DOS as a "stand-alone" sort utility. Locate <text> ------------- Description- Allows search and retrieval of filename or description information within file lists. Parameters- <text> can be any ASCII character or combination of characters entered from the keyboard. Comments- LOCATE text searches are case-insensitive. If a text match is not found, the message "Match not found!" appears at the bottom of the 2nd-level menu screen. If a text match is found, VersaFAM positions the highlight cursor at the line where the first match was found. NOTE: Searches are also position-sensitive. That is, any file name entries appearing above the cursor highlight on the 2nd-level menu will NOT be searched! This functionality is provided to eliminate unnecessary re-searching of previous portions of the file list when using LOCATE multiple times. Move ---- Description- Allows relocation of file and text information within a file list. Parameters- None. Comments- If no files have been marked, the file line at the current cursor position is "picked up". The user is then prompted to move the cursor to the desired "put down" point within the file list. When a location is chosen, the ENTER key is pressed. The file line is erased from its previous position, to appear at the new location. If files have been previously MARKed, they are erased and "put down" in the order in which they are encountered in the file list. VersaFAM File Area Manager - 30 - Version 1.16 OS [remote password] -------------------- Description- Executes a DOS shell to whatever directory is highlighted on the 1st-level menu, or to the current directory at the 2nd or 3rd-level menus. Parameters- If operating remotely, users are first prompted for a password. Incorrect passwords force a return to whatever menu level OS was invoked from. No password is needed when operating locally. Comments- VersaFAM uses memory-swapping routines written by Kim Kokkonen of TurboPower Software. These routines maximize the amount of usable RAM in the shell by swapping most of VersaFAM to disk or EMS memory. Type "EXIT" and press the ENTER key to return to VersaFAM from the OS shell. Pack ---- Description- Compresses a file at the current cursor position, using an external archive utility. Parameters- <packer> is the name of the archive utility to be used to compress the file. If the Packer verb in VFAM.DAT has been defined, the default is that value. The Packer identity can also be toggled using the CTRL/A key command at the 2nd-level menu. Comments- The original, uncompressed file is deleted from the area directory, and replaced with the archived file. The file list is updated to reflect the change. Pack cannot (as of yet) be used with the MARK command. Quit ---- Description- Terminates the VersaFAM program and returns to the previous operating system or shell. Parameters- None. Comments- If a file area has been changed, its contents will automatically be saved before the Q)uit command is processed. VersaFAM File Area Manager - 31 - Version 1.16 Rename ------ Description- Allows renaming of a file at the DOS level. Parameters- None. Comments- The file list in the current file area is updated to reflect the filename change. Only the overstrike cursor may be used in this mode. If the new name is the same as the old, or is invalid in any way, VersaFAM displays an error message and aborts the R)ename operation. Text ---- Description- Allows the contents of a text file to be displayed at the 2nd or 3rd menu level. Parameters- None. Comments- The text file is displayed using the external list or editor utility defined by the Editor verb in the VFAM.DAT configuration file. The ENTER key also executes the T)ext function at the 3rd menu level. Unpack <unpacker> ----------------- Description- Decompresses an archived file at the current cursor position, using an external archive utility. Parameters- <unpacker> is the name of the archive utility to be used to decompress the file. The archive will be unpacked to the directory specified by the UnarcDir verb in VFAM.DAT. Comments- When used at the 2nd menu level, U)npack decompresses the contents of the entire archive to the work directory. Archive identification is automatic, regardless of the file extension used. When called from the 3rd menu level, U)npack extracts selected files from the archive. U)npack cannot (as of yet) be used with the MARK command. VersaFAM File Area Manager - 32 - Version 1.16 View ---- Description- Displays the contents of archive files. Parameters- None. Comments- The filenames that comprise the archive are displayed in a row and column format similar to that produced by the archive utilities used to P)ack and U)npack. Archive identification is automatic, regardless of file extensions used. V)iew will not work on NON-FILE lines, MISSING files, unarchived files, or files using a compression type different from those supported by VFAM. The ENTER key also executes the V)iew function at the 2nd menu level. Write ----- Description- Allows editing of text and file descriptions within a file list. Parameters- None. Comments- For more information on text editor operation, see the section titled "The VersaFAM Text Editor". VersaFAM File Area Manager - 33 - Version 1.16 2nd-level key commands ---------------------- Because of limited space in menu displays, many of VersaFAM's available commands are referenced only in the HELP screens. Examples of this are the keystroke commands available throughout the program. Some commands require single keystrokes, while others specify double keystrokes. When a forward slash (/) is placed between two key references, it means that the first key should be held down while the other is pressed. The following keystroke commands are available at the 2nd menu level: ALT/A ----- Description- Used to add an informational file to an archive at the current cursor position. Parameters- None. Comments- The path and filename of the informational file is that defined for the InfoFile verb in VFAM.DAT. ALT/C ----- Description- Copies the text line at the cursor position and inserts it above the original line. Parameters- None. Comments- This command can be used to create repetitive graphics (such as vertical lines for graphics boxes) easily, without having to define the graphics as a text template. Lines containing filename information can be copied in the same manner, if this is desired. VersaFAM File Area Manager - 34 - Version 1.16 ALT/F1 - F10 ------------ Description- This range of keystroke commands executes external program functions as defined for ExtFuncxx verbs in the VFAM.DAT configuration file. Parameters- dependent upon the external program executed. Comments- If an external function is undefined in VFAM.DAT, the external program call is aborted, and a warning message is written in the StatusLog log file, if it exists. Control returns to VersaFAM when the external program is terminated. These functions have been tested in a variety of different graphics modes, all of which seem to work satisfactorily. NOTE: The text cursor, usually turned "off" in VFAM, is activated for external functions. ALT/H ----- Description- Inserts a text header into the file list above the current cursor line. Parameters- None. Comments- The identity of the header file is defined by the ListHdr verb in VFAM.DAT. ALT/L ----- Description- Loads the filename at the current cursor line as an alternate file list for viewing/editing. Parameters- None. Comments- This function can be used to edit text templates using VFAM's internal text editor and OEC code generator. When the ESC key is pressed after editing, the user is returned to the 1st menu level. VersaFAM File Area Manager - 35 - Version 1.16 ALT/M ----- Description- This command MARKs all lines in a file list for processing. Parameters- None. Comments- Use ALT/M for mass ERASE, COPY, HURL or MOVE operations involving ALL file and non-file lines in an area. MARKed files are highlighted on a light gray background, with a text color defined by the Color verb in VFAM.DAT. ALT/U ----- Description- This command unMARKs all lines in a file list. Parameters- None. Comments- Use ALT/U to unMARK all previously MARKed files in a file area. UnMARKed lines assume their original text and background color attributes. CTRL/A ------ Description- Toggles the identity of the default external archive utility used to compress files at the current cursor line. Parameters- depends on the external utility used. Comments- All external archive utilities must be available via the DOS path. CTRL/C ------ Description- Capitalizes the first character of the file line at the current cursor location. Parameters- None. Comments- A quick way of standardizing file area descriptions, especially when dealing with uploaders who don't seem to know where the CAPS key is located on the keyboard. VersaFAM File Area Manager - 36 - Version 1.16 CTRL/F1 - F10 ------------- Description- This range of keystroke commands inserts a text template into the file list above the current cursor line. Parameters- None. Comments- Text template identity is determined by the Templatexx verb definitions in VFAM.DAT. CTRL/L ------ Description- Lowercases all characters in a file line at the current cursor location. Parameters- None. Comments- This command can be used in conjunction with CTRL/C to eliminate file lines written entirely in capital letters, without having to re-type them. CTRL/L is first executed to lowercase all characters, then CTRL/C is pressed to capitalize the first letter in the file description. Convenient when working with uploaders who are all too familiar with where the CAPS LOCK key is. CTRL/O ------ Description- Toggles OEC color encode/decode status. Parameters- None. Comments- Does not remove OEC codes from file lines if they exist, nor does it prevent OEC codes from being entered via the text editor. CTRL/O simply enables or disables interpretation of these codes. OEC encode can be turned "off" by default, by using the NoOEC verb in VFAM.DAT. CTRL/U ------ Description- Uppercases all characters in a file line at the current cursor location. Parameters- None. Comments- Use this command if you for some unknown reason prefer to see file descriptions written entirely in capital letters, without having to re-type them. VersaFAM File Area Manager - 37 - Version 1.16 Cursor keys ----------- Description- The cursor arrow keys, PgUp/PgDn keys, Home and End keys allow scrolling through the individual text and file lines that make up the file list for each area. Parameters- None. Comments- Right and left arrow keys have no effect on the 2nd menu level. Up and down arrow keys scroll up or down a line at a time. PgUp and PgDn keys scroll up or down a page at a time. Home scrolls to the top of the file list, while End scrolls to the bottom of the list. DEL --- Description- Deletes the line at the current cursor position. Parameters- None. Comments- DEL gets rid of both file and non-file lines within a file list. DEL does not erase DOS files associated with file lines within the list. Use ERASE for this. ENTER ----- Description- When pressed at the 2nd menu level, the ENTER key allows viewing of the contents of the archive file at the current cursor location. This is identical to the V)iew function. Parameters- None. Comments- The archive accessed depends on the position of the highlight cursor at the 2nd menu level. Pressing ENTER has no effect when the cursor references a NON-FILE line, a MISSING file, a non-archived file, or a file using an archive type not supported by VFAM. ESC --- Description- Returns to the 1st menu level. Parameters- None. Comments- If the contents of a file list have been changed, they are automatically saved before returning to the 1st menu level. VersaFAM File Area Manager - 38 - Version 1.16 F1 -- Description- Displays a program-wide listing of undocumented keystroke commands. Parameters- None. Comments- Help screens can be activated from 1st or 2nd menu levels. Press any key to return to the menu display. F2 -- Description- Displays a listing of current external function assignments, as defined by the ExtFuncxx verbs in VFAM.DAT. Parameters- None. Comments- Help screens can be activated from 1st or 2nd menu levels. Press any key to return to the menu display. F3 -- Description- Displays a listing of current text template assignments, as defined by the Templatexx verbs in VFAM.DAT. Parameters- None. Comments- Help screens can be activated from 1st or 2nd menu levels. Press any key to return to the menu display. F9 -- Description- Toggles the MARK status of the line at the current cursor location. Parameters- None. Comments- Pressing F9 will MARK an unMARKed line, or unMARK a MARKed line. The cursor position is automatically incremented downward by one line, to facilitate multiple marking operations. VersaFAM File Area Manager - 39 - Version 1.16 INS --- Description- Inserts a blank line into a file list above the current cursor location. Parameters- None. Comments- Convenient when separating large groupings of file information into smaller subgroups. INS must also be used to create a blank space at the end of a file list when MOVEing a line to the end of the list. 3rd-level menu commands ----------------------- If the ENTER or V keys are pressed at the 2nd menu level, and the file at the current cursor line is an archive supported by VFAM, the 3rd menu level is accessed. This level allows viewing, listing, editing and extraction of archive file contents. The 3rd menu level display should look something like that shown below: List File: C:\Bbs\File\Xansoft\Files.Bbs Directory: C:\Bbs\File\Xansoft Archive: FROT200.LZH Archive Type: LHA Work Area: C:\Test VersaFAM v1.16 --------------------------<INSERT>-------------------------- Name Original Packed Date Time --------------------------------------------------------------------------- FROT.EXE 17541 16944 03/07/92 22:12:30 FROT.CFG 4118 1500 03/07/92 22:25:52 FROT200.DOC 21914 5719 03/07/92 22:23:50 LOGO1.BBS 1979 584 01/03/92 13:51:58 LOGO2.BBS 991 305 01/30/92 10:38:06 LOGO3.BBS 1209 418 01/30/92 14:01:08 LOGO4.BBS 1445 424 01/30/92 14:24:26 LOGO5.BBS 1447 425 01/30/92 14:36:36 ------------------------------------------------------------[L1 ]-[C ] OS Text Unpack Quit <VIEW ARCHIVES> VersaFAM File Area Manager - 40 - Version 1.16 List File shows the full drive, path and filename information for the currently active file list. Directory shows the directory where files are physically located. Archive displays the name of the archive file whose contents are being viewed. Archive Type indicates the archive format used to create the archive file currently being viewed. Work Area shows where archive contents will be U)npacked, if this option is chosen. The Name column lists the filenames of the individual files contained within the archive. The Original column indicates the space in bytes taken up by each file in its uncompressed form. The Packed column indicates the space in bytes taken up by each file in its compressed (archived) form. Date and Time display date and time stamp information for individual files within the archive. The following menu commands are accessible at the 3rd menu level: OS [remote password] -------------------- Description- Executes a DOS shell to whatever directory is highlighted on the 1st-level menu, or to the current directory at the 2nd or 3rd-level menus. Parameters- If operating remotely, users are first prompted for a password. Incorrect passwords force a return to whatever menu level OS was invoked from. No password is needed when operating locally. Comments- VersaFAM uses memory-swapping routines written by Kim Kokkonen of TurboPower Software. These routines maximize the amount of usable RAM in the shell by swapping most of VersaFAM to disk or EMS memory. Type "EXIT" and press the ENTER key to return to VersaFAM from the OS shell. VersaFAM File Area Manager - 41 - Version 1.16 Quit ---- Description- Terminates the VersaFAM program and returns to the previous operating system or shell. Parameters- None. Comments- If a file area has been changed, its contents will automatically be saved before the Q)uit command is processed. Text ---- Description- Allows the contents of a text file to be displayed at the 2nd or 3rd menu level. Parameters- Depends upon external editor/viewer chosen. Comments- The text file is first extracted from the archive, then displayed using the external list or editor utility defined by the Editor verb in the VFAM.DAT file. The ENTER key also executes the T)ext function at this menu level. Unpack <unpacker> ----------------- Description- Extracts a single file from within an archive file at the current cursor position, using an external archive utility. Parameters- <unpacker> is the name of the archive utility to be used to decompress the file. The archive will be unpacked to the directory specified by the UnarcDir verb in VFAM.DAT. Comments- When used at the 2nd menu level, U)npack decompresses the contents of the entire archive to the work directory. Archive identification is automatic, regardless of the file extension used. When called from the 3rd menu level, U)npack extracts selected files from the archive. U)npack cannot (as of yet) be used with the MARK command. VersaFAM File Area Manager - 42 - Version 1.16 3rd-level keystroke commands ---------------------------- Because of limited space in menu displays, many of VersaFAM's available commands are referenced only in the HELP screens. Examples of this are the keystroke commands available throughout the program. Some commands require single keystrokes, while others specify double keystrokes. When a forward slash (/) is placed between two key references, it means that the first key should be held down while the other is pressed. The following keystroke commands are available at the 3rd menu level: ENTER ----- Description- Allows viewing/editing of archived text files. Parameters- Depend upon external viewer/editor chosen. Comments- The text file is first extracted from the archive, then displayed using the external list or editor utility defined by the Editor verb in the VFAM.DAT file. The T)ext menu command also executes this function. ESC --- Description- Returns to the 2nd menu level. Parameters- None. Comments- None. Cursor keys ----------- Description- The cursor arrow keys, PgUp/PgDn keys, Home and End keys allow scrolling through the list of file areas at the 1st menu level. Parameters- None. Comments- Right and left arrow keys have no effect on the 3rd menu level. Up and down arrow keys scroll up or down a line at a time. PgUp and PgDn keys scroll up or down a page at a time. Home scrolls to the top of the archive list, while End scrolls to the bottom of the list. VersaFAM File Area Manager - 43 - Version 1.16 The VersaFAM text editor ------------------------ VersaFAM incorporates an OEC-capable text editor for editing of text and file descriptions within file lists. If a line containing valid filename information is chosen, the filename may be edited using R)ename, or the description may be modified using W)rite. If a NON-FILE line is chosen, the entire line (up to 127 characters including OEC codes) can be edited. Text editor keystroke commands ------------------------------ The text editor provides many keystroke commands referenced only within HELP files (available by pressing F1 at 1st or 2nd menu levels). Dual keystrokes separated by a forward slash (/) indicate that the first key should be held down while the second is pressed. The following keystroke commands are available within the text editor: ALT/B ----- Description- Inserts OEC "blink" code into a text line. Parameters- None. Comments- All characters typed after the blink code will blink, until another OEC code (other than blink) is encountered, regardless of the file line. NOTE: Some graphics modes do not support blinking characters. ALT/E ----- Description- Deletes text from the current cursor position to the end of a line. Parameters- None. Comments- ALT/E also works for input routines used with other VFAM commands, such as L)ocate, P)robe, D)upe and R)ename. VersaFAM File Area Manager - 44 - Version 1.16 ALT/F1 - F10 ------------ Description- This range of keystroke commands allows selection of graphics character sets. Parameters- None. Comments- Graphics characters include those used in constructing lines and boxes, plus special symbols used in mathematics. All graphics characters have ASCII values greater than 128. Once a character set is selected, function keys F1 through F10 can be used to output characters to the screen. ALT/I ----- Description- Toggles text editor cursor mode. Parameters- None. Comments- The insert cursor mode displaces characters in front of the cursor when new text is typed. The overstrike cursor mode allows new characters to be typed over old, without displacement. ALT/O ----- Description- Inserts an OEC text/background color code into a file line. Parameters- None. Comments- The code inserted depends upon text and background colors previously selected using the color selection keystroke combinations listed in the section titled "Changing text/ background colors". Current text and background color choices can be seen in the lower left-hand corner of the screen when the text editor is active. VersaFAM File Area Manager - 45 - Version 1.16 CTRL/<-> -------- Description- Moves the cursor to the beginning or end of a line. Parameters- None. Comments- CTRL/(right arrow) will move to the 127th character of the current line, whether or not the line contains that many characters. The first part of the line will scroll off the left side of the screen to accommodate this function. CTRL/(left arrow) will move to the beginning of the file description for a filename line, or to the first character in the line for a NON-FILE line. CTRL/X ------ Description- Activates extended keycode translation routines for remote mode operation. Parameters- None. Comments- ALT/X is available only when in remote mode (when running VFAM with the /R command line switch). When selected, CTRL/X allows selection of extended keycode commands (such as ALT/ keycodes) that are not supported by many telecommunications programs. Via keycode translation, VersaFAM supports all extended keycode commands during remote mode operations. The X-KEY status is shown at the text editor menu, next to the <INDEX> status indicator. F1 - F10 -------- Description- This range of keystroke commands allows output of graphics characters. Parameters- None. Comments- The identity of characters output depends on the graphics character set previously selected using keystroke commands ALT/F1 through ALT/F10. VersaFAM File Area Manager - 46 - Version 1.16 DEL --- Description- Deletes characters from a file line. Parameters- None. Comments- When deleting many characters from the end of a file line, it is often more convenient to use ALT/E (delete to end of line) instead of repeatedly using the DEL key. TAB and SHIFT/TAB ----------------- Description- Tabs cursor forward and backward, respectively, on a file line. Parameters- None. Comments- Use TAB or SHIFT/TAB to quickly move the cursor on a file line, without destroying or changing characters. A quick alternative to repeatedly using cursor right and left arrow keys. Changing text/background colors ------------------------------- Background color and low/high intensity text colors can be changed by using the following keystroke commands when in the text editor: COLOR (lo/hi) BACKGROUND (lo) TEXT (lo) TEXT (hi) ------------------------------------------------------------------ black/dk gray ALT/1 SHIFT/F1 CTRL/F1 blue/lt blue ALT/2 SHIFT/F2 CTRL/F2 green/lt green ALT/3 SHIFT/F3 CTRL/F3 cyan/lt cyan ALT/4 SHIFT/F4 CTRL/F4 red/lt red ALT/5 SHIFT/F5 CTRL/F5 magenta/lt magenta ALT/6 SHIFT/F6 CTRL/F6 brown/yellow ALT/7 SHIFT/F7 CTRL/F7 lt gray/white ALT/8 SHIFT/F8 CTRL/F8 The ALT/O keystroke command can then be used to insert the OEC codes into a text or file line. VersaFAM File Area Manager - 47 - Version 1.16 How VersaFAM interprets OEC codes --------------------------------- BBS programs disallow the use of most ASCII characters on the first column of a file list line not containing filename information. This is done so as not to confuse the BBS program into thinking the text on a non-file line is part of a filename. For example, if the letter "A" is typed in the first column of a file list line, most BBS software will interpret this as a filename, and search the associated DOS directory for a file named "A". Of course, this "file" will show up as MISSING when the file list is displayed on the BBS. In order to be recognized as text instead of a filename, the first column of a non-file line is padded with a special ASCII character that tells the BBS software not to look for a filename. Approved characters ------------------- Pad characters accepted by most BBS software are listed below. If any of these characters is used in the first column of a file list description, the BBS software will interpret the line as being "text only", and will not look try to look for DOS files. Because many of these characters can be interpreted as special printer codes, listing the actual characters might wreak havoc. Where necessary, information on these characters has been given in the form of their ASCII values, and the keystroke commands commonly used to output these characters to the screen. VersaFAM File Area Manager - 48 - Version 1.16 Character ASCII value CTRL/A 1 CTRL/B 2 CTRL/C 3 CTRL/D 4 CTRL/E 5 CTRL/F 6 CTRL/G 7 CTRL/H 8 CTRL/I 9 CTRL/J 10 CTRL/K 11 CTRL/L 12 CTRL/M 13 CTRL/N 14 CTRL/O 15 CTRL/V 22 CTRL/Y 25 (space) 32 + 43 , 44 - 45 : 58 < 60 = 61 > 62 [ 91 \ 92 ] 93 ^ 94 | 124 ~ 126 When a character is entered in the first column of a non-file text line, VersaFAM will check to see if the character is one of the above. If it is, it is placed in the first column. If not, the first column of the text line is padded by the character defined for the TextFlag verb in VFAM.DAT. If TextFlag is undefined, the space character (ASCII 32) is used by default. Interpreted vs. uninterpreted OEC displays ------------------------------------------ VersaFAM implements a subset of the OEC color codes used by many BBS programs to control text and background colors in file list displays. When the highlight cursor is moved over a text line at the 2nd menu level, the actual, uninterpreted text line, complete with OEC codes, is displayed (if the NoOEC verb in VFAM.DAT has not been activated). All other visible text lines display as "interpreted", showing the effects of any embedded OEC text and/or background color codes. VersaFAM File Area Manager - 49 - Version 1.16 VersaFAM OEC limitations ------------------------ Only OEC codes having to do with text and background color control are supported by VersaFAM. All other OEC codes will be displayed "uninterpreted". Also unsupported are the character compression commands (ASCII 25 codes) used in standard OEC. A utility called OEC2VFAM has been included in this archive package to convert standard OEC codes to VFAM format by "expanding" any character compression codes encountered, and writing the results to a new file. Using text templates -------------------- VersaFAM incorporates a powerful text editing feature known as text templating. Text templates are ASCII text files that can be selectively inserted into file lists from the 2nd-level menu. This functionality relieves the tedium often associated with constructing and editing file list headers, descriptive text and other graphics. "Boilerplate" files for descriptive headers, text boxes and other intricate designs can be inserted with a keystroke, without having to laboriously re-create them from scratch every time they are needed. Template files are inserted within a list file by using keystroke commands in the range of CTRL/F1 through CTRL/F10, depending upon which template is desired, at the 2nd-level menu. Template files may be modified within VersaFAM by PROBEing the template filename into a file list, positioning the highlight cursor on the new filename, and pressing ALT/L. This displays the template file as an "alternate" file list that can be edited like a standard list, by executing the W)rite command. It is recommended that template files be assigned their own special directory, and that this directory be included within VersaFAM as a file area, to facilitate convenient maintenance of template files. VersaFAM File Area Manager - 50 - Version 1.16 Using PINPOINT -------------- PINPOINT is a dynamic text-matching subroutine designed to make finding directories and file areas easier. Unlike L)ocate, which searches for text and filename information within file lists, PINPOINT searches for matching text in file area directories and descriptions at the 1st menu level, and also when HURLing files. This allows users to quickly "home in" on file areas to be processed. To activate PINPOINT, simply press the spacebar at the 1st menu level, or at the split-screen HURL display. Type in a portion of the file area name you would like to target (optionally the area description, if at the 1st menu level). PINPOINT evaluates each character of the text string entered, attempting to match it with file area directory names or descriptions. If a successful match is found, the highlight cursor moves to the matching line. If a match is not found, a warning tone sounds, indicating there are no matches for the text string as entered. To exit the PINPOINT routine, press any cursor key, the ESC key, or the space bar. Pressing the ENTER key both exits the PINPOINT mode, and initiates the next desired action (entry into the 2nd menu level, or HURLing a file, depending on where PINPOINT is invoked). PINPOINT will only find the FIRST text match between an entered string and a file area directory/description. If you have many file areas with similar directory names or descriptions, you may either want to make them less similar, or enter different text strings when PINPOINT is active. PINPOINT has proven a great time-saver, particularly on systems that include dozens or even hundreds of different file areas. Editing VFAM.DAT ---------------- The VersaFAM configuration file, VFAM.DAT, can be edited from within the VersaFAM program by moving the highlight cursor to the file area titled "EDIT VFAM.DAT" on the 1st menu level, then pressing the ENTER key. This file area is automatically created by VersaFAM, and will always appear as the last entry in the area list. Once within the configuration file at the 2nd menu level, the W)rite command may be used to activate the text editor. Configuration file lines may be inserted, deleted or modified. When editing is complete, the ESC key can be pressed to return to the 1st level menu. After editing, the configuration file is automatically re-read by VersaFAM. Any configuration changes (color, verb assignments, etc.) will take effect immediately. VersaFAM File Area Manager - 51 - Version 1.16 Running VersaFAM remotely ------------------------- VersaFAM can be set up for remote operation by including the /R switch when executing VFAM from the DOS command prompt. The presence of the /R parameter signals VersaFAM to make all required adjustments for remote operation. The only thing the remote user has to remember to do is engage his/her NUM LOCK key at the remote terminal. Menu and keystroke selections in remote mode work the same as in local mode, with the exception of those commands containing "extended" keycodes. Extended keycodes are ALT, CTRL, SHIFT and function key combinations whose keycodes are not supported by all communications or terminal programs. VersaFAM gets around this obstacle through creation of a "shorthand" mnemonic code used to activate extended keycodes. Examples of this code are shown below: Extended keycode VersaFAM "shorthand" code ------------------------------------------------------ ALT/F1 A + F + 1 (3 keystrokes) ALT/1 A + 1 F6 F + 6 ALT/C A + C ALT/F10 A + F + 0 CTRL/F1 C + F + 1 SHIFT/F1 S + F + 1 Shorthand code functionality is automatically available on 1st and 2nd menu levels when running remotely. A special kludge is needed for bringing this functionality to the text editor, however. To distinguish the letter "A" from the ALT shorthand code for example, the <X-KEYS> mode has been created. <X-KEYS> can only be invoked in remote mode, when the text editor is active. When the CTRL/X keystroke combination (not an extended keycode) is pressed, the label "<X-KEYS>" will appear next to the "<INSERT>" text mode indicator. Pressing CTRL/X again will turn <X-KEYS> off. When not in X-KEYS mode, the following is true: A. Pressing letter keys will output letters to the screen. B. Pressing number keys will result in cursor movement. C. Pressing cursor keys will result in cursor movement. D. Entering shorthand codes will have no effect. When X-KEYS mode is activated: A. Pressing letter keys (except A, C, F or S) will output uppercase letters to the screen. B. Pressing number keys will output numbers to the screen. C. Pressing cursor keys will output numbers to the screen. D. Entering shorthand codes will produce the desired effect. VersaFAM File Area Manager - 52 - Version 1.16 VersaFAM utilities ------------------ The VersaFAM distribution archive includes several utility programs designed specifically for use with VersaFAM: FILEX file update utility ------------------------- FILEX.EXE provides a convenient method for adding new files and descriptions to FILES.BBS-style file areas. FILEX can be executed as an external program call from within VFAM, or can be run as a stand-alone program from DOS. For more information, read the FILEX.DOC information file. CBFSORT file sort utility ------------------------- CBFSORT.EXE is an exceptionally fast sort routine based on original code by Charles B. Falconer, a local professional programmer. The CBFSORT program sorts individual groupings and sub-groupings of valid file lines within a file list, without disturbing surrounding text or descriptive data. CBFSORT can be executed as an external program call from within VFAM, or can be run from DOS. OEC2VFAM conversion utility --------------------------- In recognition of the fact that most sysops will already have established file areas before using VersaFAM, the OEC2VFAM utility has been included to convert standard OEC format files to the VersaFAM format. This conversion involves expansion of ASCII 25 compression codes used in standard OEC, replacing such codes with the actual characters they represent. OEC2VFAM scans a specified input file, then writes the converted results to an output file. This eliminates the need to manually re-create or re-format existing file list information. VFADD path import utility ------------------------- The VFADD utility allows sysops of earlier Opus<tm> BBSes to append VFAM.DAT with download path information taken from any existing SYSTEM??.BBS or SYSTEM??.DAT files located in the directory from which VFADD is executed. Before appending, path information can be sorted either according to SYSTEM?? file hierarchy (the default), or alphanumerically according to the path itself. VersaFAM File Area Manager - 53 - Version 1.16 BBS-specific utilities and support ---------------------------------- In order to keep VersaFAM as "generic" a file area manager as possible, support for BBS-specific conversion utilities of this type has been discontinued. Inquiries by motivated third parties as to use of VersaFAM data structures for the purpose of creating such utilities are welcomed. Qualified, well-written utilities of this type may be included in future VersaFAM public releases. Credits and copyrights ---------------------- ARCA, ARCE Copyright (C) System Enhancement Associates ARJ Copyright (C) Robert K. Jung DOORWAY Copyright (C) Marshall Dudley LHARC, LHA, LHSFX Copyright (C) Haruyasu Yoshizaki LIST Copyright (C) Vernon D. Buerg LZEXE Copyright (C) Fabrice Bellard PAK Copyright (C) NoGate Consulting PKZIP, PKUNZIP Copyright (C) Phil Katz/PKWare TURBO PASCAL Copyright (C) Borland International The beta test team ------------------ Thanks to all of the sysops who bravely volunteered to beta test this latest public release. It's been a long road, but definitely a worthwhile one! Fully half of the new features wouldn't have been included without your input. You are the force that truly drives shareware development efforts. Salud! Registration ------------ Registering the VFAM package (still an inflation-busting $15.00!) entitles you to a customized VersaFAM executable bearing your name, plus free program updates via FidoNet or U.S. Snail. Not to mention my sincere thanks. More details on registration are available in the REGISTER.DOC file. IMPORTANT NOTE: This unregistered version of VersaFAM is not, and WILL NEVER BE, CRIPPLED IN ANY WAY. My steadfast belief is that people will honestly pay for software they find useful, without someone having to try to force them into it by sabotaging the software to make it more limited and/or less effective. VersaFAM File Area Manager - 54 - Version 1.16 More about Turbo Power Software ------------------------------- Some of the subroutines used in this program are public domain code written by the knowledgeable folks at TurboPower Software. If you'd like to know more about TurboPower Software and their many fine public domain and shareware programs, write to Kim Kokkonen at the following address: Kim Kokkonen, President TurboPower Software P.O. Box 66747 Scotts Valley, CA 95066 More about XanSoft Development ------------------------------ Who we are XanSoft Development (pronounced ZAN-soft) is a small start-up company started in Naugatuck, CT in 1991. Its purpose is to bring superior quality graphic programs and utilities to the public at affordable prices. Bill Auclair, XanSoft's president, has many years of experience in the development of computer-based graphics and training programs for business, education and industry, spanning a wide range of topics. What we do XanSoft specializes in the creation of software and graphics used in presentations, animation sequences, computer-based training programs and simulations. We currently use the IBM personal computer as a platform for graphics and software development. FOR MORE INFORMATION Written inquiries should be addressed to: XanSoft Development c/o Bill Auclair 13-1 Ridge Rd. Naugatuck, CT 06770 XanSoft maintains a computer bulletin board system (Xanadu BBS) on which we carry samples of our products. The BBS may be dialed via modem at (203) 723-8568. Transmission speed is from 1200 to 9600 baud, using no parity, an 8-bit data word, and 1 stop bit. The XanSoft BBS is used to exchange messages, prototypes and other information between XanSoft technicians and our clients. VersaFAM File Area Manager - 55 - Version 1.16 Appendix A: VersaFAM menu and keystroke commands ------------------------------------------------- All menus: ESC ............... Previous menu PgUp/PgDn ......... Move up or down one screen HOME/END .......... Move to beginning or end of list F ................. Display free space on all drives 1st-level menu: ALT-R ............. Reset subdirectory K counters 2nd-level menu: INS/DEL ........... Insert/delete line at cursor ALT-F1 thru F10 ... Activate external functions CTRL-F1 thru F10 .. Insert text templates ALT-A ............. Add "info" file to archive ALT-C ............. Copy line at cursor ALT-H ............. Add file header to list file ALT-L ............. Load alternate list file F9 ................ MARK file at cursor position ALT-M / ALT-U ..... MARK/UNMARK all files for processing CTRL-A ............ Toggle default PACKER CTRL-C ............ Make file descriptions Capitalized CTRL-L ............ Make file descriptions lowercase CTRL-O ............ Enables/disables OEC encode/decode CTRL-U ............ Make file descriptions UPPERCASE Text editor: ALT-F1 thru F10 ... Activate graphics character sets F1 thru F10 ....... Output graphics characters to screen ALT-I ............. Toggle insert/overstrike cursor CTRL <----> ....... Move cursor to beginning or end of line CTRL-X ............ Toggle <X-KEYS> (REMOTE mode only) ALT-O ............. Insert OEC color code into text ALT-B ............. Insert OEC "blink" code into text TAB/Shift-TAB ..... Tab cursor backward and forward ALT-E ............. Delete to end of line VersaFAM File Area Manager - 56 - Version 1.16 Appendix B: VersaFAM color configuration codes ----------------------------------------------- Color parameters: #1 = 1st-level blurb color #2 = border color #3 = highlight color #4 = error/warning color #5 = 1st-level directory color #6 = 1st-level quantity (K) color #7 = 1st-level description color #8 = non-OEC text color #9 = MARKed text color Color parameter values: 0 Black 8 Dark Gray 1 Blue 9 Light Blue 2 Green 10 Light Green 3 Cyan 11 Light Cyan 4 Red 12 Light Red 5 Magenta 13 Light Magenta 6 Brown 14 Yellow 7 Light Gray 15 White 128 may be added to any parameter to produce a blinking effect. VersaFAM File Area Manager - 57 - Version 1.16 Appendix C: OEC text/background color codes -------------------------------------------- OEC text and background codes are used in some BBS programs to replace the standard ANSI color codes, which take longer to execute and occupy more space. The first portion of standard OEC codes consists of an ASCII(22) character followed by an ASCII(1) character. If the text background color is black, a third character, ASCII(16), is added. The last character in the code determines the text and/or background color. Ordinal ASCII values for this character are shown in the chart below: B A C K G R O U N D C O L O R S black blue green cyan red mgnta brown gray .--------------v-----v------v-----v-----v-----v-----v------v--- T | black 0 16 32 48 64 80 96 112 E | blue 1 17 33 49 65 81 97 113 X | green 2 18 34 50 66 82 98 114 T | cyan 3 19 35 51 67 83 99 115 | red 4 20 36 52 68 84 100 116 C | magenta 5 21 37 53 69 85 101 117 O | brown 6 22 38 54 70 86 102 118 L | lt gray 7 23 39 55 71 87 103 119 O | dk gray 8 24 40 56 72 88 104 120 R | lt blue 9 25 41 57 73 89 105 121 S | lt green 10 26 42 58 74 90 106 122 | lt cyan 11 27 43 59 75 91 107 123 | lt red 12 28 44 60 76 92 108 124 | lt mgnta 13 29 45 61 77 93 109 125 | yellow 14 30 46 62 78 94 110 126 | white 15 31 47 63 79 95 111 127 VersaFAM File Area Manager - 58 - Version 1.16 Appendix D: External function symbol codes ------------------------------------------- The codes below can be embedded within external function calls defined for ExtFuncxx verbs in VFAM.DAT, and made to symbolize any combination of path, filename or extension information for the file at the current cursor line. EMBEDDED CODES: @ = <path\filename.ext> # = <path> $ = <filename.ext> & = <filename> ^ = <.ext> VersaFAM File Area Manager - 59 - Version 1.16 Appendix E: VersaFAM configuration file verbs ---------------------------------------------- BIOS Tells VFAM to use BIOS rather than direct screen writes Color Defines colors used for borders, highlights, errors, etc. ZapDir Path to directory to be used as a ZAP directory UnarcDir Path to directory used to de-compress archive files SwapDir Path used when swapping VFAM to disk for external ops. NoEMS Tells VFAM not to use EMS, even when it is available NoOEC Enables/disables OEC encode/decode capability Packer The name of the archive utility to use for PACKing ListFile The list file name (FILES.BBS for many BBSes) ConvertList Allows conversion to a list format other than FILES.BBS. Backup List file backup filename StatusLog Full path and filename of the VFAM operational log file ListHdr Full path and filename of the list header file Editor Name of the utility to be used to list/edit files RepackEditFile Allows updating of files within archives after editing OrphanDesc Description to be attached to orphan files when found InfoFile Full path and filename of info file to add to archives TextFlag Pad character used to identify descriptive file lines Sound Enables beep for text editor and missing files DOSPassword Password for drop to DOS when operating remotely ExtFunc1 - 10 External function definitions Template1 - 10 Text template definitions SysDir File area path information VersaFAM File Area Manager - 60 - Version 1.16 Appendix F: VersaFAM limits and defaults ----------------------------------------- Ranges and limits File areas: 256 File lines/area: 1024 Characters/line: 127 Characters/directory label: 40 Archive types: 5 characters External functions: 80 characters File area directories: 40 characters File area descriptions: 40 characters Orphan descriptions: 65 characters Packer labels: 8 characters Text template paths: 80 characters Defaults External editor: 'LIST' Write to log file: False Orphan description: '[11]-Adopted-' Packer: 'ARCA' PROBE filespec: '*.*' Re-archive edited files: False Sound: False Text editor cursor mode: INSERT Use EMS memory: True Use OEC codes: True