|
This version is still in development and is not considered stable yet. For the latest stable version, please use Spring Shell 4.0.2! |
Help
Running a shell application often implies that the user is in a graphically limited
environment. This is why it is important that the shell commands are correctly self-documented, and this is where the help
command comes in.
Typing help + ENTER lists all the commands known to the shell and a short description of what they do, similar to the following:
my-shell:>help
Available commands:
Built-In Commands
clear: Clear the terminal screen
help: Show help about available commands
version: Show version info
Typing <command> -h or <command> --help shows the short help string for the given command. For more details about a command, like available parameters, their
type, whether they are mandatory or not, use the help <command> syntax:
my-shell:>help version
NAME
version - Show version info
SYNOPSIS
version --help
OPTIONS
--help or -h
help for version
[Optional]