github.com/simh.simh
1
0
Fork 0
mirror of https://github.com/simh/simh.git synced 2026-02-27 09:09:46 +00:00
Code Releases Activity

SCP: Document all simulator defined environment variables in help and sim_doc

Browse Source
This commit is contained in:
Mark Pizzolato
2022-12-22 09:49:10 -10:00
parent c127dc99c2
commit 4975fbe59c
3 changed files with 39 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -81,6 +81,7 @@ All Simulator updates on Open SIMH will be present in this repository, and any c
- Building with the simh makefile can optionally compile each source file separately and store the compiled result. This approach lends itself to quicker building for folks who are developing new simulators or new simulator modules. This was requested and discussed in #697. Invoking make with BUILD_SEPARATE=1 on the make command line or as an exported environment variable will achieve separate compiles. Invoking make with QUIET=1 on the make command line or as an exported environment variable will summary output of activities being performed instead of full compiler commands.
- TAPE and SCSI libraries have been extended to fully support partial record reads of fixed sized records which may contain multiple records in recorded data. Images of this type are common for QIC tape archives generally available on bitsavers and elsewhere. Attach time checking on simulated QIC tape devices reports possible problems that may occur.
- Github CI Actions builds of all simulators for Linux, macOS and Windows platforms.
- All the available simulator defined environment variables are documented in the help and sim_doc document file.
#### Changes to the PDP-11 and VAX simulators also not in the Open SIMH repo
@@ -531,6 +532,23 @@ Built In variables %DATE%, %TIME%, %DATETIME%, %LDATE%, %LTIME%, %CTIME%, %DATE_
%SIM_VERBOSE% The Verify/Verbose mode of the current Do command file
%SIM_QUIET% The Quiet mode of the current Do command file
%SIM_MESSAGE% The message display status of the current Do command file
%SIM_NAME% The name of the current simulator
%SIM_BIN_NAME% The program name of the current simulator
%SIM_BIN_PATH% The program path that invoked the current simulator
%SIM_OSTYPE% The Operating System running the current simulator
%SIM_RUNTIME% The Number of simulated instructions or cycles performed
%SIM_RUNTIME_UNITS% The units of the SIM_RUNTIME value
%SIM_REGEX_TYPE% The regular expression type available
%SIM_MAJOR% The major portion of the simh version
%SIM_MINOR% The minor portion of the simh version
%SIM_PATCH% The patch portion of the simh version
%SIM_DELTA% The delta portion of the simh version
%SIM_VM_RELEASE% An optional VM specific release version
%SIM_VERSION_MODE% The release mode (Current, Alpha, Beta)
%SIM_GIT_COMMIT_ID% The git commit id of the current build
%SIM_GIT_COMMIT_TIME% The git commit time of the current build
%SIM_RUNLIMIT% The current execution limit defined
%SIM_RUNLIMIT_UNITS% The units of the SIM_RUNLIMIT value (instructions, cycles or time)
Environment variable lookups are done first with the precise name between
the % characters and if that fails, then the name between the % characters

BIN
doc/simh_doc.doc
View File

Binary file not shown.

25
scp.c
View File

@@ -1757,7 +1757,12 @@ static const char simh_help2[] =
" %%DATE_MONTH%%, %%DATE_DD%%, %%DATE_D%%, %%DATE_WYYYY%%, %%DATE_WW%%,\n"
" %%TIME_HH%%, %%TIME_MM%%, %%TIME_SS%%, %%TIME_MSEC%%, %%STATUS%%, %%TSTATUS%%,\n"
" %%SIM_VERIFY%%, %%SIM_QUIET%%, %%SIM_MESSAGE%%, %%SIM_NAME%%, %%SIM_BIN_NAME%%,\n"
" %%SIM_BIN_PATH%%, %%SIM_OSTYPE%%, %%SIM_RUNTIME%%, %%SIM_RUNTIME_UNITS%%\n\n"
" %%SIM_BIN_PATH%%, %%SIM_OSTYPE%%, %%SIM_RUNTIME%%, %%SIM_RUNTIME_UNITS%%,\n"
" %%SIM_RUNLIMIT%%, %%SIM_RUNLIMIT_UNITS%%, %%SIM_REGEX_TYPE%%,\n"
" %%SIM_MAJOR%%, %%SIM_MINOR%%, %%SIM_PATCH%%, %%SIM_DELTA%%,\n"
" %%SIM_VM_RELEASE%%, %%SIM_VERSION_MODE%%, %%SIM_GIT_COMMIT_ID%%,\n"
" %%SIM_GIT_COMMIT_TIME%%, %%SIM_ARCHIVE_GIT_COMMIT_ID%%,\n"
" %%SIM_ARCHIVE_GIT_COMMIT_TIME%%, %%SIM_RUNLIMIT%%, %%SIM_RUNLIMIT_UNITS%%\n\n"
"+Token %%0 expands to the command file name.\n"
"+Token %%n (n being a single digit) expands to the n'th argument\n"
"+Token %%* expands to the whole set of arguments (%%1 ... %%9)\n\n"
@@ -1815,9 +1820,21 @@ static const char simh_help2[] =
"++++++++ simulator\n"
"++%%SIM_OSTYPE%% The Operating System running the current\n"
"++++++++ simulator\n"
"++%%SIM_RUNTIME%% The Number simulated instructions or cycles\n"
"++++++++ performed\n"
"++%%SIM_RUNTIME_UNITS%% The units of the SIM_RUNTIME value\n\n"
"++%%SIM_RUNTIME%% The Number of simulated instructions or\n"
"++++++++ cycles performed\n"
"++%%SIM_RUNTIME_UNITS%% The units of the SIM_RUNTIME value\n"
"++%%SIM_REGEX_TYPE%% The regular expression type available\n"
"++%%SIM_MAJOR%% The major portion of the simh version\n"
"++%%SIM_MINOR%% The minor portion of the simh version\n"
"++%%SIM_PATCH%% The patch portion of the simh version\n"
"++%%SIM_DELTA%% The delta portion of the simh version\n"
"++%%SIM_VM_RELEASE%% An optional VM specific release version\n"
"++%%SIM_VERSION_MODE%% The release mode (Current, Alpha, Beta)\n"
"++%%SIM_GIT_COMMIT_ID%% The git commit id of the current build\n"
"++%%SIM_GIT_COMMIT_TIME%% The git commit time of the current build\n"
"++%%SIM_RUNLIMIT%% The current execution limit defined\n"
"++%%SIM_RUNLIMIT_UNITS%% The units of the SIM_RUNLIMIT value\n"
"++++++++ (instructions, cycles or time)\n\n"
"+Environment variable lookups are done first with the precise name\n"
"+between the %% characters and if that fails, then the name between\n"
"+the %% characters is upcased and a lookup of that valus is attempted.\n\n"