| 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. |
Panel commands
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. Please enter the '?' command for yourself for a more complete, accurate and up-to-date list of supported panel commands.
Command Description
------- -----------------------------------------------
!message SCP priority messsage
# Silent comment
* Loud comment
.reply SCP command
? alias for help
aea Display AEA tables
aia Display AIA fields
alrf Command deprecated: Use "archlvl enable|disable|query asn_lx_reuse" instead
ar Display access registers
archlvl Set Architecture Level
archmode Alias for archlvl
asn_and_l Command deprecated: Use "archlvl enable|disable|query asn_lx_reuse" instead
attach Configure device
auto_scsi Command deprecated - Use "SCSIMOUNT"
autoinit Display/Set automatic create empty tape file switch
automount Display/Update allowable tape automount directories
b Set breakpoint
b+ Set breakpoint
b- Delete breakpoint
cache Execute cache related commands
cachestat Cache stats command
capping Set/display capping value
cckd cckd command
cd Change directory
cf Configure current CPU online or offline
cfall Configure all CPU's online or offline
clocks Display tod clkc and cpu timer
cmdlevel Display/Set current command group
cmdlvl (alias for cmdlevel)
cmdsep Display/Set command line separator
cmdtgt Specify the command target
cnslport Set console port
codepage Set/display code page conversion table
conkpalv Display/alter console TCP keep-alive settings
cp_updt Create/Modify user character conversion table
cpu Define target cpu for panel display and commands
cpuidfmt Set format 0/1 STIDP generation
cpumodel Set CPU model number
cpuprio Set/Display cpuprio parameter
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
defstore Define/Display main and expanded storage values
defsym Define symbol
delsym Delete a symbol
detach Remove device
devinit Reinitialize device
devlist List device, device class, or all devices
devprio Set/Display devprio parameter
devtmax Display or set max device threads
diag8cmd Set diag8 command option
dir Displays a list of files and subdirs in a directory
ds Display subchannel
ecps:vm Command deprecated - Use "ECPSVM"
ecpsvm ECPS:VM Commands
engines Set engines parameter
evm Command deprecated - Use "ECPSVM"
exit (Synonym for 'quit')
ext Generate external interrupt
fcb Display the current FCB (if only the printer is given)
fpc Display floating point control register
fpr Display floating point registers
f{+/-}adr Mark frames unusable/usable
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
herc Hercules command
herclogo Read a new hercules logo file
hercprio Set/Display hercprio parameter
hst History of commands
http Start/Stop/Modify/Display HTTP Server
httpport Command deprecated - Use "HTTP PORT ..."
httproot Command deprecated - Use "HTTP ROOT fn"
i Generate I/O attention interrupt for device
iodelay Display or set I/O delay value
ipending Display pending interrupts
ipl IPL Normal from device xxxx
iplc IPL Clear from device xxxx
k Display cckd internal trace
kd Short form of 'msghld clear'
ldmod Load a module
legacysen Set legacysenseid setting
loadcore Load a core image file
loadparm Set IPL parameter
loadtext Load a text deck file
log Direct logger output
logopt Set/Display logging options
lparname Set LPAR name
lparnum Set LPAR identification number
lsdep List module dependencies
lsmod List dynamic modules
mainsize Define/Display mainsize parameter
manufactu 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_t Control tape initialization
msg Alias for message
msghld Display or set the timeout of held messages
msglevel Display/Set current Message Display output
msglvl Alias for msglevel
msgnoh Similar to "message" but no header
mt Control magnetic tape operation
numcpu Set numcpu parameter
numvec Set numvec parameter
ostailor Tailor trace information for specific OS
panrate Display or set rate at which console refreshes
pantitle Display or set console title
pgmprdos Set LPP license setting
pgmtrace Trace program interrupts
plant Set STSI plant code
pr Display prefix register
pscp Send prio message scp command
psw Display or alter program status word
ptt Set or display internal trace
pwd Print working directory
qcpuid Display cpuid
qd Query dasd
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
rmmod Delete a module
s Instruction stepping
s+ Instruction stepping on
s- Turn off instruction stepping
s? Instruction stepping query
savecore Save a core image to file
sclproot Set SCLP base directory
scp Send scp command
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 diag8 sh option
showdvol1 Enable showing of dasd volsers in device list
shrd shrd command
shrdport Set shrdport value
sizeof Display size of structures
srvprio Set/Display srvprio parameter
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
syncio Display syncio devices statistics
sysclear System Clear Reset manual operation
sysepoch Set sysepoch parameter
sysreset System Reset manual operation
s{+/-}dev Turn CCW stepping on/off
t Instruction trace
t+ Instruction trace on
t- Turn off instruction tracing
t? Instruction trace query
timerint Display or set timers update interval
tlb Display TLB tables
toddrag Display or set TOD clock drag factor
todprio Set/Display todprio parameter
traceopt Instruction trace display options
tt32 Control/query CTCI-W32 functionality
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
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.
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 help)
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.
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 1 to 999 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 that allows one to automatically issue panel commands in response to certain messages being issued.
To use the Hercules Automatic Operator facility, one first defines a "rule" consisting of a "target" and an associated "command". The "target" is just 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 is only for those messages issued by Hercules to its HMC (hardware console). It cannot be used for whatever messages the guest operating system may issue to any of its terminals. It is only a Hercules automatic operator and not a "VSE", "MVS", "VM", etc, automatic operator.
Defining a Rule
To define a HAO rule, enter the command:
hao target
to define the rule's "target" match pattern (a simple regular expression), followed by the command:
hao command
to define the rule's associated panel-command.
The target pattern is a simple regular expression value as defined by whatever regular expression facility your host build platform happens to support. For Windows it must be a Perl Compatible Regular Expression (PCRE). For other supported build platforms it might be some other supported regular expression syntax. Check your host platform's programming documentation for further details.
The associated command is whatever valid Hercules panel command you wish to issue in response to a message being issued that matches the given pattern target.
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, one may 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. If you need to define more than 64 rules you will either have to build Hercules for yourself (increasing the value of the HAO_MAXRULE constant in hao.c) or else beg one of the Hercules developers to please do it for you.
Note that there is currently no way to define a command whose arguments vary based on actual message text. That is to say, there is currently no way to say
"Reply with the command 'devinit cuu filename' in response to message text 'HHCXXnnnI Device cuu intervention required.' where cuu is whatever cuu was identified in the message."
The HAO is not that sophisticated (yet). Only simple plain-text commands may be defined and issued. No automatic substitution is done based on message text (although normal 'DEFSYM' symbol substitution is supported however, as that is a normal panel-command feature supported separately from the HAO). This may possibly change in the future however, depending on user need/demand.
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. Thus the advice to choose your rules' target patterns carefully very much applies here.
Technical Support
For technical support, please see our Technical Support web page.
Last updated $Date: 2011-05-29 07:05:53 +0000 (Sun, 29 May 2011) $ $Revision: 7473 $