home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Hall of Fame
/
HallofFameCDROM.cdr
/
qbbsetc
/
1edra101.lzh
/
1EDIT-RA.DOC
next >
Wrap
Text File
|
1990-05-06
|
35KB
|
1,255 lines
┌─────────────────────────────────┐
│ ┌─────────────────────────────┐ │
│ │ -*- 1-EDIT-RA -*- │ │
│ └─────────────────────────────┘ │
└─────────────────────────────────┘
Version: 1.01
For
RemoteAccess
by
Bob Ransom
Copyright (c) 1990
All Rights Reserved
┌───────────────────────────────────────┐
│ TABLE OF CONTENTS │
└───────────────────────────────────────┘
What Is 1-EDIT-RA? .............................. 2
Acknowledgements ................................ 3
Special Notes to RA Users ....................... 4
Shareware & Warranty ............................ 5
FOSSILS, ANSI.SYS & Other Requirements .......... 6
LOCAL.DEF File .............................. 6
Locked COM Ports ............................ 7
Command Line Syntax ............................. 9
Colors ...................................... 9
Drop To DOS Security ........................ 9
USERS.BBS Backups ........................... 9
Getting Started ................................. 10
Setting Up 1-EDIT-RA Within RemoteAccess .... 10
Drop To DOS ..................................... 11
Local Drop To DOS ........................... 12
Remote Drop To DOS .......................... 12
The MENU Editor ................................. 14
The USER Editor ................................. 15
Mass User Updates ........................... 15
Registering 1-EDIT-RA ........................... 17
Keys ........................................ 17
Installing Keys ............................. 17
Final Notes ..................................... 18
1-EDIT v1.01 Page 1
┌───────────────────────────────────────┐
│ WHAT IS 1-EDIT-RA? │
└───────────────────────────────────────┘
1-EDIT-RA is a combined User Editor and Menu Editor for
RemoteAccess systems designed to work reliably from
remote. Features include:
- Built-in FOSSIL routines for guaranteed remote
performance.
- Full carrier detection which returns to
RemoteAccess when carrier is dropped.
- Automatic high speed performance with locked
ports at up to 38,400 baud (and possibly
higher).
- Status line showing user name, baud and modem
settings, and time remaining.
- Drop to DOS functions while online.
- User-definable colors.
- Full editing capabilities of nearly all fields
in the USERS.BBS file.
- Mass flag updating of user records.
- Mass "High Message Read" updating of all user
records.
- Full menu editing capabilities including
adding and deleting menus, renaming menus,
copying menus, plus direct editing of each line
of the menu record. Direct editing allows you
to insert, delete, change, and list the lines of
the edited menu, plus full menu simulation.
- Small file size: the program is only around
69K and will run in about 84K of memory. This
allows 1-EDIT-RA to run easily from a Type 7
shell.
1-EDIT v1.01 Page 2
┌───────────────────────────────────────┐
│ ACKNOWLEDGEMENTS │
└───────────────────────────────────────┘
A big hearty "Thank You" to all those trusting soles who
opened up their machines and systems files to me to help
beta test this software. To make sure it works, a program
needs to be tested on as many setups as possible and the
owners of those systems must be willing to really give the
program a workout. These guys have. Thanks to Barron
Featherston, Bob Holiday, Chris Lamprecht, Jim Roe, Jim
Westbrook, Bill Chambers, George Vandervort, and John
Parlin.
Additional thanks go to John Parlin for creating such a
great FOSSIL interface for Turbo Pascal programmers. His
JPDOOR makes programming doors a breeze. Some background
is warranted here: I began this program well over a year
ago, using FOSSIL and door routines that I wrote myself.
My package was decent and workable -- not great, mind you,
but not bad. However, it never did all the things I
wanted it to do so development was put on hold for quite
a while. Then I took a look at John's package, yelled
"Eureka!" loudly, promptly ditched my door units and
replaced them with his, and began the final work on
1-EDIT-RA. If you're interested in writing doors of your
own in TP, definitely take a look John's package.
Registration for it is only $15 and it is *very* complete,
including .TPU's for TP 4.0, TP 5.0, and TP 5.5.
Special thanks also go to Mike Janke for help in
converting the data structures used by this program from
QuickBBS to RemoteAccess.
1-EDIT v1.01 Page 3
┌───────────────────────────────────────┐
│ SPECIAL NOTES TO RA USERS │
└───────────────────────────────────────┘
As originally written, 1-EDIT was (is) a QuickBBS remote
editor. Because of the similarities between QuickBBS and
RemoteAccess, adding RA support to the original program
would have been pretty easy. I intended to put the
program into RemoteAccess mode by means of a command line
switch. But then I started thinking....
Right now, RA and Quick are pretty close to one another
structurally, but what's it going to be like in a few
months? The data structures are already starting to go
their separate ways. In a few months, with changes in
both programs, they could be miles apart. Why not prepare
for it now?
So I hacked some more and came up with an RA-specific
program, 1-EDIT-RA. I think that by doing this,
maintaining support for both programs will be easier -- I
won't have to worry about changes made in one piece of
code effecting one system or the other when it shouldn't.
Anyway, while having two very similar versions floating
around may be confusing to some, I think it will pay off
in the long run.
The release of the first version of 1-Edit-RA was probably
a bit premature as I didn't take advantage of some of the
things special to RA - i.e. different paths to the
USERS.BBS and system files. That's been fixed (along with
several other things) in this version. And, next time,
somebody slap me if I try to release something too soon.
So, that's where that stands.
1-EDIT v1.01 Page 4
┌───────────────────────────────────────┐
│ 1-EDIT-RA: SHAREWARE & WARRANTY │
└───────────────────────────────────────┘
Here comes the dull but necessary stuff:
SHAREWARE INFO
This program is released to the public as shareware. This
means try it and if you like it, you must register it
within a reasonable amount of time. The program is not
freeware nor public domain; it is copyrighted material
with all rights reserved. You are granted only a limited
license to test this software. No changes whatsoever may
be made.
You may copy 1-EDIT-RA and transfer it to others provided
you follow these brief rules:
1- You may not change the program, its archive, or its
documentation in anyway without express written consent
from me, the author.
2- You may not sell the program. This program may be
distributed on pay systems, but not on a
"fee-per-download" basis.
3- You may not distribute this product with other products
without express written consent from me.
Registration of 1-EDIT-RA is a cheap $10 and covers you
for all future releases of the program. More information
on registering is included later in this document.
WARRANTY
No warranty of any kind, covering either hardware or
software damage, is expressed nor implied. Use this
program at your own risk.
1-EDIT v1.01 Page 5
┌─────────────────────────────────────────────────┐
│ FOSSILS, ANSI.SYS, and OTHER REQUIREMENTS │
└─────────────────────────────────────────────────┘
There are a few things you should know before attempting
to boot 1-EDIT-RA for the first time:
FOSSIL Driver
1-EDIT-RA requires a FOSSIL driver to be installed and
active at all times. This shouldn't prove to be much of a
hindrance since 1-EDIT-RA was designed for remote use. If
you are editing strictly from the local console, RACE and
RAMenu do the same job faster and nicer, and they *don't*
require a FOSSIL. (However, they're not meant for remote
use, either.) 1-Edit-RA has been tested with both the X00
driver and the BNU driver; both work fine. One note to
BNU users who use the TSR version of the program: Be sure
that you're not having BNU remove itself from memory when
you exit your BBS and/or mailer.
ANSI Graphics
1-EDIT-RA requires all users of the program to have the
ANSI.SYS driver installed - both on the BBS and remote
caller's systems. 99.9% of sysops do have it installed so
this shouldn't be a problem. If you're unfamiliar with
ANSI.SYS, see your DOS manual. ANSI.SYS is included with
all versions of DOS.
DORINFO1.DEF & LOCAL.DEF
1-EDIT-RA requires a DORINFO1.DEF file to be present when
starting. First, some background on this file and how to
get around the necessity of having it: When RemoteAccess
shells to another program, either through a menu Type 7
exit or a menu Type 15 exit, it creates two files in your
system directory: DORINFO1.DEF and EXITINFO.BBS. Both
contain information for the child program to use in
determining the user's name, baud rate and modem settings,
graphic settings, etc. When you return to RemoteAccess
from the shell, RemoteAccess deletes both of these files.
That's why you can never find them on your disk -- they're
already gone.
Because 1-EDIT-RA requires DORINFO1.DEF and because a copy
1-EDIT v1.01 Page 6
won't always be available, I've made the program search
for a second file called LOCAL.DEF. LOCAL.DEF is nothing
but a copy of DORINFO1.DEF which should stay in your main
RA system directory (usually "C:\RA"). When run,
1-EDIT-RA will first search for the DORINFO1.DEF file. If
it's not found, it will then try to find the LOCAL.DEF
file. If that's not found, the program aborts. If it
*is* found (remember, you're supposed to leave it on your
disk so it should be there), 1-EDIT-RA will copy it over
to DORINFO1.DEF. When you quit 1-EDIT-RA, the
DORINFO1.DEF file will be deleted.
A copy of LOCAL.DEF is included in the 1-EDIT-RA archive
which you may edit to reflect your name and system name.
Here's what it looks like with my comments in braces { }:
-------------------------------------------------------
THE CREATIVE CONNECTION-SOUTHFIELD, MI-(313)559-9039
BOB {Sysop first name}
RANSOM {Sysop last name}
COM0 {Don't edit this!}
0 Baud,N,8,1 {No need to edit this}
0 {This does nothing - just a zero}
BOB {User first name}
RANSOM {User last name}
LATHRUP VILLAGE, MI {No need to edit; not used}
1 {1=Graphics. Don't edit}
32000 {User security level}
235 {User time remaining}
-------------------------------------------------------
Feel free to edit your copy of LOCAL.DEF to reflect the
proper sysop names and user names. The COM port setting
MUST remain as COM0 -- this indicates a local connect.
Changing the security and time remaining is up to you.
Time remaining is not counted while in local. After
editing, place the LOCAL.DEF in your RA system directory
and leave it there.
Locked COM Ports
Locked COM ports are supported automatically by 1-EDIT-RA.
There is no need to use DorSpeed, SetSpeed, etc.
1-EDIT-RA has been successfully tested at speeds up to
38,400 baud.
Directories
1-Edit-RA may be run from any directory you choose. When
first started, it searches your DOS environment for "SET
RA=", then uses that path to find the CONFIG.RA,
1-EDIT v1.01 Page 7
DORINFO1.DEF, and LOCAL.DEF files. If you don't have the
RA environment variable set (you should already), please
set it. See your RA docs for more info.
Also, 1-Edit-RA expects to find your USERS.BBS in the path
defined in CONFIG.RA as "Message base directory." Your
CONFIG.RA should already be pointing to the proper
directory.
Okay, that takes care of the requirements. Now, you've
unZIPped the 1-EDIT-RA file and put it somewhere on your
hard drive, and put the edited LOCAL.DEF into your RA
system directory. Now you're almost ready to get started.
1-EDIT v1.01 Page 8
┌───────────────────────────────────────┐
│ COMMAND LINE SYNTAX │
└───────────────────────────────────────┘
1-EDIT-RA allows you to customize it somewhat via the
command line. Four parameters may be included if you wish
(they're optional):
-Fxx Sets foreground color to xx. xx must be 0-7.
Default color is cyan (#3).
-Hxx Sets the highlight color to xx. xx must be 0-15.
Default highlight color is bright yellow (#14).
-Sxxxxx Sets the minimum security level for the Drop to
DOS feature to xxxxx. xxxxx must be 0-32000.
Default is 32000. More on this feature later.
-B Tells 1-Edit-RA to make a backup of USERS.BBS
before entering the User Editor. Default is to
NOT make a backup. While most often you won't
need this option, you may wish to use it if
plagued by noisy phone lines.
? Brings up very short help screen describing
command line parameters.
None of these parameters are required; use any, all, or
none of them as you choose. The command line may be in
upper case or lower; it doesn't matter.
1-EDIT v1.01 Page 9
┌───────────────────────────────────────┐
│ GETTING STARTED │
└───────────────────────────────────────┘
With that boring stuff out of the way, we'll get on to the
meat of the program. I'm not going to bother taking you
through each and every option in the editors -- most
commands are pretty self-explanatory, so I'll just touch
on most of it and highlight oddities, etc. Any sysop that
has gotten a RemoteAccess system up and running shouldn't
have any problems.
Setting Up 1-EDIT-RA Within RemoteAccess
1-EDIT-RA has been tested under both a RemoteAccess Type 7
exit and a Type 15 exit; either setup will work just fine.
However, because of its small size, 1-EDIT-RA is probably
best run as a Type 7 except on systems with very tight
memory constraints (i.e. Desqview and DoubleDOS systems).
For Desqview/DoubleDOS users: As best as I can tell,
1-EDIT-RA runs in about 84K of memory.
Here's a sample of how a Type 7 setup would look from
within RAMENU:
---------------------------------------------------------
Edit Menu Item
1 2 3 4 5
1234567890123456789012345678901234567890123456789012345678
<^1^> ............ Run 1-EDIT-RA Editor
Optional Data:
\command.com /c 1EDIT.EXE -F7 -H15 -S100 -B
User Display
Action Execute sub-program (Type 7)
Optional data
Hot-Key 1
Automatic No
Colour Colour example
Security 32000
Flags-A --------
Flags-B --------
Flags-C --------
Flags-D --------
---------------------------------------------------------
1-EDIT v1.01 Page 10
As mentioned earlier, the -F, -H, -S, and -B command line
parameters are completely optional; leave them off if
you're happy with the defaults.
Actual Startup
When you first start 1-EDIT-RA, it will check to see that
a FOSSIL is present. If not, the program aborts. From
there it begins its search for DORINFO1.DEF, using
LOCAL.DEF if necessary. Some values are initialized, then
an opening screen pops up. If you haven't registered your
program yet, the program will ring the bell a few times,
then pause for 4 seconds to <ahem> encourage registration.
After the pause you'll be prompted to "Press [ENTER] to
continue:". Press enter and you'll get the main menu.
From the main menu you may choose to edit user files, menu
files or drop to DOS. At this point, registered versions
of 1-EDIT-RA will show a status line on the local console
detailing who's online, baud and modem settings, and time
remaining. Unregistered versions show only the line
"Unregistered Evaluation Copy."
A side note that applies here and throughout most of the
program: Pressing [ENTER] or entering a question mark will
redraw the screen. This is really only useful in times of
high line noise, but it's nice to have available when you
need it.
┌───────────────────────────────────────┐
│ DROP TO DOS FEATURE │
└───────────────────────────────────────┘
This feature can be both very useful and very dangerous,
so please read this section carefully. Before attempting
to use the Drop to DOS feature, be sure your CONFIG.SYS
file sets COMSPEC=<path to COMMAND.COM>. 1-EDIT-RA uses
that DOS environment variable to tell it where to find
COMMAND.COM. For more info on CONFIG.SYS files and
setting COMSPEC, see your DOS manual. If you wish to test
whether COMSPEC= is set or not, type SET at any DOS
prompt. This will cause DOS to display your environment
settings
When displaying the main menu, 1-EDIT-RA checks the users
security level (set in DORINFO1.DEF) against the security
1-EDIT v1.01 Page 11
level set on the command line (or the default, 32000). If
the user's level equals or exceeds that level, the Drop to
DOS function appears on the main menu. If the user's
security level is *less* than the specified level, the
option doesn't even show up as an option. This allows you
to have co-sysops be able to edit your BBS files without
actually cutting them loose in DOS.
LOCAL DROP TO DOS
Drop to DOS works two different ways, depending on whether
you're calling locally or remotely. When in local mode,
the drop to DOS is just a very simple shell. You hit "D"
and you get the familiar flashing cursor. (What actually
happens is a second copy of COMMAND.COM is loaded.) You
may run whatever files you need to run from here. When
ready to return to 1-EDIT-RA, simply type EXIT.
REMOTE DROP TO DOS
Things become a bit more complicated when dropping to DOS
remotely because 1-EDIT-RA goes on hold during the shell.
This is similar to Type 7 and Type 15 exits out of
RemoteAccess -- when you shell out, you loose RA's ability
to send things through the modem, watch carrier and time
remaining, etc. The same happens when you shell out of
1-EDIT-RA -- whatever you shell to must take over all
modem functions including FOSSIL interface, carrier
detect, etc. Because of this, a warning pops up when
executing the shell reminding you not to go and try to
load WordPerfect or some other program that has no modem
routines.
When you do execute the shell, you're prompted to enter a
filename to execute. Leave this field blank and 1-EDIT-RA
will return to the main menu. If you do execute a program
or batch file, BE SURE TO INCLUDE THE FILE EXTENSION WITH
THE FILENAME (i.e. ".EXE", ".COM", ".BAT"). You may also
include as many command line parameters as you can fit
into the field. These parameters will be passed on to the
child program. When you exit the child program, you'll be
returned automatically to 1-EDIT's main menu.
A sample batch file called DOSSHELL.BAT is included in the
archive for you to look over. It details how you can set
up a true drop to DOS from 1-EDIT-RA using CTTY COMx or (a
better method using Gateway) CTTY GATEx. If you try this
out, be sure to pass your baud rate to the batch file on
the command line as: DOSSHELL.BAT 2400 (or whatever rate
1-EDIT v1.01 Page 12
you're using). This batch file should be tested CAREFULLY
before relying on it!!!! Also, I'd suggest you give
serious consideration to adding WATCHCD or some other
carrier watcher to the batch file so that the carrier is
monitored while in the shell.
1-EDIT v1.01 Page 13
┌───────────────────────────────────────┐
│ THE MENU EDITOR │
└───────────────────────────────────────┘
Those of you familiar with Adam Hudson's original Menuedit
will feel right at home here. When you first choose the
menu editor from the main menu, you'll be presented with a
directory of the menus in your RemoteAccess menu area.
1-EDIT-RA uses the CONFIG.RA file to determine the path to
this area. After displaying all of the menus you'll have
the option of editing/adding a menu, renaming a menu,
copying a menu, deleting a menu, or relisting the files.
There's no need to explain most of these functions. One
thing you might like to know is that any rename, delete,
or copy operation can be stopped by pressing [ENTER] on a
blank input field.
Choose the <E> option and you'll be prompted for the menu
filename to edit. Input the name. If the menu isn't
found, you'll be asked if you wish to create it. After
entering the menu name, you'll be dropped onto the main
menu editor menu. From here you can do a variety of
things, all very similar to the same functions in
Menuedit.
Rather than beat a dead horse trying to detail each
section of this menu, you should just play with it a bit.
It's pretty easy. Start by copying a menu, any menu, to
another menu file called, maybe, TEST or FRED or
something. Then hack on that copied menu. You'll get the
hang of it pretty quickly (like instantly, I hope).
1-EDIT v1.01 Page 14
┌───────────────────────────────────────┐
│ THE USER EDITOR │
└───────────────────────────────────────┘
Most all of this section should be pretty easy to figure
also. For the most part, everything is self-explanatory.
Press the plus key (+) for the next user or the minus key
(-) for the previous user. When moving from user to user,
if you hit the beginning or end of the USERS.BBS file, the
program will "wrap around" for the next user. Example:
You come to the last user in the file, say user #100, then
press the plus key (+). 1-EDIT-RA will "wrap around" to
user #0.
Pick and choose the fields you need to edit, press the
bracketed key <>, and you edit to your heart's content.
One note of interest: Should you go to edit a field and
then decide not to change anything, just press [ENTER] and
that field will remain unchanged.
At the bottom of the screen, you'll see a small window
with choices to add a user, delete a user, toggle NO-KILL
and other flags, etc. <Q>uit takes you back to the main
menu. <O>ther clears this small window and replaces it
with a different set of options that allow you to make
mass updates to flags or high message read numbers (see
below), and to edit some of the other user fields that
aren't often edited. To return to the first set of
options, press <O> again.
MASS UPDATES
From the <O>ther window, you have the ability to do mass
updates to flags and high message read numbers. What's
this good for? Well, a couple of things:
Some of you use a combination auto-executed menu options
and flags to show your BBS users a news file. After they
read the file, you set that flag to OFF. When you create
a new news file, you must go back and turned everyone's
flag back on again. Mass Flag Upd. allows you to do that.
You're asked for the flag you wish to set (A, B, C, or D),
the flag position to set (1-8), and whether you want it on
or off. After entering the information, 1-EDIT-RA will go
through and reset that flag bit for each user in the
USERS.BBS.
Mass updating of high message read is usually good after
1-EDIT v1.01 Page 15
you either bomb your message base, or do a slightly messed
up message renumber. I've had a few occasions where my
message base has gotten destroyed and I've had to delete
all the files. After doing so, all the user records still
contain the old high message read numbers, so the users
all get the "No new messages" line when they attempt to
read new messages. Using this mass update option lets you
reset everybody's high read number back to 0 (or whatever
number you want).
1-EDIT v1.01 Page 16
┌───────────────────────────────────────┐
│ REGISTERING 1-EDIT-RA │
└───────────────────────────────────────┘
KEYS
1-EDIT-RA uses a "keyed" registration system. The
information used to create your key is your system name
and sysop name as contained in your CONFIG.RA file.
Unregistered versions of the program (programs running
without the key) ring the bell and have a 4 second pause
built in at the beginning of the program, plus the status
line is disabled. Registered versions will also show the
registered system name and sysop name during the opening
screen (i.e. "Registered to: Creative Connection Bob
Ransom"). These are the only differences between
registered and unregistered copies. 1-EDIT-RA has no
built in self-destruct mechanisms or other disgusting
things.
When you register 1-EDIT-RA, you'll receive a small key
file that will disable the bell ringing and pause, and
enable the status line. If you hold a valid Fidonet node
number, your key file will be sent to you through netmail
file attach. Sysops who aren't a part of Fidonet or who
are outside of the continental U.S. and Canada will
receive their key files on a disk through the mail.
INSTALLING KEYS
When you receive your key file, it will be named something
like LASTNAME.KEY (where LASTNAME is your last name).
Place this key file into the directory where 1-EDIT-RA
will be running from and rename it 1EDIT-RA.KEY. Repeat:
It must be in the same directory as 1-Edit-RA! Be sure to
check your spelling here: "1-EDIT-RA.KEY" won't work; only
"1EDIT-RA.KEY" will.
Leave this key in place for as long as you use 1-EDIT-RA.
It will be good for all future releases of the program.
If for some reason I should need to make a change in the
key encryption routines (which would invalidate your key),
a new key will be sent to you immediately.
REGISTERING
A registration form called REGISTER.DOC is included in the
1-EDIT-RA archive. Please complete this form and mail it
1-EDIT v1.01 Page 17
with your check or money order for $10 (U.S. funds) to the
address on that form. You key will be sent to you within
a few days of receipt of your check.
┌───────────────────────────────────────┐
│ THE END │
└───────────────────────────────────────┘
Okay, I guess that wraps it up. Hopefully this document
is complete enough that you can set up and run 1-EDIT-RA
without problems. Should you encounter a problem of some
kind or an unfound bug, please be sure to let me know.
Suggestions for enhancements are always welcomed, too.
You can contact me through the RemoteAccess Support echo,
the QuickBBS Support echo, the QuickPro echo, or by
netmail.
The current version of this program is available for file
request from my system under the magic name of 1EDIT-RA.
First time callers can also download the program from the
QuickBBS Files section.
-Bob Ransom
27840 Lathrup Blvd.
Lathrup Village, MI 48076
The Creative Connection BBS
24 hours / 7 days
300-1200-2400 Baud / 8-N-1
313/559-9039
1:120/96
1-EDIT v1.01 Page 18