git clone https://github.com/SDL-Hercules-390/hyperion.git <directory-name>
Note: By downloading the .zip file (or cloning the repostiory) you agree to the terms
of the Q Public Licence.
brew install gnu-sed
git clone https://github.com/SDL-Hercules-390/hyperion.git <directory-name>
Note: By downloading the .zip file (or cloning the repostiory) you agree to the terms
of the Q Public Licence.
./util/bldlvlck
Please note that SDL Hyperion comes pre-delivered with an already pre-generated
./configure
script, so doing a ./autogen.sh
is
not necessary and is in fact now strongly discouraged.
An autogen would only be necessary if you were to manually make some changes
to the Hercules default Makefile.am
and/or configure.ac
files (which under normal circumstances you should never need to do).
./configure
By default, the configure script will attempt to guess appropriate
compiler optimization flags for your system. If its guesses
turn out to be wrong, you can disable all optimization by
passing the
option to
configure, or specify your own optimization flags with
. For additional configuration
options, run: ./configure
.
make
sudo make install
This is an optional step because once Hercules is built, you should be able to run Hercules directly from the Hercules build directory itself without needing to install anything beforehand. But if you want to officially install it somewhere, then by all means do so.
It should be mentioned however, that if you do decide to run directly out of the build directory, you should first set the 'cap_sys_nice' capabilities on the Hercules executables and start Hercules as root. This will allow Hercules to properly set the priorities of its internal threads:
sudo setcap 'cap_sys_nice=eip' ./hercules sudo setcap 'cap_sys_nice=eip' ./herclin sudo setcap 'cap_net_admin+ep' ./hercifcYou don't need to do this if you do
sudo make install
however
since the makefile does this for you. You only need to do this when you decide
to not install the results of the build and run directly out of the build
directory instead.
You will need to amend the configuration file hercules.cnf to reflect your device layout and intended mode of operation (S/370, ESA/390, or z/Architecture). See the Hercules Configuration File page for a complete description.
The Creating Hercules DASD page describes various methods of creating and loading virtual DASD volumes. The compressed CKD DASD support is described in this page.
Note! If you intend to run any licensed software on your PC using Hercules, it is your responsibility to ensure that you do not violate the software vendor's licensing terms! |
Note: Hercules requires privileged access to your host's networking devices in order for Hercules networking to work properly. If your configuration contains any networking devices, then Hercules must be started with Administrative (root) privileges. If Hercules is not started with Administrative (root) privileges then initialization of your networking devices will fail and your guest's networking will not work properly. If your guest does not need access to your host's network Hercules should be run as a normal unprivileged user (the default). |
To start Hercules enter this command at the host's command prompt:
hercules [ -f filename ] | [ --config=filename ]
[ -o logfile] | [ --output=logfile ]
[ -r rcfile ] | [ --rcfile=rcfile ]
[ -b logofile ] | [ --herclogo=logofile ]
[ -d ] | [ --daemon ]
[ -e ] | [ --externalgui ]
[ -p modpath ] | [ --modpath=modpath ]
[ -l modname ] ... | [ --ldmod=modname ] ...
[ -s symbol=value ] ... | [ --defsym=symbol=value ] ...
[ -v ] | [ --verbose ]
[ -h ] | [ --help[=type] ]
[ -t[factor]] | [ --test[=factor]]
[ > logfile ]
where:
filename
- is the name of the configuration file. The default, if none is specified, is hercules.cnf. The default may be overridden via the
HERCULES_CNF
environment variable.
logfile
- is the name of the optional (but highly recommended!) log file. The log file receives a copy of all messages displayed on the control panel and is extremely important to have for problem analysis and bug reporting. This option can also be specified using "--logfile=".
rcfile
- is the name of the Hercules .RC run commands file. The run commands file automatically executes panel commands upon startup.
logofile
- is the name of the Hercules logo file. The logo file is the initial welcome screen presented when a TN 3270 terminal connects to a hercules 3270 device.
--daemon
- specifies that Hercules is to be run in 'daemon' mode, wherein it runs invisibly with no attached console.
--externalgui
- indicates Hercules is to be controlled by an External GUI.
modpath
- is the directory from which dynamic modules are to be loaded. This option overrides both the
MODPATH
configuration file statement and system defaults. The system default varies depending on the host platform where Hercules is being run.
modname
- is the name of an additional dynamic module to be loaded at startup. More than one additional module may be specified, although each must be preceded with the
-l
option specifier.
symbol=value
- the name of a symbol and its associated value to be used in configuration file processing or panel commands. See the command 'defsym' for more information on using symbols. The '-s' option may be repeated. Note: 'value' may be quoted to contain imbedded blanks.
--verbose
- sets the message-level to verbose. This is the same as entering the command
msglvl +verbose
.
--help[=type]
- displays help regarding the syntax of command-line arguments and, optionally, other information as well if the optional help
type
is also specified.The optional
type
value identifies what type of help you want to display. Valid values are:short
,long
,version
orbuild
. Additionally,all
andfull
are also accepted as aliases forlong
.The
short
help option displays just the syntax of the the command line arguments. Theversion
help option displays version information. Thebuild
option displays some of the more important optional features that Hercules was either built with or without. Thelong
,all
andfull
options displays all three types. The default isshort
(i.e. only the command-line syntax is shown).
--test[=factor]
- starts Hercules in test mode, activating special .rc file script commands used only by QA test scripts. Normal Hercules use should never specify this switch.
factor
is an optional test timeout factor within the range 1.0 to 14.3. The test timeout factor is used to adjust each test script's specified timeout value to compensate for the speed of the system on which they are running.Use a factor greater than 1.0 on slower systems to slightly increase timeout values giving each test more time to complete.
Please note that due to manner in which command line arguments are parsed this option must be specified as one argument. Thus "-t2.0" is correct whereas "-t 2.0" is not. Oftentimes it is easier to use the long
--test=factor
syntax instead.Test timeout values (specified as optional arguments on the special runtest script command) are a safety feature designed to prevent runaway tests from never ending. Normally tests end automatically the very moment they are done.
logfile
- is the name of the optional (but highly recommended!) log file. The log file receives a copy of all messages displayed on the control panel and is extremely important to have for problem analysis and bug reporting.
Next connect a tn3270 client to the console port (normally port 3270). The client will be connected to the first 3270 device address specified in the configuration file (this should be the master console address). If your master console is a 1052 or 3215, connect a telnet client instead of a tn3270 client.
Now you can enter an ipl command from the control panel.
The main Hercules screen contains a scrollable list of messages with a command input area and system status line at the bottom of the screen.
To scroll through the messages, use either the Page Up or Page Down keys, the Ctrl + Up Arrow or Ctrl + Down Arrow keys, or the Home or End and/or the Ctrl + Home or Ctrl + End keys.
Use the Insert key to switch between insert and overlay mode when typing in the command input area. Use the Home and End keys to move to the first or last character of the command you are typing, or the use the left/right arrow keys to move to a specific character. Use the Escape key to erase the input area.
Pressing Escape when the command input area is already empty causes the screen to switch to the semi-graphical "New Panel" display mode, which shows the overall status of the system and devices.
When in the semi-graphical "New Panel" display mode there is no command input
area. Instead, single character "hot keys" are used to issue some of the more
common functions such as starting or stopping the CPU. The hot-keys are those
which are highlighted. Pressing the '?' key displays brief help information
on how to use the semi-graphical panel.
Normal cursor handling | |
---|---|
Key | Action |
Esc | Erases the contents of the command input area. If the command input area is already empty, switches to semi-graphical New Panel. |
Del | Deletes the character at the cursor position. |
Backspace | Erases the previous character. |
Insert | Toggles between insert mode and overlay mode. |
Tab | Attempts to complete the partial file name at the cursor position in the command input area. If more than one possible file exists, a list of matching file names is displayed. |
Home | Moves the cursor to the start of the input in the command input area. If the command input area is empty, scrolls the message area to the top. |
End | Moves the cursor to the end of the input in the command input area. If the command input area is empty, scrolls the message area to the bottom. |
Page Up | Scrolls the message area up one screen. |
Page Down | Scrolls the message area down one screen. |
Up arrow | Recalls previous command into the input area. |
Down arrow | Recalls next command into the input area. |
Right arrow | Moves cursor to next character of input area. |
Left arrow | Moves cursor to previous character of input area. |
Ctrl + Up arrow | Scrolls the message area up one line. |
Ctrl + Down arrow | Scrolls the message area down one line. |
Ctrl + Home | Scrolls the message area to the top. |
Ctrl + End | Scrolls the message area to the bottom. |