FIDO-FAM Version 5
FIDO-FAM
FIDO BBS File Area Maintenance Utility
User Manual
- also supports OPUS and QuikBBS -
Copyright (c) 1988 Dennis Glaeser All rights reserved.
3016 Country Knoll Dr. MDC - RCC BBS
St. Charles, MO 63303 Fido 100/10
(314) 928-3525 (voice) (314) 232-6881
FIDO is a registered trademark of Tom Jennings
FIDO-FAM Version 5
Table of Contents
1 Overview and Syntax 1
2 System Requirements 3
2.1 Operation on the Host machine 3
2.2 Remote Operation 3
2.3 Colors 3
2.4 Host Serial Driver 4
2.5 Required Files and Paths 5
2.5.1 Location of System Files 5
2.5.2 Text File Format for Area Definitions
6
2.5.3 Path Checks 6
3 Command Line Parameters 8
3.1 Single Character Parameters 8
3.2 Multi-Character Commands 9
3.3 The FAMOPT environment variable 9
4 SEND Files 10
4.1 Types of SEND Files 10
4.1.1 Single Send File 10
4.1.2 Multiple Send Files 11
4.2 Batch SEND 11
4.3 Interractive SEND 12
5 FIDO-FAM.CFG File 13
6 File Area Selection Screen 14
6.0.1 Dynamically Added File Areas 14
7 File Area Editor Operation 15
7.1 Cursor and Function Keys 16
7.2 Cursor and Screen Movement 16
7.3 Commands to Mark/Unmark Lines 17
7.4 File Area Editing Commands 18
7.4.1 - A - Abandon/Adopt the file(s) 18
7.4.2 - C - Send a Command to DOS 19
7.4.3 - E - Line Editor 20
7.4.4 - F - Find 21
7.4.5 - G - Regenerate the Display 22
7.4.6 - I, Ins, 0 - Insert a comment 22
7.4.7 - J - Jump 22
FIDO-FAM Version 5
7.4.8 - K, Del, . - Kill/Delete Line(s) 22
7.4.9 - M - Move/Copy lines 23
7.4.10 - O - Overwrite this Comment 23
7.4.11 - Q - Quit the Editor 24
7.4.12 - R - Rename the File 24
7.4.13 - S - Sort files 24
7.4.14 - T - Date the file description 25
7.4.15 - V - View a File 25
7.4.16 - # - Move line to another area 25
7.4.17 - ? - Display a 'help' screen 26
7.4.18 CTRL-A - Adopt all orphans 26
7.4.19 CTRL-D - unDate the Comment(s) 26
7.4.20 CTRL-E - Edit DIR.BBS 26
7.4.21 CTRL-T - Touch (File Date/Time) 26
8 Backup of .BBS Files 27
9 Shareware Registration 27
10 Change History 28
10.1 Version 2.0 28
10.2 Version 3.0 28
10.2.1 Version 3.01 28
10.3 Version 4.0 29
10.4 Version 5.0 29
10.4.1 Version 5.01 30
10.4.2 Version 5.02 30
FIDO-FAM Version 5
1 Overview and Syntax
FIDO-FAM is designed to be a FIDO BBS File Area Maintenance
utility. It allows the user to quickly and easily review,
modify, and coordinate the files in any File area with the
appropriate FILES.BBS file.
This utility is designed to work with either version 11 or 12
of FIDO, and also has features to support OPUS and QuikBBS .
FIDO-FAM uses FIDO.SYS, SYSTEMnn.BBS files, or a text file to
define File Area Paths.
Syntax : FIDO-FAM [a] [b] [c] [d] [h] [i] [l] [n] [z]
[path to system files | text filename]
[SEND nn [nn..[nn]] TO filename]
Note: any command line parameter may be prefixed with either
'-' or '/' if desired. For example, the following command
line parameters are equivalent:
d -d /d
Environment string FAMOPT may also be used in place of, or
in conjunction with the command line to specify parameters.
The FAMOPT string can contain any command line option EXCEPT
the SEND command.
A configuration file named FIDO-FAM.CFG may also be used to
invoke parameters. A sample file named DEFAULT.CFG is
distributed with FIDO-FAM and is commented sufficiently to
be self-explanatory.
FIDO-FAM operates on any MSDOS system. It may be run remotely,
as long as the remote terminal/computer responds to ANSI terminal
commands for color and cursor positioning. All screens are
designed to work with either color or monochrome displays.
Page 1 (c) 1988 Dennis Glaeser
FIDO-FAM Version 5
FIDO-FAM provides two modes of operation: REMOTE and LOCAL. The
basic difference between them is that REMOTE uses DOS for I/O,
whereas LOCAL mode does direct screen writes for fast displays.
REMOTE mode is the default configuration because it allows
operation through the communication ports, if the Console device
is redirected appropriately (usually with the CTTY=COMx
command). You do not need to be operating remotely to use REMOTE
mode!
The 'L' parameter puts the program in LOCAL mode which writes
directly to display memory for very fast screen displays. LOCAL
MODE WORKS ONLY ON THE HOST MACHINE AND REQUIRES AN IBM-PC OR
COMPATIBLE. Local mode is NOT required if you are using the host
machine, it is simply a display speedup. If for any reason your
display is messed up using Local mode, be sure to try running
without the 'L' command.
Page 2 (c) 1988 Dennis Glaeser
FIDO-FAM Version 5
2 System Requirements
2.1 Operation on the Host machine
FIDO-FAM can be run on any computer running MSDOS or PCDOS 2.x or
higher, and which has an ANSI terminal or ANSI device driver
installed. For example, an IBM PC (or compatible) may be used as
long as an ANSI device driver (ANSI.SYS, or FANSI- CONSOLE) is
installed. Any computer whose terminal emulates a VT100/102,
such as the DEC Rainbow, may also be used.
If FIDO-FAM is run on an IBM PC (or clone) ONLY in LOCAL mode
the ANSI driver is not required. Without the ANSI driver
FIDO-FAM cannot be run in REMOTE mode.
2.2 Remote Operation
FIDO-FAM can be run remotely. This allows authorized users,
typically the Sysop or File Area Managers (assistant Sysops), to
do file area maintenance from home. The remote terminal, or
modem program, being used MUST respond to the ANSI terminal
control strings for:
- Cursor Positioning
- Clear Screen
- Clear to End of Line
- Colors - Note: all displays are designed to work even if
color is ignored.
An 80 x 24 display is used, to support remote users who don't
have 25 line screens.
2.3 Colors
FIDO-FAM normally uses color in all of its displays. A command
line switch ('N') will totally disable the issuance of color
commands. A configuration file named FIDO-FAM.CFG may be used to
configure the colors used in all FIDO-FAM displays. A file named
DEFAULT.CFG, distributed with FIDO-FAM, shows the default colors
used by the various FIDO-FAM displays. If different colors are
desired, copy the appropriate lines from DEFAULT.CFG to a file
Page 3 (c) 1988 Dennis Glaeser
FIDO-FAM Version 5
named FIDO-FAM.CFG and change the values to your liking. The
configuration file is discussed in depth later in this document.
screens.
Some users have complained that FIDO-FAM does not restore
colors to their original settings when it exits. If you have
that concern, read on.
The ANSI device specification does not provide a means to
querry the system about 'current' colors. Therefore it is
impossible to generically restore the original colors upon exit
from any program using the ANSI device driver for color control.
FIDO-FAM will restore colors on an IBM-PC or compatible through
the use of BIOS calls, if the 'L' command line parameter is
used. Remember that this can only work on a local machine. It
has no effect on the remote user's terminal.
There is a better way! Since any (non-local) system using
FIDO-FAM must have an ANSI device installed, there is a powerful,
easy, and safe way to restore your favorite colors after ANY
program has run. Furthermore it works ALL THE TIME, running
local or remote! The secret: put color control commands in the
DOS PROMPT. Refer to your DOS documentation on the Prompt
Command, and ANSI.SYS for more details.
2.4 Host Serial Driver
In order to allow remote programs to be run, the Host machine
must allow the program to do its I/O through the Communications
port, instead of the local Console and Keyboard. There are
basically two ways to do this: 1) the CTTY command, or 2) use
redirection on the command line when calling the program. In
either case the redirection goes through a Serial Device driver.
In order to work without limitations, FIDO-FAM requires a
Serial Device driver which responds correctly to an Input Status
request (is a char waiting to be read). Generally, only drivers
which buffer input will respond as needed.
In plainer English: During the execution of many commands,
FIDO-FAM checks with DOS to see if a keypress is waiting to be
read. This is done to support local Function Keys (on IBM
compatibles) and to allow repetative cursor movements before
updating the screen display.
Some device drivers respond to a keypress check with a 'yes',
and then proceed to wait until a key is pressed!! This makes
using FIDO-FAM very difficult. The symptoms of this problem are:
FIDO-FAM does not immediately respond to a single keypress while
in the File Area Editor; but a subsequent keypress invokes the
Page 4 (c) 1988 Dennis Glaeser
FIDO-FAM Version 5
previously pressed key! In other words FIDO-FAM reacts one
keypress out of synch, or appears to require two keystrokes when
one should do.
If this occurs try to invoke redirection from the command line
as follows:
FIDO-FAM >com1
Return to The Skeptic Tank's main Index page.
end to a file or uit
Entering the 'S' command invokes the interractive SEND
operation. You will first be prompted for the Area Numbers to
SEND. Don't forget that if you intend to create a single file the
areas will appear in the order specified here.
Next is a prompt for the file name (which determines single or
multiple SEND files as described above).
If a legal DOS filename was input and that file exists, you
will be given the option to:
ppend,
uit
If multiple SEND files are requested (*\filename) any existing
files are overwritten in their respective directories.
Page 12 (c) 1988 Dennis Glaeser
FIDO-FAM Version 5
5 FIDO-FAM.CFG File
If a file named FIDO-FAM.CFG is found in the same directory where
the system files are found, it will be processed to allow a
number of user-defineable configurations:
- Colors. If you want to paint mustaches on my Mona Lisa,
here's your chance. The defaults are the colors FIDO-FAM
has been using.
- The char used to replace the ESC char while editing
comments. The default is the Tilde (~).
- The number of additional Areas which can be dynamically
added when using FIDO.SYS. The default is 5.
- Any of the command line options. NOTE: the .CFG file is
processed FIRST, the FAM-OPT environment variable is
processed SECOND, and the arguments on the command line are
processed LAST.
The file DEFAULT.CFG is provided to show you how the
FIDO-FAM.CFG file must look. The comments make the file self
explanatory (hopefully). Use any text editor to modify as
desired. The name of an item (on the left side of the '=') must
remain exactly as shown to be recognized (caps and spacing).
Invalid data is ignored. The order of items is immaterial. If
you want the default for any item you may remove it from the .CFG
file if you like (saves processing time).
Page 13 (c) 1988 Dennis Glaeser
FIDO-FAM Version 5
6 File Area Selection Screen
FIDO-FAM's first screen displays the lowest level subdirectory
names of the available file areas, and the prompt:
to edit,
end to a file or uit
Entering a valid area number will invoke the File Area Editor
for that area (described below).
The 'E' command (Expanded Info) will prompt for the Area
Number, and then display the full path name for that area and its
description (if available).
The 'S' command is discussed above (Interractive SEND).
The 'Q' command exits FIDO-FAM. If the 'L' option was invoked
on the command line, the screen colors will be restored, and the
screen cleared to those colors before exiting.
6.0.1 Dynamically Added File Areas
FIDO-FAM allows a you to dynamically add a new Area by simply
entering an Area number which does not already exist.
If you are using SYSTEMnn.BBS files to define Area Paths, a
non-existent Area number is any number in the valid range (0 to
99 normally, or 0 to 255 if the 'H' parameter is in effect).
If you are using FIDO.SYS to define Area Paths, FIDO-FAM allows
for five (5) additional Areas. This number can be changed by
using a FIDO-FAM.CFG file (discussed below).
When you enter a non-existent Area number, you will be prompted
to keyin the path to use for that area. If you specify a
non-existent directory, you will be given the opportunity to have
it created. You can, of course, ESC from this process at any
point.
Added Areas are displayed differently in an Areas Display, to
remind you that they were dynamically added. Other than that,
they operate the same as any other Area.
Any invalid input is ignored. No funny messages, just no
action (except to erase the bad input from the screen).
Page 14 (c) 1988 Dennis Glaeser
FIDO-FAM Version 5
NOTE: if you add Areas under the Move or # command within the
Area Editor (discussed below), those Areas only exist while
editing that Area. When you Quit the editor they will NOT appear
in the Areas list.
7 File Area Editor Operation
The file area editor starts by reading the directory of the
selected area. It then reads FILES.BBS, if it is there. A
working array of information is displayed for manipulation. Each
line is numbered on the screen, with the current line in reverse
video (and an asterisk in case color is not available). If a
comment or description is too long to fit on the screen (because
of the line number), its display is truncated, but no data is
lost. The entire string is available for editing (discussed
below).
If there is no FILES.BBS, and the Area Directory is empty, the
display states: 'New FILES.BBS, no files found'. The only
actions available are to Insert comments, or Edit the one line
that is displayed. If no Inserts or Editing is done, a FILES.BBS
is NOT created. ANY modifications will cause a FILES.BBS to be
created in that subdirectory.
Per FIDO specs, any line in FILES.BBS is either a File Name and
optional Description, or a Comment. If the first character of the
line is a space, dash, '%', the Esc char, or '@', the line is a
comment, otherwise it is a file. (The '% ' char is used by Fido
12 for display control, the Esc char is used by OPUS for colors
and display control.)
If FILES.BBS is found, its contents are displayed. Files named
in FILES.BBS which are found in the directory are displayed with
their file size and description. If Showing File Dates, they are
displayed between the file size and comment, with two spaces
between file date and the comment (just like OPUS). File names
which are not found are tagged 'Missing' in place of file size.
If the 'A' command line parameter was NOT used, any files in
the area directory, not named in FILES.BBS are appended to the
working display array, with their size [date] and a description
of 'Orphan'. Using the 'A' parameter automatically adopts these
files, and they appear no different than the files already in
FILES.BBS.
The bottom two or three lines of the screen display the
available commands, and prompts. The capital letter shown in
each mnemonic is the character which will invoke that command.
Page 15 (c) 1988 Dennis Glaeser
FIDO-FAM Version 5
Character commands do not require a terminating carriage return.
Numeric input requires a terminating carriage return. The bottom
line changes to show the valid commands for the current line.
In general the ESC key will abort any input or operation in the
Area Editor. Most displays show ESC as an input option.
7.1 Cursor and Function Keys
When running the program locally on an IBM PC (or compatible) the
Arrow Keys, PgUp, PgDn, Ins, Del, and some Functon keys, may be
used, as noted below, in place of the appropriate character
command. This assumes, of course, that the response generated by
those keys has not been modified through the use of ANSI
commands, 'Smart Key' programs, or Command Line Editor programs,
etc.
During remote operation from a machine which has a PC style
keyboard, the numeric equivalent of the Cursor keys perform the
same function. Therefore, you may be able to toggle NumLock On
and use the 'Cursor Keys'. This mechanism will work either Local
or Remote. The Numeric keys which are not on the Cursor Key Pad
act the same as those on the Cursor Keys.
No warranties expressed or implied about the use of Cursor or
Function keys on any non PC-clone. Try them, if they work, fine.
If they don't, use the character commands.
Note that the Local HOME/7 and END/1 keys have been implemented
but no character command has been defined for these functions.
7.2 Cursor and Screen Movement
Command Description
-----------------------------------------------------------------
7, Home jump to top of data
1, End jump to end of data
U, 9, PgUp page up a full screen or to the top of the data
D, 3, PgDn page down a full screen or to the bottom of the
data
P, 8, UpArrow move to the previous line
N, 2, DnArrow move to the next line
Page 16 (c) 1988 Dennis Glaeser
FIDO-FAM Version 5
[, F5 move cursor to top of display
], F6 move cursor to bottom of display
CTRL-P, F1 scroll window and cursor UP one line (cursor
appears stationary on screen, display scrolls
'behind' it)
CTRL-N, F2 scroll window and cursor DOWN one line (cursor
appears stationary on screen)
ALT-P, F3 scroll window DOWN one line - cursor remains on
same line (cursor moves UP, but is on same line
number)
ALT-N, F4 scroll window UP one line - cursor remains on
same line (cursor moves DOWN, but is on same line
number)
7.3 Commands to Mark/Unmark Lines
Marked Lines are highlighted and have the '<' char following the
line number (for non-color displays). If the current line is
Marked, its '*' is changed to a '#'.
Command Description
-----------------------------------------------------------------
B - Mark a Block of lines
You are prompted to enter the range of lines:
Mark line [..line] xx (xx is the current line
number)
You may respond with a single number, two
numbers, or simply hit RETURN. If the input is a
single number, or RETURN, you will be prompted
for the last number in the desired range. If the
input was two numbers (separated by any
non-numeric characters) that range is used. You
may enter a large number for the high end (ie:
9999) and the actual max value will be used.
Invalid input (ie: first > last) is ignored and
the operation is aborted.
X - UnMark a block of lines
Works the same as the 'B' command.
CTRL-B - Mark ALL lines
Page 17 (c) 1988 Dennis Glaeser
FIDO-FAM Version 5
as described.
CTRL-X - Unmark ALL lines
as described.
* - Mark/UnMark the current line
This toggles the current line only.
Editing Commands (described below) which work with Marked Lines
operate in this manner:
If there ARE marked lines, the prompt is:
The views and opinions stated within this web page are those of the
author or authors which wrote them and may not reflect the views and
opinions of the ISP or account user which hosts the web page. The
opinions may or may not be those of the Chairman of The Skeptic Tank.