home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Black Box 4
/
BlackBox.cdr
/
hamradio
/
bpqyapp.arj
/
BPQYAPP.DOC
< prev
next >
Wrap
Text File
|
1991-08-15
|
29KB
|
977 lines
BPQ Yapp File Server Program For IBM-PC/Clones
==============================================
Copyright Jon Welch - Ver 1.00 04/07/91
---------------------------------------
Introduction
============
The BPQ Yapp File Server program is a software package which
provides a file server on a BPQ Node to enable users to upload or
download files from it using the YAPP file transfer protocol. 26
different file areas can be defined with access restricted to
upload only, download only or full access. Help files are
available on all commands plus an extra info file for system
details. The system name and command prompts are fully
configurable by the user.
DISCLAIMER OF WARRANTY
THIS SOFTWARE AND MANUAL ARE PROVIDED "AS IS" AND WITHOUT
WARRANTIES AS TO PERFORMANCE OF MERCHANTABILITY OR ANY OTHER
WARRANTIES WHETHER EXPRESSED OR IMPLIED. BECAUSE OF THE VARIOUS
HARDWARE AND SOFTWARE ENVIRONMENTS INTO WHICH THIS PROGRAM MAY BE
PUT, NO WARRANTY OF FITNESS FOR A PARTICULAR PURPOSE IS OFFERED.
BPQYAPP V 1.00 1 04/07/91
C O N T E N T S
===============
Chapter Page
------- ----
1 System Requirements 3
2 Installing The Software 4
2.1 System Files and Usage 4
3 Configuring The Software 5
4 Setting up the Yapp File Server 7
5 Using the Yapp File Server 8
Appendices
----------
A - My BPQCFG.TXT File 10
B - Recognised Users 16
Distribution Restrictions
=========================
The BPQ Yapp File Server program is NOT public domain
software but I am making no charge for you to use it. If you
wish, you can make a contribution to the development of this and
future amateur radio software which I am currently writing but
feel under no obligation to do so.
If you want to contribute or just contact me with comments,
asking for help and advice etc. please write to :
Jon Welch,
50 Quarrydale Road,
Sutton In Ashfield,
Notts. NG17 4DR.
Great Britain
If you are writing from outside Great Britain, please
remember to include your country in your address so I know where
to reply to if necessary !
BPQYAPP V 1.00 2 04/07/91
1 System Requirements
=====================
The software is designed to run in conjunction with the BPQ
Node software and Deskview and as such, will not work as a
standalone YAPP File Server package.
The software will work on any 80x86 computer running MS-DOS
3.00 or above with a window size of at least 36K under
Deskview.
The software has been tested on BPQ V 4.01 and Deskview 2.31
but should work with any compatible version.
BPQYAPP V 1.00 3 04/07/91
2 Installing The Software
=========================
To install the software you will need to copy all the files
from the distribution file to a directory on a floppy disc or
your hard disc.
You will also need to modify your current BPQCFG.TXT file to
add the yapp file server as an application into the node. This is
done my modify the applications line in the file and also
creating a port definition for the program. See the example of my
current BPQCFG.TXT file in Appendix E for help on doing this.
In more detail, you need to add a keyword to the
applications line which the user will enter to access the Yapp
File Server. There is room for eight on the applications line so
find a spare slot and add it in. Each of the keywords is numbered
starting at $01, then going up to $02, $04, $08, $10, $20, $40
and $80 for the other seven. In my example below, my YAPP keyword
is the fifth in the line and so it's number or APPLMASK is $10.
This needs to be defined in the port configuration for the
program as shown below also.
TNCPORT APPLICATIONS=PMS,,*SYS,MH,YAPP
COM=3
TYPE=TNC2
APPLMASK=$10
APPLFLAGS=$00
ENDPORT
Please refer to the relevant documention that comes with
your copy of the BPQ software for more information if required.
You will also need to create a DVP file for Deskview and a
sample one is enclosed for you to work from.
2.1 System Files and Usage
--------------------------
The files comprising the system, where they are located and
their function are as follows :
BPQYAPP.CFG - Configuration file for program (mandatory)
BPQYAPP.HLP - Text file sent for H command (optional)
BPQYAPP.INF - Text file sent for I command (optional)
BPQYAPP.EXE - Main Program
YS-PIF.DVP - Sample configuration file for Deskview
BPQCFG.TXT - My BPQ configuration file
BPQYAPP V 1.00 4 04/07/91
3 Configuring The Software
==========================
The configuration for the program is stored in a single file
called BPQYAPP.CFG. This file is a standard text file and should
be edited with a text editor that does not add formatting
characters to the text (such as Wordstar in non-document mode).
The format of the file is given below :
Line 1
------
This tells the computer which virtual COM port your TNC is
connected to in the BPQ Node software. It can either be from 1 to
16 depending how you BPQCFG.TXT is configured.
Line 2
------
This tells the computer which application number the program
is based on it's position in the BPQCFG.TXT applications line.
For each of the available positions 1 to 8, this number will be :
1, 2, 4, 8, 16, 32, 64 or 128
Line 3
------
This line is the name you wish to give to your Yapp File
Server. This is displayed on the welcome screen when a user
connects to your file server.
eg. Jon's Megga Fabbo Yapp File Server
The following lines identify the file upload and download
areas you wish to set up. Each line comprises of five fields,
each separated by a comma.
Field 1 - File Area Designator. This is a single letter from
A to Z which uniquely identifies the area. You need not specify
the areas in alphabetical order.
Field 2 - File Area Directory. This is the complete pathname
(including drive if necessary) of the directory containing the
files for this area.
Field 3 - File Area Description. This text string is used on
the W command to tell the user what type of files are contained
in the file area.
Field 4 - Download Flag. This can be either a Y or N and
tells the system if file downloads are allowed from this area.
BPQYAPP V 1.00 5 04/07/91
Field 5 - Upload Flag. This can be either a Y or N and tells
the system if file uploads are allowed to this area.
eg. A,C:\TNC\PMS\DOWNLOAD,Download Area,Y,N
You must terminate the list of file areas with a single line
containing a '*'.
The final line in the configuration file is the prompt sent
to the user.
eg. Cmd:B,D,H,I,U,V,W >
A sample BPQYAPP.CFG file is thus :
3
16
Jon's BPQ Yapp Server
A,C:\TNC\PMS\DOWNLOAD\GENERAL,General Download Area,Y,N
C,E:\GRPHCGA,CD-ROM CGA Graphic Programs 89 files,Y,N
E,E:\GRPHEGA,CD-ROM EGA/VGA Graphic Programs 94 files,Y,N
G,E:\GRPHUTIL,CD-ROM General Graphic Programs 47 files,Y,N
H,E:\GAMEADVE,CD-ROM Adventure Games 143 files,Y,N
I,E:\GAMEARCA,CD-ROM Arcade Games 270 files,Y,N
J,E:\GIFS,CD-ROM GIF Pictures 336 files,Y,N
T,C:\TNC\PMS\DOWNLOAD\TNC,TNC Driver Support Files,Y,N
U,C:\TNC\PMS\UPLOAD,Upload Area,N,Y
V,E:\VIRUSERS,CD-ROM Virus Protection Programs,Y,N
*
Cmd:B,D,H,I,U,V,W >
BPQYAPP V 1.00 6 04/07/91
3.1 Setting up the Yapp File Server
-----------------------------------
There is very little to do in setting up the Yapp File
Server.
If you have not done so already, configure the BPQYAPP.CFG
file accordingly.
You may also want to customise the main help file
BPQYAPP.HLP and the info file BPQYAPP.INF
For all your file areas, you can also create an optional
'area information' file. Again, this is a plain ASCII text file,
must be called AREA.INF and stored in any file area that you
require. When the user issues a 'W <area>' command, the AREA.INF
file is also displayed below the header line and before the list
of file names. This feature can be used to tell the user, for
example, that all files in the area are .ZIP files and must be
decompressed with PKUNZIP before use.
BPQYAPP V 1.00 7 04/07/91
3.2 Using The Yapp File Server
------------------------------
Assuming you have installed the software correctly, loaded
the BPQ code, Deskview, a suitable terminal driver program and
opened up the Yapp File Server program, the Yapp File Server is
accessed by connecting to the node and typing the keyword you
defined in the BPQCFG.TXT applications line.
You will then be welcomed to the file server and be given
the command prompt.
All the time a remote user is logged onto the file server,
the sysop still has control over the keyboard in the window as
well. This means that the sysop can enter commands as though they
were coming from the remote user. This can be used to guide new
users through the program by showing them what commands do what,
or the remote user can be logged off if he mis-uses the file
server etc.
To close down the file server, simple use the close option
of Deskview or press Alt X whilst in the file server window.
The different commands available whilst in the file server
are :
B - Log off the Yapp File Server.
Disconnecting has the same effect. The program will then
revert back to waiting for the next user to connect.
D <area> <file> - Download file.
This is used to download a file using YAPP transfer. The
area can be A to Z if setup in the configuration file by the
sysop.
eg. D B HELP.COM
H - Display help file.
This command will display the BPQYAPP.HLP file to the user
if one exists.
I - Display info file.
This command will display the BPQYAPP.INF file if one
exists. Use it to show your stations hardware/software
configuration and anything else you may wish to tell the user.
BPQYAPP V 1.00 8 04/07/91
U <area> <file> - Upload file.
This is used to upload a file using YAPP transfer. The area
can be A to Z if setup in the configuration file by the sysop.
eg. U A MYPROG.EXE
V - Show version.
This will show what version of the Yapp File Server is
running.
W - List file areas.
This will list the file areas as configured by the sysop in
the BPQYAPP.CFG file. Each area will indicate whether you can
download and upload to it.
W <area> (filespec) - List files (matching filespec).
This will list all the files matching the optional filespec
(defaulting to all files) contained in that particular area. The
area can be A to Z if setup by the sysop.
eg. W A *.ZIP
BPQYAPP V 1.00 9 04/07/91
Appendix A - My BPQCFG.TXT File
========== ------------------
; For Version 3.59
;
;
; CONFIGURATION FILE FOR G8BPQ SWITCH SOFTWARE
;
; The program which converts this text file to binary
; form is currently very crude - be VERY careful when
; editing this file!
;
;
; The order of parameters in not important, but they
; all must be specified - there are no defaults
;
;
;
; Memory Usage. If EMS=1, the system will attempt to put its
; data area into EMS Memory. At the moment it makes no attempt
; to manage sharing of the EMS window, so you must not run any
; other software using EMS.
;
; It seems to work ok when used with Desqview, at least on my
; AST, but it is primarily intended for use with AA4RE BBS, which
; needs a great deal of space.
;
;
EMS=0 ; dont use EMS RAM
;
; I seem to have problems with systems not using DESQVIEW -
; especially NNA BBS's. The DV calls SHOULD be ignored if DV is
; not loaded, but just in case, if you set DESQVIEW=0, the
; 'Release Timeslice' call wont be used. MAKE SURE that you set
; DESQVIEW=1 if using DV, or performance will be seriously
; affected.
;
DESQVIEW=1
;
;
; Station Identification.
;
; If a user connects to the NODE Callsign or Alias, he is linked
; to the switch code, and can use normal NetRom/TheNet commands
;
; If he connects to the BBS Callsign or Alias he will be connected
; directly to a BBS port. If none are available, the connect will
; be rejected.
;
; Note that of you are running only a NODE (ie BBS=0), or
; or just a BBS (NODE=0), then you must still put in two pairs of
; calls, but they MUST be the SAME.
;
; If you are running both, the calls MUST be different
BPQYAPP V 1.00 10 04/07/91
NODECALL=G7JJF-8 ; NODE CALLSIGN
NODEALIAS=IP0423
BBSCALL=G7JJF ; BBS CALLSIGN
BBSALIAS=JJFPMS ; BBS ALIAS
;
; 'ID' MESSAGE - SENT EVERY IDINTERVAL MINS
;
; WILL BE ADDRESSED FROM THE PORT CALLSIGN (IF DEFINED)
; ELSE FROM THE NODE CALL
;
; The following format allows KA nodes to include your system in
; their 'Nodes' lists.
;
IDMSG:
Network node (IP0423) running TNCBPQ V1.40 and BPQ Yapp Server V1.00
***
;
UNPROTO=MAIL ; DEFAULT UNPROTO ADDR
; 'I' COMMAND TEXT
;
; Note that the bit about needing a port param in connects is only
; necessary if you are running more that one (radio) port.
;
INFOMSG:
G7JJF Packet Switch, Sutton In Ashfield, Notts. IO93IC
Commands are basically the same as NET/ROM, but to connect to
another normal station (not another node), you must specify a
port number before the callsign. Use PORTS command to list
available ports. The PMS command connects you to the associated
Mailbox and the YAPP command takes you to a Yapp File Server
for downloading/uploading of files.
***
; CTEXT - If specified, will be sent when someone connects to
; the NODE ALIAS at level 2. It is not sent on connects to the
; NODE callsign, as this could confuse BBS forwarding connect
; scripts.
;
CTEXT:
Welcome to G7JJF's Packet Switch in Sutton In Ashfield
Type ? for list of available commands.
***
; Network System Parameters
;
OBSINIT=5 ; INITIAL OBSOLESCENCE VALUE
OBSMIN=4 ; MINIMUM TO BROADCAST
NODESINTERVAL=60 ; 'NODES' INTERVAL IN MINS
IDINTERVAL=15 ; 'ID' BROADCAST INTERVAL (UK Regs require
; an AX25 ID every 15 mins)
;
BPQYAPP V 1.00 11 04/07/91
BTINTERVAL=15 ; NO BEACONS
L3TIMETOLIVE=25 ; MAX L3 HOPS
L4RETRIES=3 ; LEVEL 4 RETRY COUNT
;
; I have seen suggestions that L4TIMEOUT should be increased to very
; high values (even as long as seven mins). Although 60 may be a bit
; short in some cases, I STRONGLY advise that you dont go much above
; 120 secs unless you understand ALL the implications.
;
; I've set TTL and TIMEOUT to the values agreed by the latest SYSOPS
; meeting - this does not imply that I agree with them!
;
L4TIMEOUT=120 ; LEVEL 4 TIMEOUT
L4DELAY=10 ; LEVEL 4 DELAYED ACK TIMER
L4WINDOW=4 ; DEFAULT LEVEL 4 WINDOW
;
MAXLINKS=30 ; MAX LEVEL 2 LINKS (UP,DOWN AND INTERNODE)
MAXNODES=120 ; MAX NODES IN SYSTEM
MAXROUTES=35 ; MAX ADJACENT NODES
MAXCIRCUITS=64 ; NUMBER OF L4 CIRCUITS
minqual=10 ; MINIMUM QUALITY TO ADD TO NODES TABLE
BBSQUAL=250 ; BBS Quality relative to NODE - used to
; limit 'spread' of BBS through the
; network to your required service area.
; I've been asked to set a low default to
; encourage you to think about a suitable
; value. Max is 255
BUFFERS=255 ; PACKET BUFFERS - 255 MEANS ALLOCATE AS MANY
; AS POSSIBLE - NORMALLY ABOUT 130,
; DEPENDING ON OTHER TABLE SIZES
;
; TNC DEFAULT PARAMS
;
PACLEN=128 ; MAX PACKET SIZE
;
; PACLEN is a problem! The ideal size depends on the link(s) over
; which a packet will be sent. For a session involving another node,
; we have no idea what is at the far end. Ideally each node should have
; the capability to combine and then refragment messages to suit each
; link segment - maybe when there are more of my nodes about than 'real'
; ones, i'll do it. When the node is accessed directly, things are a
; bit easier, as we know at least something about the link. So, from
; Version 3.11 onwards, there are two PACLEN params, one here and
; one in the PORTS section. This one is used to set the initial value
; for sessions via other nodes, and for sessions initiated from here.
; The other is used for incoming direct (Level 2) sessions.
; In all cases the TNC PACLEN command can be used to override
; the defaults.
;
; The main reason for changing this now was a request from someone
; wanting to run an HF port.
;
;
BPQYAPP V 1.00 12 04/07/91
;
TRANSDELAY=1 ; TRANSPARENT MODE SEND DELAY - 1 SEC
;
; Level 2 Parameters
;
; T1, T2 and N2 are now int the PORTS section
;
T3=180 ; LINK VALIDATION TIMER (3 MINS)
IDLETIME=900 ; IDLE LINK SHUTDOWN TIMER (15 MINS)
;
;
; Configuration Options
;
BBS=1 ; INCLUDE BBS SUPPORT
NODE=1 ; INCLUDE SWITCH SUPPORT
;
HIDENODES=0 ; IF SET TO 1, NODES STARTING WITH # WILL
; ONLY BE DISPLAYED BY A NODES * COMMAND
;
;
;
; 'COMBIOS' Port definitions.
;
; This section defines the virtual TNC's that the code supports.
;
; I'm afraid this is now rather more complicated than it was!
;
; You can now define any COMBIOS port to run in normal (TNC2)
; mode, PK232 HOSTMODE (with varients for UFQ and AA4RE), or KISS
; mode. KISS mode allows you to run things like TCP/IP, STATS
; packages, PACSAT Telemetry decode, etc above the switch.
;
; The basic format is:
;
; TNCPORT
; COM=n ; COMBIOS port number
; TYPE=TNC2|KISS|PK232/AA4RE|PK232/UFQ
; KISSMASK=nn ; Required only for KISS
; APPLMASK=nn ; Defaults to 1 (BBS)
; ENDPORT
;
; TYPE defaults to TNC2. See file KISSMODE.DOC for full details
; of facilities available in KISS mode.
;
; The two PK232 modes are equvalent to the old HOSTMODE=1 or 2,
; but can now be used on any port. See HOSTMODE.DOC for more
; details
; Dont try to define more than 16 ports.
;
; For my software, you must decide on the port for the PMS to be
; accessed from. This can be anything from 1 to 15.
; You must then set this port, plus the following to the settings
; shown below :
BPQYAPP V 1.00 13 04/07/91
TNCPORT
COM=1
TYPE=TNC2
APPLMASK=$03
APPLFLAGS=$07
ENDPORT
TNCPORT
COM=2
TYPE=TNC2
APPLMASK=$08
APPLFLAGS=$00
ENDPORT
; This is the setting for my BPQ Yapp File Server if you
; want to install it eventually.
TNCPORT
COM=3
TYPE=TNC2
APPLMASK=$10
APPLFLAGS=$00
ENDPORT
PORT
; ID=144.625 Mhz 1200 baud
ID=Not Active
TYPE=ASYNC
PROTOCOL=KISS
IOADDR=2F8H ; COM1 - FOR COM2 PUT 2F8H
INTLEVEL=3 ; COM1 - FOR COM2 PUT 3
SPEED=9600
CHANNEL=A
QUALITY=10
MAXFRAME=2
TXDELAY=500
SLOTTIME=100
PERSIST=64
FULLDUP=0
FRACK=7000
RESPTIME=2000
RETRIES=10
PACLEN=120
ENDPORT
BPQYAPP V 1.00 14 04/07/91
;
; 2ND PORT OF KPC4/KAM (FIRST PORT IS DEFINED AS ABOVE)
;
PORT
; ID=432.675 Mhz 1200 baud
ID=144.625 Mhz 1200 baud
TYPE=ASYNC
PROTOCOL=KISS
IOADDR=2F8H
INTLEVEL=3
SPEED=9600
CHANNEL=B ; this is the special bit for KAM/KPC4
QUALITY=10
MAXFRAME=2
TXDELAY=500
SLOTTIME=100
PERSIST=64
FULLDUP=0
FRACK=7000
RESPTIME=2000
RETRIES=10
PACLEN=120
ENDPORT
ROUTES:
;
; ROUTES TO LOCK IN
;
; specify Callsign, Quality and Port. You can now also specify
; MAXFRAME, FRACK, PACLEN (in that order) to override the port
; defaults.
;
;
***
;
; APPLICATIONS SUPPORTED
;
; UP TO 8 ENTRIES OF UP TO 12 BYTES EACH
;
; THE FIRST 3 ARE RESERVED FOR BBS, HOST, AND REMOTE SYSOP
; YOU CAN DEFINE THE OTHERS AS YOU LIKE.
;
; FOR COMPATIBILITY WITH EARLIER VERSIONS, JUST ENTER
; APPLICATIONS=BBS
;
; NAMES STARTING WITH * ARE NOT INCLUDED IN 'VALID COMMANDS'
; DISPALY
;
APPLICATIONS=PMS,,*SYS,MH,YAPP
;
;
BPQYAPP V 1.00 15 04/07/91
Appendix B - Recognised Users
========== ----------------
Jon G7JJF
If you have any problems using the software, first of all
please read this manual thoroughly. The answer to most of your
questions will be hidden somewhere. If all else fails, please
contact me at the address given below or G7JJF @ GB7FLG for help
and advice.
I would also appreciate any input you would care to give
concerning the program. If you have any ideas or comments that
would make it a better program, then please let me know.
*****************************************************
**** Remember To Support Your Local Packet Group ****
*****************************************************
Jon Welch, G7JJF @ GB7FLG.#23.GBR.EU
50 Quarrydale Road, CompuServe ID : 100012,2607
Sutton In Ashfield,
Notts. NG17 4DR.
Great Britain
4th July, 1991
BPQYAPP V 1.00 16 04/07/91