ftp.wwiv.com/ftp.wwiv.com.zip/ftp.wwiv.com/pub/HATCH/PBSS10B1.ZIP/PBSSM.DOC

Text File | 1995-12-07 | 13KB | 273 lines

      PBssm 1.0 - COPYRIGHT 1995 - TRACY L. BAKER - STARPORT VALHALLA BBS
                }}} SPV is an *OFFICIAL* WWIV Support Site {{{
    *** All the legal junk is at the end of this file, it must be read! ***
                           >>> A CEREBRUM RELEASE <<<

    <<< IF YOU ARE USING A 80286 COMPUTER, THIS PROGRAM WILL NOT WORK! >>>
       <<< CONTACT PAPA BEAR ([e-mail]) FOR A CUSTOM VERSION >>>

                               { SECTION 0.0 }
                            : TABLE OF CONTENTS :
Section 1:
          1.0 -------------- Introduction
          1.1 -------------- Hardware requirements
          1.2 -------------- Software requirements
          1.3 -------------- Setting Up
          1.4 -------------- This program, the BBS, and file sharing
          1.5 -------------- This program and WWIV color codes

Section 2:
          2.0 -------------- Command line switches for PBssm
          2.1 -------------- Internal command explanations
          2.2 -------------- Debug information
          2.3 -------------- Exit codes (error levels)

Section 3:
          3.0 -------------- Legal junque (You _should_ read this!)
          3.1 -------------- Copyright notice
          3.2 -------------- Warranty
          3.3 -------------- License Agreement
          3.4 -------------- Registration

Section 4:
          4.0 -------------- The Hall of Honor - those who have registered

-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-

                                { SECTION 1.0 }
                                : INTRODUCTION :
PBssm is a small program that will allow you to read, write, and delete WWIV's
short messages (SSMs).  Normally, once an SSM is sent, you cannot do any of
these things short of deleting the entire SMW.DAT file.  And, while there are
other utilities out there that do jobs similar to this, none are as dedicated
nor as complete as this.

Keep in mind that this program edits LOCAL SSMs.  It does not, in this
version, access networked SSMs.  There is another GREAT Cerebrum utility out
there, ELN, that does this already.  For more information on ELN, E-Mail Dawg
([e-mail]).

-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-

                                { SECTION 1.1 }
                            : HARDWARE YOU'LL NEED :
You'll NEED a a machine capable of running WWIV.  You'll also need an 80386
class processor or better (80486, Pentium, Pentium Pro, etc.).  If you can run
WWIV, then you can run this program.

If you're using a computer with a 80286 or older processor, E-Mail me
([e-mail]), and I'll make a custom compiled copy for you!

-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-

                                { SECTION 1.2 }
                           : AND NOW, THE SOFTWARE :
A WWIV BBS is required since the whole purpose of this program is to modify a
particular data file generated by that BBS program.  MS-DOS 5.0+, Windows 95,
and OS/2 should all run this program just fine.

-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-

                                { SECTION 1.3 }
                                   : SETUP :
Since you're reading this, I assume you've already decompressed the archive it
came in.  So the set up is quite simple:

Place PBSSM.EXE in your main BBS directory (C:\WWIV perhaps) and then run.
That's it!  If PBSSM.EXE is not executed from the main BBS directory, you'll
know about it.

Alternatively, you CAN place it in its own directory just as long as you place
a copy of your current CONFIG.DAT from your main BBS directory in the PBSSM
directory with it.

-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-

                                { SECTION 1.4 }
                       : A FEW NOTES ABOUT FILE SHARING :
PBssm supports full file sharing as a matter of course.  This is so you can
safely run this program while the BBS is up and running.  However, there is a
caveat to running PBssm with the BBS online.

PBssm LOCKS the SSM data file.  This means that while neither the program nor
your BBS will crash if they both try to access the SSM data file, PBssm will
not allow access by the BBS if it has control.  This is to protect your file
from corruption.  Your BBS will simply try access it a number of times, then
give up.  If this happens, the SSM bound for the data file from your BBS will
be tossed into the bit-bucket.

However, the times that PBssm actually have control over the SSM data file
(or USER.LST or CONFIG.DAT) have been coded to be extremely short-lived and
efficient.  PBssm keeps the files locked for a period of time no longer than
necessary.  This way PBssm and BBS should get along just fine when accessing
these files.

-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-

                                { SECTION 1.5 }
                              : WWIV COLOR CODES :
This program will read the stock WWIV color codes (0-9) just fine.  When making
a new SSM, you can also use extended color codes.  However, since PBssm does
not know how you have these extended colors defined, they'll not be shown in the
colors you expect.  Instead, extended color coded SSMs will be shown in light
green on black.  When shown on the BBS, they'll be displayed properly.

When entering a message, use a CTRL-C to generate the heart, the type in the
color number.  The heart will always appear as gray, and the number, with the
following text will appear in the appropriate color.

-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-

                                { SECTION 2.0 }
                           : COMMAND LINE SWITCHES :

/DEBUG -- Turn on debug reporting information in the PBSSM.LOG file
/L     -- Turn OFF reporting to the PBSSM.LOG file.
/?     -- Show online help.

-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-

                                { SECTION 2.1 }
               : INTERNAL COMMANDS (OR, WHAT DOES THIS KEY DO?) :
There are 10 keys which are active.  They are listed below, with descriptions of
what they do, if necessary:

[ - Move to the previous message.  "Wraps around" from the number 0 message
    to the last message in the data file.

] - Move to the next message.  "Wraps around" from the last message to the
    number 0 message in the data file.

{ - Move back 10 messages.  "Wraps around" like the [ command.

} - Move forward 10 messages. "Wraps around" like the ] command.

D - Delete the message that is currently being displayed on the screen.

X - Delete ALL messages addressed to the user that is currently being
    displayed on the screen.  Use this cautiously, since no confirmation will
    be asked between each message.

E - Edit the message that is being currently displayed on the screen.  See
    the W command for more information about editing.

W - Create a new message.  When the message has been completed, you'll be
    able to send it to a specific user, or all active users on your BBS.  If
    you select a single user, you can enter the user's name (a partial name
    is an acceptable input -- the program will search for possible matches
    and ask you which you want), or their user number.  You cannot send
    messages to deleted users.

    When entering a message, you'll be able to enter using WWIV's full range
    of color codes (0-9).  Entering the color codes is done a little
    differently than most editors.  To generate the heart, press CTRL-C
    (*NOT* CTRL-P,CTRL-C that most editor use).  The next character entered
    will be the color number.  Hearts will ALWAYS appear in grey.  The color
    number and following text will appear in the color that corresponds to
    the number.  If color codes OTHER THAN 0-9 are used, then the resulting
    text will be displayed in light green.  When viewed via the BBS, however,
    they will be displayed in their normal extended colors, as defined with
    the BBS.

S - Search the message/user names for specific text.  After pressing S,
    you'll be asked to press U (for a username search), M (for a message text
    search), or Q (to Quit).  Searches for user names, and message text are
    accomplished on a partial match basis.  So entering PAPA in a user search
    will definitely trigger a match on PAPA BEAR.

Q - Quit back to DOS.

-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-

                                { SECTION 2.2 }
                            : DEBUG IN THE MACHINE :
If /DEBUG is used on the command line, the quite a lot of extra information
will be reported in the PBSSM.LOG file.

This information can help me, as the programmer, fix the program if you're
having problems with it.  It can also help YOU, too.

So if you're experiencing problems, first try the /DEBUG switch.  if the log
file information doesn't help you solve the problem, then please E-Mail me
the log ([e-mail]), and I'll work on it!

-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-

                                { SECTION 2.3 }
                             : ERROR (EXIT) CODES :
00 - No error.  Normal exit.
01 - Error creating PBSSM.REG (does not already exist).
02 - CONFIG.DAT was not found in the current directory.
03 - Could not read CONFIG.DAT (see LOG for more details).
04 - Could not paint required screen to video.
05 - Could not open SSM data file.

-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-

                                { SECTION 3.0 }
                                : LEGAL JUNQUE :
PBssm      - Copyright (C) 1995      - by Tracy L. Baker
WWIV       - Copyright (C) 1988-1995 - Wayne Bell

-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-

                                { SECTION 3.1 }
                                 : COPYRIGHT :
The PBssm software and its accompanying documentation are protected by
both United States copyright law and international treaty provisions.  You
may make copies of this program, and distribute those copies, provided that
you do not change any part of the PBS*.* archive, which include:

PBSSM.EXE    [The executable file.]
PBSSM.DOC    [This documentation file.]
PBSSM.HIS    [History of revisions file.]
PBSSM.ANN    [My version related announcement file.]
PBSSM.REG    [Registration file for this program.]
FILE_ID.DIZ  [BBS description file.]
MULTIPAK.OFF [Registration form to register multiple PB utils for a discount.]

-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-

                                { SECTION 3.2 }
                                  : WARRANTY :
PBssm is provided as is, without warranty, either expressed or implied.  The
author specifically disclaims all other warranties, expressed or implied,
including, but not limited to, any implied warranty of merchantability or
fitness for a particular purpose.  You're using it, and I'm not responsible.

-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-

                                { SECTION 3.3 }
                             : LICENSE AGREEMENT :
Users are granted a limited license to use the unregistered version of PBssm
for an evaluation period not to exceed thirty (30) days. Any other use of
PBssm, or use past the evaluation period requires registration.  Users may
freely copy and distribute PBssm, provided that no fee is charged, and that
the PBssm archive contains unmodified copies of the original files as
produced by the author.  No part of PBssm may be modified, altered, reverse
engineered, or sold without prior written permission from the author.

-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-

                                { SECTION 3.4 }
                                : REGISTRATION :
Registration allows you to use PBssm past the 30 day trial period. Plus, it
makes you feel better and encourages further development of this, and other,
software by the author.  Registration is $5 (US currency only). Fill out the
form in PBSSM.REG and send it, and the $5 check or money order to the address
in PBSSM.REG. Finally, registering this program will convince my wife that
all the hours of development I've put in this project really are worth it!

  Send your registrations to:

  Tracy L. Baker
  5890 Bandolero #1036
  El Paso, TX 79912

-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-

                                { SECTION 4.0 }
               : THE HALL OF HONOR -- THOSE WHO ARE REGISTERED :

-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-<*>-