/* HelpText.js */
TerminalHelpText =
"Type 'help name' to learn more about the command 'name'
" +
'alias [-g] [name="value"] Create or display Terminal aliases
' +
"analyze Get information about the current machine
" +
"cat [message] Display a .msg file
" +
"check [script] [args...] Print a script's logs to Terminal
" +
"clear Clear all text on the terminal
" +
"cls See 'clear' command
" +
"connect [ip/hostname] Connects to a remote server
" +
"free Check the machine's memory (RAM) usage
" +
"hack Hack the current machine
" +
"help [command] Display this help text, or the help text for a command
" +
"home Connect to home computer
" +
"hostname Displays the hostname of the machine
" +
"ifconfig Displays the IP address of the machine
" +
"kill [script] [args...] Stops the specified script on the current server
" +
"killall Stops all running scripts on the current machine
" +
"ls Displays all programs and scripts on the machine
" +
"mem [script] [-t] [n] Displays the amount of RAM required to run the script
" +
"nano [script] Script editor - Open up and edit a script
" +
"ps Display all scripts that are currently running
" +
"rm [file] Delete a file from the server
" +
"run [name] [-t] [n] [args...] Execute a program or script
" +
"scan Prints all immediately-available network connections
" +
"scan-analyze [d] Prints info for all servers up to d nodes away
" +
"scp [script] [server] Copies a script to a destination server
" +
"sudov Shows whether you have root access on this computer
" +
"tail [script] [args...] Displays dynamic logs for the specified script
" +
"theme [preset] | bg txt hlgt Change the color scheme of the UI
" +
"top Displays all running scripts and their RAM usage
" +
'unalias "[alias name]" Deletes the specified alias
';
HelpTexts = {
alias: 'alias [-g] [name="value"]
' +
"Create or display aliases. An alias enables a replacement of a word with another string. " +
"It can be used to abbreviate a commonly used command, or commonly used parts of a command. The NAME " +
"of an alias defines the word that will be replaced, while the VALUE defines what it will be replaced by. For example, " +
"you could create the alias 'nuke' for the Terminal command 'run NUKE.exe' using the following:
" +
'alias nuke="run NUKE.exe"
' +
"Then, to run the NUKE.exe program you would just have to enter 'nuke' in Terminal rather than the full command. " +
"It is important to note that 'default' aliases will only be substituted for the first word of a Terminal command. For " +
"example, if the following alias was set:
" +
'alias worm="HTTPWorm.exe"
' +
"and then you tried to run the following terminal command:
" +
"run worm
" +
"This would fail because the worm alias is not the first word of a Terminal command. To allow an alias to be substituted " +
"anywhere in a Terminal command, rather than just the first word, you must set it to be a global alias using the -g flag:
" +
'alias -g worm="HTTPWorm.exe"
' +
"Now, the 'worm' alias will be substituted anytime it shows up as an individual word in a Terminal command.
" +
"Entering just the command 'alias' without any arguments prints the list of all defined aliases in the reusable form " +
"'alias NAME=VALUE' on the Terminal.
" +
"The 'unalias' command can be used to remove aliases.
",
analyze: "analze
" +
"Prints details and statistics about the current server. The information that is printed includes basic " +
"server details such as the hostname, whether the player has root access, what ports are opened/closed, and also " +
"hacking-related information such as an estimated chance to successfully hack, an estimate of how much money is " +
"available on the server, etc.",
cat: "cat [message]
" +
"Display message files, which are files ending with the '.msg' extension. Example:
" +
"cat j1.msg",
check: "check [script name] [args...]
" +
"Print the logs of the script specified by the script name and arguments to the Terminal. Each argument must be separated by " +
"a space. Remember that a running script is uniquely " +
"identified both by its name and the arguments that are used to start it. So, if a script was ran with the following arguments:
" +
"run foo.script 1 2 foodnstuff
" +
"Then to run the 'check' command on this script you would have to pass the same arguments in:
" +
"check foo.script 1 2 foodnstuff",
clear: "clear
" +
"Clear the Terminal screen, deleting all of the text. Note that this does not delete the user's command history, so using the up " +
"and down arrow keys is still valid. Also note that this is permanent and there is no way to undo this. Synonymous with 'cls' command",
cls: "cls
" +
"Clear the Terminal screen, deleting all of the text. Note that this does not delete the user's command history, so using the up " +
"and down arrow keys is still valid. Also note that this is permanent and there is no way to undo this. Synonymous with 'clear' command",
connect: "connect [hostname/ip]
" +
"Connect to a remote server. The hostname or IP address of the remote server must be given as the argument " +
"to this command. Note that only servers that are immediately adjacent to the current server in the network can be connected to. To " +
"see which servers can be connected to, use the 'scan' command.",
free: "free
" +
"Display's the memory usage on the current machine. Print the amount of RAM that is available on the current server as well as " +
"how much of it is being used.",
hack: "hack
" +
"Attempt to hack the current server. Requires root access in order to be run. See the wiki page for hacking mechanics
",
help: "help [command]
" +
"Display Terminal help information. Without arguments, 'help' prints a list of all valid Terminal commands and a brief " +
"description of their functionality. You can also pass the name of a Terminal command as an argument to 'help' to print " +
"more detailed information about the Terminal command. Examples:
" +
"help alias
" +
"help scan-analyze",
home: "home
" +
"Connect to your home computer. This will work no matter what server you are currently connected to.",
hostname: "hostname
" +
"Prints the hostname of the current server",
ifconfig: "ipconfig
" +
"Prints the IP address of the current server",
kill: "kill [script name] [args...]
" +
"Kill the script specified by the script name and arguments. Each argument must be separated by " +
"a space. Remember that a running script is uniquely identified by " +
"both its name and the arguments that are used to start it. So, if a script was ran with the following arguments:
" +
"run foo.script 1 sigma-cosmetics
" +
"Then to kill this script the same arguments would have to be used:
" +
"kill foo.script 1 sigma-cosmetics
" +
"Note that after issuing the 'kill' command for a script, it may take a while for the script to actually stop running. " +
"This will happen if the script is in the middle of a command such as grow() or weaken() that takes time to execute. " +
"The script will not be stopped/killed until after that time has elapsed.",
killall: "killall
" +
"Kills all scripts on the current server. " +
"Note that after the 'kill' command is issued for a script, it may take a while for the script to actually stop running. " +
"This will happen if the script is in the middle of a command such as grow() or weaken() that takes time to execute. " +
"The script will not be stopped/killed until after that time has elapsed.",
ls: "ls [| grep pattern]
" +
"The ls command, with no arguments, prints all files on the current server to the Terminal screen. " +
"This includes all scripts, programs, and message files. " +
"The files will be displayed in alphabetical order.
" +
"The '| grep pattern' optional parameter can be used to only display files whose filenames match the specified pattern. " +
"For example, if you wanted to only display files with the .script extension, you could use:
" +
"ls | grep .script
" +
"Alternatively, if you wanted to display all files with the word purchase in the filename, you could use:
" +
"ls | grep purchase",
mem: "mem [script name] [-t] [num threads]
" +
"Displays the amount of RAM needed to run the specified script with a single thread. The command can also be used to print " +
"the amount of RAM needed to run a script with multiple threads using the '-t' flag. If the '-t' flag is specified, then " +
"an argument for the number of threads must be passed in afterwards. Examples:
" +
"mem foo.script
" +
"mem foo.script -t 50
" +
"The first example above will print the amount of RAM needed to run 'foo.script' with a single thread. The second example " +
"above will print the amount of RAM needed to run 'foo.script' with 50 threads.",
nano: "nano [script name]
" +
"Opens up the specified script in the Script Editor. If the script does not already exist, then a new, empty script " +
"will be created",
ps: "ps
" +
"Prints all scripts that are running on the current server",
rm: "rm [file]
" +
"Removes the specified file from the current server. A file can be a script, a program, or a message file.
" +
"WARNING: This is permanent and cannot be undone",
run: "run [file name] [-t] [num threads] [args...]
" +
"Execute a program or a script.
" +
"The '[-t]', '[num threads]', and '[args...]' arguments are only valid when running a script. The '-t' flag is used " +
"to indicate that the script should be run with the specified number of threads. If the flag is omitted, " +
"then the script will be run with a single thread by default. " +
"If the '-t' flag is used, then it MUST come immediately " +
"after the script name, and the [num threads] argument MUST come immediately afterwards.
" +
"[args...] represents a variable number of arguments that will be passed into the script. See the documentation " +
"about script arguments. Each specified argument must be separated by a space.
",
scan: "scan
" +
"Prints all immediately-available network connection. This will print a list of all servers that you can currently connect " +
"to using the 'connect' Terminal command.",
"scan-analyze": "scan-analyze [depth]
" +
"Prints detailed information about all servers up to [depth] nodes away on the network. Calling " +
"'scan-analyze 1' will display information for the same servers that are shown by the 'scan' Terminal " +
"command. This command also shows the relative paths to reach each server.
" +
"By default, the maximum depth that can be specified for 'scan-analyze' is 3. However, once you have " +
"the DeepscanV1.exe and DeepscanV2.exe programs, you can execute 'scan-analyze' with a depth up to " +
"5 and 10, respectively.
" +
"The information 'scan-analyze' displays about each server includes whether or not you have root access to it, " +
"its required hacking level, the number of open ports required to run NUKE.exe on it, and how much RAM " +
"it has",
scp: "scp [script name] [target server]
" +
"Copies the specified script from the current server to the target server. " +
"The second argument passed in must be the hostname or IP of the target server.",
sudov: "sudov
" +
"Prints whether or not you have root access to the current machine",
tail: "tail [script name] [args...]
" +
"Displays dynamic logs for the script specified by the script name and arguments. Each argument must be separated " +
"by a space. Remember that a running script is uniquely identified by both its name and the arguments that were used " +
"to run it. So, if a script was ran with the following arguments:
" +
"run foo.script 10 50000
" +
"Then in order to check its logs with 'tail' the same arguments must be used:
" +
"tail foo.script 10 50000",
theme: "theme [preset] | [#background #text #highlight]
" +
"Change the color of the game's user interface
" +
"This command can be called with a preset theme. Currently, the supported presets are 'default', 'muted', and 'solarized'. " +
"However, you can also specify your own color scheme using hex values. To do so, you must specify three hex color values " +
"for the background color, the text color, and the highlight color. These hex values must be preceded by a pound sign (#) and " +
"must be either 3 or 6 digits. Example:
" +
"theme #ffffff #385 #235012
" +
"A color picker such as " +
"Google's " +
"can be used to get your desired hex color values
" +
"Themes are not saved, so when the game is closed and then re-opened or reloaded then it will revert back to the default theme.",
top: "top
" +
"Prints a list of all scripts running on the current server as well as their thread count and how much " +
"RAM they are using in total.",
unalias: 'unalias "[alias name]"
' +
"Deletes the specified alias. Note that the double quotation marks are required.
" +
"As an example, if an alias was declared using:
" +
'alias r="run"
' +
"Then it could be removed using:
" +
'unalias "r"
' +
"It is not necessary to differentiate between global and non-global aliases when using 'unalias'",
}