MagnaFile v2.00
The Ultimate File List Compiler
for Telegard 2.5i, 2.5j, & 2.5k
Copyright (C) 1990,1991 by Blue Wave Software
All Rights Reserved
Written by
George Hatchew
and
Fred Rappuhn
We would like to thank Martin Pollard for supplying us with the
information needed to complete this project.
Blue Wave Software would like to thank you for showing interest in
MagnaFile; the ultimate in file list compiler programs for Telegard
2.5i+.
When this program was started, it was simply meant to be a NEW file list
compiler, which would allow SysOps running The Blue Wave Mail Door to
pass along a file listing showing all new files uploaded to his/her BBS
since the user's last mail download. This would then be displayed inside
The Blue Wave Mail Reader when the user begins reading his/her mail
packet.
Well, it developed into a monster! As we went along, we kept thinking of
all the 'neat' things that could be done with it. So, features kept
being added. And added. It is now to the point where we are satisfied
it can do everything we can think of. If it doesn't do something *you*
want it to do, let us know! There's always room for growth.
If you are not running The Blue Wave Mail Door, or do not know what The
Blue Wave Mail System is, here is a little information:
The Blue Wave Mail Door is the first Off-Line Reader/Mail System for
Telegard BBS systems. You, as a Sysop, run the Blue Wave Mail Door as
an external utility, allowing your users to capture mail (FidoNet, Local
Bases, GroupMail) into a compressed format. The user then downloads the
mail packet, and has the opportunity to read the messages OFF-LINE, at
their convenience. This in turn, frees up your BBS so you can get more
callers on in one day. It also makes your users more active in the
message bases. Since this documentation is for MagnaFile, we won't go
into detail about all of the features of The Blue Wave Mail System. We
can only suggest that you give it a try. If you cannot find a copy, you
can file request the system from either:
1:2240/107 -- The Flight of the Raven 9600bps HST-Dual Standard
1:2240/176 -- The Wild! Blue BBS 2400bps MNP-5.
The latest version of the door (BBS portion) can be FREQed as BWTG,
and the latest version of the reader (User portion) can be FREQed as
BWREADER. You will need both files for the complete package.
MagnaFile
---------
MagnaFile, in it's simplest form, will simply generate a list of new
files since a user's last call date to your system. This list can then
be passed to The Blue Wave Mail Reader, where it will be shown to the
users when they read their mail packet.
MagnaFile has 9 command line switches, and 2 command line parameters,
which can be combined in many, many different ways to achieve the
desired output. As always, the cryptic command line syntax reads:
(parameters in [] are completely optional)
MGNAFILE outputfile [headerfile] [switches]
OutputFile: The file list that MagnaFile will create. This can be a
complete drive:\path\filename.ext, or simply a file name.
If you do not specify a path, the file will be written in
the current directory.
HeaderFile: File to include at the TOP of the listing. This can be
something like a BBS advertisement, ANSI picture, or system
information. The contents of [headerfile] will not be
altered, but will be copied into [outputfile].
Switches : There are 8 valid command line switches--
/ALL Default=OFF (builds only new file list)
/INFO Default=OFF (does not append user info to list)
/ANSI Default=OFF (does not use ANSI color in file list)
/ONELINE Default=OFF (compiles 2-line-per-file listing)
/NOPAUSE Default=ON (will insert {PAUSE}'s for the reader)
/MASTER Default=OFF (when on, will build COMPLETE list)
/NOSTATS Default=ON (will append file area stats at end)
/ACS=xxx Default=OFF (when used will build custom lists)
/DAYS=nnn Default=OFF (when used will specify #of days to check)
/NOLIST=xxx Default=OFF (when used will NOT build lists for
those with ACS of xxx.)
The operations of these switches will be discussed in the
next section. In most cases, you can use them together to
create your custom file list.
MagnaFile Command Line Switches
-------------------------------
MagnaFiles command line switches may confuse some people. You may or
may not ever use them, but you are missing out on a great deal of power
if you don't. Full descriptions and examples will be given to help you
keep your hair [it may be grey when you are done, but at least you still
have it!].
To pass a file to The Blue Wave Reader, you must first specify a file
name to send using BWUTILS.EXE. In the G)eneral Information menu, there
are 5 fields, labeled READER FILES. For ease in discussion, lets use
NEWFILES.TXT. Insert NEWFILES.TXT into one of the empty fields.
Now you will want to edit your BLUEWAVE.BAT file to run MGNAFILE before
each user enters the door:
cd\bbs\bluewave
mgnafile newfiles.txt
bwmail
cd\bbs
exit
When running MGNAFILE with no switches, it will look for BWMAIL.CTL in
the current directory. If it is found, it will read it's information
from there, and then look for DOOR.SYS in your Telegard Directory [or
wherever you told BWMAIL to find DOOR.SYS]. It will find out
information about the current user on-line, and build a text file of any
new files that were uploaded since the user last called your BBS.
To make a colorful new-file listing, use the command:
MGNAFILE newfiles.txt /ansi
in your batch file. To include a system advertisement at the beginning
of the file, use the command:
MGNAFILE newfiles.txt header.txt /ansi
in the batch file.
That was the basic purpose of this program. However, the following
command line parameters were added to make your list more 'customized'.
/ALL **> You can use the /ALL command to generate a file listing
of ALL files on your system that the current user in
DOOR.SYS has access to. By using the /ACS= command, you
can eliminate the need for DOOR.SYS. When you use the
/ALL command, /DAYS= is not valid, since the purpose of
/ALL is to list all accessable files, regardless of age.
/ANSI **> This command line switch is valid when used with any
other switch. It simply adds ANSI color to the file
listing. [A nice touch to the bland display if you are
including a file list with your mail packets.]
/INFO **> This switch is valid *only* when a DOOR.SYS file is used
to base the file listing on. It will append user's
information into the file listing indicating:
1) Number of file points user has.
2) Number of files a user has downloaded.
3) Number of K the user has downloaded.
4) Your system's upload/download ratio by Kilobytes.
5) Your system's upload/download ratio by # of files.
/INFO is invalid when used in conjunction with /MASTER
and the /ACS=xxx command.
/ONELINE **> MagnaFile defaults to a 2-line-per-file listing of any
files contained in the file listing. 2-line mode
displays:
1) File Name.
2) File Size, in bytes.
3) File Points required to download the file.
4) Number of times the file has been downloaded.
5) If file is offline, it indicates OFFLINE.
6) File Description.
7) File's extended description, if any.
By using the /ONELINE command, you can force MagnaFile
into a 1-line-per-file listing. This 1-line mode
displays:
1) File Name.
2) File Size, in bytes.
3) File Description.
4) File's extended description, if any.
/NOPAUSE **> Forces MagnaFile *not* to insert the {PAUSE} strings
that The Blue Wave Off-line Mail Reader needs in order
to pause the ANSI 'reader file' screens. This switch is
not needed when compiling a list with the /MASTER
option. When using /MASTER, /NOPAUSE is automatically
set to ON.
/MASTER **> Forces MagnaFile to compile a COMPLETE list of files on
your BBS. DOOR.SYS is not required, and any [read: all]
ACS strings are ignored. This is handy for a sysop to
compile a complete listing of files for his/her own
reference. /MASTER overrides the /ACS=xxx, /DAYS=nnn,
and /ALL commands. In other words, if /MASTER is used,
the only valid commands are /ANSI, /ONELINE, and
/NOSTATS.
[{PAUSE} strings are automatically turned OFF, as
described above].
/NOSTATS **> When compiling either a /ALL, /ACS=, or /MASTER file
listing, MagnaFile will add file area statistics to the
end of your file listing, indicating the number of files
in each area, the number of bytes used by those files,
and grand totals of the number of bytes used, and number
of files in your file listing. Using /NOSTATS will
cause MagnaFile *not* to append this statistics listing.
/ACS=xxx **> By using the /ACS=xxx command, you may override the need
for a DOOR.SYS file. Much of the power of MagnaFile
lies in this command, and its companion, /DAYS=nnn. It
is much easier to explain this command by using
examples:
You want to compile a file listing for all users who
have access to file areas with the following
restrictions:
Must have security of 30.
Must be 18 years old.
Must have a flag of X (you want to include those adult
files :->).
By using the command:
MGNAFILE c:\bbs\dls\files.lst /ACS=s30a18fx
you can compile a file listing of ONLY the file areas
that a user with those parameters would have access to.
Please note that the above example will compile a list
of ALL files accessible by a user with those parameters.
In other words, /ALL is automatically activated.
The only valid ACS codes for compiling a file listing
are:
Snnn -=> Users with a security level of nnn.
Dnnn -=> Users with a download security level of nnn.
Pnnn -=> Users with nnn file points.
Ann -=> Users must be at least nn years old.
Fx -=> Users must have the flag x. (A-Z are valid)
Unnnn -=> User must be user # nnnn in USER.LST.
Bnnn -=> User must be at nnn baud (3=300, 12=1200,
192=19200).
Please note that 'vv' WILL NOT WORK, although it is
possible to accomplish the same thing. If your
validated users have s50, fv, and must be 12 years old,
then simply use '/ACS=s50fva12' as the command.
However, if MagnaFile encounters a 'vv' for the security
level of a file area, and you are compiling a NEW files
listing, the 'vv' WILL work (MagnaFile pulls the 'vv'
ACS string out of the setup for BWUTILS).
/DAYS=nnn **> Finally, the /DAYS=nnn command. /DAYS=nnn is valid
*only* when used with the /ACS=xxx command. As stated
above, /ACS=xxx defaults to compiling a listing of *all*
files for the specified ACS level. By using the
/DAYS=nnn option, you can specify the number of days to
include in the file listing.
To list all new files within the last 10 days for users
with a security level of 50, use the following:
MGNAFILE 10days.lst /ACS=s50 /DAYS=10 /ANSI
/NOLIST=xxx By special request comes the /NOLIST=xxx command. If you
use the /NOLIST switch, you will be able to NOT generate
a new files list for those with an ACS specified by xxx.
This is useful for Long Distance callers who may not want
to get your NEW FILES listing each time they enter The Blue
Wave Mail Door. If the user online (DETERMINED BY DOOR.SYS)
fits into the ACS specified, a file will not be produced!
There are so many possible ways to use MagnaFile, we must leave it up to
you to be creative. We were successful in setting up a File Area menu
letter that would essentially do the following:
1) Create a DOOR.SYS file.
2) Run a batch file containing all of the commands needed to:
A) Execute MagnaFile with the proper parameters.
B) Place the compiled file listing in a specified download area.
C) Compress the File listing.
D) Return to Telegard.
E) Display a file telling the user where he may download the
newly compiled file listing.
3) After Telegard exited back to the mailer after each caller, it is
necessary to add a check to your batch file similar to the
following:
if exist c:\bbs\dls\uploads\newfiles.lst delete newfiles.lst
In our batch file, we used the MagnaFile command line:
MGNAFILE newfiles.lst /ALL /NOPAUSE /INFO
This command line generates a CUSTOM file listing for the user currently
online! Now there is no more need to worry that your users are seeing
files in your FILES listing that they don't have access to! It also
informs them of their upload/download standings (/INFO) and will
instruct MagnaFile not to insert the {PAUSE} strings (/NOPAUSE).
Again, be creative!
MagnaFile is distributed as FREEWARE. There is no charge to use this
program. If you use it, and enjoy it, please pass it along to a friend!
Questions/comments/suggestions/complaints about MagnaFile and/or The
Blue Wave Mail System should be directed to the following nodes:
1:2240/176 Sysop: George Hatchew
1:2240/107 Sysop: Fred Rappuhn
There is a national support echo on the FidoNet backbone called BLUEWAVE.
Here we will be able to answer any and all questions related to products
produced by Blue Wave Software.
We monitor the National FidoNet TELEGARD echo every day, however, I am
sure Martin would like to keep the subject to TELEGARD. We can answer
questions there also, but please respect the echo conference rules and
try not to wander off-topic [too much].
Thank you for your support.
---George Hatchew
---Fred Rappuhn
Blue Wave Software
PO Box 1057
Flint, MI 48503