============================================
           PortManager v1.00 -- DLG(tm) Port Management
                          Documentation
                        - June 1, 1993 -
           ============================================


        Copyright (c) 1993 by Sam Yee.  All Rights Reserved.


======================================================================
COPYRIGHT
=========

The  program,  PortManager  and  its  documentation  are  written  and
copyrighted  by  Sam Yee.  The UNREGISTERED version of PortManager may
be   distributed  freely  providing  the  following  restrictions  are
satisfied:

o Distributors may not charge more than the cost of a diskette used in
  the distribution of this program.

o Distributors may only distribute the unmodified copy of the original
  program, along with its documentation, and copyright notices intact.

o Commercial  distribution  is  only  possible with written permission
  from the author.

The  REGISTERED  versions  of  PortManager  may  not be redistributed.
Redistribution is illegal, immoral, and strictly prohibited.


======================================================================
DISCLAIMER
==========

This   program  and  its  documentation  are  provided  "as  is".   No
warranties  are  made  with  respect  to  the  accuracy,  reliability,
performance  or  operation  of this software and information.  You are
using this program at your own risk.  The author is not liable for any
damages that may have been caused by using this software.


======================================================================
INTRODUCTION
============

PortManager  is  a GUI (Graphics User Interface) program allowing you,
the  DLG  Sysop,  to manage your BBS ports.  It is particularly useful
for  "lazy"  sysops or sysops of multi-line sytems.  PortManager keeps
track  of  the  status  a  specific list (configurable) of ports.  The
basic  GUI  consists  of  a ports list display and a set of 100 (5 are
usable  in  demo  version)  action  buttons.   20 of these buttons are
visible  at  a time, and the rest can be accessed by using a scroller.
When  the  Sysop wishess to take an action on a port, he/she clicks on
the  port  and  then  clicks on one of the action buttons.  This saves
tremendous amount of time having to type the command out in AmigaShell
and/or  having  to figure out information about the user such as which
port  the  user  is  on.   As  well  as launching executable programs,
PortManager can launch ARexx scripts (by calling "rx <script>"), batch
files (by calling "execute <batch>"), and internal commands.  Most DLG
%switches   are  supported,  plus  some  new  switches  pertaining  to
PortManager  are  included.   Sooner  or  later, you'll wonder how you
could have lived without it!


======================================================================
REGISTRATION
============

The  demo  version  of PortManager is only capable of handling up to 5
buttons.   If  you  want more buttons, you must register.  Please read
PortManager.registration  for more information.  When you register you
will get a key file which allows you to handle up to 100 buttons, plus
you will be notified via e-mail of any updates.


======================================================================
REQUIREMENTS
============

This  program  runs  on  any Amiga(tm) with version 2.04 of the OS.  A
system  with 512K would suffice.  Also, TelePro's DLG(tm) BBS software
is  required.   This  program  has  been tested with DLG v.995, but it
should work with any version released since last year.


======================================================================
INSTALLATION
============

You  must put PortManager and its accompanying files into the assigned
directory  called  DOORS:ASI.   DOORS:   is the proposed directory for
doors  (or  BBS  utilities)  used  by  many  system operators and door
programmers.   ASI  is  a  directory  where  you should put the BBS or
telecommunication  utilities  written  by  me.  You should also create
several  directories within DOORS:ASI.  However, when you "un-LHA" the
archive  it  will  create  some  of  these  directories  for you.  The
directories are:

DOORS:ASI/bin/        -- Where all executable files go.
DOORS:ASI/config/     -- Where all configuration files go.
DOORS:ASI/data/       -- Where all the data files go.
DOORS:ASI/doc/        -- Where all the documents go.
DOORS:ASI/help/       -- Where all the help files go.
DOORS:ASI/key/        -- Where all the key files go.
DOORS:ASI/script/     -- Where all the scripts go.
DOORS:ASI/text/       -- Where all other text files go.
DOORS:ASI/user/       -- Where all the data for users go.

The files pertaining to PortManager are as follows:

bin/PortManager       -- PortManager program
doc/PortManager.doc   -- What you are reading now
doc/PortManager.registration
                      -- Registration form and information
config/PortManager.cfg
                      -- PortManager General configuration file
config/PortManager.buttons
                      -- PortManager Buttons configuration file


======================================================================
USAGE
=====

Usage: PortManager <key> <value> ...

 keys:

 CONFIGFILE   general configuration file
              (default DOORS:ASI/CONFIG/PortManager.cfg)
 BUTTONSFILE  buttons configuration file
              (default DOORS:ASI/CONFIG/PortManager.buttons)

