home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Hall of Fame
/
HallofFameCDROM.cdr
/
qbbsetc
/
raal104.lzh
/
RAADDLOG.DOC
next >
Wrap
Text File
|
1990-12-14
|
10KB
|
227 lines
[*] RAAddLog [*]
Version 1.04
(C) Copyright 1990, By Randall Edwards
DISCLAIMER
----------
The program RAADDLOG.EXE and this documentation are the
copyrighted property of Randall Edwards. All rights, except
those outlined in this document, are reserved.
By using this software you acknowledge that this
software may not suit your particular needs or be completely
trouble free. Use this program at your own risk.
In no event will Randall Edwards be liable for any
damages, including any lost profits, lost savings or other
incidental or consequential damages arising out of the use of
or inability to use these programs, even if Randall Edwards
has been advised of the possibility of such damages.
In short, there's absolutely no guarantees with this
program. Use it at your own risk. If you break it, you can
have both pieces.
CREDIT WHERE CREDIT IS DUE
---------------------------
Thanks to the authors of RemoteAccess for writing such a
fine bulletin board system for which this utility is intended
to be used with.
Thanks to Fabrice Bellard, of Grabels France, for his
fine utility LZEXE which was used to compress the final .EXE
file and resulted in a significant, over 35%, savings in disk
space in the final distributed .EXE file.
I give credit to the Taiwanese, who for near-slave wages
produced this computer that this program was written on. By
allowing companies based in the United States to steal their
labor and the profits from their hard work, I have the wealth
and time to 'play' around with this machine and to write
programs like this. They have only their near-slave wages,
terrible working conditions, and my appreciation and hope
that they can overcome obstacles in their way and achieve
full social justice.
PURPOSE AND USAGE
-----------------
RAAddLog is a simple program to add a formatted log entry
into your RemoteAccess system log. This is handy for adding
log entries while in your batch file doing maintenance or
while running door programs to keep track of when a user did
this or that. For instance I also use it to log when my
system reboots or runs AutoExec.Bat. You'll probably think
of many uses for it.
The program usage is simple. Whatever you specify on
the program's DOS command line is included into the system
log. Let's take an example:
C> RAAddLog Doing system maintenance.
This would enter the message "Doing system maintenance."
into your system log formatted with the appropriate time and
date entries.
For example, with the Opus style of logging it would
produce something like:
+ 7-Apr 21:22:23 RAAL Doing system maintenance.
or with the FrontDoor syle of logging, something like:
---------- Sat 7 Apr 90, RAAddLog
+ 21:22:23 Doing system maintenance.
If you don't specify anything on the DOS command line,
then you'll be prompted with a short help screen telling you
that you need to run it with something on the DOS command
line. Simple huh?
I hope you find it useful. If you have any suggestions,
comments, or <eek!> bug reports, please send them to Randy
Edwards at the Socialism OnLine! BBS (203) 274-4639; 300 -
14.4k HST at FidoNet 1:141/552 or at Good Egg Net 99:9300/552.
TECHNICAL NOTES:
----------------
Well, if you could call a program as simple as this
technical, these would be the notes. <grin>
The program uses redirectable screen writes so you won't
have to worry about it messing up your screen if you're
running a multi-tasking system.
The program returns two errorlevels: zero or one. If
the program ends normally with no errors it will return a DOS
errorlevel of 0. If it has any errors it will return a DOS
errorlevel of 1.
The program outputs to the screen whether it is actually
creating a new log file, according to what you specified in
your CONFIG.RA file, or if it is appending to an existing log
file.
RAAddLog must be able to find the CONFIG.RA file. First
it looks for it in the current subdirectory. If it can't find
it in the current subdirectory it then reads the RA environment
variable to locate CONFIG.RA. If it can't find it using the RA
environment variable (or if the environment variable is not set)
it will then abort with a DOS errorlevel of 1.
RAAddLog reads CONFIG.RA and gets the type of log you have
selected, either Opus-type or FrontDoor-type and it also gets
the location of your log file from CONFIG.RA. Then RAAddLog
uses the appropriate log format (either Opus or FrontDoor) to
write out information into the log file.
RAAddLog is dependent on the version of CONFIG.RA it
reads to be sure it is getting the proper format. If it finds
a version of CONFIG.RA that it doesn't know how to read, it
will abort with a DOS errorlevel of 1.
As noted in the credits, the .EXE file was compressed
with Fabrice Bellard's LZEXE program, which resulted in a
more than one-third savings in disk space for the final
distributed RAADDLOG.EXE file.
VERSION HISTORY
---------------
1.04 - Code cleanup, released with source code. No
functional changes from 1.03.
1.03 - Minor change in the way RAAddLog gets the RA=
environment variable. Should be more reliable
and it's 400+ bytes smaller than version 1.02.
Changed the program identifier in the Opus log format
from "LOG!" to "RAAL".
1.02 - Minor changes in the way RAAddLog finds Config.Ra.
First, RAAddLog looks in the current subdirectory
for a copy of Config.Ra. If it finds one, it uses
it. If it does not find on in the current subdir,
then the program attempts to read the RA environment
variable to find Config.Ra - if if finds it using
the environment variable fine, if not it aborts.
RAAddLog now checks the Config.Ra file to ensure that
it is running on the proper version of RA. This
version of RAAddLog will run on RA versions 0.01 to
0.03 and will abort if you attempt to run it on
other versions.
1.01 - Minor maintenance release in preparation to releasing
the program through the SDS.
Name changed from RALOG in version 1, to RAADDLOG in
version 1.01. This was done to make the name more
unique and to reflect its actual function better.
Changed code to add the program name (RAAddLog) when
outputting a log entry into a FrontDoor-style log
format. This should be entirely compatible with
the standard FrontDoor logging format. (Opus log
format is unchanged.)
Minor code cleanup and cosmetic changes.
1.0 - Initial public release.
LICENSE
-------
It's free. If you like it use it. If you don't like it
then erase it from your disk(s) and forget all about it.
Under no circumstances may any money be charged for this
program, its distribution, or use. It is forbidden to modify
and redistribute the source code. The source code is included
for example use only.
The only persons and/or organizations that are
specifically forbidden to use this program are anyone
employed by the Department of Defense and/or the National
Security Agency of the United States Government or those
actual government organizations; and/or any citizen of the
Republic of South Africa for as long as the racist
apartheid regime there is still in power.
All trademarks mentioned in this document are
probably registered to their respective owners.