home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
ftp.wwiv.com
/
ftp.wwiv.com.zip
/
ftp.wwiv.com
/
pub
/
BBS
/
BBSEE14.ZIP
/
BBSEE.DOC
next >
Wrap
Text File
|
1991-10-12
|
67KB
|
1,997 lines
░░░░░░░░░░░ ░░░░░░░░░░░ ░░░░░░░░░░ ░░░░░░░░░░░ ░░░░░░░░░░░
░░ ░░ ░░ ░░ ░░ ░░ ░░
░░ ░░ ░░ ░░ ░░ ░░ ░░
░░░░░░░░░░ ░░░░░░░░░░ ░░░░░░░░░░ ░░░░░░░░░░ ░░░░░░░░░░░
░░ ░░ ░░ ░░ ░░ ░░ ░░
░░ ░░ ░░ ░░ ░░ ░░ ░░
░░░░░░░░░░░ ░░░░░░░░░░░ ░░░░░░░░░░ ░░░░░░░░░░░ ░░░░░░░░░░░
BBSee 1.4 User's Manual And Reference
Copyright (C) 1991 Martin Vallevand
Table of Contents
Chapter 1 General Information . . . . . . . . . . . . . . . . . . . . 1
1.1 License . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.2 Files on the 'Program' Disk . . . . . . . . . . . . . . . . . 2
1.4 System requirements . . . . . . . . . . . . . . . . . . . . . 2
1.4 Background . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.5 Credits . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Chapter 2 Configuration . . . . . . . . . . . . . . . . . . . . . . . 4
2.1 BBSEE.CFG . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2.2 General directory and files . . . . . . . . . . . . . . . . . 5
2.3 Output Directory files . . . . . . . . . . . . . . . . . . . 6
2.4 Single word exclusion, . . . . . . . . . . . . . . . . . . . 7
2.5 Source / BBS Board Selection . . . . . . . . . . . . . . . . 7
2.6 On-Line Help . . . . . . . . . . . . . . . . . . . . . . . . 8
2.7 Analyze Directory . . . . . . . . . . . . . . . . . . . . . . 8
2.8 Colour Installation . . . . . . . . . . . . . . . . . . . . . 8
2.9 Miscellaneous . . . . . . . . . . . . . . . . . . . . . . . . 9
Chapter 3 File option . . . . . . . . . . . . . . . . . . . . . . . 10
3.1 File importation . . . . . . . . . . . . . . . . . . . . . 10
3.2 File Duplication . . . . . . . . . . . . . . . . . . . . . 11
3.3 Uncompress and Import NEWFILES.DAT . . . . . . . . . . . . 12
3.4 Create Record . . . . . . . . . . . . . . . . . . . . . . . 12
3.5 DOS Shell . . . . . . . . . . . . . . . . . . . . . . . . . 12
3.6 Record Editing . . . . . . . . . . . . . . . . . . . . . . 13
Chapter 4 Search Option . . . . . . . . . . . . . . . . . . . . . . 14
4.1 Word Search . . . . . . . . . . . . . . . . . . . . . . . . 14
4.2 Filename Search . . . . . . . . . . . . . . . . . . . . . . 14
4.3 Output Search List . . . . . . . . . . . . . . . . . . . . 14
Chapter 5 Catalog option . . . . . . . . . . . . . . . . . . . . . . 16
5.1 Analyze directory . . . . . . . . . . . . . . . . . . . . . 16
5.2 Catalog floppy . . . . . . . . . . . . . . . . . . . . . . 16
5.3 Uncatalog floppy . . . . . . . . . . . . . . . . . . . . . 16
5.4 Label floppy . . . . . . . . . . . . . . . . . . . . . . . 17
5.5 Make Catalog File . . . . . . . . . . . . . . . . . . . . . 17
5.6 Cross Reference . . . . . . . . . . . . . . . . . . . . . . 18
5.7 Describe Floppy . . . . . . . . . . . . . . . . . . . . . . 18
Chapter 6 Tag option . . . . . . . . . . . . . . . . . . . . . . . . 19
6.1 Delete tagged file . . . . . . . . . . . . . . . . . . . . 19
6.2 Create download file . . . . . . . . . . . . . . . . . . . 19
6.3 Remove tags . . . . . . . . . . . . . . . . . . . . . . . . 19
6.4 View tags . . . . . . . . . . . . . . . . . . . . . . . . . 19
6.5 Create upload files . . . . . . . . . . . . . . . . . . . . 19
6.6 Output tags to disk . . . . . . . . . . . . . . . . . . . . 20
Chapter 7 Using the program . . . . . . . . . . . . . . . . . . . . 21
Chapter 8 Command line arguments . . . . . . . . . . . . . . . . . . 22
Appendix A Registration Information . . . . . . . . . . . . . . . . 23
Appendix B Program Return Codes . . . . . . . . . . . . . . . . . . 25
Appendix C Cursor Movement and Editing Keys . . . . . . . . . . . . 26
Appendix D Import Usage . . . . . . . . . . . . . . . . . . . . . . 27
Appendix E Database Packing . . . . . . . . . . . . . . . . . . . . 28
Appendix F Deleted File List Maintenance . . . . . . . . . . . . . . 29
BBSee Version 1.4
Chapter 1 General Information
BBSee is a program designed to simplify the process of finding files
on BBS's that you access, and cataloging files that you have
downloaded. It also provides many other functions designed to make up
and downloading files easier.
1.1 License
BBSee is a commercial package, that is being distributed as shareware
for personal evaluation only. This is not public domain, or free
software. After a one month period of evaluation, if you decide not
to purchase a registered version of BBSee, you must delete all copies
of BBSee, in compressed or uncompressed form, that you have in your
possession. You are also allowed, and encouraged, to distribute the
shareware package freely, to potential users and on-line BBS's, as
long as you do not charge for this service, and you provide a complete
set of programs as specified in section 1.2 of this document.
BBSee has been subject to thorough testing, and every reasonable
effort has been made to make BBSee a safe, fast, and easy to use
package. However the databases that BBSee makes, can easily be the
largest databases that many people will ever see on their computers.
With such large systems, there are many ways to corrupt the database,
including rebooting the computer or powering down during use of BBSee,
so care is advised.
Also, it is impossible to test this program on the many combinations
of computer software and hardware available in the PC marketplace, and
to anticipate all uses for software. Therefore all copies of BBSee,
and any program distributed with the package, shareware, registered,
or advanced, are purchased AS IS, and Martin Vallevand will not be
held responsible for any damage, to your computer, programs, data, or
anything else for that matter, that may result from its use. By using
BBSee you consent to do so at your own risk. If you find that this is
unsatisfactory, DO NOT run BBSee.
To register BBSee contact:
Martin Vallevand
TAC Systems
Suite 100
56 Fourth Avenue
Ottawa, Ontario
K1S 2L2
Voice (613)233-1728
For further information Martin Vallevand can be contacted on the
SYNAPSE BBS. See Appendix A for further information.
Page 1
BBSee Version 1.4
1.2 Files on the 'Program' Disk
BBSEE.EXE Program File
BBSEE.DOC Documentation
BBSEE.HLP On-Line Help File
BBSETUP.EXE Modifies BBSEE.CFG
SAMPLE A file for use as a test (from SYNAPSE)
README.2ND Latest file information.
REGISTER.FRM Form used to register BBSee.
GO.BAT The first thing most people do.
WHATS.NEW Information on new features in this release.
HISTORY Revision history for BBSee.
QUICKST.ART Start using BBSee now.
IMPORT.EXE General BBS file listing conversion utility.
Files on the 'Extras' Disk
READDEL.EXE Delete file reader.
WRITEDEL.EXE Delete file writer.
PACBBSEE.EXE Database 'pack' utility.
READCAT.EXE Create PCBoard list from CatDisk output.
WRITECAT.EXE Update BBSee database from CatDisk output.
CAT2BBC.DOC Documentation for the above.
The files on this disk are not essential to run BBSee, but they
certainly will make its use more versatile. Depending on file import
needs other utilities may be added to this list. Check the README
file for the latest information.
System requirements
100% IBM compatible computer.
MS-DOS 3.30 or higher. (lower versions were not tested)
Roughly 256K free RAM.
9 File handles and open DOS files (from config.sys).
You must have a line of FILES=14 or more in your CONFIG.SYS file.
Hard disk strongly recommended.
BBSee will use as much disk space as you'd like to devote to BBS file
listings. The faster the disk transfer rate the better. The addition
of disk caching, even as small as 128K, can improve performance by
approx. 500%.
1.4 Background
This program is written in the large model of Borland C++ 2.0, CXL 5.2
and the MIX C/database toolchest. I believe these to all be
excellent, inexpensive, packages although the database package can be
Page 2
BBSee Version 1.4
slow on adding records to a large database. A fast string search
algorithm, the Boyer-Moore algorithm, is used to find words. To me
this is to brute force searching, what qsort is to a bubble sort.
Most of the overhead is in the disk read. CXL has been superseded by
TCXL however I found too many bugs in version 5.51 to use it, and have
not yet tried 5.52.
BBSee and BBSetup has been compressed with LZEXE, and further
processed to disable UNLZEXEing as a very limited means of protecting
the programs from alteration. The registered version can be ordered
in uncompressed format if you specify this on the order form.
All the file access in the BBSee program use standard Turbo C calls,
with the exception of the routines that manipulate the label on the
floppy, which use extended FCBs and DOS interrupts. Other than
directly writing to the floppy disk sectors, I don't believe there is
another method to write the volume label. I have read, that everyone
should use the DOS label program to label diskettes, for technical
reasons, so I will mirror that recommendation.
Regardless of whether you use BBSee or not, I strongly recommend that
all users of DOS 4.00 or higher, always run the DOS SHARE.EXE command,
to protect themselves from deficiencies in the FCB structures in their
version of DOS. As well, if your drives support disk change
indication, you will be provided with better protection for your
valuable archive floppy disks.
1.5 Credits
I would like to thank the following people for assisting me in the
development of this software. The diligent work of this team of beta
testers and proof readers has helped me so much, and I believe their
many suggestions have greatly enhanced the functionality of BBSee.
Bernard "The Exterminator" Desruisseaux for finding bugs big and
small, and for providing many good (and sound) ideas.
Paul "The Cosmetician" Loshuk for keeping the documentation and help
clean, and for prompting me to take BBSee beyond the simple program I
first intended.
Michel Tordion, for providing insight, and listening to me babble.
Phil Lachance for his help testing BBSee under Windows.
Angela Tweeddale for putting up with me showing her the program, and
having to read the documentation over-and-over again, without
complaint.
Page 3
BBSee Version 1.4
Daniel Coulombe for allowing SYNAPSE to be used as the basis for the
beta testing, and the 'home' of BBSee.
Page 4
BBSee Version 1.4
Chapter 2 Configuration
The most complicated portion of using BBSee, is the configuration that must
be done before BBSee can be run. BBSee needs to know the location of many
files and programs, if you intend to use all its options. If you don't
install BBSee properly then these options may not function properly, or
BBSee may exit with an error code. Also BBSee will overwrite certain
files, if they exist, so some care should be used in reviewing default
filenames.
BBSee configuration is performed in a program, BBSETUP.EXE that handles all
aspects of BBSee configuration. Although this program MUST be run
initially, it also can be used to reconfigure options at any time. As you
become proficient in the use of BBSee, you will probably go into BBSetup,
many times, to change the inclusion and exclusion word lists.
Note as a general rule whenever user input is required in BBSEE.EXE or
BBSETUP.EXE, selecting <Esc> will cancel the operation, <F1> will get help
if available, <Enter> will select the option or move to the next option and
<Ctrl Enter> will process an entire set of choices. See Appendix C for
further information.
2.1 BBSEE.CFG
All configuration information is contained in the file BBSEE.CFG.
BBSee searches for the file BBSEE.CFG in the default directory, and if
not found BBSee searches in the same directory that BBSEE.EXE was run
from.
If BBSEE.CFG is not found in the above steps BBSee will abort
indicating that BBSETUP.EXE must be run first.
To create BBSEE.CFG it is necessary to run the program BBSETUP.EXE
first. Do not create this file manually. The rest of this section
deals with using this program.
BBSetup.
BBSetup is a DOS program that runs from the DOS prompt. It creates
the file described above, BBSEE.CFG, in the default directory. You
can create as many BBSEE.CFG files as you wish. The main purpose for
doing this would be to maintain separate database files, exclusion
lists and floppy catalogs.
Page 5
BBSee Version 1.4
The main menu for BBSETUP.EXE is as follows:
╒═════ BBSee Configuration ═════╕
│ General directories and files │
│ Output directory files │
│ ───────────────────────────── │
│ Single word exclusions │
│ Paired word exclusions │
│ File extension exclusions │
│ Required Words │
│ BBS/Source names │
│ ───────────────────────────── │
│ Analyze Directory │
│ Colour Installation │
│ Miscellaneous │
│ Exit │
╘═══════════════════════════════╛
2.2 General directory and files
The directories and filenames for all files used by BBSee are outlined
in this section. Note that the sub-directory mentioned should be of
the form drive:\subdirectory with no trailing backslash. If you must
use the root directory, which I don't recommend, DO NOT include the
backslash. These fields are checked for the existence of drives or
directories, however you should ensure that they are correct. PLEASE
BE CAREFUL.
The first step in configuration is to enter the name of the master
database and the catalog database. The reason that the database
filenames are not fixed is to allow multiple BBS list databases and
disk catalogs, in separate sub-directories, if desired.
BBSee creates in total five permanent database files,
1. the master database file and index, (mastername.DB and .IDX),
2. the floppy catalog file and index, (catalogname.DB and .IDX),
3. the index of deleted files, ( mastername.DEL ).
The BBS description directory is the sub-directory where most of your
file description lists will be located. This can be modified during
the import function of BBSee.
The Download File directory is the sub-directory where your
telecommunication program places downloaded files. This is used in
the Analyze Directory option of Catalog.
Archive Files directory is the sub-directory where files could be
moved after being downloaded, but before being moved to floppy disk.
This is also used in the Analyze Directory option.
Page 6
BBSee Version 1.4
Qmail File directory is the sub-directory where your .QWK files are
kept. NEWFILES.DAT files in the .QWK files, can be extracted from
these files and imported into the master database. Other .QWK files
in other sub-directories on the same drive can be selected by
navigating through the disk using the cursor. This directory is used
in the Import/Unzip Newfiles option.
PKUNZIP directory is the sub-directory where PKUNZIP.EXE exists. This
is also needed in the Import/Unzip Newfiles option.
The Output directory is the working directory for BBSee to place
temporary files, and to locate most output files. See the following
section on output directory files for further information.
The Tag files directory is where BBSee places the download and upload
files from the tagged file option. The extension field should contain
the extension that will be appended to the output file that BBSee
creates, depending on whether the upload or download option was
selected within BBSee. A blank is possible. The first part of the
filename will be the name of the BBS. This feature is intended to be
used with automated file/mail management programs, such as Access(QMM)
Liberator, and Intellicomm.
2.3 Output Directory files
This screen contains the default filenames for the files, other than
the databases, created by BBSee. All of these files are placed in the
output directory. If you don't want to create a file for any of these
options, specify NUL as the filename.
The Added file list is the filename used as output of all new files
added to the database. This is useful when batch updates of files are
undertaken, however for the most part I recommend NUL as the device
for this option, as it causes a lot of disk overhead.
The Discard file is the name of the file that is to contain
information about files that were discarded during the import process,
for each of the various rules used in the import. Note that this file
is opened in append mode. I suggest that you use the NUL device once
you have a reasonable idea of how data is imported. While learning
BBSee I suggest that you create this discard file, and examine it to
see what BBSee rejects, until you are satisfied with your exclusion
word lists.
The Duplicate file shows filenames and descriptions when there is
potential for a description change. A '>' indicates that a
description was replaced. This file should be watched carefully as
the potential exists that file descriptions will not match the
filename that is duplicated. Filenames with 3 or fewer characters in
the filename will not have their descriptions replaced, as the short
Page 7
BBSee Version 1.4
filenames are often not unique, especially when you access many BBS
sources.
The Word Search Output file is the file which BBSee creates when you
output the results of a search or the output of tagged files to disk.
This is a PCBoard-like file with the inclusion of the BBS and file
catalog locations. Output to this file will be added to the end of
the file if the indicated file is found.
The two catalogs files are the output files chosen in the output of
the floppy catalog option. See Section 5.5 for further information.
The cross reference extension is the extension used in making a BBS
cross reference file. See Section 5.6 for further information.
The floppy description file is the output from the Describe Floppy
option of catalog. See Section 5.7 for further information.
The usage log is a facility that allows you to log certain activities
within BBSee. The main purpose is to log additions to the database,
for those people that want to monitor database growth.
2.4 Single word exclusion,
Paired word exclusions,
File extension exclusion and
Required words.
These options allow for processing of file descriptions based on
certain words, (actually strings) so that the file can either be
included, or excluded from addition to the BBSee database. If you
include and exclude words 'smartly' the size of your database can be
greatly limited. Note, if for example, you specify to exclude the
word 'windows' (you do not want all files associated with Windows v3.0
to be in you database); should you later start running Windows and
want files and accompanying descriptions to be included, you must
reread in the entire original file list(s). A certain amount of
thought, both about your present and future computing needs should be
done before deciding on words to exclude and include.
Some strings may be better specified as words, ie you may wish to
exclude descriptions with the word BMP, forgetting that it is included
in some words ( IBMPC ). To include an entire word use the leading
and/or trailing spaces by enclosing the word with the space in double
quotes. ("gif ", " pcx "," bmp", etc.).
2.5 Source / BBS Board Selection
The third part of the configuration is a list of the BBS names that
you plan to include in the list. The order of these names is
important. See the section on file duplication for further
Page 8
BBSee Version 1.4
information. You can also include the name of a friend as a 'BBS' if
you intend to share file lists. The Format and Options selections are
used in processing non-PCBoard files.
Note that the shareware version of BBSee allows up to 3 BBS sources,
plus one UNKNOWN source. There also is an advanced version of BBSee
available which will allow 14 BBS sources, plus the UNKNOWN source.
2.6 On-Line Help
The file BBSEE.HLP provides on-line help for BBSee. It must be
located in the same subdirectory as BBSEE.EXE. This is to allow
running BBSee from a path. As such, no configuration is necessary.
BBSee will run without this file, it simply produces an error message
when the help function is called.
Online help is not meant as a substitute for reading this
documentation, but as a quick reference to certain menu functions.
The help is available by pressing F1 from almost any menu or sub-menu
option.
2.7 Analyze Directory
This option provides a means to create a personalized batch file that
can process files on your computer in any manor you wish. The ~ macro
allows substitution of default directory information into the batch
file when the batch file is created. This information comes from
other options within BBSETUP.EXE. NOTE that lines two and three of
this batch file ONLY apply to files with the .ZIP extension.
There are two files created in the Output Directory for this option,
which are set by the top two fields on this screen. See Section 5.1
for a detailied explanation of how these files are created and used.
2.8 Colour Installation
This option will allow for setting up colours within the various menus
of BBSee. In the shareware version you are able to explore this
feature, but it will not save changes for any option except the Search
Window. The advanced version of BBSee will provide further colour
configuration capabilities.
As well, if you a have a CGA that produces flicker, flicker
elimination can be obtained by instructing BBSee to wait for video
retraces before writes. Mono mode disables colour settings for use
with monochrome monitors. Enter a Y in the appropriate field to
enable these selections.
Page 9
BBSee Version 1.4
2.9 Miscellaneous
Under this option there are data fields that are used in various
functions of BBSee. The file date option excludes files older than a
certain date from being added to the database. This exclusion date
default is not permanent, it can be modified in the File menu
selection of BBSee, under the "Modify Import Options" sub option.
Although you may want to specify that older files, such as pre-1986 be
excluded, you must remember that some sources have files dated as
early as 01-01-80. A suggestion is to browse through the lists you
wish to read into BBSee and determine if any of these files exist.
The archive type specifies the archive method being used for the .QWK
package. Presently, only the PKUNZIP program can be used to unarchive
.QWK packets. You must manually extract the NEWFILES.DAT file from
your .QWK file, if you use another archiving program. This may be
changed in later versions if there is significant demand.
The effective cps is the cps rate used to estimate the download time
for marked files. You may wish to change this to match your effective
modem speed (ie 270 for 2400 baud MNP, 1600 for a USR HST). Of
course, the BBS you are calling will have to match your modem speed.
Page 10
BBSee Version 1.4
Chapter 3 File option
The heart of the BBSee program is a master database of file descriptions
that can come from many sources. File description listings can be imported
from BBS directory listings, Qmail QWK files, telecommunication program
screen captures and log files, file output from BBSee itself, and they can
be entered manually.
3.1 File importation
Importation is the method of bringing a file list into BBSee and
processing the listing, line-by-line, into a BBSee database record.
Because of the many, many different list types, it is impossible to
guarantee that all files in a list will be included.
BBS file listing, are incorporated into the database using a
sequential read of a DOS text (ASCII) file, each line being one
record. The layout of a file description 'record' is one that I have
adopted based on viewing PCBoard file description listings. Anyone
having definitive specifications is encouraged to forward them to me
as described in Appendix A. The file "record' layout that BBSee
expects is:
filename position 1-12
spaces position 13-14
filesize position 15-21
spaces position 22-23
date position 24-31 ( format mm-dd-yy )
spaces position 32-33
description position 34-80
Any lines that follow this original record with blanks in columns 1-33
and text in columns 34 - 80 are treated as continuation of the
description record. The pipe character | is allowed to indicate the
start of a continuation line if it is the first character of a line.
An asterisk in position 32 is allowed. This sometimes indicates a new
file in a BBS on-line search.
Data is incorporated into the database from the parsed text file,
using the exceptions input in BBSetup. The rules built into the BBSee
import logic function as follow:
- Filenames must be uppercase.
- All descriptions are converted to lower case. The character set
is limited to the extended ascii characters between 32 and 165.
No allowance is made for code pages.
Page 11
BBSee Version 1.4
- If the file contains one of the required words it is considered
mandatory. This file will be added in all instances.
- Records with a description containing two paired exclusion
strings, will not be entered into the database.
- Any file description continuation lines that begin with the words
'Uploaded by .....' or 'Last filedate in .ZIP ..' or containing
'files - New:' will be stripped out.
- Ending punctation character . and ! are removed.
- Catalog only descriptions always replaced.
- Files descriptions beginning with (CRS) will have the (CRS)
stripped. the 'Last Revision Date...' string for CRS files will
also be stripped.
Note that if you manually create a PCBoard-like text file using a text
editor, you should ensure no tab characters are in your output
document, as they can make it appear that the file meets
specifications, when it truly does not.
Another program supplied in BBSee, IMPORT.EXE, is intended to assist
in the automatic creation of file lists, by parsing non-standard file
lists into the PCBoard 'standard' that BBSee uses. In general, if you
don't know if a BBS is a PCBoard type, run the import file through the
import program to see if it meets the PCBoard column specs. General
use of this program is outlined in Appendix D.
If this non-standard BBS file can be converted automatically using
IMPORT, BBSee has the capability of performing this conversion when a
file is imported. Simply specify in BBSetup, that the file type is
type AUT, (for automatic), rather than PCB. If you must do a manual
IMPORT, specify ASK for the file type, and BBSee will prompt you
before importing the file. See Appendix D for further information.
Note that the nature of the database will not allow automatic
determination, and indication of various file areas and conferences on
the BBS. This is extremely difficult to detect automatically, and so
the feature is not available.
3.2 File Duplication
There is a mechanism in place to prevent the addition of filenames
with different descriptions, sizes, times and extensions into the
master database. Filenames from description listings ( excluding
extension) are compared to those already in the database and if the
filename is found certain database modifications may take place.
PRIORITY will be given to the BBS names higher on the configuration
Page 12
BBSee Version 1.4
list of sources (the lower number). The extension, file date, and
file size stored in the database will be that of the highest priority
source.
The same is true of the description, although if the filename is more
than three characters long, the description having the most
characters is stored in the database, regardless of the source. No
method exists to eliminate this problem, or to prevent replacing file
descriptions, without user prompting, which is not desirable. This
number can be changed if desired, in the File - Modify Import Options
window.
3.3 Uncompress and Import NEWFILES.DAT
Users of Qmail or MarkMail with offline mail readers are probably
aware that it is possible to browse all files new to the BBS from a
previous date, offline. I am not going to try to explain how these
programs works, rather I'll explain how BBSee handles the importation
of the new file information contained within them. If you plan to use
a BBS regularly, and it has the above option, usually configured as
doors, I suggest that you investigate them.
Contained in most .QWK files downloaded with the 'scan for newfiles'
option of the mail door turned on, is a file called NEWFILES.DAT.
BBSee will allow for a semi-automatic import of this file description
list into the master database. Within BBSee, after selecting the
Unzip option, use the cursor to select the .QWK file that you wish to
import into the database. After this, select the BBS source of this
file. The file description records will then be entered into the
database. This of course assumes proper configuration of the mail and
archive file directories.
If your BBS has this capability, regular use of this feature will keep
your database up-to-date, and eliminate the need to regularly download
the entire list of newfiles added to your BBS's.
3.4 Create Record
Using this option it is possible to create a master database entry.
The best use for this option is to add unknown files, personal files,
and obsolete files to the database so that the floppy disk catalog can
also be updated. This file is not subject to any of BBSee's import
'rules'.
3.5 DOS Shell
This option allows exiting to DOS to execute many DOS programs and
commands. Do not run any TSR's, reboot, or turn off you machine while
you are in the shell. To return to BBSee you must type the command
Page 13
BBSee Version 1.4
EXIT at the DOS prompt. It is better to quit BBSee and come back if
you must leave the program for a long period of time.
If you use BBSetup in the shell, the changes you make will not take
place, until you quit and execute BBSee.
3.6 Record Editing
There is presently no mechanism in place to edit an existing database
record. If you must change a record, you must create an ASCII text
file meeting PCBoard specifications, with a description longer than
currently in the database, and 'Steal' the description.
Page 14
BBSee Version 1.4
Chapter 4 Search Option
Search for words and/or filenames. Outputs the filename if found, and
also, if the filename has been catalogued on floppy disk, the label and
directory of the catalogued floppy can be displayed.
4.1 Word Search
This option allows you to search for strings within the database.
Because of the nature of the search the most unique word should be in
the primary word field. The primary word is searched in all filenames
and description. The qualifier and exception words are only matched
in the descrition.
The search on a word continues until the entire database is read or a
complete screen of information is displayed, at which time the
filename will be highlighted with a selection bar. It is then
possible to select filenames by moving the selection bar up and down
using the cursor. Full database information on the selected filename
is available by typing the letter V (for View). <ESC> will abandon
the search at this point. Also see the TAG option.
Hitting a key while a search is in progress, ie when no selection bar
is displayed, will cause a prompt which will allow you to abort the
search.
Typing <Alt L> will lock on the view window until <Alt L> is pressed a
second time, or the <ESC> key is pressed. The default View Window
lock (On or Off), can be configured in BBSetup.
4.2 Filename Search
Using this option will allow you to perform an indexed search on the
filename. This is by far the speediest search, if you have a pretty
good idea of the filename, or you want to look for various versions of
a particular file. This is equivalent to a PCBoard <L>ocate without
requiring the trailing *.*.
To 'browse' the file near the search, the page/cursor up and down keys
can be used. A file also can be tagged, using the <keyboard +> and
untagged using the <keyboard -> keys. See tags for further
information.
4.3 Output Search List
This option creates an ASCII listing of the files that meet the same
search criteria as an on screen search. This listing is in PCBoard
like format with the addition of the BBS source, and any disk
cataloging information that you may have. This listing can be
imported into BBSee. If this file exists it is opened in append mode.
Page 15
BBSee Version 1.4
4.4 Show All (Catalog)
To toggle the search results between displaying the master database
information, to displaying only information also contained in the
floppy catalog, hit enter on this option.
Page 16
BBSee Version 1.4
Chapter 5 Catalog option
The purpose of these functions is to improve disk maintenance of downloaded
files. I find that I download a large quantity of files that start to
accumulate in my download sub-directory. Using the various options in this
section will lessen this problem, and allow you to easily catalog your
downloaded files, on floppy disks.
5.1 Analyze directory
This option uses the batch file specifications created in the
configuration. Reviewing what I do, should assist you in creating a
usable analyze.bat file. These are implemented as a batch file so
that you may inspect the file prior to running it. This sample could
be further modified to meet your personal requirements.
The default configuration functions as follows. Files in the download
directory are compared with the description database. If they are
found they are added to a file, by default, ANALYZE.BAT, that can
perform the following operations when executed. Note that in all
cases batch options 2 and 3 will only work for .ZIP files.
1. File is copied from download to archive directory.
2. README.ROS and READ_ME.TXT ( Rose Media ads ) are removed from
the ZIP file.
3. Comments are removed from the file ( This requires a shareware
package STRIPZIP).
4. Original file is deleted from the download directory.
I would recommend that if you approximate my archiving method, that
you also investigate programs such as FILL or ICOPY. These will
assist in copying files from this archive directory to floppy disk,
and they will maximize your floppy disk utilization.
A second output file from this option is a list of files that were not
found in the master database. A single file, by default, NOTFOUND.ADD
is created that meets the specification for a BBS file listing. This
file description can be edited with a text editor (the description is
initially indicated *Not Found*), and can be imported directly into
the database. BBSee does not like the tab character so be careful
when you use your text editor.
5.2 Catalog floppy
5.3 Uncatalog floppy
Both of these functions will work by inserting the desired floppy into
the appropriate disk drive. Additionally a floppy can be uncataloged
by volume label name.
Page 17
BBSee Version 1.4
A floppy can be cataloged, if it meets two criteria, a) the floppy has
a volume label and b) a matching volume label has not already been
cataloged. If files exist on the floppy that do not have descriptions
in the BBSee master database, you may wish to create a Floppy
description file, edit it with the proper descriptions, and import
this edited file into BBSee, with an unknown category. If not, an
entry with the 'Catalog only' description will be entered into the
master database.
If you insert a floppy with a volume label that has already been
cataloged, BBSee will ask if you want to replace the existing catalog
entry for that label. Be careful when you label your floppies, as you
can easily overwrite your catalog database entries, on an update.
5.4 Label floppy
This option allows you to label floppies without exiting to DOS. If
there is no volume label on your floppy, a default unique label
assigned by BBSee will be displayed. You can edit or change this if
you desire.
The default layout of this name is established in BBSetup. There are
two components, the name component and the number component. The name
component is up to seven characters, the number component is up to
9999. They must be separated by a space. BBSee will increment the
number component automatically to allow for the unique label, and will
force the number to have a 4 character length, by padding with zeros,
to make Catalog listings sequential. BBSee does not modify the
BBSEE.CFG file in performing this function.
If you enter a volume label manually using the formula described
above, it is also possible to an incremental list of files, ie CFILES
0001, TELIX 0001. Subsequent calls to the label function will give
you the next available number. Remember to include the leading zeroes
for the first count that you input.
If a volume label exists on a floppy, that will be the label that is
shown in the input window. If you desire to use the automatic label
feature described above, you must first delete the label, by inserting
spaces, and then call the label function again, to get the proper
default label.
5.5 Make Catalog File
This option creates a list of files you have cataloged, sorted by
either disk volume, or filename. This list is useful as it is output
in a format that BBSee can use as input. This allows for sharing file
lists with friends and other user groups.
Page 18
BBSee Version 1.4
5.6 Cross Reference
A catalog cross reference creates a list of files you have cataloged
against a list from another source. The list is a list of
differences. This should make it easier to determine what to upload
to other sources. Remember to check a BBS before uploading to ensure
that you don't upload something they received since your last file
import.
5.7 Describe Floppy
This option allows for the creation of a file, in PCBoard format,
containing any file descriptions associated with files on a floppy.
If a file has no description in the master database, the message, 'Not
in BBSee catalog' is output to the file, in the description. Since
this file is in PCBoard format, if you edit the 'not in BBSee catalog'
message with a more appropriate description and then import the file
into BBSee, the master database will have more valid data.
Page 19
BBSee Version 1.4
Chapter 6 Tag option
When file searches take place, it is possible to 'tag' a file. This is
done using the <Keyboard +> key, or the T key. Files can be individually
untagged with the <Keyboard -> key or the U key. Additional options are
available in the Word Search Option, <Ctrl T> tags a screen of filename
'hits', and <Alt T> tags all screens of filename 'hits'. File tags are
indicated with the character.
6.1 Delete tagged file
This option deletes all tagged files from the database. These
filenames are permanently removed from the database. In fact they
cannot be re-added (See Appendix E). This feature is to ensure that
you don't have to delete the same files every time a complete BBS file
list is subsequently imported, for update purposes. This will also
remove the tags.
6.2 Create download file
This option creates a download file in the tagged file dir. The
format of the filename is bbsname.{defaultextension} ie. SYNAPSE.DOW.
The layout of this file is a simple sequential file of tagged
filenames that are found in the master database on the selected BBS.
This will remove all tags from the selected BBS, unless the indicated
bbsname has no tagged files.
6.3 Remove tags
The tag is removed from every tagged file. All file information is
left unchanged.
6.4 View tags
Provides an on screen listing of all tagged files, as well as an
estimate of how long a file transfer of these files will take.
6.5 Create upload files
This option creates an output list of all tagged files, in a format
that can be edited to use with automatic file uploading facilities of
scripts Liberator, Access (QMM), Telix Square and CatCalls, and the
new program Intellicomm. The choice of these formats is configured
in BBSetup.
Page 20
BBSee Version 1.4
The options to use in BBSetup are:
Q - QMM/Access
L - Liberator
W - CatCalls - Wildcat 3.0
2 - CatCalls - Wildcat 2.0
S - Telix Square
I - Intellicomm
Note that the Upload and Download file extension need to match those
specified for use with your program. I will attempt to add support
for additional Upload/Download types if the appropriate file
specifications are provided to me. See Appendix 'A'
6.6 Output tags to disk
This option creates an output list of all tagged files in PCBoard
format. This file is opened in append mode. Tags are removed from
all tagged files.
Page 21
BBSee Version 1.4
Chapter 7 Using the program
I have included a file, SAMPLE, that is simply a small NEWFILES.DAT file
from SYNAPSE to help you test BBSee. You can later expand the actual
master database by importing your BBS's allfiles listings. I suggest that
you investigate various exclusion word combinations in BBSETUP prior to
creating your 'good' database. Once you've got the hang of it, you can of
course import files from any sources you want.
The first step, which I again emphasize as probably the most important is
to understand how to configure all the directories properly. Read the
configuration section, if you haven't already.
It is now time to run the program, that is after all why you've read all of
this in the first place.
1. Run BBSETUP.EXE at the DOS prompt. I would recommend that you make a
temporary subdirectory for this purpose. Files can be moved at a
later date.
2. Continue through BBSetup configuration.
3. Place the desired file(s) to be imported in your description
directory.
4. Run BBSee and select the File Import Option.
5. Enter the filename (wildcards are possible).
6. When you are prompted to Select a BBS, moving the cursor, or selecting
the first character, will scroll through valid options.
7. <Enter> to add files, <Esc> to abort
8. When the file update is complete you are free to explore the program.
Enjoy, and good luck!
Page 22
BBSee Version 1.4
Chapter 8 Command line arguments
1. BBSEE [primary word [qualifier 1 [qualifier 2 [exception 1]]] ]
This will start word searches directly. Blanks are not allowed,
unless they are enclosed in quotes.
ie BBSEE QMAIL
searches all filename and descriptions with qmail in them
BBSEE QMAIL READ OFFLINE CIS
search all filenames and descriptions with qmail and ( read or
offline) but not containing the string cis
2. BBSEE [-u [[drive:]directory]filename[ext] ]
This option allows for automatic updates of Qmail packages, if you
have configured the Source/BBS name to be the same as that of your
mail package. The default extension is .QWK.
ie. BBSEE -u SYNAPSE
update the master database with files from the newfiles.dat
contained in synapse.qwk in the default mail directory.
BBSEE -U C:\MAIL\SYNAPSE.QWK
as above but override using the default mail directory.
3. BBSEE [-i [[drive:]directory]filespec Source ]
This option allows for automatic importation of a file list using the
corresponding source.
ie. BBSEE -I *.* SYNAPSE
update the master database with all files in the temporary
directory for the source SYNAPSE.
BBSEE -i D:\MYDIR\FILES.LST BBS1
update the master database with descriptions from the file
FILES.LST contained in directory D:\MYDIR for the source BBS1.
Page 23
BBSee Version 1.4
Appendix A Registration Information
I have tried to keep the price for the BBSee package extremely low to
encourage people to register. At these low prices, if you use BBSee there
should be no reason to NOT register. I plan to add functionality which
BBSee does not yet have, however this will only come into being with your
support. The pricing for BBSee is as follows:
#1 $10.00 A license to use BBSee Advanced and an Activation Key, which will
provide for 14 BBS's in your master database and Colour
configuration.
#2 $20.00 #1 plus a floppy containing any new utilities and import
functions, a program to install the Activation Key, support in
use of the product and notification of upcoming releases.
#3 $25.00 #2 plus automatic delivery of version 2, whether I decide to
release it as shareware or not.
#4 $ 5.00 A license to use the shareware version of BBSee and an Activation
Key, to eliminate registration notices.
#2 $15.00 #4 plus a floppy containing any new utilities and import
functions, a program to install the Activation Key, support in
use of the product and notification of upcoming releases.
Bank or postal money orders should be sent when possible. Please make
these out to Martin Vallevand. If you send me a cheque I will wait for it
to clear, before I mail out anything. All orders must be pre-paid.
In Canada these prices are in Canadian dollars. Ontario residents also
must include the 8% PST.
All orders from outside of Canada must be paid in $US dollars. The
exchange difference will also be used to pay the difference in postage and
applicable taxes. Money orders are preferred. If you send a cheque, (on
American banks only), add $5 to the appropriate cost.
These prices are subject to change at any time.
If you are the author of a useful shareware package, and you send me a copy
of your product, registered and licensed in my name, I will either return
your package, or more likely, register you and send you the activation key
to for BBSee Advanced. Barterware?
I can be reached at
Martin Vallevand
Suite 100
56 Fourth Avenue
Ottawa, Ontario
K1S 2L2
Page 24
BBSee Version 1.4
for further information on obtaining this package. I am also open to
suggestions on methods of improving BBSee, by adding new functions or by
enhancing existing methods.
I cannot respond to letters or phone calls from users who have not opted
for the purchase of product support. Also I cannot return a disk
forwarded to me with a BBS listing, or other information, unless return
CANADIAN postage is also enclosed.
I can also be reached at SYNAPSE BBS. This BBS is an excellent IBM-only
PCBoard BBS located in Gatineau, Quebec, (very near Ottawa, the Capital of
Canada). The SYNAPSE Sysop, Daniel Coulombe has graciously allowed me to
use his BBS as a 'home' for BBSee. New users are authorized two weeks to
evaluate the BBS. The phone numbers for the public nodes are
╔═════════════╣ 12 Phone Lines ╠═════════════╗
║ Node 1: (819) 561-5268 - HST-DualStd ║
║ Node 2: (819) 243-7179 - CompuComm96 ║
║ Node 3: (819) 561-6745 - HST-DualStd ║
║ Nodes 4,8: (819) 243-0306 - HAYES 9600 ║
║ Nodes 5,9,10: (819) 561-4321 - v.32 ║
║ Nodes 6,7: (819) 561-3740 - HST 14.4K ║
║ Node 11: (819) 561-0981 - HST-DualStd ║
║ Node 12: (819) 561-0950 - v.32 ║
╚════════════════════════════════════════════╝
I also monitor many relevant conferences on Smartnet, Nanet, RelayNet, and
IntelecNet. Although I cannot guarantee a reply, you may try to contact me
through these networks.
I will attempt to maintain the latest version of all BBSee shareware
products on SYNAPSE BBS. Presently, an account has been set up for BBSEE
USER with a password of VISITOR for the sole purpose of your downloading
the current BBSee files. The format for this file is BBSEEnn.ZIP where nn
is the version number. The 'Extra' disk is also available as BBSEEnnX.ZIP.
Page 25
BBSee Version 1.4
Appendix B Program Return Codes
0 Normal exit
1 Not authorized
2 Could not open BBSEE.CFG for read
3 Invalid BBSEE.CFG
4 Configuration aborted
5 Could not open BBSEE.CFG for write
6 Error writing BBSEE.CFG
7 Could not open master database
8 Could not create master database
9 Could not open master filename index
10 Could not create master filename index
11 Could not open delete index
12 Could not create delete index
13 Could not open floppy catalog database
14 Could not create floppy catalog database
15 Could not open catalog filename index
16 Could not open catalog volume index
17 Not enough memory for BBSee
18 Input file error
19 Could not open add file
20 Could not open error file
21 Could not open download file
22 Invalid syntax on -u
23 File not found on -u
24 Could not open master database file for word search
25 Could not open output catalog file
26 Could not open cross reference file
27 Index error - rebuilt index
28 Could not open upload file
29 Could not open duplicate file
31 No NEWFILES.DAT or error in UNZIP in batch .qwk file
32 Error on batch import option
33 No filename specified on -u
34 Import failed on -u
35 BBS name not found
36 Could not open floppy description file.
37 Error on -i option in import.
38 Error on -i option, source name not found.
39 Error on -i option, Input file not found.
40 Conversion error
41 Database add error
The remedy for many of these errors will be to increase the FILES=
statement in your CONFIG.SYS file.
Page 26
BBSee Version 1.4
Appendix C Cursor Movement and Editing Keys
Cursor Movement
---------------
Arrow keys - cursor movement
Ctrl-LeftArrow - word left
Ctrl-RightArrow - word right
Home - beginning of field
End - end of line/field
Ctrl-Home - beginning of first field
Ctrl-End - end of last field
Tab - next field
Shift-Tab - previous field
Inserting and Deleting
----------------------
Ins - toggle insert mode
Del - delete character at cursor
BackSpace - delete character left
Ctrl-BackSpace - delete word left
Ctrl-T - delete word right
Ctrl-U - delete to end of field
Ctrl-Y - delete to end of form
Other Editing Keys
------------------
Enter - process current field
Ctrl-Enter - process all fields
Ctrl-R - restore field
Esc - abort data entry
Page 27
BBSee Version 1.4
Appendix D Import Usage
Attempting to import file description lists into BBSee that are not in
PCBoard format, can cause a lot of problems. To overcome some of these
problems, a utility program, IMPORT.EXE is included in the BBSee package to
assist in the import process. The function of this program is to convert
files into a usable PCBoard-like data structure. All non-PCBoard files
should be converted with this program, before you attempt to import them
into BBSee.
The syntax to the IMPORT program is
IMPORT {sourcename} {destname} pdm
p directs the number of passes that IMPORT makes on the file. The
choice is 1 or 2. Some BBS listings require two passes to eliminate
CR/LF, and Formfeed problems.
d directs the date determination of the import, Y indicates to IMPORT
to swap the day and month fields (ie the format is MM-DD-YY), N
indicates not to swap the day and month, and C indicates to check for
the date format. Of course if all days are < 13 the check will
indicate not to swap the day and month
m directs the mode of the import. IMPORT will automatically try to (the
A option) determine the appropriate columns that it uses in the import
process. You can override this if automatic mode does not produce a
workable PCBoard-like listing, by using the M (manual) option. This
mode will allow you to manually enter column details for various
fields. The filename and description fields must be entered, if the
size and/or date are missing, indicate this by entering 0 for the
start and stop column locations.
The default if the pdm options are omitted is 2CA
If the automatic mode of IMPORT works with your description list, BBSee
can also perform the automatic conversion. Input AUT (automatic) in the
BBSetup for the appropriate BBS, and enter the pd (pass and date)
parameters as determined above.
If you have a BBS listing from a major BBS that does not work automatically
with IMPORT I would very much appreciate it if you would send me a disk,
containing a sample, and I will attempt to incorporate its structure into
the automatic import. See Appendix A for information on contacting me.
Other utilities for file conversion may be included on the extras disk.
See the README.2ND file.
Page 28
BBSee Version 1.4
Appendix E Database Packing
Most database packages, do not actually delete files from a database, they
simply mark the files for deletion. The BBSee database is no exception.
To reclaim this space it is necessary to 'pack' the database. In addition
to reclaiming disk space, (vis-a-vis a random un-packed database), the
packed file is maintained in alphabetical order. Due to the nature of the
BBSee database, an undelete feature, before unpacking, is not possible.
To pack the BBSee master database, run the program PACBBSEE at the DOS
prompt, in a BBSee directory. PACBBSEE will read your BBSEE.CFG file and
automatically pack the master database. During the PACBBSee operation, a
record count will be displayed on the screen.
Note that to use this program, a new file is actually created, and your old
file is maintained, in case a problem is encountered. You will therefore
require disk space equal to that of you original database and index to
complete the database pack. Because of the extensive hard disk activity
required, this process can take a considerable amount of time. It is not
essential to the operation of BBSee, and disk savings can usually only be
achieved after a large number of imports. I would pack the database after
the all of your bbs allfiles listings are included.
Page 29
BBSee Version 1.4
Appendix F Deleted File List Maintenance
Filenames that you delete from the master database are added to an index
file (the .DEL file) so that they are not added to the database again. At
times you may wish to review your deleted files, and allow certain deleted
files to be added as your computing requirements change. To do this, the
following steps should be followed.
Step 1.
The first step is to create an ASCII file of your present .DEL file.
The program READDEL.EXE will read your present .DEL file and output it
to standard output. The format to view the file on the screen is
READDEL {master delete file} To trap standard output to a file it is
necessary to use the DOS redirect command. The syntax for the redirect of
READDEL is:
READDEL {master delete file} > {filename}
Care should be taken here as DOS does not prevent you from overwriting
a file on a redirect.
This program can be used to view the deleted file list by reviewing the
above file, or omitting the > filename.
Step 2.
The second step in editing the .DEL is to use an ASCII text editor on
the filename output in the previous step. Remove all the lines
containing filenames that you no longer wish excluded. You can also add
filenames to this file at this point, that will cause the entered
filenames to be removed from the master database in the next step.
Ensure that you use DOS naming rules when entering these filenames, and
do not add a trailing dot. DO NOT include the following extensions if
you are manually entering filenames.
ZIP, PAK, COM, LZH, EXE, ARC, SDN, GIF, ARJ, TXT,
DOC, ZOO, BAT, and SYS
Page 30
BBSee Version 1.4
Step 3.
The third step is to write a new .DEL file using the WRITEDEL.EXE
program. This program, will read the list that you have edited above,
delete records from the master database if necessary, and create a new
.DEL file. The syntax for use of this program is:
WRITEDEL {input file} {output file}
The output file is the name of you master .DB and .DEL files without an
extension. It will not overwrite your present .DEL file. You must first
delete (or rename) the appropriate .DEL file. If you don't run this
program from your database directory, ensure that the output file includes
the proper sub-directory information.
WRITEDEL will check to see if the input file is in the appropriate format.
This checking is not all inclusive so be careful.
Page 31