By using different configuration files, you can manage different types
of ports (e.g., local and remote) independently.


======================================================================
RUNNING THE PROGRAM
===================

When  the  program  is run, an averaged sized window opens.  The upper
half  of the window is the ports display area.  This "listview" gadget
allows  you, by using its scroller, to move around in the list, so you
can  select the port to take action on.  On the bottom half, there are
20  action  buttons,  ranging from 1 to 100.  Only buttons 1 through 5
can be activated, unless you register the program.  Activation buttons
6  through  100  will  open  the  "About" window, which reminds you to
register.   Like  the  ports  displayer,  the  action  buttons  can be
scrolled  around  with  by its scroller.  By scrolling around, you can
access  up to 100 (subject to change in future versions) buttons.  The
program  can be forcibly terminated by sending a break-C signal to it,
or press control-C from the main window.


======================================================================
PULL-DOWN MENUS
===============

There  are  two pull-down menus, each contains menu-items and possibly
sub-menu-items.

Project
-------

About:      Display something about the program.
            Short-cut key = Right-Amiga-?

Load...:
    General Config: Load general system configuration.
                    Short-cut key = Right-Amiga-O
    Buttons:        Load action buttons configuration.
                    Short-cut key = Right-Amiga-L

Save...:
    General Config: Save general system configuration.
                    Short-cut key = Right-Amiga-W
    Buttons:        Save action buttons configuration.
                    Short-cut key = Right-Amiga-S

Quit:       Quit program
            Short-cut key = Right-Amiga-Q
            If the general or buttons configuration has been changed
            you will be prompted if you really want to quit or not.
            Click on [Okay] if you want to quit.
            Click on [Cancel] if you want to get back to the program.

Edit
----

General Config: Edit general system configuration
                Short-cut key = Right-Amiga-G
                See "EDIT GENERAL CONFIGURATION" below.

Buttons:        Edit action buttons configuration
                Short-cut key = Right-Amiga-B
                See "EDIT BUTTONS CONFIGURATION" below.


======================================================================
EDIT GENERAL CONFIGURATION
==========================

When  editing general system configuration, you will be asked first to
enter  the  DLG  ports  to  manage.   The names of these ports must be
separated  by  spaces,  and  each  port name must not end with the ':'
character.   For  example, to manage TL0, TR0, and TR1, enter "TL0 TR0
TR1".

Now,  you will be asked to enter the display format for ports that are
alive  (with  user  occupying  it)  or dead (empty port).  The display
format  accepts those switches (or flags) defined below.  For example,
to  display  alive  ports  with their port names, user names, and user
actions,  enter  "%PORT %NAME %PMFACTION".

Next,  you  will  be  asked for the time interval (in seconds) to wait
before  checking the status of each port.  If you enter 0, the program
will  only  be  awaken up when there is a change to a port's data file
(e.g., "T:TR0.user").  Note that the program uses "file notification",
so  if  your  "T:" directory doesn't support it, do not enter 0 or you
will  not  get  any port status updates.  If you enter -1, port status
updates  will  not  occur,  but  you may configure an action button to
manually  force updates (see the internal command "PMCUPDATE" in flags
description  section  below).   Any other positive number will get the
program to wake up once every interval you specified, to check for the
status  of each port.

Finally,  click on [Okay] to accept the changes, or [Cancel] to reject
them.


======================================================================
EDIT BUTTONS CONFIGURATION
==========================

After selecting this menu-item you will be asked to click on an action
button  to  edit.   You  may use the buttons list scroller to find the
button  you want.  When editng a button you will be asked to enter its
name.   The  name length is limited to 8 characters.

You  will also be asked to enter the command which will be called when
the  button  is  hit.  The command can either be an exeternal AmigaDOS
command  or  an  internal  one.   The  command  may  contain flags (or
switches)  which  are described below.

Now,  you will be asked whether the command you entered is an AmigaDOS
one  or  an  internal one.  Click on the checkbox to reflect the type.

Next,  you will be asked whether you want a requester to be displayed,
to  confirm  the  button's  action,  when the button is hit.

At  last, click on [Okay] to accept the changes, or [Cancel] to reject
them.  To exit editing buttons press the escape key.


======================================================================
PORTMANAGER FLAGS AND COMMANDS
==============================

Flags  (or  switches)  may  contain  formatting codes.  The formatting
codes  and  flag  are defined as "%[-|0|.][<field-width>]<flag>".  The
'-' stands for left-justification, '0' pads 0s before a numerical flag
(e.g.,  "%BAUD"),  and  "."  to  truncate  the  flag  to <field-width>
characters, and <field-width> is of course the width of the flag.

