msgmx
Display or change MSGMX settings.
You can execute any of the MSGMX commands at any time; even if not connected to any servers.
Synopsis
msgmx history flush | export [<Filename>]
msgmx set <set option>
msgmx show <show option>
msgmx save | load [<Filename>]
msgmx source <Filename>
msgmx log file <Filename> [ on | off | show [ contents ] ]
Options
Assign values to MSGMX setting parameters.
- history
- Clear or export the command history.
- log
-
Activate/deactivate logging and/or change the log file destination (see options below).
- set
- Set specified operational parameters (see options below).
- show
- Display the value of the specified setting (see options below).
- save
- Save the current configurations to either the current configuration file or a specified file.
- load
- Load the last-saved configuration settings from either the current configuration file or a specified file.
- source
- Executes the scripts in the specified file sequentially and then return to the prompt.
log Options
Assign values to MSGMX log-setting parameters with the msgmx log command.
- <on | off>
- Start or stop sending information to the log file.
- file <filename | path/filename>
-
Change the file that collects logging information. Changing the log file name closes the previous file and opens a new file. If the file does not exist, MSGMX creates one and opens it. If the new file cannot be created or opened, command execution is inhibited.
- show
- Display the log file path.
- show contents
- Display the log file contents.
set Options
Assign values to MSGMX setting parameters with the msgmx set command.
- cache-update-time <Int>
-
MSGMX caches system status and command history for the status bar and for predictive autocompletion at the command line. MSGMX updates the cache at this configurable interval in seconds (default 3).
- color < LightMode | DarkMode | LightMonochromeMode | DarkMonochromeMode >
-
Set MSGMX to use dark text on a light-colored background or vice-versa. You can also choose between monochrome and color palettes. For LightMode and DarkMode, MSGMX uses color to differentiate commands, operands, and options.
- echo-command <on | off>
- Display the command to be executed with a preceding "+" prior to execution.
- history-depth <Int>
- Set the number of commands saved as history.
- max-threads <Int>
- MSGMX can execute different commands in different threads when called in a script. This parameter sets the maximum number of threads used.
- prediction <on | off>
- Show command, option, and flag drop-down prediction menu based on characters already entered as you type.
- source-error <abort | warn | ignore>
- If an error is encountered while running an msgmx source command, or when or using the -f / --file option while starting up MSGMX, the type of response is determined by this setting. abort (default) displays the line causing the error and exits the command. warn displays the line causing the error and continues to execute commands. ignore silently continues to execute commands.
- status <on | off>
- Toggle display of the status bar.
- status-refresh <Int>
- This setting is deprecated. It will be removed in a future release. Status bar refresh rate.
- summary <on | off>
- Show brief help text for each drop-down prediction menu item. Turning the summary off does not affect the display of the drop-down prediction menu selections.
- timeout <Int>
- Set command timeout in seconds. This is the time for which MSGMX waits for a response after executing a command against the connected target.