| Extended cursor handling | |
|---|---|
| Key | Action |
| Alt + Up arrow | Moves cursor up one row. |
| Alt + Down arrow | Moves cursor down one row. |
| Alt + Right arrow | Moves cursor right one column. |
| Alt + Left arrow | Moves cursor left one column. |
| Tab | If cursor is outside the command input area, moves cursor to the start of the input in the command input area. Otherwise behaves as described in previous table. |
| Home | If cursor is outside the command input area, moves cursor to the start of the input in the command input area. Otherwise behaves as described in previous table. |
| End | If cursor is outside the command input area, moves cursor to the end of the input in the command input area. Otherwise behaves as described in previous table. |
The following is what is displayed on the Hercules harware console (HMC)
in response to the '?' command being entered. Please note that it may not
be completely accurate or up-to-date. Enter the '?' command for
yourself for a more complete, accurate and up-to-date list of supported
panel commands:
The ipl command may also be used to perform a load from cdrom or
server. For example if a standard SuSE S/390 Linux distribution CD is loaded
and mounted on /cdrom for example, this cdrom may then be ipl-ed by:
ipl /cdrom/suse.ins
The attach and detach commands are used to dynamically
add or remove devices from the configuration,
and the define command can be used to alter the device number
of an existing device.
The devinit command can be used to reopen an existing device.
The args (if specified) override the arguments
specified in the configuration file for this device.
The device type cannot be changed and must not be specified.
This command can be used to rewind a tape, to mount a new tape or
disk image file on an existing device, to load a new card deck
into a reader, or to close and reopen a printer or punch device.
In single-step mode, pressing the enter key will advance to the
next instruction.
There is also an alternate semi-graphical control panel. Press Esc to
switch between the command line format and the semi-graphical format.
Press ? to obtain help in either control panel.
When a command is prefixed with '-', the the command will not be redisplayed at
the console. This can be used in scripts and is also used internally when commands
are to be invoked without being redisplayed at the panel.
Panel commands
Command Description
---------------- -----------------------------------------------
!message *SCP priority message
# Silent comment
$locate Display sysblk, regs or hostinfo
$runtest *Start the test if test mode is active
$test *Your custom command (*DANGEROUS!*)
$zapcmd *Enable/disable command (*CAREFUL!*)
* Loud comment
.reply *SCP command
? alias for help
abs *Display or alter absolute storage
aea Display AEA tables
aia Display AIA fields
alrf Command deprecated. Use facility command instead
ar Display access registers
archlvl *Set or Query current Architecture Mode
archmode Deprecated. Use the archlvl command instead
asn_and_lx_reuse Command deprecated. Use facility command instead
attach *Configure device
auto_scsi_mount *Command deprecated - Use "SCSIMOUNT"
autoinit *Display/Set auto-create-empty-tape-file option
automount *Display/Update allowable tape automount directories
b *Set breakpoint
b+ (Synonym for 'b')
b- Delete breakpoint
b? Query breakpoint
cachestats Cache stats command
cckd *Compressed CKD command
cctape *Display a printer's current cctape
cf *Configure current CPU online or offline
cfall Configure all CPU's online or offline
clocks Display tod clkc and cpu timer
cmdlvl *Display/Set current command group
cmdsep *Display/Set command line separator
cmpscpad *Set/display the CMPSC zero padding value.
cnslport Set console port
codepage *Set/display code page conversion table
conkpalv *Display/alter console TCP keepalive settings
cp_updt *Create/Modify user character conversion table
cpu *Define target cpu for panel display and commands
cpuidfmt Set format BASIC/0/1 STIDP generation
cpumodel Set CPU model number
cpuprio *(deprecated)
cpuserial Set CPU serial number
cpuverid *Set CPU verion number
cr *Display or alter control registers
cscript *Cancels a running script thread
ctc *Enable/Disable CTC debugging
define *Rename device
defsym *Define symbol
delsym *Delete a symbol
detach *Remove device
devinit *Reinitialize device
devlist *List device, device class, or all devices
devprio *(deprecated)
devtmax *Display or set max device threads
diag8cmd *Set DIAG 8 instruction options
ds Display subchannel
dumpdev *Specify bootstrap loader DUMP parameters
ecps:vm *Command deprecated - Use "ECPSVM"
ecpsvm *ECPS:VM Commands
engines Set engines parameter
evm *Command deprecated - Use "ECPSVM"
exec *Execute a Rexx script
exit (Synonym for 'quit')
ext Generate external interrupt
f? Query unusable page frame range(s)
facility *Enable/Disable/Query z/Arch STFLE Facility bits
fcb *Display a printer's current FCB
fpc *Display or alter floating point control register
fpr *Display or alter floating point registers
f{+/-}adr *Mark page frame(s) as +usable/-unusable
g Turn off instruction stepping and start all CPUs
gpr *Display or alter general purpose registers
hao *Hercules Automatic Operator
help *list all commands / command specific help
herclogo *Read a new hercules logo file
hercnice *(deprecated)
hercprio *(deprecated)
hst *History of commands
http *Start/Stop/Modify/Display HTTP Server
hwldr *Specify boot loader filename
i Generate I/O attention interrupt for device
iodelay *Display or set I/O delay value
ipending Display pending interrupts
ipl *IPL from device or file
iplc *Command deprecated - use IPL with clear option
k Display cckd internal trace
ldmod *Load a module
legacysenseid Set legacysenseid setting
loadcore *Load a core image file
loaddev *Specify bootstrap loader IPL parameters
loadparm *Set the default IPL 'LOADPARM' parameter
loadtext *Load a text deck file
locks *Display internal locks list
log *Direct logger output
logopt *Set/Display logging options
lparname *Set LPAR name
lparnum *Set LPAR identification number
lsdep List module dependencies
lsequ List device equates
lsmod *List dynamic modules
mainsize *Define/Display mainsize parameter
manufacturer Set STSI manufacturer code
maxcpu Set maxcpu parameter
maxrates *Display highest MIPS/SIOS rate or set interval
message *Display message on console a la VM
model *Set/Query STSI model code
modpath *Set module load path
mounted_tape_reinit *Control tape initialization
msg Alias for message
msglevel *Display/Set current Message Display output
msglvl Alias for msglevel
msgnoh Similar to "message" but no header
mt *Control magnetic tape operation
netdev *Set default host networking device
numcpu Set numcpu parameter
osa *(Synonym for 'qeth')
ostailor *Tailor trace information for specific OS
o{+/-}dev Turn ORB tracing on/off
panopt *Set or display panel options
panrate (deprecated; use PANOPT RATE=nnn instead)
pantitle (deprecated; use PANOPT TITLE=xxx instead)
pgmprdos *Set LPP license setting
pgmtrace *Trace program interrupts
plant Set STSI plant code
pr *Display or alter prefix register
psw *Display or alter program status word
ptp *Enable/Disable PTP debugging
ptt *Activate or display internal trace table
qcpuid *Display cpuid(s)
qd *Query device information
qeth *Enable/Disable QETH debugging
qpfkeys Display the current PF Key settings
qpid Display Process ID of Hercules
qports Display TCP/IP ports in use
qproc Display processors type and utilization
qstor Display main and expanded storage values
quiet *Toggle automatic refresh of panel display data
quit *Terminate the emulator
r *Display or alter real storage
restart Generate restart interrupt
resume Resume hercules
rexx *Modify/Display Hercules's Rexx settings
rmmod Delete a module
s *Instruction stepping
s+ *Activate instruction stepping
s- Turn off instruction stepping
s? *Query instruction stepping
savecore *Save a core image to file
sclproot *Set SCLP base directory
scpecho *Set/Display option to echo to console and history of scp replys
scpimply *Set/Display option to pass non-hercules commands to the scp
script *Run a sequence of panel commands contained in a file
scsimount *Automatic SCSI tape mounts
sf+dev *Add shadow file
sf-dev *Delete shadow file
sfc *Compress shadow files
sfd *Display shadow file stats
sfk *Check shadow files
sh *Shell command
shcmdopt *Set shell command options
shrd *shrd command
shrdport *Set shrdport value
sizeof Display size of structures
srvprio *(deprecated)
ssd *Signal shutdown
start *Start CPU (or printer/punch device if argument given)
startall Start all CPU's
stop *Stop CPU (or printer/punch device if argument given)
stopall Stop all CPU's
store Store CPU status at absolute zero
suspend Suspend hercules
symptom Alias for traceopt
sysclear *System Clear Reset manual operation
sysepoch Set sysepoch parameter
sysreset *System Reset manual operation
s{+/-}dev Turn CCW stepping on/off
t *Set tracing range or Query tracing
t+ *Turn on instruction tracing
t+- *Automatic instruction tracing
t- Turn off instruction tracing
t? *Query instruction tracing values
threads *Display internal threads list
timerint *Display or set timers update interval
tlb Display TLB tables
toddrag Display or set TOD clock drag factor
todprio *(deprecated)
traceopt *Instruction and/or CCW trace display option
tt32 *Control/query CTCI-WIN functionality
txf *Transactional-Execution Facility tracing
tzoffset Set tzoffset parameter
t{+/-}CKD Turn CKD_KEY tracing on/off
t{+/-}dev Turn CCW tracing on/off
u *Disassemble storage
uptime Display how long Hercules has been running
v *Display or alter virtual storage
version Display version information
xpndsize *Define/Display xpndsize parameter
yroffset Set yroffset parameter
(*) Enter "help
Additional Command Help
Some commands also offer additional help information regarding their syntax,
etc. Enter "help <command name>" to display
this additional help information. (Note: not every command supports additional help)
The hercules.rc (run-commands) file
Hercules also supports the ability to automatically execute panel commands upon startup via the 'run-commands' file. If the run-commands file is found to exist when Hercules starts, each line contained within it is read and interpreted as a panel command exactly as if the command were entered from the HMC system console.
The default filename for the run-commands file is "hercules.rc", but may be overridden by setting the "HERCULES_RC" environment variable to the desired filename.
Except for the 'pause' command (see paragraph further below), each command read from the run-commands file is logged to the console preceded by a '> ' (greater-than sign) character so you can easily distinguish between panel commands entered from the keyboard from those entered via the .rc file.
Lines starting with '#' are treated as "silent comments" and are thus not logged to the console. Line starting with '*' however are treated as "loud comments" and will be logged.
In addition to being able to execute any valid panel command (including the
'sh' shell command) via the run-commands file, an additional
'pause nnn' command is supported in order to introduce
a brief delay before reading and processing the next line in the file. The
value nnn can be any number from 0.001 to 999.0 and specifies
the number of seconds to delay before reading the next line. Creative use of
the run-commands file can completely automate Hercules startup.
The "Hercules Automatic Operator" (HAO) Facility
The Hercules Automatic Operator (HAO) feature is a facility which can automatically issue panel commands in response to specific messages appearing on the Hercules console.
To use the Hercules Automatic Operator facility, you first define a "rule" consisting of a "target" and an associated "command". The "target" is a regular expression pattern used to match against the text of the various messages that Hercules issues as it runs. Whenever a match is found, the rule "fires" and its associated command is automatically issued.
The Hercules Automatic Operator facility only operates on messages issued to the Hercules console. These messages may originate from Hercules itself, or from the guest operating system via the SCP SYSCONS interface or via the integrated console printer-keyboard (3215-C or 1052-C). HAO cannot intercept messages issued by the guest operating system to its own terminals.
Defining a Rule
To define a HAO rule, enter the command:
hao tgt target
to define the rule's "target" match pattern followed by the command:
hao cmd command
to define the rule's associated panel-command.
The target is a regular expression as defined by your host platform. When running on Linux, Hercules uses POSIX Extended Regular Expression syntax. On a Windows platform, regular expression support is provided by Perl Compatible Regular Expression (PCRE). The HAO facility can only be used if regular expression support was included in Hercules at build time.
The associated command is whatever valid Hercules panel command you wish to issue in response to a message being issued that matches the given target pattern.
Substituting substrings in the command
The command may contain special variables $1, $2, etc, which will be replaced by the values of "capturing groups" in the match pattern. A capturing group is a part of the regular expression enclosed in parentheses which is matched with text in the target message. In this way, commands may be constructed which contain substrings extracted from the message which triggered the command.
The following special variables are recognized:
$1to$9- the text which matched the 1st to 9th capturing group in the target regular expression$`- the text preceding the regular expression match$'- the text following the regular expression match$$- replaced by a single dollar sign
Note that substitution of a $n variable does not occur if there are fewer than n capturing groups in the regular expression.
As an example, the rule below issues the command "i 001F" in response to
the Hercules message "HHC01090I 0:001F COMM: client 127.0.0.1 devtype 3270:
connection reset":
hao tgt HHC01090I .:([0-9A-F]{4}) COMM: .* connection reset
hao cmd i $1
Another example, shown below, illustrates how the dot matrix display of a
3590(?) tape unit might be used to implement an automatic tape library in
response to the Hercules message "HHC00224I 0:0581 Tape file *, type
HET: display "K2DSBK2 " / "M2DSBK3S" (alternating)":
hao tgt HHC00224I .:([0-9A-F]{4}) Tape file .*: display (?:".{8}" \/ )?"M([A-Z0-9]{1,6})\s*S"
hao cmd devinit $1 /u/tapes/$2.aws
Which would result in the Hercules command "devinit 0581 /u/tapes/2DSBK3.aws"
being automatically issued.
More information about Perl Compatible Regular Expression (PCRE) syntax (as well as a nice online web page that allows you to test your expressions) can be found here:
Other commands and limitations
To delete a fully or partially defined HAO rule, first use the "hao list"
command to list all of the defined (or partially defined) rules, and then use
the "hao del nnn" command to delete the specific rule identified by
nnn (all rules are assigned numbers as they are defined and are thus
identified by their numeric value). Optionally, you can delete all defined or
partially defined rules by issuing the command "hao clear".
The current implementation limits the total number of defined rules to 64.
This limit may be raised by increasing the value of the HAO_MAXRULE
constant in source file hao.c and then rebuilding Hercules.
All defined rules are checked for a match each time Hercules issues a message.
There is no way to specify "stop processing subsequent rules". If a message is
issued that matches two or more rules, each associated command is then issued
in sequence.
Technical Support
For technical support, please see our Technical Support web page.