Examples: Suppose %BAUD reports 2400, and %NAME reports Sam Yee.

Example 1: %NAME    => "Sam Yee"
           %2NAME   => "Sam Yee"
           %10NAME  => "Sam Yee   "

Example 1: %-NAME   => "Sam Yee"
           %-10NAME => "   Sam Yee"

Example 2: %0BAUD   => "2400"
           %05BAUD  => "02400"

Example 3: %.NAME   => "Sam Yee"
           %.4NAME  => "Sam "

Supported DLG Flags
-------------------

%NAME            Full name
%FIRST           First name
%LAST            Last name
%UNAME           Underscored name
%ADDRESS         Address
%CITY            City
%PROVINCE        Province
%COUNTRY         Country
%POSTAL          Postal Code
%PHONE           Phone number
%BYEAR           Birth year
%BMONTH          Birth month
%BDAY            Birth day
%AGE             Age
%JOINED          Date Joined
%LASTCALL        Date of last call
%CALLS           Number of calls
%ALIAS           Alias
%PASSWORD        Passwd
%COMPUTER        Comp type
%LEVEL           Usr Level
%SCLEGNTH        Screen legnth
%SCWIDTH         Screen width
%HELPLVL         Help level
%PROTOCOL        DL protocol
%SYSPAGES        Sysop pages
%DAYLIMIT        daily limit
%SESLIMIT        session limit
%DIRLIMIT        size of users allowed private dir
%MSGENTER        messages written
%MSGREAD         messages read
%BYTESUP         bytes uploaded
%BYTESDN         bytes downloaded
%FILESUP         number of files uploaded
%FILESDN         number of files downloaded
%RATIO           Up/Down ratio limit
%LASTMSG         last message area visited
%LASTFILE        last file area visited
%PORT            port
%BAUD            baudrate
%CREDIT          netmail credits
%NETPRIV         netmail privaledges
%UUCP            uucp status
%ANSI            ansi status, (color or mono)
%DATE            current date and time

PortManager Specific Flags
--------------------------
%PMFACTION       what the user is doing right now
%PMFCLI          the CLI number of the user's process

PMF stands for PortManagerFlag

PortManager Specific Commands
-----------------------------
%PMCABOUT <none>
    display information about the program
%PMCQUIT  <none>
    quit program
%PMCUPDATE <none>
    update ports display

PMC stands for PortManagerCommand
<none> denotes no arguments needed for the command.  Future internal
commands may require arguments, but you don't have to worry about it
until then.


======================================================================
UPDATES
=======

Registered  users  are  privileged to free updates (excluding magnetic
media  cost  and  postal  charges), when they are ready.  Bugs will be
fixed,  but  I  make no promise that new features will be added.  Note
that  since I'm still a college student, I don't always have free time
(especially during semesters) to update the software.


======================================================================
PRODUCTS RELEASED AND UNDER DEVELOPMENT
=======================================

Released:
- ECopy  v1.00  (Hard/floppy drive utility with space "optimization").
  Can    be    used    for    making   backups.    A   must-have   for
  pictures/mods/utilities collectors! Freeware.
- TeleWho v1.00 (DLG(tm) BBS utility) Freeware.
- TelePage v1.00 (DLG(tm) BBS utility) Freeware.
- RawIN.lib v1.10 (Input handling library  for  BBS  door programmers)
  Freeware.
- Multi-Talk v0.93 (Multi-user teleconference system) Shareware.
- TeleReg   v1.00   (User  registry  (and  others)  database  allowing
  concurrent users)  Shareware.
- IfAge v1.00 (DLG(tm) Age Checker) Freeware.
- GateTerm v1.00 (CLI Terminal/Outdialer) Shareware.
- TeleVal v1.00 (DLG(tm) Call Back Verifier/Validator) Shareware.
- NovPack v1.00 (Package of novelty programs) Freeware.
- PortManager v1.00 (DLG(tm) Port Management) Shareware.

Under Development:
- TeleBank (DLG(tm) BBS utility, a time/credit accounting system)
- *top secret* projects :-)


======================================================================
TRADEMARKS
==========

Amiga, and AmigaDOS are trademarks of Commodore-Amiga.
DLG is a trademark of TelePro Technologies.


======================================================================
CONTACT
=======

Questions, ideas, comments, bug reports, etc. should go to:

Home Address: Sam Yee
              4595 Nanaimo St.
              Vancouver, B.C.
              Canada V5N-5J5

    Internet: samy@sfu.ca
     FidoNet: 1:153/765 (Terra Firma BBS 1-604-434-3665)