home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
OS/2 Shareware BBS: 2 BBS
/
02-BBS.zip
/
tagbet.zip
/
TAGGER.DOC
< prev
next >
Wrap
Text File
|
1995-03-18
|
45KB
|
1,194 lines
The OffLine (Online-)Filetagger for Maximus-OS/2 Version 1.1 beta/6:
Legalities :
------------
Author and Copyright:
Michael Mrosowski
Mühlenweg 1
2000 Wedel
Germany
1. Liability
This software and accompanying materials are distributed "AS IS" without
warranty, express, implied or statutory, including but not limited to any
implied warranties of merchantability and fitness for a particular purpose.
In no event shall anyone involved with the creation and production of this
product be liable for indirect, special, or consequential damages, arising
out of any use thereof or breach of any warranty.
2. Distribution
This program is Public-Domain, that means that everyone can use and copy this
program (name: OffLine Filetagger v1.1) as long and as often as he wants as
long as he passes along all files included in this package completely and
unchanged. This right is currently bound to the actual version 1.1.
BUT!
It is strictly forbidden to sell this program without an explicit permission
from the Author. That means nobody is allowed to take money for the distri-
bution of this program.
*******************************************************************************
Hall of Fame :
--------------
This program has been supported in a heroic, unselfish and brave manner by
the following honourable sponsors:
(in alphabetical order starting with first name)
Andreas Harm Krause
Carsten Schmidt
Hermann Wilken
Jürgen Jung
Leonhard Scheiber
Markus Schloesser
Sascha Close
Thomas Trueten
Torsten Grimme
-------------------------------------------------------------------------------
>>>> I looked through all my bills, if nevertheless i missed a sponsor, <<<<
>>>> please mail me and i correct it in the next doc. <<<<
-------------------------------------------------------------------------------
*******************************************************************************
CONTENTS
*******************************************************************************
1. Hi there !
2. Have a short look
3. What does it indeed ?
4. Under which configuration does it run ?
5. What is new ?
6. Quick installation
7. Tagger details
7.1 Commandline parameters
7.2 TAGGER.CFG
7.3 Area Management
7.4 Performing the download
8. Using the Tagger
8.1 General Usage
8.2 the Filemanager
8.3 Additional hints for use
9. TAGSERVE the Shared-Memory server.
10.Final Notes
==============================================================================
1.Hi there !
------------
This is the documentation of the OffLine Filetagger. Since English isn't my
native language you will certainly remark plenty of errors throughout this
text. Simply ignore them if possible (-8.
Anyway i hope that this documentation will help you to install and use the
Tagger. As this program is completely free for use i haven't spent that much
time for this doc. So if you encounter unpleasant problems during the
installation, please send me a netmail (address see "chapter" 10.) and i
will try to help and answer if i can.
==============================================================================
2.Have a short look :
---------------------
1. Copy the files in a directory on your bbs computer and unpack them.
2. Change in a OS/2 session to this directory and start TAGGER.EXE
3. When (let's hope) the Tagger starts, press "H" for help or simply try
around. You will only see some demo-areas.
5. Fantastic ! (not ?, okok thats your personal opinion)
==============================================================================
3.What does it indeed ?
-----------------------
With the Tagger your users can choose easily files of your fileareas for
download. The selection takes place comparable to some popular filemanagers.
If the user chooses finally "Download" the program executes a CMD-file that
can be customized to your wishes. The CMD-file which is delivered in the
package (DOWNMULT.CMD) actually creates a bbs-file which effects the download
of the selected files when the program returns to Maximus.
By the way, the selection is done online. The name OffLine stands for the
name of the BBS where the Tagger has been created.
==============================================================================
4.Under which configuration does it run ?
-------------------------------------------
The Tagger is a OS/2 32-Bit application that has been compiled with
EMX GNU-C. It has been developed for the use with Maximus v2.01wb and v2.02
but can be used with other OS/2 BBS-Systems as well if an area-listing in
filearea.ctl-style and files.bbs per area are provided. Numerical userlevels
will be implemented in near future.
It has been tested on HPFS- and FAT-partitions (as well as with CD-ROMS), but
works usually only with DOS-filenames (longer filenames misarrange the screen-
display a bit). The users of the Tagger must have an ANSI or AVATAR emulation.
==============================================================================
5.What is new ?
---------------
See the Text WHATSNEW.ENG
==============================================================================
6.Quick installation :
----------------------
For Upgrade Instructions look also into WHATSNEW.ENG.
First copy all Tagger files in a new directory (if not already done).
These files are:
CONFIG.CMD REXX-Script for interactive Tagger-Configuration
CONFINFO.DAT Data for CONFIG.CMD
DEUTSCH.LNG German languagefile
DOWNMULT.CMD REXX-Script for creation of the bbs file for download
EMX.DLL EMX 0.9a Runtime-Module, Required in Libpath
ENGLISH.LNG English languagefile
FILE_ID.DIZ Archive Description
FILEDESC.ZIP Example REXX-Script to generate File-Announcements
FILEPATH.CFG Holds the Archiver Paths used by the REXX-Scripts
GETID.CMD REXX-Script for getting the Filedescription out of archives
in Filemanager mode.
RXANSI.DLL REXX-Function for Com-Port access, by S.Mullarkey
RXANSI.ZIP Documentation for RXANSI.DLL
RATIO.ZIP REXX-Script to enable Ul/Dl-Ratio Checking
SCANCD.CMD REXX-Script for including CD's into a filebase.
(generates a filearea.ctl and copies files.bbs)
T.CMD cmd-file to start the Tagger (executed from TAGGER.MEC)
TAGGER.CFG Tagger configuration file.
TAGGER.DOC the English documentation
TAGGER.EXE the program
TAGGER.HLP helpfile in English
TAGGER.HLF helpfile in German
TAGGER.MEC Mecca-Script to start OffTag (compile it to TAGGER.BBS)
TAGSERVE.EXE Shared Memory Filebase Server
TLOCFM.CMD sample REXX-Script to start OffTag locally in Filemanager mode
VIEWIT.CMD REXX-Script to View Archive Contents online
WHATSNEW.ENG English text about new features of OffTag 1.1
------ the following files are required only for the testrun of -----------
------ of the Tagger and can be deleted after the test -----------
FILEAREA.CTL Example filearea.ctl
FILEBASE.DAT Filebase with demo-data (will be overwritten on next
FILEBASE.DMP RESCAN)
6.1 Including the Tagger in the Menus.ctl :
-------------------------------------------
The Tagger should be included in the MENUS.CTL in a suitable menu.
-------
Display_File c:\tagger\tagger Limited "3 OffLine Tagger"
------- ^here the directory of the Tagger + (tagger.mec)
6.2 Executing TAGGER.EXE :
--------------------------
In the following files the directories have also to be adjusted :
(Places marked with "^" and a comment)
TAGGER.MEC:
[colour goto start endcolour]
Sorry, the Fullscreen-Tagger doesn't run with TTY.
Choose ANSI or AVATAR in the user-menu, if your terminalprogram
supports this.
[Enter]
[Exit]
[/start moreoff xtern_run]cmd.exe /c c:\max\tagger\t.cmd %P %K
^here the tagger directory
[link]c:\max\tagger\dl+K
^and again over here
T.CMD:
cd c:\max\tagger
^ change to the tagger dir
if exist dl%2.bbs del dl%2.bbs
tagger P=%1 NODE=%2
cd c:\max
^ and back to the maximus dir
TAGGER.CFG:
Use CONFIG.CMD to adjust the filepaths to the needed files.
If you do not have the maximus-specific files lastusXX.bbs and
max.prm you can disable these parameters (press space once on keyword)
and pass the necessary user info per parameter.
The DateFormat (in the Miscellaneous Section) is defined in an european
manner. Change it, if you need to. (see 7.2 miscellaneous section)
(MM-DD-YY)
FILEPATH.CFG
Adjust the Paths listed there.
6.3 Other considerations:
-------------------------
Important !:
Check if OffTag handles all your users access levels right. It recognizes
automatically userlevel and keys and also excludes barricaded areas.
But it can not recognize your menu structure and the menu-choice based
override statements. (OffTag has one special override statement
for read-only areas, see: Read Only Areas)
Upload/Download ratios are not directly supported. Use the Ratio-Scripts
of RATIO.ZIP and adjust ratio.mec to the ratios you use. (Use then
ratio.mec instead of tagger.mec).
AND check if the download limits are calculated correctly.
OffTag is configured to use Node-Numbers. You can reconfigure OffTag also
not to use Node-Numbers but i do not recommend it.
Do not forget to compile TAGGER.MEC after you changed it.
If you use the provided download-per-script method maximus has to have
global access to areas enabled. This is usually archieved by including
a file_tag command somewhere in your file-section. I've also been
reported that an area 0 has to exist.
External Protocols can be called (if you change downmult.cmd). But you
have to consider that neither the downloads will be registered in the
maximus logfile nor OffTag will reduce the users download-account.
That should be enough for using the Tagger with your BBS.
Any remaining questions are (i hope) explained in the following section.
==============================================================================
7.Tagger details :
------------------
7.1 Commandline parameters :
----------------------------
These parameters can either passed directly when executing TAGGER.EXE
(e.g. in T.CMD) or they can be listed in the parameter-section of
TAGGER.CFG (see 7.2).
RESCAN updates the filebase (if used) an leaves the Tagger after this.
More about the Filebase can be found in 7.2. (Filepath section).
UPDATE=<Area1>,<Area2>,....
Partial Rescan only for the stated areas. Faster than a usual Rescan.
Update checks the listed Areas only for new/renamed/deleted files.
Be sure not to include any spaces in this expression.
Example: UPDATE=UPLOADS,F100,AC-FILES
FILEMANAGER
starts the Tagger in the Filemanager Mode.
This parameter is for use of Sysops/Cosysops only because all
File-Areas can then be seen and (depends on Filemanager section)
also altered.
STARTALLFILES
starts the Tagger immediately in the allfiles-list
STARTNEWFILES
starts the Tagger immediately in the newfiles-list
P= com-handle of Maximus or Binkley. If P= is not stated the Tagger runs
only in local mode (P=0).
NODE= passes the nodeno of the actual port. Is used to load the user-
information out of the correct lastuser%%.bbs file and to avoid
collisions when creating the download bbs-files.
CFG= forces the Tagger to use a different cfg-file as tagger.cfg
e.g. CFG=c:\tagger\nerd.cfg
This parameter is only useful if you pass it directly to TAGGER.EXE.
QUIT leaves the Tagger immediately after the execution of the download
cmd-file. This will be default if no "Quit" or "NoQuit" statement
has been stated in the protocols section in TAGGER.CFG.
DLCDEL=
allows customization of the char which marks the beginning of the
downloadcounter in the file description (default : [). Use no Quotes.
MULTILINEDESC
The Tagger will interprete any comment-lines following a file in
the files.bbs file as extended description and will add them to
the file-description if this parameter is passed.
DESCID=""
The char(s) stated here must be the first chars of the line holding
the extended descriptions, when MULTILINEDESC is used. Use Quotes
here. (Default:DESCID=" ")
COMMENTID=""
This statement allows to include comments of your FILES.BBS in the
Tagger Filelist (only in unsorted view).
Example: COMMENTID="- "
A RESCAN is needed to include the comments.
WRAP
displays word-wrapped descriptions (instead of one-line descriptions).
WRAPATCR
Ideal for Graphical FILE_ID.DIZ in multi-line descriptions.
This wraps the description display (in WRAP mode) like in
the files.bbs. (needs a rescan to work)
CLEANUPDESC
This will eliminate all Non-Ascii chars (<32 and >127) in the
file-description and also multiple spaces. This can help
speed up tagger loading and reduce memory utilization when
many file_id.diz's are in the files.bbs. (rescan needed)
NOMISSING
Files which are listed in the FILES.BBS but haven't been found by the
Tagger, won't be listed as MISSING when this parameter is passed.
So they remain selectable.
NOPRIVCHECK
supresses the check for the proper priv-level of the actual user
before displaying an area.
NOKEYCHECK
supresses the check for the proper user-keys before displaying an
area.
INCBARRICADES
Usually areas holding the statement "FileBarricade" are simply
ignored. This parameter includes them, if keys and priv-level are ok
or disabled.
CARRIERCHECKOFF
turns off the carrier-check. If not, the Tagger will be ended when
the carrier is lost.
C= C=0 for B&W and C=1 for colours (default:C=1)
WAITTRANSMIT
This feature lets the tagger react more directly on user keystrokes.
It checks OS/2's send-buffer and will wait on transmitting data until
the send-buffer is nearly empty. Especially for low-speed modem users
this provides a substantial increase in performance.
SHOWPROGRESS
Shows litte dots, when the tagger loads (without tagserver) and
when it rescans.
DEBUGRESCAN
This comment shows some info when the tagger does a rescan
perhaps useful, perhaps not ;-).
The following settings are usually read out of the lastuser.bbs file of
Maximus. These parameters overwrite these values (only in the Tagger), if
required (the default-values are used, if no path to the lastuser.bbs has
been stated in TAGGER.CFG) and the parameter is not passed.
X= screenwidth (>=80, Default:80)
Y= screenheight (>=12,Default:25)
B= user bps-rate (Default:14400)
T= today downloaded kb (Default:0)
REMTIME=
remaining user online-time. (in minutes)
PRIV= privlevel of the user (use PRIV=TWIT,PRIV=DISGRACE etc.)
KEYS= keys of the user (exmpl.: KEYS=123456789AFGH)
GRAPHICS=[1/0]
GRAPHICS=0 lets OffTag use a Non-Ibm Charset.
(Note: In local mode you will always see graphics chars,
no matter what graphics parameter is set)
VIDEO=[0,1,2]
This Overrides the Users Video-Setting. OffTag will use
Ansi for 0 and 1 [TTY and ANSI] and AVATAR for Value 2.
This value is usually read out of max.prm
L= downloadlimit of the user in kb (Default:2000)
7.2 TAGGER.CFG :
----------------
TAGGER.CFG should stand in the same directory as TAGGER.EXE (unless you
specify its Name and Path by passing it with the CFG= parmeter). It is
divided into several sections. The order of these sections should be kept
up.
The Parameters, Filepaths, Colors and Miscellaneous Sections can also be
set using the Script CONFIG.CMD.
The Parameters-Section :
------------------------
In this section you can place commandline-parameters. These parameters are
treated exactly the same as if they were directly passed to the program
(but directly passed parameters overwrite same parameters in cfg-file).
Use only one parameter per line.
Example:
Parameters
Wrap
Showprogress
Waittransmit
Dlcdel=<
Quit
End Parameters
The Filepath-Section :
----------------------
Paths to the files used by the Tagger are defined in this section.
See the example 1 page below for correct spelling.
LogFile:
--------
In this file the Tagger can keep a record of its activities, when and
of whom the tagger has been used, downloaded files and any errors which
occured.
Arealist:
---------
The Tagger uses the arealist as directory of fileareas and access rights.
Usually this is the file FILEAREA.CTL. Include statements will be recog-
nized.
Lastuser:
---------
User dependent data is read out of maximus' lastuser file. They are :
priv-level, bps-rate, lastlogin, keys, screensize, dl-today.
For multinode-systems you can mark with "%%" the position in the filename
where the nodeno (passed with "NODE=nn") has to be inserted.
Maxprm:
-------
The file MAX.PRM delivers the downloadlimit dependent on the users priv-level
to the Tagger.
Filebase:
---------
If you put a path in here, the Tagger creates on first startup a filebase
holding all information about fileareas and their contents it needs.
Especially if you have many fileareas this will help to speed up the
startup of the tagger considerably.
But you have to notice the Tagger if the contents of the Filebase have
to be changed (uploads, file moves etc.). Practically this should be done
AFTER the FBP utility of maximus has been run. Simply call the Tagger only
with the Parameter RESCAN (TAGGER.EXE RESCAN). Then the filebase will
be updated and the tagger leaves immediately back to the caller.
A faster alternative is the Parameter UPDATE= which allows to update only
selected areas.
Please do NOT put a fileextension at the end of the path because the
Tagger will add the exetension .DAT and .DMP by himself.
Downloadlist:
-------------
After selecting "Download" the Tagger will create a list of the selected
files and pass the name along with some other parameters (see protocols-
section) to a cmd-file. If you leave out this parameter the selected files
will be passed as parameters. Use the "%%" like in the lastuser parameter
to specify the position of the nodeno.
The downloadlist has one line per selected file which holds the filename,
filesize filedate and filedescription.
e:\100\xmas.zip 123456 12-24-93 Xmas-Demo, find Santa Claus
Languagefile :
--------------
Place the name of an alternative languagefile here. This file will
change the programs texts and menus. See english.lng and deutsch.lng for
examples. If you leave this parameter out, the program will default to
english language.
The language-file should have one identifier followed by a quoted c-type
string.
Be aware that if you change these texts you can occasionally can cause
the program to abort with an error (if you state a wrong format-string or
make a string too long to fit in place). So test the program before you
release it for use in your BBS.
In some of the strings you find a "~" this is used to highlight the
following letter. This works only in the strings where it is originally
used.
Some identifiers end with "menu". These hold the keys the user has to
press to execute a function. Each position in such a menustring stands
for a function. If you replace the char at this position with a Space
the option is disabled. Control Keys work also (except Ctrl+z) when you
put the code with Alt+nnn. E.g.: "" means Ctrl+W
Example :
English:
askquitmsg " Quit (~Yes/~No) ? "
quitmenu "YN"
French:
askquitmsg " Sortir (~Oui/~Non) ?"
quitmenu "ON"
German:
askquitmsg " Ende (~Ja/~Nein) ? "
quitmenu "JN"
Optimistic:-)
askquitmsg " End it (~Yes/~Yes) ? "
quitmenu "Y "
Helpfile :
----------
Here you can place the name of the help-file which will be displayed, when
the user presses "H". The default is "tagger.hlp".
Example of a Filepath-Section:
Filepaths
logfile c:\tagger\tagger.log
arealist c:\box\max\filearea.ctl
lastuser c:\box\max\lastus%%.bbs
maxprm c:\box\max\max.prm
filebase c:\tagger\filebase
downloadlist c:\tagger\dlfile%%.lst
languagefile english.lng
helpfile tagger.hlp
End Filepaths
The Colors-Section :
--------------------
In this section the colors of OffTag are adjusted.
The Syntax is: <ColorId> <Foreground> ON <Background>
Valid color values are:
Background:
BLACK,BLUE,GREEN,CYAN,RED,MAGENTA,BROWN,LIGHTGRAY
Foreground:
BLACK,BLUE,GREEN,CYAN,RED,MAGENTA,BROWN,LIGHTGRAY
DARKGRAY,LIGHTBLUE,LIGHTGREEN,LIGHTCYAN,LIGHTRED,
LIGHTMAGENTA,YELLOW,WHITE
I recommend using CONFIG.CMD to set the colors.
The Miscellaneous-Section :
---------------------------
I put in the miscellaneous section any things that didn't really fit in
the other sections.
DateFormat :
------------
The dateformat is used when entering the newfiles date or displaying
the filedates. DD stands for the day (01..31), MM for the month (01..12)
and YY for the year (00..99). These letters should be divided by
a seperator. Four digits for a year or months in words are not possible.
Right : YY-MM-DD DD.MM.YY MM/DD/YY
Wrong!: DD.MM.YYYY DD---MM---YY DMMDYY DMY etc.etc.
Timeout :
---------
Timeout sets the time in seconds after that the timeout-warning window
will appear if the user hasn't pressed any keys during this time.
This window will then perform a 60 seconds countdown and if the user
hasn't still pressed any key the Tagger exits.
Default are 120 seconds.
MaxTagged :
-----------
This limits the maximum number of files which can be tagged in one session
with the tagger. Usually Maximus can tag a maximum of 30 files before
starting the download. If this is not enough for your purposes, you must
change the file downmult.cmd to repeat the [menu_cmd download] after each
30 files. Default are 30 files.
DescLimit :
-----------
This statement limits the maximum length per file description which is
stored in OffTag. This can reduce (like cleanupdesc) the filebase and
thus speed up loading and reduce memory use of tagger at the cost of
information. The internal limit of OffTag is 1000 chars.
UseCreationDate :
-----------------
Forces the tagger to use the Creation Date of a file instead of the
Last Write Date. If the Creation Date is zero however (e.g. on
FAT-Partitions) the Last Write Date is taken.
NoDownloadMenu :
----------------
Tagger starts immediatly when Download is selected. It uses the first
Protocol-Definition in the Protocols section. There has to be at least
one.
BBSDesclimit :
--------------
Limits each line edited in filemanagermode to this length.
Default is 254 chars.
Example :
Miscellaneous
Dateformat MM/DD/YY
Timeout 240
MaxTagged 30
DescLimit 80
NoDownloadMenu
BBSDescLimit 255
End Miscellaneous
The Speedadapt-Section :
------------------------
In this section the Tagger tries to adapt to the bpsrate of the user. So
it should be even bearable for 2400er users.
First put in the bpsrate for which (and less) the following flags in
that line are used. Please put the lines in rising bpsrate order.
Possible flags :
NoScroll :
----------
If the scrollbar leaves the screen a complete page-up/down is done instead
of a single-line scroll.
ShortBar :
----------
The scrollbar is displayed only by colored ">" and "<" not as a solid line.
NoSelectColor :
---------------
Tagged files aren't highlighted any more. So they can only be recognized
by the brackets ("[]").
NoColor :
---------
No color at all.
Example:
Speedadapt
1200 NoScroll Nocolor
2400 NoScroll ShortBar NoSelectColor
4800 NoScroll ShortBar
12000 NoScroll
End Speedadapt
The Protocols-Section :
-----------------------
In the protocols-section you can define a downloadmenu for different
protocols. If you do not define any protocol simply download.cmd ist called
(parameters see below).
The menu appears, when you press 'D' for download in the Tagger. Per line
you define one protocol in the following synatx:
[Local|Extern] [Quit|NoQuit] <Key> <Description> <REXX-Script> [Script-Parameter]
Local/Extern: Specifies if Menu-Option is for local or external use.
If not specified the option is displayed in both cases.
Quit/NoQuit : If you use Quit the Tagger will exit after executing the stated
CMD-file. This is useful if the CMD-file creates a bbs-file
which is executed after the return to Maximus. NoQuit can be
used for extern protocols.
After that place the letter which shall be pressed in the menu to choose
this protocol. Then the description. Please replace all " " in the descrip-
tion by "_". Then put in the name of the CMD-file which has to be executed
and finally you can give a parameter which will then be passed as first
parameter to the CMD-file. This is useful to distinguish protocols when using
one CMD-file for different protocols. You can use a maximum of 15 lines.
Example:
Protocols
Extern Quit Z ZModem DOWNMULT.CMD Z
Extern Quit L ZModem_Logoff DOWNMULT.CMD L
Local NoQuit K Copy_Files COPYIT.CMD
End Protocols
The FileManager Section :
-------------------------
Different Parameters for the Filemanager-mode of OffTag are defined here.
For more infos concerning the Filemanager mode see 8.2.
Access :
--------
This allows to restrict certain Filemanager actions to different User-
levels (Sysop is Default). In any case all functions only work when the
FILEMANAGER parameter ist passed to the Tagger.
Syntax : ACCESS <Action> <Userlevel>
The Actions are :
DELETE COPY MOVE EDIT ADOPT DROP UPDATE RENAME DRIVES
Example:
Access Move AsstSysop
(Allows Users with level AsstSysop to move files)
NotAdopt :
----------
Specifies which files not to List when you use the Adopt/Pickup command.
Multiple NOTADTOP lines will be recognized.
Syntax: NOTADOPT <Filemask> <Filemask> ......
Example:
NotAdopt *.cmd *.bak FILES.BBS FILES.IDX FILES.DMP FILES.DAT
DriveInfo :
-----------
Lets you specify the drive letters of the drives to be listed in the
free space info.
Syntax: DRIVEINFO <DriveLetter> <DriveLetter> ....
Example:
DriveInfo C D E F M N
FileIdSpawn :
-------------
The CMD-File/Program to be started if you want to get a file-description
out of an archive.
Example:
FileIdSpawn GETID.CMD
FileID :
--------
The name of the textfile holding the file-id (if found) when returning to
OffTag.
Example:
FileID FILEID.TXT
DefaultDescription :
--------------------
The standard description which will be preset on newly adopted files.
Example:
DefaultDescription [000] No Description available
The External Section :
----------------------
External Programs can be executed Users of Offtag can issue an external
function for a file (typically an archive viewer). Up to 5 Functions can
be defined.
The Keys which start these functions have to be define in the language file.
FILEMENU "HASGWFNTLDQRV "
Function: 12345
(here is only "V" defined for Archive Viewing)
To enable more external Functions in the Filemanager mode (e.g. Touch,
Vircheck) you can add options in the language file for the Filemanager Menu.
FM_FILEMENU "HASGWFNTLDQRVX KMCEP U I"
12345
(and additionally a vircheck with X, you can also use Ctrl Combinations
if you enter them with Alt+nnn Codes)
In the External Section you can put one program/script per line. Additionally
you can add a parameter.
When issued, the script/program will be then be started with the following
parameters:
Com-Handle (Filehandle of the open Com-Port, or 0 for local mode)
NodeNo (NodeNumber, if specified)
Filename (Fully qualified filename)
Paramter (optional Parameter specified in external section)
Example:
External
VIEWIT.CMD
VIRCHECK.CMD
End
7.3 Area Management :
-------------------
Read-Only Areas :
-----------------
"Fileoverride Download <Priv-Level>[/<Lock>]"
If you use this statement in an area-definition of the filearea.ctl the
tagger will allow download in this area only for the defined priv-level
and above. But the area will be displayed to everyone which has a
priv-level sufficcient for the "FileAccess" statement.
You have type the entire Word "Download" a single "D" is NOT recognized
by OffTag.
Area-Grouping :
---------------
This is a powerful feature for sysops which have very many Fileareas.
The Tagger now allows to group fileareas in groups and sub-groups like
directories. The definition of groups is done (as comment) in the
filearea.ctl (and included files). The statements listed below have to
follow directly after the %.
Note: Be sure to RESCAN your Filebase after changing any group-
statements. Only then the changes will be recognized.
These commands are supported:
%TAG GROUP <GroupName> <Description>
---------------------------------------
Defines a group. If the group is a subgroup of another group the
groupname has to start with the upper-groupname then "\" then the
groupname itsself (like a directory path to a subdirectory).
All groups have to start with a "\".
Usually you define all groups at the begin of the filearea.ctl, anyway
the groups have at least to be defined before they are used in the
PATH and ALIAS commands.
Example:
%TAG GROUP \OS/2 all about OS/2
%TAG GROUP \OS/2\INTERN local os/2 areas
%TAG GROUP \OS/2\AC-NET os/2 areas of the ac-network
%TAG PATH <Groupname>
-----------------------
The Path command defines the group that will be used for the following
Fileareadeclarations. It can be stated multiple times for the same group
if areas of one group are not listed sequentially in your filearea.ctl.
Example:
%TAG PATH \OS/2\INTERN
%TAG ALIAS <Groupname>
------------------------
The Alias command allows to let one filearea appear in different groups.
It has to be placed BEHIND the area-declaration.
You can use multiple ALIAS commands per group.
Example of a filearea.ctl which is formatted for Tagger grouping.
%Now for the Groupdeclarations
%TAG GROUP \OFFLINE Our filelists, new uploads, sysop portrait ...
%TAG GROUP \MUSIC Doobeedo
%TAG GROUP \GRAPHICS Pictures
%TAG PATH \OFFLINE
area 0
fileaccess Twit
fileinfo Filelists, infos
download d:\samples\files
upload c:\upload
end area
%TAG ALIAS \MUSIC
%TAG ALIAS \GRAPHICS
area 1
fileaccess disgrace/1
%
% this area is readonly up to level Worthy (included)
%
fileoverride download Privil
fileinfo New Uploads
download c:\upload
upload c:\upload
end area
%TAG PATH \MUSIC
area 400
fileaccess disgrace/4
fileinfo Sound Tools
download d:\4\400
upload c:\upload
end area
%TAG PATH \GRAPHICS
area 500
fileaccess disgrace/5
fileinfo Pictures
download d:\5\500
upload c:\upload
end area
area 508
fileaccess disgrace/5
fileinfo Offline User Portraits
download d:\5\508
upload d:\5\508
end area
%TAG ALIAS \OFFLINE
Area-Dependent Commands:
------------------------
The commands WRAPATCR,CLEANUPDESC,DESCLIMIT and MULTILINEDESC can be
applied to particular areas. Simply put them before the area-definition(s)
in the filearea.ctl. And put them after the areas again (with a '-' added)
to switch them off again.
Example:
%TAG CLEANUPDESC
area 1
....
end
%TAG DESCLIMIT 40
area 2
...
end
%TAG CLEANUPDESC-
%TAG DESCLIMIT 1000
If WRAPATCR,CLEANUPDESC or MULTILINEDESC have already passed as Parameter
this has no effect as the Parameters apply globally. In the case of
desclimit the smaller value (of tagger.cfg or declared in .ctl) is taken.
You need to do a RESCAN after having changed the filearea.ctl.
7.4 Performing the Download :
-----------------------------
As stated above a CMD-file ist called to perform the download or whatever
you want to do with the tagged files (creating gif-catalogues etc.).
The Tagger does not update the users download statistics. So if you use
an external protocol you (in the CMD-file) or the protocol have to do that.
The following example shows in which order parameters are passed to the
CMD-file :
(in TAGGER.CFG)
Protocols
Quit Z Z-Modem ZMODEM.CMD Z
End Protocols
The user chooses "Z" in the download-menu.
Then ZMODEM-CMD will be executed with the following parameters.
ZMODEM.CMD Z 5 01 c:\tagger\dlfile01.lst
│ │ │ │
│ │ │ Name of the downloadlist which holds the selected files
│ │ nodeno (passed with NODE=nn to the Tagger)
│ com-handle (passed with P=nn to the Tagger)
last parameter in the definition line (can be left out)
Hint :
If you want to now what parameters exactly the Tagger passes in your
installation, have a look at the logfile. The whole parameterline is logged
there after the download has been selected.
If you do not put a path for the downloadlist in the filepath-section the
Tagger will pass the selected files in quotes ("") directly on the command-
line.
==============================================================================
8.Using the Tagger :
--------------------
8.1 General Usage :
-------------------
Using the Tagger is explained in the file TAGGER.HLP. For cursor control it
is recommended to turn on NUM-LOCK or to enable the Doorway-Mode in the
Terminalprogram because there are no ANSI-Codes for PgUp and PgDn.
Anyway in local mode these keys also work. Local keys are always accepted,
also if an external user accesses the Tagger. (An exception is the Archive
Viewer, this is due to a limitation in the REXX Com-Port interface)
The sysop-chat can be activated with "C" or ALT-C (if more then 20 lines are
displayed). You or the user can quit the chat with 2xESC.
8.2 The Filemanager Mode :
--------------------------
When passing the Parameter "FILEMANAGER" to the tagger it starts in File-
Manager Mode. There you can Move/Copy/Kill Files in/to different Areas.
Also included is a Dupe-Listing mode (just like New-Files, but it checks for
dupes in your file-base).
As this is still a beta, be careful. The Kill command actually deletes Files.
Also backup your files.bbs files. I tried to stay on the safe side and
the tagger creates a *.bak of the files.bbs if it changes it.
Warning:
Be sure to enable the "FILEMANAGER" parameter only to people with sysop
status because this mode allows sight and action (including Kill) on ALL
defined file-areas.
The Dupelister :
----------------
Lists Files which appear more than one time in either the whole filebase
or in one group of areas (if you entered one). This is done either by
matching the filename only or filename+extension.
The Dupelister always lists the area-title even when the list is sorted.
So some area titles may appear multiple times.
File-Manager actions :
----------------------
The File-Manager acts only on the files of one area. If the Display-Mode
includes multiple areas the tagger takes the area of the currently
highlighted file. This may be irritating on sorted lists when files
of different areas follow directly.
Also the actions ONLY work if a file is highlighted (not on '..' and
not on Area-Headlines) except for the PickUp option.
If some files in this area are tagged, the actions will work on the
tagged files of the area (not on tagged files in any other area).
If no file is tagged in the area, they work on the highlighted file.
Move:
-----
Moves the file(s) to another filearea which can be selected. This is
actually done by first Copying the File to the destination area and
then Killing the File in the source-area.
Copy:
-----
This is a Dupe-Producer, it has been requested so i implemented it.
Same as Move without deleting the Source.
Kill:
-----
Will erase the selected file(s) out of the files.bbs and from the disk.
You will be prompted for Yes/No before the files are killed.
Edit:
-----
Edit the file description.
Additionally you can replace the description by the contents of a
description file (e.g. File_Id.Diz). See the Tagger.Cfg part for more info.
PickUp:
-------
Adopts new files (present in the areas downloadpath) in the filelist.
See the Tagger.Cfg part on information how to exclude specific files
from adopting.
Drop:
-----
Deletes a file out of the files.bbs. But it stays physically on the disk.
Rename:
-------
In work.
DriveInfo:
----------
Lists the Size and Free Space of all Drives stated in the tagger.cfg
The Tagger filebase is updated on leaving the tagger.
Tagger also creates a file called "areascan.log" which holds the changed
areas. This can be used with utilities (like fbp.exe).
The filebase is not updated (yet) when Tagger exits via Timeout or
Carrier loss.
Get Description:
----------------
While Adopting New Files or Editing existing Files you can get the File-
Description out of the Archive. The provided cmd-file GETID.CMD does this.
More about this in the TAGGER.CFG news, below.
Limited Filemanager Rights:
---------------------------
You can restrict each Filemanager function to a specified Userlevel.
More about this in the TAGGER.CFG section.
8.3 Additional hints for use :
------------------------------
- If you want to run the Tagger with different configurations, (e.g. different
languagefiles, logfiles etc.) use the CFG= commandline parameter to switch.
- As the tagger automatically adjusts to the users screensize (according to
lastusxx.bbs) it can be useful if you issue a MODE co80,50 or MODE co132,50
in T.CMD, if your monitor supports that. So you can also see what users with
more than 25 lines or 80 columns do (after tagger.exe you can specify a
MODE co80,25 again).
- If the users do not get all areas listed in the Tagger they usually have
access to and you have specified a key in the Fileaccess statement of your
filearea.ctl. Make sure the user has those keys really set when he enters
the Tagger.
- When the tagger displays with wrapped lines (see WRAP parameter) he will
wrap the filedescription by words depending on the screenwidth. On an
usual screenwidth of 80 columns the description has a maximum length of
42 chars per wrapped line (if WRAP is on). If you include descriptions
which have another line-length than 42 columns they will be usually
displayed different to their original layout. Check the Parameter WRAPATCR
to correct this.
==============================================================================
9. TAGSERVE the Shared-Memory server.
--------------------------------------
Especially for BBS's with many files, the start up of OffTag takes quite a
while even when using the filebase.
So i added the "Shared Memory Server" which significantly speeds up loading
and which let's the Tagger hog less memory on Multi-Node systems.
It works like this:
You start TAGSERVE.EXE which will stay running in background all the time.
TAGSERVE loads the Filebase into Memory and will offer it to all Tagger
Sessions which are started on the same computer.
Each Tagger session itself mirrors some essential information (which is
stored in the filebase.dat) from the shared memory pool and accesses the
Data (these are the contents filebase.dmp) of the shared memory whenever
needed. So the loading time will reduce to some memory transfer and perhaps
some time for swapping in (if needed parts of the memory pool had been
swapped out).
TAGSERVE itself will remark when the filebase has been changed by UPDATE,
RESCAN or the filemanager and reload the filebase.
If you do not use the default name "FILEBASE" or you use another path
for the filebase than the default (current) path you can pass the name
with the parameter "FILEBASE=<Name>" to TAGSERVE.
Example:
TAGSERVE FILEBASE=c:\base\mybase
==============================================================================
10. Final Notes:
----------------
Again the name of the author:
Michael Mrosowski
Mühlenweg 1
22880 Wedel
Germany
Fidonet : 2:240/5022.1
Internet: lagaffe@offline.sh.sub.de
I state again that nobody needs to pay anything for the use of this program.
But if you like the program and you want keep up my motivation you can support
the further development of this project by donating some money.
A nice postcard is also always welcome.
Anyway if you decide not to do this that won't affect my attitude to answer
your questions (if i can) either.
So for any who wants to send some money, here's my account :
Michael Mrosowski
Account#: 6256 66-205
BLZ : 200 100 20
Bank : Postgiroamt Hamburg
concern : OffLine-Donation
Amount : at will
Anyone who supported me in that way will officially appointed to be a sponsor
of this program and will be listed in the following versions "Hall of Fame"
The newest version of OffTag will always be accessible in the BBS
stated below and is requestable with the magic OFFTAG
The latest Betas are accessible with the magic TAGBETA
Ideas for future Releases:
RIP-Support
Support for Adept-BBS (sooner)
OffLine BBS Wedel (Sysop Jens Meske)
Fido : 2:240/5022 and 2:240/5023
Telephone : +49/4103/17984 (>=2400) and +49/4103/17985 (>=9600)
(both v32bis/Zyx16.8, and be aware that the menus are in german)
Each form of questions, suggestions and criticism is appreciated.
Until now i had always time to answer any netmail. If i don't answer a mail
simply ask again. Sometimes i forget to answer :)
Have fun with it !
Michael Mrosowski