──────────────────────────────────────────────────────────────────────────
TOOLS
Disk/Conference Management System
TOOLSRUN
Request File Language Reference
Service Level 6 Version 6.8
Document Number TOOLS-003-03
──────────────────────────────────────────────────────────────────────────
┌─── Production of this document ────────────────────────────────────┐
│ │
│ This document was prepared and formatted using the BookMaster• │
│ document markup language. │
│ │
└────────────────────────────────────────────────────────────────────┘
Fifth Edition, January 30th, 1995
This is the fifth edition of this document, and applies to the
TOOLSRUN EXEC, Version 6.8, Service Level 6.
Cover art by Bill Trautman and Scott Tietjen, using CUADRAW.
© Copyright International Business Machines Corporation 1995
All Rights Reserved
Although describing the request file language, this information is not
intended as a user's guide. It is intended as a specification of interest
to the authors of TOOLSRUN request file generators, to administrators
debugging failed request files, and to any person wishing to send message
requests. Although great care has been taken with the human factors of
the output (messages) that are returned to users, request files are
sufficiently complex to thwart a reasonable effort in human engineering,
therefore the human interface for input is left as an exercise for another
program, such as the TOOLS EXEC.
The TOOLS and TOOLSRUN programs are owned by the IBM ISSC Solution Center
- Northeast. These programs and supporting documentation are provided
as-is. We do not warrant uninterrupted or error free operation of the
programs. We have no obligation to provide service, defect correction, or
any maintenance for the programs or documentation. We have no obligation
to supply any program or documentation updates or enhancements to you even
if such are or later become available.
TOOLSRUN EXEC was developed by Mike Cowlishaw and is maintained by Bob
Cronin. TOOLSREQ SCRIPT is maintained by Scott Hightower.
If you need to report a problem or have a question regarding TOOLSRUN EXEC
or this documentation, you should append it to the TOOLS FORUM on IBMVM.
If you have a suggestion for an enhancement, you should append it to the
TOOLWISH FORUM on IBMVM.
You can use the TOOLS EXEC to access the IBMVM disk. The disk name is
IBMVM, managed by IBMVM at KGNVMC.
If you have a problem with TOOLSRUN and are not running the most recently
distributed service level, you will be required to upgrade to the latest
level and demonstrate that the problem still occurs before it will be
actively investigated.
Book Cover COVER
Notices NOTICES
Edition Notice EDITION
Preface PREFACE
Maintenance of TOOLSRUN PREFACE.1
Table of Contents CONTENTS
Figures FIGURES
Summary of Changes CHANGES
Fifth Edition CHANGES.1
Fourth Edition CHANGES.2
Third Edition CHANGES.3
Second Edition CHANGES.4
The General Requirements of TOOLSRUN Request Files 1.0
The General Requirements 1.1
Files That Do Not Meet Requirements 1.2
Processing of Messages 1.3
Examples 1.4
Request Verbs Organized by Application 2.0
Setup Verbs 2.1
Routing Setup Verbs 2.2
Query Verbs 2.3
File Read/Write Verbs 2.4
File Management Verbs 2.5
Ownership and Distribution Verbs 2.6
Miscellaneous Verbs 2.7
Comprehensive List of All Request Verbs 3.0
Examples of Syntax Notation 3.1
AGET 3.2
ALIST 3.3
APLACE 3.4
APPEND 3.5
AREPLACE 3.6
BATCH CANCEL 3.7
BATCH QUERY 3.8
BATCH RELEASE 3.9
CLASS 3.10
CLEAN 3.11
CMS 3.12
COMMENT 3.13
COMMENT VIA 3.14
COPY 3.15
CREATE 3.16
DISK 3.17
:disk 3.18
DISK SHUTDOWN/SHUTPERM 3.19
DISK START 3.20
ERASE 3.21
FOR 3.22
FROM 3.23
GET 3.24
HELP 3.25
HIDE 3.26
INFORM 3.27
LIST 3.28
LOCK 3.29
LOGOFF 3.30
NEWOWN 3.31
NOTIFY 3.32
ORIGIN 3.33
OWN 3.34
PLACE 3.35
PROPAGATE 3.36
PRUNE 3.37
PUT 3.38
QUERY DISK 3.39
QUERY FILE 3.40
QUERY INFORM 3.41
QUERY SYSTEM 3.42
QUERY USAGE 3.43
QUERY VERSION 3.44
REFRESH 3.45
REGISTER 3.46
REGRESS 3.47
RENEW 3.48
REPLACE 3.49
RESPONSE 3.50
SET ADDRESS 3.51
SET DESCRIPTION 3.52
SET FILE 3.53
SET MODE 3.54
SHUTDOWN 3.55
SUMMARY 3.56
TRACE 3.57
UNINFORM 3.58
UNLOCK 3.59
UPDATE 3.60
VIA 3.61
VOTE 3.62
Appendix A. TOOLS versus TOOLSRUN Request Cross Reference A.0
TOOLS Library BIBLIOGRAPHY
Getting Help BACK_1
1. Setup verbs 2.1
2. Routing setup verbs 2.2
3. Query Verbs 2.3
4. File Read/Write verbs 2.4
5. File management verbs 2.5
6. Ownership and distribution verbs 2.6
7. Miscellaneous Verbs 2.7
| 8. TOOLS and TOOLSRUN Publications BIBLIOGRAPHY
Changes from the previous edition are marked with vertical bars (|) in the
margins.
| This version of the document has been brought up to date for TOOLSRUN
| version 6.8, service level 6.
| The following significant changes and corrections were made:
| • More discussion of method of transmission.
| • Discussion of write request propagation.
| • BATCH (self release)
| Minor changes were made to the descriptions of the DISK, FROM and ORIGIN
| cards. A few other minor changes were also made.
This version of the document has been brought up to date for TOOLSRUN
version 6.8, service level 2.
The following significant changes and corrections were made:
• New verbs BATCH and RENEW.
• A detailed authorization section has been added for each request verb,
relating it to the specific control verbs described in TOOLSRUN
Control File Language Reference.
• Added a Machine type column to Figure 2 in topic 2.2.
• Added PUT to Figure 4 in topic 2.4.
In addition, several minor changes have been made for clarification.
This version of the document has been declassified and prepared for
external release.
This is a revised version of TOOLSRUN 6.0 Request File Language Reference
by Louis M. Puster, Jr..
This version of the document has been brought up to date for TOOLSRUN
version 6.6, service level 11.
• Class M punch or print files punched with no header.
• Request verbs are expressed in the form
:TOOLS verb parameters
or
:diskname verb parameters
The second form implies the name of the disk, as if a DISK statement
had been processed.
• Request file structure
Zero or more "setup" verbs, such as ORIGIN, FOR, PROPAGATE or
RESPONSE. DISK is the usual setup verb, except for system
requests.
Certain request verbs can specify a count of description records.
The next count number of records are read and concatenated into a
single long line and constitute the description data for this
request.
Other verbs, such as CREATE have a method parameter and require
data to immediately follow the description records. This data
must be in the method specified, usually NETDATA format. However,
TOOLSRUN can accept unformatted embedded data if the ASIS method
is specified. In this case, long records may be read from print
| files. (See method in topic 3.1 for a more detailed description.)
Note: NETDATA format data may not be placed in print files.
• Request verbs must be spelled out in full, no abbreviations are
allowed.
• Multiple requests may be placed in one request file. You will
probably want to do this if you want to ensure that a set of requests
are performed in a specific sequence (since there is generally no
guarantee that a series of requests transmitted across a network will
arrive in the same order they were sent). For example, to ensure that
no files referenced by a new package are created before the package
file, build a single request consisting of the CREATE request for the
package file followed by the CREATE requests for the files in the
package.
- All requests in one deck must be for the same disk; System (1) and
disk-specific request verbs may not be mixed in the same request
file.
- If there are any request verbs following a CMS request, they will
be lost.
| - If there are any request verbs following ASIS data, they will be
| imbedded in the data.
- If one of the requests in a multiple request file fails, the rest
of the requests are not processed and the file is not propagated
to other systems, which can make recovery complicated.
| - Write requests are normally propagated automatically, but not if
| included in a multiple request deck with read requests.
(1) System requests have no preceding DISK verb and are directed
to the Toolsrun system itself. These include AGET, ALIST,
APLACE, CMS, LOGOFF and SHUTDOWN; and QUERY SYSTEM, QUERY
USAGE and QUERY VERSION.
• TOOLSRUN ignores the entire deck if it is not class M.
• If TOOLSRUN attempts to process the file, but does not recognize the
format, the class is changed to C and a warning is issued to the disk
notify person(s) and logged in the @SYSTEM AUDIT file.
• There exist many EXECs, invoked by the various TOOLSRUN exits, that
will recognize specially formatted files (such as CMS NOTEs) and
convert them to a class M file that TOOLSRUN can process. However,
these are beyond the scope of TOOLSRUN processing, per se.
If enabled, TOOLSRUN will examine messages, special messages, or IUCV
messages. If the message text looks like it might be a valid request,
TOOLSRUN will punch a class M request to itself, consisting of the text of
the message. Any request that can be correctly expressed in a single line
can thus be sent as a message.
Message requests from System users go to the top of the reader, so they
will be processed next.
Following is an example of a request to the IBMVM disk to send a copy of
the TOOLS FORUM in NETDATA form:
:TOOLS DISK IBMVM
:TOOLS GET TOOLS FORUM NETDATA
Following is a request that creates a two line file on the IBMVM disk,
with a description of "A trivial example." The requestor wishes to receive
a response only if the request fails; the class and method of the
response, and the disposition of the request deck in the event of a
failure, are left to the defaults for the disk.
:TOOLS RESPONSE * FAIL * *
:TOOLS DISK IBMVM
:TOOLS CREATE MY DATA ASIS 1
A trivial example
This is my data.
I like my data.
Following is request that replaces a PACKAGE file and creates a file newly
referenced by it. By combining the two requests into a single deck, the
create request cannot race ahead of the PACKAGE replacement.
:TOOLS DISK IBMVM
:TOOLS REPLACE MY PACKAGE NETDATA 1
Version 1.3, MYNEW EXEC added
[package file in NETDATA form]
:TOOLS CREATE MYNEW EXEC NETDATA 1
Front end exec for MY MODULE
[exec file in NETDATA form]
Here is the same multiple request as seen by a shadow machine:
:TOOLS ORIGIN LEXVMK JOEBLOW 19930601132759
:TOOLS DISK IBMVM
:TOOLS REPLACE MY PACKAGE NETDATA 1
Version 1.3, MYNEW EXEC added
[package file in NETDATA form]
:TOOLS CREATE MYNEW EXEC NETDATA 1
Front end exec for MY MODULE
[exec file in NETDATA form]
┌─────────────────┬──────────────────────────────────────────────────────┐
│ Verb │ Usage Notes │
├─────────────────┼──────────────────────────────────────────────────────┤
│ CLASS │ Obsolete form of RESPONSE. │
├─────────────────┼──────────────────────────────────────────────────────┤
│ COMMENT │ This statement is ignored. │
├─────────────────┼──────────────────────────────────────────────────────┤
│ DISK │ Selects the disk for subsequent verbs. There may be │
│ │ more than one in a spool file, but they must all be │
│ │ for the same disk. │
├─────────────────┼──────────────────────────────────────────────────────┤
│ DISK NOCOPY │ Inhibits propagation of the request to shadows. │
│ │ Priv authority is required. │
├─────────────────┼──────────────────────────────────────────────────────┤
│ FOR │ Allows you to submit a request on behalf of someone │
│ │ else. Applies to all subsequent verbs until changed │
│ │ by another FOR. │
├─────────────────┼──────────────────────────────────────────────────────┤
│ PROPAGATE │ Forces propagation of this entire request file, │
│ │ unless a verb fails. │
├─────────────────┼──────────────────────────────────────────────────────┤
│ RESPONSE │ Selects the way that the service machine │
│ │ communicates with you. │
├─────────────────┼──────────────────────────────────────────────────────┤
│ TRACE │ Traces the execution of the subsequent verbs. For │
│ │ debugging. │
└─────────────────┴──────────────────────────────────────────────────────┘
Figure 1. Setup verbs. Request verbs that establish the environment for
subsequent verbs in the request file.
┌─────────────────┬─────────────┬────────────────────────────────────────┐
│ Verb │ Machine │ Usage Notes │
│ │ Type │ │
├─────────────────┼─────────────┼────────────────────────────────────────┤
│ FROM │ COPIER │ Originator of a request that has been │
│ │ MASTER PEER │ forwarded due to a Reroute statement │
│ │ REROUTER │ in the control file. │
│ │ SERVANT │ │
├─────────────────┼─────────────┼────────────────────────────────────────┤
│ ORIGIN │ COPIER │ Originator of a request that has been │
│ │ MASTER PEER │ propagated from a master to a shadow. │
│ │ SERVANT │ │
├─────────────────┼─────────────┼────────────────────────────────────────┤
│ VIA │ Not Req'd │ A service machine that has processed │
│ │ │ this request already. For loop │
│ │ │ detection. │
└─────────────────┴─────────────┴────────────────────────────────────────┘
Figure 2. Routing setup verbs. Request verbs inserted by TOOLSRUN when
files are forwarded from one service machine to another.
Machine Type refers to the control card used to identify the
TOOLSRUN machine. See TOOLSRUN Control File Language Reference.
┌─────────────────┬───────────┬──────────────────────────────────────────┐
│ Verb │ Minimum │ Usage Notes │
│ │ Privilege │ │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ ALIST │ System │ Returns a list of files that are on the │
│ │ │ A-disk of the service machine. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ BATCH QUERY │ Getter │ Returns a list of batched GET requests. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ HELP │ Not │ Returns general information about the │
│ │ Req'd. │ disk (if a valid one is selected) or │
│ │ │ else the whole service machine. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ LIST │ Getter │ Returns one line of information per │
│ │ │ selected file. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ QUERY DISK │ Getter │ Returns information about the selected │
│ │ │ disk. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ QUERY FILE │ Getter │ Returns information about a specified │
│ │ │ file. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ QUERY INFORM │ Getter │ Either returns a list of files for which │
│ │ │ you are being informed about or a list │
│ │ │ of all users who are informed for a │
│ │ │ specified file. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ QUERY SYSTEM │ System │ Returns information about the system. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ QUERY USAGE │ System │ Returns usage statistics about each │
│ │ │ disk. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ QUERY VERSION │ Not │ Returns TOOLSRUN version number, number │
│ │ Req'd. │ of disks and system contact. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ SUMMARY │ Getter │ Returns one line of information per │
│ │ │ selected file. │
└─────────────────┴───────────┴──────────────────────────────────────────┘
Figure 3. Query Verbs. Verbs that return information.
┌─────────────────┬───────────┬──────────────────────────────────────────┐
│ Verb │ Minimum │ Usage Notes │
│ │ Privilege │ │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ AGET │ System │ Get a copy of a file from the A-disk of │
│ │ │ the service machine. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ APLACE │ System │ Place a file on the A-disk of the │
│ │ │ service machine. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ AREPLACE │ System │ Obsolete form of APLACE. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ APPEND │ Appender │ Add information to an appendable file. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ BATCH CANCEL │ Getter │ Remove batched GET requests from the │
│ │ │ queue. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ BATCH RELEASE │ Priv │ Causes files matching requests in the │
│ │ │ batch queue to be sent out. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ CREATE │ Owner │ Create a new file on a maintained disk. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ GET │ Getter │ Get a copy of a file from a maintained │
│ │ │ disk. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ PLACE │ Priv │ Place a file on a maintained disk │
│ │ │ regardless of whether it already exists │
│ │ │ or not. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ PRUNE │ Replacer │ Remove all appends submitted prior to a │
│ │ │ specified date and time. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ PUT │ COPIER │ Refresh a file on a maintained disk. │
│ │ MASTER │ │
│ │ PEER │ │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ REPLACE │ Replacer │ Replace an existing file on a maintained │
│ │ │ disk. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ UPDATE │ Replacer │ Apply updates to a file on a maintained │
│ │ │ disk. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ VOTE │ Appender │ Register your vote in a VOTE file. │
└─────────────────┴───────────┴──────────────────────────────────────────┘
Figure 4. File Read/Write verbs. Verbs that read or write files.
┌─────────────────┬───────────┬──────────────────────────────────────────┐
│ Verb │ Minimum │ Usage Notes │
│ │ Privilege │ │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ CLEAN │ Priv │ Removes discarded, backup and hidden │
│ │ │ files to make more space on a maintained │
│ │ │ disk. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ CLEAN SAFE │ Replacer │ Removes discarded files created prior to │
│ │ │ a system IPL to make more space on a │
│ │ │ maintained disk. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ COPY │ Priv │ Instructs one service machine to send │
│ │ │ files to another. Used to repair a │
│ │ │ shadow of a disk that is not current │
│ │ │ with the master. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ ERASE │ Owner │ Erase a file from a maintained disk. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ HIDE │ Replacer │ Hide a file by renaming it. Can be │
│ │ │ restored using REGRESS. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ LOCK │ Replacer │ Prevent file updates until unlocked. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ REFRESH │ Priv │ Ask a shadow of a disk to obtain fresh │
│ │ │ copies of files from the master. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ REGRESS │ Replacer │ Undo a REPLACE or HIDE. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ SET DESCRIPTION │ Replacer │ Replace the description of a file in the │
│ │ │ NAMES file. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ SET FILE │ Owner │ Rename a file. Updates the NAMES file │
│ │ │ but not the INFOLIST file. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ SET MODE │ Replacer │ Changes the filemode digit of a file. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ UNLOCK │ Replacer │ Re-enable file updates. REPLACE also │
│ │ │ does this. │
└─────────────────┴───────────┴──────────────────────────────────────────┘
Figure 5. File management verbs. Verbs that affect file names or content
but do not send or receive the content from users.
┌─────────────────┬───────────┬──────────────────────────────────────────┐
│ Verb │ Minimum │ Usage Notes │
│ │ Privilege │ │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ INFORM │ Getter │ Place you on a distribution list to be │
│ │ │ notified about changes to files and │
│ │ │ optionally send you the changed files. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ NEWOWN │ Replacer │ Transfers the ownership of your file to │
│ │ │ another person. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ OWN │ Owner │ Establish ownership for a file name. │
│ │ │ The file may already exist (and not be │
│ │ │ owned) or not yet exist. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ RENEW │ Getter │ Renew all of your subscription(s) to a │
│ │ │ Toolsrun controlled disk. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ SET ADDRESS │ Getter │ Change all your file ownerships and │
│ │ │ subscriptions to your new userid (or │
│ │ │ someone else's userid). │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ UNINFORM │ Getter │ Undo an INFORM. │
└─────────────────┴───────────┴──────────────────────────────────────────┘
Figure 6. Ownership and distribution verbs. Verbs that affect the
ownership or the distribution list for change notification.
┌─────────────────┬───────────┬──────────────────────────────────────────┐
│ Verb │ Minimum │ Usage Notes │
│ │ Privilege │ │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ CMS │ System │ Send a CMS request for execution by the │
│ │ │ service machine. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ DISK SHUTDOWN │ Priv │ Temporarily relinquish control of a │
│ │ │ disk. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ DISK START │ Priv │ Re-establish control of a disk. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ LOGOFF │ System │ Causes the service machine to │
│ │ │ immediately log off. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ NOTIFY │ Not │ Send a message to the owner of a disk or │
│ │ Req'd. │ a service machine. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ REGISTER │ Getter │ Inform a service machine that you have │
│ │ │ obtained copies of a package from a disk │
│ │ │ by means other than a GET request. │
├─────────────────┼───────────┼──────────────────────────────────────────┤
│ SHUTDOWN │ System │ Causes TOOLSRUN EXEC to exit. │
└─────────────────┴───────────┴──────────────────────────────────────────┘
Figure 7. Miscellaneous Verbs. Verbs that do not fit into any of the
previous categories.
Authorization:
Generally, one of the composite authorization verbs (GETTER, APPENDER,
REPLACER, PACKAGER, OWNER or PRIV) described in TOOLSRUN Control File
Language Reference. Usually, one or more specific primitive authorization
verbs (e.g. GET, DISK-NOCOPY) in parentheses. Other possibilities
include SYSTEM or the TOOLSRUN network configuration verbs (e.g. MASTER or
SERVANT). In some cases, additional text is required for a complete
description.
Format
fname File names and types can each be from one to eight characters.
The valid characters are A-Z, 0-9, $, #, @, +, - (hyphen), :
(colon), and _ (underscore). Lower case letters are also
allowed, but they are translated to upper case before being
processed.
fnpat A filename pattern which allows
ABC* The set of files whose filename begins with ABC.
*ABC The set of files whose filename ends with ABC.
*ABC* The set of files whose filename contains ABC anywhere.
* The set of all files.
ABC The set of files whose filename is ABC.
Note: Files whose filename is ABC would be selected in all the
cases above.
ftpat A filetype pattern handled exactly like the fnpat.
count The count is required.
[count | 0]
The count is optional, the default value is 0.
[{count | 0} [date [option]]]
The count is optional, and defaults to 0. The date is optional,
and count must be specified if date is specified. The option is
optional, and count and date must be specified if option is
specified.
{SHUTDOWN | SHUTPERM}
One and only one of SHUTDOWN and SHUTPERM must be specified.
[sincedate]
Most requests which return information may be restricted by date
to the most recent data. This date is of the form
YYYYMMDD[HH[MM[SS]]], the trailing six digits are optional and
default to zeros. SINCE dates contain 8-14 digits without any
spaces or punctuation.
text Mixed case information. All other parameters are translated to
upper case before processing.
| method One of:
| ASIS Fixed format records of length 80. Toolsrun does not
| alter the records in any way.
| NETDATA Data is transmitted as if in a continuous stream of
| bytes. While packaged in fixed length records for
| actual transmission, the data is combined with
| descriptive information (control records) to allow
| reconstitution at the receiving end.
| COPY A file is transmitted in a form suitable for
| processing by another Toolsrun machine. This is a
| combination of fixed format Toolsrun control records
| and data in NETDATA format. The file itself is sent
| along with its NAMES file entry, and its backup (if
| there is one).
Purpose
This request causes the service machine to send you a copy of the
specified file from its A-disk.
Authorization:
SYSTEM.
Format
┌─── AGET ───────────────────────────────────────────────────────────────┐
│ │
│ AGET fname ftype method │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
fname The filename of the file.
ftype The filetype of the file.
method Either NETDATA or ASIS.
Purpose
This will send you a list of files on the A-disk that match the pattern
you supplied.
Authorization:
SYSTEM.
Format
┌─── ALIST ──────────────────────────────────────────────────────────────┐
│ │
│ ALIST fnpat ftpat method │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
fnpat The filename pattern.
ftpat The filetype pattern.
method Either NETDATA or ASIS.
Purpose
Puts a file on the A-disk regardless of whether it exists already or not.
Authorization:
SYSTEM.
Format
┌─── APLACE ─────────────────────────────────────────────────────────────┐
│ │
│ APLACE fname ftype method [count | 0] │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
fname The filename of the file.
ftype The filetype of the file.
method Either NETDATA or ASIS.
count The number of description records following, defaults to zero.
Comments
The content of the file to be created immediately follows the last
description record and is in the format specified by method.
Examples
For a file with no description records, sent in NETDATA format, the form
of the APLACE request deck is:
:TOOLS APLACE fname ftype NETDATA 0
[file in NETDATA form]
Purpose
Inserts a dated separator line and a file into another file in such a way
that the separator lines in the target file are maintained in date order.
The data is usually (but not necessarily) appended to the end of the
target file.
Authorization:
APPENDER(APPEND, INSERT, INSERT-HEADER, MODIFY, MODIFY-HEADER). In
addition, must own the file or the filetype must be publicly appendable by
use of the ADDER control card. To modify an existing append, must own the
file, be the original appender or be someone on whose behalf the append
was made (using the FOR override). Only the owner of the file may replace
the header or insert an append. Of course, PRIV may do any of the above.
Format
┌─── APPEND ─────────────────────────────────────────────────────────────┐
│ │
│ APPEND fname ftype method [{count |0} [date [option]]] │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
fname The filename of the file.
ftype The filetype of the file.
method Either NETDATA or ASIS.
count The number of description records following. Defaults to zero.
date An 8-14 digit date YYYYMMDD[HH[MM[SS]]], may be omitted or
specified as an asterisk (*) to select the default of now.
option Choose one of:
MODIFY The append with the specified date will be modified.
If the date is zero, the header will be modified.
MODIFY is the default when a date is supplied. It may
also be specified by an asterisk (*).
INSERT An append will be inserted into the file according to
the date. If the date is zero, a header will be
inserted at the top of the file.
Note: Omit the option for a normal append.
Comments
The content of the file to be created immediately follows the last
description record and is in the format specified by method.
Examples
For an append with one description record, sent in NETDATA format, the
form of the APPEND request deck is:
:TOOLS APPEND fname ftype NETDATA 1
description record
[file in NETDATA form]
Comments
This verb is obsolete and is changed to APLACE by TOOLSRUN.
Purpose
Remove some or all of your batched GET requests from the queue.
Authorization:
GETTER(BATCH-CANCEL). You may cancel only those GET requests that came
from your userid and node, including any node that is equated to your
node.
Format
┌─── BATCH CANCEL ───────────────────────────────────────────────────────┐
│ │
│ BATCH CANCEL [fnpat ftpat] │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
fnpat
ftpat A filename and filetype pattern. If one is specified, both must
be specified.
• If fnpat ftpat are omitted, removes all requests from the
batch queue that came from your userid and node, including
any node that is equated to your node.
• If fname ftype are specified without wildcard characters,
removes all requests for that file that came from your
userid and node, including any node that is equated to your
node.
• If fname ftype are specified with wildcard characters,
removes all requests that specified exactly that pattern
that came from your userid and node, including any node that
is equated to your node.
Purpose
• If you are PRIV, returns a list of all the files in the batch queue,
along with the node and userid that submitted the request.
• If you are not PRIV, returns a list of all the files in the batch
queue that were submitted by your userid and node, including any node
that is equated to your node.
Authorization:
GETTER(BATCH-QUERY).
Format
┌─── BATCH QUERY ────────────────────────────────────────────────────────┐
│ │
│ BATCH QUERY │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
None.
Purpose
Causes files matching requests in the batch queue to be sent out.
Authorization:
| GETTER(GET) for BATCH RELEASE fnpat ftpat, otherwise PRIV(BATCH-RELEASE).
Format
┌─── BATCH RELEASE ──────────────────────────────────────────────────────┐
│ │
| │ BATCH RELEASE [fnpat ftpat | method | ALL] │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
| fnpat ftpat A filename and filetype pattern. If this form is permitted
| for this disk, and this user has not already used this form
| recently, either for their own request or someone else's,
| release the request by this user (or if FOR was specified, by
| the FOR user) that exactly matches fnpat ftpat.
method One of:
GET Releases only those requests in the batch queue that
did not come from shadows.
REFRESH Releases only those requests in the batch queue that
did come from shadows.
ALL Releases all requests from the batch queue.
Comments
A BATCH RELEASE issued with the FOR override will release just the
requests made by the user identified by the FOR override.
Comments
This verb is obsolete and is changed to RESPONSE by TOOLSRUN.
Purpose
Removes discarded, backup and hidden files to make more space on a
maintained disk.
Authorization:
REPLACER(CLEAN-SAFE) or PRIV(CLEAN-ALL, CLEAN-ALLSAFE, CLEAN-BACKUP,
CLEAN-BACKUPSAFE, CLEAN-ERASABLE, CLEAN-NAMES).
Format
┌─── CLEAN ──────────────────────────────────────────────────────────────┐
│ │
│ CLEAN type [days | 0] │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
type Choose one of:
SAFE Erase discarded files created prior to a system
IPL.
ERASABLE Erase all discarded files now.
BACKUPSAFE Erase all discarded and backup files created
prior to a system IPL.
BACKUP Erase all discarded and backup files now.
ALLSAFE Erase all discarded, backup and hidden files
created prior to a system IPL.
ALL Erase all discarded, backup and hidden files now.
NAMES Clean the disk NAMES file, resetting file
statistics and removing blank lines and entries
for nonexistent files.
days Preserve a file eligible for erasure for this many days,
defaults to zero.
Purpose
Executes CMS command cmd at the service machine and returns the console
output.
Authorization:
SYSTEM.
Format
┌─── CMS ────────────────────────────────────────────────────────────────┐
│ │
│ CMS cmd │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
cmd Any CMS command, along with its parameters and options.
Comments
Since cmd is any CMS command, it is potentially a dangerous request - use
carefully.
Any subsequent request is lost.
Purpose
To include in a request deck a record that will be ignored by TOOLSRUN.
Authorization:
None required.
Format
┌─── COMMENT ────────────────────────────────────────────────────────────┐
│ │
│ COMMENT text │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
text The text is ignored.
Purpose
Obsolete implementation of VIA.
Authorization:
None required.
Format
┌─── COMMENT VIA ────────────────────────────────────────────────────────┐
│ │
│ COMMENT VIA node userid disk │
│ │
└────────────────────────────────────────────────────────────────────────┘
Comments
TOOLSRUN accepts COMMENT VIA, for compatibility, but no longer generates
it.
Purpose
This causes the selected files to be sent from one service machine to
another, together with their backup files and NAMES file entries.
Authorization:
PRIV(COPY).
Format
┌─── COPY ───────────────────────────────────────────────────────────────┐
│ │
│ COPY fnpat ftpat node userid disk [sincedate] │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
fnpat The filename pattern to copy.
ftpat The filetype pattern to copy.
node The nodeid of the service machine to receive the files.
userid The userid of the service machine to receive the files.
disk The name of the disk to receive the files.
sincedate An 8-14 digit date YYYYMMDD[HH[MM[SS]]]. Restricts file
selection to files changed on or after this date.
Purpose
Places a new file on a maintained disk and creates an entry in the NAMES
file for it. The description data is placed in the NAMES file and should
describe the purpose for the file.
Authorization:
Files already owned require REPLACER(CREATE-OWNED). PACKAGE files not
already owned require PACKAGER(PACKFILE-OWN). Other files not already
owned require OWNER(CREATE). Mode zero files require PRIV.
Format
┌─── CREATE ─────────────────────────────────────────────────────────────┐
│ │
│ CREATE fname ftype method [count | 0] │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
fname The filename of the file to create.
ftype The filetype of the file to create.
method Either NETDATA or ASIS.
count The number of description records following, defaults to zero.
Comments
The content of the file to be created immediately follows the last
description record and is in the format specified by method.
Examples
For a file with two description records, sent in ASIS format, the form of
the CREATE request deck is:
:TOOLS CREATE fname ftype ASIS 2
first description record
second description record
first file record
second file record
...
Purpose
This setup verb establishes the name of the disk that is to receive the
updates and optionally inhibit normal copying of the file to shadows.
Authorization:
PRIV(DISK-NOCOPY) is required for the NOCOPY parameter. Otherwise, no
authorization is required.
Format
┌─── DISK ───────────────────────────────────────────────────────────────┐
│ │
│ DISK disk [COPY | NOCOPY] │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
disk The name of the disk to be selected.
COPY Allow normal propagation to shadows, this is the default.
NOCOPY Inhibit propagation to shadows.
| Comments
| Ignored if preceded by a From or Origin card.
| Restrictions
| If more than one Disk card appears in a request deck, each must specify
| the same disk nickname.
Purpose
This is an alternative form of the DISK setup verb, and specifies the
target disk in the same record as the action verb.
Authorization:
Depends on the verb.
Format
┌─── disk ───────────────────────────────────────────────────────────────┐
│ │
│ :disk verb │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
disk The name of the disk to be selected.
verb The verb whose action is to be applied to the selected disk,
including any keywords, etc.
Comments
If verb can be completely specified in one record, and does not require
descriptive records or data, and if messages are enabled, then verb may be
sent as a message using this form.
Examples
A Get request sent to the IBMVM disk:
IBMVM: GET TOOLS FORUM NETDATA
Purpose
Shut down a maintained disk.
Authorization:
PRIV(DISK-SHUTDOWN, DISK-SHUTPERM).
Format
┌─── DISK SHUTDOWN/SHUTPERM ─────────────────────────────────────────────┐
│ │
│ DISK disk {SHUTDOWN | SHUTPERM} [count | 0] │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
disk The name of the disk to shut down.
SHUTDOWN
SHUTPERM The type of shutdown. If SHUTDOWN is specified, the disk is
shut down until either a DISK START is received, or TOOLSRUN is
restarted. If SHUTPERM is specified, the disk remains shut down
until an explicit DISK START is received.
count The number of description records following, defaults to zero.
The description will be saved and included in the response to
users who submit requests while the disk is shut down.
Purpose
Start a maintained disk.
Authorization:
PRIV(DISK-START).
Format
┌─── DISK START ─────────────────────────────────────────────────────────┐
│ │
│ DISK disk START │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
disk The name of the disk to start.
Purpose
Remove the specified file from the NAMES file and discard it and its
backup (if any).
Authorization:
PACKAGER(PACKFILE-ERASE) for PACKAGE files. OWNER(ERASE) for other files.
In addition, must own the file or be PRIV.
Format
┌─── ERASE ──────────────────────────────────────────────────────────────┐
│ │
│ ERASE fname ftype [count | 0] │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
fname The filename of the file to erase.
ftype The filetype of the file to erase.
count The number of description records following, defaults to zero.
Purpose
This setup verb establishes the user on whose behalf the following
request(s) will be performed.
Authorization:
None required for the FOR override itself. However, must be authorized to
perform the request(s). Certain restrictions also apply, and may vary
from one disk to another; see FOR override in TOOLS Request File
Submission Program Users Guide and Reference and OPTION FORVERBS in
TOOLSRUN Control File Language Reference.
Format
┌─── FOR ────────────────────────────────────────────────────────────────┐
│ │
│ FOR node userid │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
node The nodeid of another user.
userid The userid of another user.
Purpose
This routing setup verb identifies the originator of a request that has
been forwarded due to a Reroute statement in the control file of another
TOOLSRUN machine.
Authorization:
A TOOLSRUN machine identified by COPIER, MASTER, PEER, REROUTER or
SERVANT.
Format
┌─── FROM ───────────────────────────────────────────────────────────────┐
│ │
| │ FROM node userid <date <nick>> │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
node The originator's node.
userid The originator's userid.
| date The date and time when the request was first processed. This is
| optional. If omitted or asterisk (*) the time the request was
| received will be used as the transaction time.
| nick The disk nickname. If specified, it overrides the disk nickname
| on any subsequest Origin or Disk cards. An asterisk (*) may be
| specified if the disk nickname is not to be overridden.
Usage
FROM is inserted automatically by the first rerouting TOOLSRUN Service
Machine to preserve the originator's node and userid and the date and time
of receipt of the original request.
Purpose
This request causes the service machine to send copies of the specified
file(s) to the requestor.
Authorization:
GETTER(GET). Mode zero files and the disk AUDIT file require PRIV.
Format
┌─── GET ────────────────────────────────────────────────────────────────┐
│ │
│ GET fnpat ftpat method [sincedate] │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
fnpat The filename pattern of the file(s) to get.
ftpat The filetype pattern of the file(s) to get.
method One of: NETDATA, ASIS or COPY.
sincedate An 8-14 digit date YYYYMMDD[HH[MM[SS]]]. Restricts file
selection to files changed on or after this date.
Usage
GET COPY is sent to the master disk as a result of a REFRESH sent to the
shadow disk.
Purpose
A request for the help text from the Toolsrun control files. If a prior
DISK statement has selected a a disk, then the help information will be
restricted to that one disk.
Authorization:
None required.
Format
┌─── HELP ───────────────────────────────────────────────────────────────┐
│ │
│ HELP │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
None.
Purpose
Makes a file invisible by replacing the backup with the current file.
REGRESS the file to recover it, but the backup file is not recovered.
Authorization:
REPLACER(HIDE). In addition, must own the file or be PRIV.
Format
┌─── HIDE ───────────────────────────────────────────────────────────────┐
│ │
│ HIDE fname ftype count │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
fname The filename of the file to hide.
ftype The filetype of the file to hide.
count The number of description records following.
Purpose
Cause TOOLSRUN to send notification or copies of changes and new data.
Authorization:
GETTER(INFORM-ALL, INFORM-COP, INFORM-EXC, INFORM-NEW, INFORM-REF,
INFORM-SUB, INFORM-UPD). In addition, informs must be enabled for the
disk, and subscribe must be further enabled for the COPY, REFERENCE,
SUBSCRIBE and UPDATE parameters.
Format
┌─── INFORM ─────────────────────────────────────────────────────────────┐
│ │
│ INFORM fnpat ftpat [infotype] │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
fnpat The filename pattern of the file to inform.
ftpat The filetype pattern of the file to inform.
infotype Choose one of:
ALL Notify you about changes to the selected file(s),
this is the default.
SUBSCRIBE Notify you about changes to the selected file(s)
and send you a copy of the updated file (or append
to the file).
NEW Notify you about the creation of new files
matching the supplied pattern.
COPY Distribute tools requests to you that match the
supplied patterns. Tools requests cannot be
easily processed except by another Toolsrun
service machine.
EXCLUDE Limit INFORM(s) that you previously made. You
will not receive notification or copies of changes
for files matching the supplied pattern.
REFERENCE Send you a copy of appends that reference, in a
REF: line, an append that you made.
UPDATE Send you a copy of the update file (or append to
the file), but do not notify you separately of the
change.
Comments
INFORM REFERENCE is experimental, and subject to change or deletion in the
future.
INFORM UPDATE is experimental, and subject to change or deletion in the
future.
Purpose
Returns fname, ftype, lines, kbytes, last change date and description for
each file. The disk TITLE, if any, appears in the heading.
Authorization:
GETTER(LIST).
Format
┌─── LIST ───────────────────────────────────────────────────────────────┐
│ │
│ LIST fnpat ftpat method [sincedate] │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
fnpat The filename pattern of the files to include in a listing.
ftpat The filetype pattern of the files to include in a listing.
method Either NETDATA or COPY.
sincedate An 8-14 digit date YYYYMMDD[HH[MM[SS]]]. Select only files last
updated on or after this date. If omitted, files will be
selected by name and type patterns only.
Purpose
This locks a file to prevent updates, even by a privileged user. However,
a privileged user may unlock your file and replace it, but it is unlikely
that this would happen by accident.
Authorization:
REPLACER(LOCK). In addition, must own the file or be PRIV.
Format
┌─── LOCK ───────────────────────────────────────────────────────────────┐
│ │
│ LOCK fname ftype │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
fname The filename of the file to lock.
ftype The filetype of the file to lock.
Comments
The file is unlocked when you replace it, or issue an UNLOCK.
LOCK is stable, but no requests for changes will be entertained.
Purpose
The service machine will immediately log itself off.
Authorization:
SYSTEM.
Format
┌─── LOGOFF ─────────────────────────────────────────────────────────────┐
│ │
│ LOGOFF │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
None.
Purpose
Ownership of the file is transferred to another userid and/or node.
Authorization:
REPLACER(NEWOWN). In addition, must own the file or be PRIV.
Format
┌─── NEWOWN ─────────────────────────────────────────────────────────────┐
│ │
│ NEWOWN fname ftype node userid │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
fname The filename of the file whose ownership is to be transferred.
ftype The filetype of the file whose ownership is to be transferred.
node The nodeid of the new owner or an asterisk (*).
userid The userid of the new owner or an asterisk (*).
Comments
Owners use NEWOWN to transfer their file to another so that the new owner
may update it. After you newown your file, you will not own it anymore,
and you will not be able to update it. However, you may newown your file
to a userid and/or nodeid of asterisk. These wildcard characters compare
equal with any userid and/or nodeid of a person who has been authorized
for at least Replacer authority on the disk. This will allow multiple
people to REPLACE the same file without being privileged users.
Purpose
The description records will be sent to one or more users that are
responsible for the disk (if there was a previous Disk record) or the
service machine (if there was no Disk record).
Authorization:
None required.
Format
┌─── NOTIFY ─────────────────────────────────────────────────────────────┐
│ │
│ NOTIFY count │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
count The number of description records following.
Comments
You will not be told who received the notification.
Purpose
This routing setup verb identifies the originator of a request propagated
by another TOOLSRUN machine.
Authorization:
A TOOLSRUN machine identified by COPIER, MASTER, PEER, or SERVANT.
Format
┌─── ORIGIN ─────────────────────────────────────────────────────────────┐
│ │
| │ ORIGIN node userid <date <disk | * <gmtoffset | *>>> │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
| node The originator's node. An asterisk (*) may be used.
| userid The originator's userid. An asterisk (*) may be used.
| date The date and time at which the request was processed at the
| sending machine, in Toolsrun format (YYYYMMDDHHMMSS). This is
| optional. If omitted, or if an asterisk (*) is specified, the
| date and time at which the request was received at this machine
| is used.
| disk The disk nickname for this request. This is optional. If
| omitted, or if an asterisk (*) is specified, the first Disk card
| determines the disk nickname.
| gmtoffset The GMT offset for the sending machine, in minutes (may be
| negative). This is optional, and if specified, indicates that
| the sending machine is using local time instead of GMT, with
| gmtoffset to be added to (or subtracted from) date to adjust it
| to GMT. If omitted, or if an asterisk (*) is specified, date is
| GMT and no adjustment is necessary.
Usage
An ORIGIN is automatically added to propagated requests by a master, to
preserve the originator's node and userid, and the date and time at which
the request was processed.
| Restrictions
| Origin must precede the first Disk card.
Purpose
Makes you the owner of a filename which may not be created by anybody
else, except privileged users (and even then you are notified). It is
also used to establish the ownership of files that exist on a disk prior
to being placed under TOOLSRUN's control.
Authorization:
PACKAGER(PACKFILE-OWN) for PACKAGE files. OWNER(OWN) for other files.
Format
┌─── OWN ────────────────────────────────────────────────────────────────┐
│ │
│ OWN fname ftype count │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
fname The filename of the file to own.
ftype The filetype of the file to own.
count The number of description records following, must be at least
one.
Purpose
Writes an existing file on a maintained disk, whether or not it already
exists, and updates the description and owner fields in the NAMES file.
Authorization:
PRIV(PLACE).
Format
┌─── PLACE ──────────────────────────────────────────────────────────────┐
│ │
│ PLACE fname ftype method [count | 0] │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
fname The filename of the file to place.
ftype The filetype of the file to place.
method Either NETDATA or ASIS.
count The number of description records following, defaults to zero.
Comments
The content of the file to be placed immediately follows the last
description record and is in the format specified by method. If the file
was locked by the requestor, PLACE unlocks it.
Examples
For a file with no description records, sent in NETDATA format, the form
of the PLACE request deck is:
:TOOLS PLACE fname ftype NETDATA 0
[file in NETDATA form]
Purpose
This setup verb forces propagation of the entire request file, unless a
request fails; in that case, none of the request file is propagated. It
may appear anywhere in the request file.
Authorization:
None required.
Format
┌─── PROPAGATE ──────────────────────────────────────────────────────────┐
│ │
│ PROPAGATE │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
None.
Comments
Requests that follow the PROPAGATE verb will result in responses being
sent to the originator from every service machine that processes it.
| Defaults
| Only single or multiple requests that write to the disk are automatically
| propagated. Requests that do not write to the disk, or multiple requests
| that include requests that do not write to the disk, are not propagated.
Purpose
Use PRUNE to remove old data from an appendable file and optionally send
it to you.
Authorization:
REPLACER(PRUNE). In addition, must own the file or be PRIV.
Format
┌─── PRUNE ──────────────────────────────────────────────────────────────┐
│ │
│ PRUNE fname ftype sincedate [ {count | 0} [disposition]] │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
fname The filename of the appendable file to prune.
ftype The filetype of the appendable file to prune.
sincedate An 8-14 digit date YYYYMMDD[HH[MM[SS]]]. Records in the
appendable file with a date earlier than the date specified will
be removed.
count The number of description records following, defaults to zero.
disposition Choose one of:
DISCARD The removed data will be discarded.
RETURN The removed data will be sent to the requestor, this
is the default.
Purpose
This request, which may only be used by Toolsrun service machines,
replaces the NAMES file entry, the file content and the backup file
content (if any) on the maintained disk.
Authorization:
A TOOLSRUN machine identified by COPIER, MASTER or PEER.
Format
┌─── PUT ────────────────────────────────────────────────────────────────┐
│ │
│ PUT fname ftype [backupflag] │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
fname The filename of the file.
ftype The filetype of the file.
backupflag 0 or 1, 0 is the default. 1 indicates that the request deck
also includes the file's backup.
Usage
When GET, with the COPY method, is requested, the returned request deck is
a PUT.
Comments
The content of the file to be replaced immediately follows the PUT verb
record; there are no description records. If the backup file is also to
be replaced, its content is next, followed by the NAMES file entry
content. If the backup file is not to be replaced, the content of the
NAMES file entry is next after the content of the file to be replaced.
All content (file, backup and NAMES file entry) is always in NETDATA form.
Examples
For a file with no backup, the form of the PUT request deck is:
:TOOLS PUT fname ftype 0
file in NETDATA form
<NAMES file entry line in NETDATA form>
For a file and backup, the form of the PUT request deck is:
:TOOLS PUT fname ftype 1
<file in NETDATA form>
<backup in NETDATA form>
<NAMES file entry line in NETDATA form>
Purpose
Respond with information about the currently selected disk including disk
address, space, help text, number of shadows and usage data.
Authorization:
GETTER(QUERY-DISK).
Format
┌─── QUERY DISK ─────────────────────────────────────────────────────────┐
│ │
│ QUERY DISK │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
None.
Purpose
Respond with information about the file, including owner, description,
size of file, file date, change date, existence of a backup file and what
package(s) include this file.
Authorization:
GETTER(QUERY-FILE).
Format
┌─── QUERY FILE ─────────────────────────────────────────────────────────┐
│ │
│ QUERY FILE fname ftype │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
fname The filename of the file to query.
ftype The filetype of the file to query.
Purpose
• If fname ftype are omitted, responds with a list of all fileids and
patterns for which you are receiving change notifications.
• If fname ftype are specified without wildcard characters, responds
with a list of the people who will be notified when the specified file
is changed.
• If fname ftype are specified with wildcard characters, responds with a
list of the people who have an inform with exactly that pattern.
Authorization:
GETTER(QUERY-INFORM).
Format
┌─── QUERY INFORM ───────────────────────────────────────────────────────┐
│ │
│ QUERY INFORM [fname ftype] │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
fname The filename of the file to query.
ftype The filetype of the file to query.
Purpose
Responds with CPU information, GMT offset, CP and CMS level, storage data,
A-disk space and number of failed and deferred requests.
Authorization:
SYSTEM.
Format
┌─── QUERY SYSTEM ───────────────────────────────────────────────────────┐
│ │
│ QUERY SYSTEM │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
None.
Purpose
Responds with usage statistics for each disk under control of the service
machine.
Authorization:
SYSTEM.
Format
┌─── QUERY USAGE ────────────────────────────────────────────────────────┐
│ │
│ QUERY USAGE │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
None.
Purpose
Responds with the version and level of the TOOLSRUN software, the number
of disks under control and the name of the system contact.
Authorization:
None required.
Format
┌─── QUERY ──────────────────────────────────────────────────────────────┐
│ │
│ QUERY VERSION │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
None.
Purpose
Submitted by a shadow owner to cause one or more files to be refreshed
from the master copy of the disk.
Authorization:
PRIV(REFRESH).
Format
┌─── REFRESH ────────────────────────────────────────────────────────────┐
│ │
│ REFRESH fnpat ftpat [sincedate] │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
fnpat The filename pattern of the file to refresh.
ftpat The filetype pattern of the file to refresh.
sincedate An 8-14 digit date YYYYMMDD[HH[MM[SS]]]. Restricts file
selection to files changed on or after this date.
Usage
A REFRESH causes a GET COPY to be sent to the disk master or source. Each
file matching the pattern is returned as a PUT, with file contents, NAMES
file entry and backup file contents (if any).
Purpose
Used by a person who has obtained copies of a file but not from the
service machine, allowing the usage data to be correct.
Authorization:
GETTER(REGISTER).
Format
┌─── REGISTER ───────────────────────────────────────────────────────────┐
│ │
│ REGISTER pkgname [count | 1] │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
pkgname The filename of the package file to register.
count The number of copies being registered, defaults to one.
Purpose
Undo a REPLACE or HIDE request by renaming the current backup copy to the
name of the active file. The previous backup file is not recovered.
Authorization:
REPLACER(REGRESS). In addition, must own the file or be PRIV.
Format
┌─── REGRESS ────────────────────────────────────────────────────────────┐
│ │
│ REGRESS fname ftype count │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
fname The filename of the file to regress.
ftype The filetype of the file to regress.
count The number of description records following, must be at least
one.
Purpose
Renew subscriptions to a Toolsrun controlled disk for the maximum allowed
by the Toolsrun administrator. The Toolsrun machine will respond with a
message indicating either successful renewal or the type of error
encountered.
Authorization:
GETTER(RENEW).
Format
┌─── RENEW ──────────────────────────────────────────────────────────────┐
│ │
│ RENEW │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
None.
Purpose
Replaces an existing file on a maintained disk and updates its entry in
the NAMES file. The description data is placed in the HISTORY file and
should describe the reason for the update.
Authorization:
REPLACER(REPLACE). In addition, must own the file or be PRIV.
Format
┌─── REPLACE ────────────────────────────────────────────────────────────┐
│ │
│ REPLACE fname ftype method [count | 0] │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
fname The filename of the file to replace.
ftype The filetype of the file to replace.
method Either NETDATA or ASIS.
count The number of description records following, defaults to zero.
Comments
The content of the file to be replaced immediately follows the last
description record and is in the format specified by method. If the file
was locked by the requestor, REPLACE unlocks it.
Examples
For a file with one description record, sent in NETDATA format, the form
of the REPLACE request deck is:
:TOOLS REPLACE fname ftype NETDATA 1
description record
[file in NETDATA form]
Purpose
This setup verb establishes the manner in which the service machine will
respond to the requesting user.
Authorization:
None required.
Format
┌─── RESPONSE ───────────────────────────────────────────────────────────┐
│ │
│ RESPONSE [class [method [format [failed]]]] │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
class The class which response files should be sent, asterisk (*)
selects the disk default (normally B).
method One of:
NONE Suppress the response.
FAIL Suppress the response unless the request failed.
MSG Send the responses as an immediate message.
MAIL Send the response as a note.
BOTH Both MSG and MAIL.
EITHER Send an immediate message if you are logged on to the
same node as the service machine, else send mail.
An asterisk (*) selects the disk default (normally EITHER).
format Choose one of:
NEW Send files in NETDATA format.
OLD Send files in RMSG format.
An asterisk (*) selects the disk default (normally NEW).
failed Choose one of:
RETURN Return failed requests back to you.
DISCARD The service machine will purge your request if it
fails. You get told what was wrong in any case.
An asterisk (*) selects the disk default (normally RETURN).
Purpose
This will update the file ownership and subscription information to
reflect your new userid. This request is also useful when another user is
assuming your responsibility for a disk. You can transfer the ownership
of all your files with one command.
Authorization:
GETTER(SET-ADDRESS).
Format
┌─── SET ADDRESS ────────────────────────────────────────────────────────┐
│ │
│ SET ADDRESS node userid │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
node Your new nodeid.
userid Your new userid.
Purpose
This replaces the description information in the NAMES file.
Authorization:
REPLACER(SET-DESCRIPTION). In addition, must own the file or be PRIV.
Format
┌─── SET DESCRIPTION ────────────────────────────────────────────────────┐
│ │
│ SET DESCRIPTION fname ftype count │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
fname The filename of the file to receive a new description.
ftype The filetype of the file to receive a new description.
count The number of description records following which replace the
file description information in the NAMES file. Must be at
least one.
Purpose
Rename a file and update the NAMES file.
Authorization:
OWNER(SET-FILE). In addition, must own the file or be PRIV.
Format
┌─── SET FILE ───────────────────────────────────────────────────────────┐
│ │
│ SET FILE fname ftype newfname newftype │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
fname The filename of the file to be renamed.
ftype The filetype of the file to be renamed.
newfname The new filename of the file.
newftype The new filetype of the file.
Comments
Informs and subscriptions are not updated.
Purpose
Renames a file to change the filemode digit.
Authorization:
OWNER(SET-MODE). In addition, must own the file or be PRIV. Only PRIV
may set the mode to zero.
Format
┌─── SET MODE ───────────────────────────────────────────────────────────┐
│ │
│ SET MODE fname ftype newfmode │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
fname The filename of the file to be renamed.
ftype The filetype of the file to be renamed.
newfmode The new filemode digit for the file, may be 0-6. Filemode
digits 0 and 6 have special uses.
Purpose
Shut down the service machine.
Authorization:
SYSTEM.
Format
┌─── SHUTDOWN ───────────────────────────────────────────────────────────┐
│ │
│ SHUTDOWN [* | FORCED | IMMEDIATE] │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
* Shutdown the service machine with a zero return code when
there are no more files to process. This is the default.
FORCED Shutdown the service machine immediately with a non-zero
return code.
IMMEDIATE Shutdown the service machine immediately with a zero return
code.
Purpose
Returns the file owner, fname, ftype and description for each file. The
disk TITLE, if any, appears in the heading.
Authorization:
GETTER(SUMMARY).
Format
┌─── SUMMARY ────────────────────────────────────────────────────────────┐
│ │
│ SUMMARY fnpat ftpat method [sincedate] │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
fnpat The filename pattern of the files to include in a summary
report.
ftpat The filetype pattern of the files to include in a summary
report.
method Either NETDATA or COPY.
sincedate An 8-14 digit date YYYYMMDD[HH[MM[SS]]]. Restricts file
selection to files changed on or after this date.
Purpose
This setup verb enables tracing of the remainder of the request file.
Authorization:
GETTER(TRACE).
Format
┌─── TRACE ──────────────────────────────────────────────────────────────┐
│ │
│ TRACE [what] │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
what If a value is supplied for what, then limit tracing to that
subroutine.
Comments
Inhibits copying of the request to subsequent nodes, as if NOCOPY were
specified.
Purpose
Remove an inform or subscription.
Authorization:
GETTER(UNINFORM). In addition, informs must be enabled for the disk.
Format
┌─── UNINFORM ───────────────────────────────────────────────────────────┐
│ │
│ UNINFORM fnpat ftpat [scope [type]] │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
fnpat The filename pattern to remove from automatic notification.
ftpat The filetype pattern to remove from automatic notification.
scope Choose one of:
* Remove the inform or subscription which exactly
matches the data provided in fnpat and ftpat. This is
the default when scope is omitted.
EVERY Remove all the informs and subscriptions which match
the pattern provided in fnpat and ftpat. You may use
* * EVERY to delete all your informs and
subscriptions.
type You may specify NEW, ALL, SUBSCRIBE, EXCLUDE, REFERENCE, UPDATE
or COPY to restrict this request to that one type of inform.
The default is an asterisk (*) meaning not restricted by type.
Purpose
Allow the file to be changed by any authorized user. The file is also
unlocked by the REPLACE and PLACE requests.
Authorization:
REPLACER(UNLOCK). In addition, must own the file and have locked it, or
must be PRIV.
Format
┌─── UNLOCK ─────────────────────────────────────────────────────────────┐
│ │
│ UNLOCK fname ftype │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
fname The filename of the file to unlock.
ftype The filetype of the file to unlock.
Comments
The UNLOCK request is stable, but no requests for changes will be
entertained.
Purpose
This request applies updates to the specified file, making it unnecessary
to resend large files which have not been extensively modified.
Authorization:
REPLACER(UPDATE). In addition, must own the file or be PRIV.
Format
┌─── UPDATE ─────────────────────────────────────────────────────────────┐
│ │
│ UPDATE fname ftype crc1 crc2 date flag method count │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
fname The filename of the file to update.
ftype The filetype of the file to update.
crc1 The CRC of the file before the update is applied or an asterisk
(*) to bypass the check. The standard CRC-16 polynomial is
used.
crc2 The CRC of the file after the update is applied or an asterisk
(*) to bypass the check.
date The 14-digit filedate for the file after the change.
flag Update strategy indicator
N No update is required. This may be used to verify the file
and/or update date and time information.
A Update contains only appends.
U File may be updated in place, since there are no deletions
or insertions (except insertions at the end of the file),
and all replacement lines are the same length as in the
original (variable length files only).
D Update meets all of the conditions for "U" except that it
contains one or more deletions.
C File must be copied to be updated.
method Either NETDATA or ASIS.
count The number of description records following, must be at least
one.
Update File Format
The update information immediately follows the description records and
consists of a file in method format, each record having a command
character followed by one space and text. The update commands are:
U fname ftype crc1 crc2 datetime flag
This statement must be first in the update information and contains
data redundant with the UPDATE request statement for safety.
fname The filename of the file to update.
ftype The filetype of the file to update.
crc1 The CRC of the file before the update is applied.
crc2 the CRC of the file after the update is applied.
datetime The file date and time to be applied to the updated file in
the form YYYYMMDDHHMMSS.
flag Same as in the UPDATE request statement.
C n
This instructs the update program to copy or skip the next "n" lines in
the original file.
D n
This instructs the update program to delete the next "n" lines in the
original file.
R text
This instructs the update program to replace the next line in the
original file with the text supplied.
I text
This instructs the update program to insert a line into the file which
contains the text supplied.
V text
This instructs the update program to compare the next line in the
original file with the text supplied. This is used by the update
program in addition to, or in conjunction with, CRC information to
insure that the update is made correctly. If the verification is not
successful, the update is aborted at this point. This does not move
the pointer in the original file, so that the verified line in this
file may be copied, deleted, or replaced if the verify is successful.
Examples
For a file that:
• has a current CRC of 10062
• has a CRC of 39259 after being updated
• has a date-time of November 17th, 1992, 14:43:29
• may be updated in place
• will be sent in NETDATA format
• has one description record
the form of the UPDATE request deck is:
:TOOLS UPDATE fname ftype 10062 39259 19921117144329 U NETDATA 1
description record
[update file in NETDATA form]
Purpose
Record rerouting TOOLSRUN Service Machines so that looping of rerouted
requests may be detected.
Authorization:
None required.
Format
┌─── VIA ────────────────────────────────────────────────────────────────┐
│ │
│ VIA node userid disk │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
node The node of a rerouting TOOLSRUN Service Machine.
userid The userid of a rerouting TOOLSRUN Service Machine
disk The disk to which the request was directed at the rerouting
TOOLSRUN Service Machine.
Usage
In the usual case, one TOOLSRUN Service Machine will reroute a request,
inserting a FROM card to preserve the originator. The next TOOLSRUN
Service Machine will then process the request.
However, it may happen that the next TOOLSRUN Service Machine will also
reroute the request. In this case, the identity of the sending machine
will be preserved by the receiving machine with a VIA card in the request
deck. This process will continue until:
• The request is processed at some final TOOLSRUN Service Machine or
• Some TOOLSRUN Service Machine finds itself among the VIA machines
(i.e. the request would endlessly circulate among TOOLSRUN Service
Machines if allowed to continue). The request is failed.
Purpose
Register a vote in a file called fname VOTE.
Authorization:
APPENDER(VOTE). In addition, must own the file or the filetype must be
publicly appendable by use of the ADDER control card. Or, of course, must
be PRIV.
Format
┌─── VOTE ───────────────────────────────────────────────────────────────┐
│ │
│ VOTE type fname token │
│ │
└────────────────────────────────────────────────────────────────────────┘
Parameters
type The keyword TOKEN.
fname The filename of the vote file.
token The item being voted for.
Comments
Double voting is detected and prevented.
VOTE is stable, but no requests for changes will be entertained.
TOOLS EXEC is an aid (2) that accepts user input, does a certain amount of
validity checking and filling in of defaults, formats and sends requests
to a TOOLSRUN service machine. Mostly, what TOOLS sends is very similar
to what the user types in. The chief differences are:
• A :TOOLS DISK diskname record precedes the user's request record.
There are some exceptions:
- System commands
- Certain DISK commands
- Overrides either precede the DISK record, or appear as options on
the DISK record.
• :TOOLS is added to the front of the user's request. Certain DISK
commands have :TOOLS DISK added to the front:
- SHUTDOWN
- START
• Any abbreviations are expanded.
• Date and time (if present) are in TOOLSRUN Standard Form
(yyyymmddhhmmss) and padded on the right with zeroes (if incomplete).
• Certain keyword parameters may be converted or disappear. (e.g.
HEADER becomes a date/time of zero; SINCE disappears.)
• The method (if any is required) defaults to NETDATA.
• The number of descriptive text records (if any) appears on the request
record itself. The descriptive text records themselves follow the
request record.
• If there is an input file, TOOLS EXEC adds it to the request deck, in
NETDATA form, and following the descriptive text records.
For example, if the user types in:
TOOLS SENDTO ANODE ANID FROG GET TADPOLE FORUM SINCE 91/03/15
TOOLS SENDTO ANODE ANID FROG APPEND TADPOLE FORUM (A test
then TOOLS EXEC will send the following request decks to ANID at ANODE:
:TOOLS DISK FROG
:TOOLS GET TADPOLE FORUM NETDATA 19910315000000
:TOOLS DISK FROG
:TOOLS APPEND TADPOLE FORUM NETDATA 1
A test
<contents of TADPOLE APPEND in NETDATA form>
There are a few other differences in specific requests.
This section provides correlation between TOOLS EXEC input and output. In
general, only the commands are shown, unless there is a significant
difference in parameters. This cross reference is intended as a guide to
help relate a topic in the TOOLS Request File Submission Program Users
Guide and Reference to the corresponding topic in this document.
User Input TOOLS Output
Commands
AGEt AGET (3)
ALIst ALIST (3)
APPend APPEND
AREplace AREPLACE (3) (4)
BATch CANCEL BATCH CANCEL
BATch QUERY BATCH QUERY
BATch RELEASE BATCH RELEASE
CLEan CLEAN
CMS CMS (3)
COPy COPY
CREate CREATE
DISK No output (5)
ERAse ERASE
GET GET
HELp HELP
HELp ALL HELP (3)
HIDe HIDE
INForm INFORM
LISt LIST
LITeral cmd cmd
LOCk LOCK
LOGoff LOGOFF (3)
NEWown NEWOWN
NOTify NOTIFY
NOTify ALL NOTIFY (3)
OWN OWN
PLAce PLACE
PRUne PRUNE
PUNchtag No output (5)
QUEry DISK QUERY DISK
QUEry FILE QUERY FILE
QUEry INFORM QUERY INFORM
QUEry SYSTEM QUERY SYSTEM (3)
QUEry USAGE QUERY USAGE (3)
QUEry VERSION QUERY VERSION (3)
REFresh REFRESH
REGIster REGISTER
REGRess REGRESS
RENew RENEW
REPlace REPLACE
| RESponse No output (5) (7)
SET SET
SHUtdown DISK disk SHUTDOWN
SHUtdown ALL SHUTDOWN (3)
SHUtdown FORCEd SHUTDOWN FORCED (3)
SHUtdown IMMediate SHUTDOWN IMMEDIATE (3)
SHUtdown PERManent DISK disk SHUTDOWN PERMANENT
STArt DISK disk START
SUBscribe INFORM fnpat ftpat SUBSCRIBE
UNInform UNINFORM
UNLock UNLOCK
UNSubscribe UNINFORM
UPDate UPDATE
VOTe VOTE
Overrides
ANSwer RESPONSE (6)
FOR FOR (6)
NOCLOSE No output (7)
NOCOPY DISK disk NOCOPY
NOPROMPT No output (7)
NOSCREEN No output (7)
PROPagate PROPAGATE
QUIET No output (7)
SENDTO No output (7)
TO No output (7)
TRACE TRACE (8)
(2) The only other one in common use is NEWTOOLS EXEC, by Walt
Daniels. OMNIDISK and other front-ends invoke TOOLS EXEC to
produce and send requests.
(3) System command - no preceding DISK record.
(4) TOOLSRUN converts AREPLACE to APLACE.
(5) Affects only the user's LASTING GLOBALV.
(6) Precedes the DISK record and/or request record.
(7) Affects only the current operation of TOOLS EXEC.
(8) Follows the DISK record (if any) and precedes the request
record.
All of these documents (except those being developed) are available on
VMTOOLS, managed by VMTOOLS at RALVM17, in the TOOLSDOC package. You can
order the package by entering this:
TOOLS SENDTO RALVM17 VMTOOLS VMTOOLS GET TOOLSDOC PACKAGE
Here's what you can get:
┌───────────┬──────────┬─────────────────────────────────────────────────┐
| │ Number │ Filename │ Title │
├───────────┼──────────┼─────────────────────────────────────────────────┤
| │ TOOLS-001 │ TOOLS │ TOOLS Request File Submission Program Users │
| │ │ │ Guide and Reference │
├───────────┼──────────┼─────────────────────────────────────────────────┤
| │ TOOLS-002 │ TOOLSCTL │ TOOLSRUN Control File Language Reference │
├───────────┼──────────┼─────────────────────────────────────────────────┤
| │ TOOLS-003 │ TOOLSREQ │ TOOLSRUN Request File Language Reference │
├───────────┼──────────┼─────────────────────────────────────────────────┤
| │ TOOLS-005 │ TOOLSRUN │ TOOLSRUN Administrators Guide │
├───────────┴──────────┴─────────────────────────────────────────────────┤
| │ Note: The following are under development: │
├───────────┬──────────┬─────────────────────────────────────────────────┤
| │ TOOLS-004 │ │ Zen and the Art of Shadow Maintenance │
├───────────┼──────────┼─────────────────────────────────────────────────┤
| │ TOOLS-006 │ │ TOOLS Conferencing Guide │
└───────────┴──────────┴─────────────────────────────────────────────────┘
| Figure 8. TOOLS and TOOLSRUN Publications. Numbered documents are
| available as BookMaster source, files already formatted for
| various printers, and BookManager online books.
| When you order the TOOLSDOC PACKAGE, you will receive TOOLSDOC PACKLIB and
| a separate BOOK file for each document. The BOOK files are suitable for
| immediate use via BookManager READ. The TOOLSDOC PACKLIB is an FCOPY
| packlib: It contains copies of the BookMaster source and preformatted
| printable files for each document. To view the list of files contained in
| the packlib, enter:
| FCOPY TOOLSDOC PACKLIB fmode (LIST
| where fmode is the filemode of the disk containing the packlib.
| To unpack one of the files and place it on a disk, display the list of
| files and type the following on the same line as the file to be unpacked:
| SELECT /N /T fmode
| where fmode is the filemode of the disk to receive the unpacked file. (If
| you just type SELECT it will unpack onto your A-disk.)
Toolsrun is a volunteer effort - but there are a lot of volunteers. The
most efficient way to get help is to post your question or problem where a
lot of people will see it. This gives you the maximum chance that someone
who knows the answer will see it, others will benefit from the answer and
you have not interrupted someone who cannot really afford interruptions
today. The place to do that is a FORUM. Here is a list of some of the
more popular ones:
TOOLS FORUM For reporting problems and asking general TOOLS and TOOLSRUN
related questions.
TOOLWISH FORUM For making suggestions and asking for enhancements.
TOOLSADM FORUM For asking fellow Toolsrun administrators for advice.
TOOLSIC FORUM For administrators of IBM Confidential disks.
TOOLSRUN LESSONS Q&A on how Toolsrun works.
TOOLS TIPS Answers to the most frequently asked questions.
TOOLTOOL FORUM Discussions about tools (EXECs and such) to help with TOOLS
and TOOLSRUN.
In addition, there are a couple of other files worth browsing, although
you cannot ask questions there:
TOOLS ANSWERS More answers to frequently asked questions.
TOOLTOOL INDEX An index of tools (EXECs and such) to help with TOOLS and
TOOLSRUN.
All of these files are found on the IBMVM conference disk, and many are
also found on IBMPC, IBMMVS and other popular conference disks.
To ask a question:
1. See if it has been asked already. (9)
2. Make sure you will see the answer before you ask the question. (10)
Otherwise, you may miss it.
You will start getting copies of appends about all sorts of things.
Among them should be the answer to your question.
3. Append your question to the forum. (11) Make it brief - if more
information is needed, someone will ask for it.
4. Wait for an answer. Sometimes it will take a day or more, so be
patient.
5. Once you have your answer, cancel your subscription (12) (if you don't
want to continue following the forum). However, wait a little while
before doing this. Sometimes you will get more than one answer, and
the first one might not be the best one, and may even be incorrect.
(9) We know you may not have the time to read all of the
suggested files. TOOLS TIPS and TOOLS ANSWERS are short
enough to be worthwhile, though. If you don't know how to
link and access a local shadow, here's how to request a copy
of a file: TOOLS SENDTO KGNVMC IBMVM IBMVM GET filename
filetype, where "filename filetype" name the file you want.
For example, TOOLS TIPS.
Note: This is a very busy master disk, and GET requests add
to its burden. You should really make an effort to find the
nearest shadow - perhaps as your next question. You may
notice that you get a response from somewhere other than
IBMVM at KGNVMC. If this happens, a shadow was selected for
you automatically. Use it in the future.
(10) If you don't know how to view local shadows or use the
various types of Inform, do this: TOOLS SENDTO KGNVMC IBMVM
IBMVM SUBSCRIBE filename filetype, where "filename filetype"
name the forum you are about to append to. For example,
TOOLS FORUM.
(11) If you don't know how to append to a forum, do the
following: Create and edit a file called "filename APPEND",
where "filename" is the same as the filename of the forum to
which you will append your question. When you are ready to
send it: TOOLS SENDTO KGNVMC IBMVM IBMVM APPEND filename
filetype, where "filename filetype" name the forum where you
want your question posted. For example, TOOLWISH APPEND is
the file containing your question, and TOOLWISH FORUM is
where it will go.
(12) Remember the "filename filetype" that you used to subscribe
in the first place? Just do this: TOOLS SENDTO KGNVMC IBMVM
IBMVM UNSUBSCRIBE filename filetype.