From b04c3e3640c6da6f6c2a065daae97e2dbf7e6f3d Mon Sep 17 00:00:00 2001 From: thindil Date: Fri, 27 Oct 2023 05:02:18 +0000 Subject: [PATCH] docs: updated the shell's help FossilOrigin-Name: c4baf81cce9fbbb2efb7de4b974dc32cc8a8ec84e19ea00dd8305b66e28c58ec --- help/help.cfg | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/help/help.cfg b/help/help.cfg index ce81cf30..2a0564f0 100644 --- a/help/help.cfg +++ b/help/help.cfg @@ -66,48 +66,48 @@ content="Clear the shell's commands' history." [History] topic="history list" usage="history list ?amount? ?order? ?reverse?" -content="Show the last $1 commands from the shell's history ordered by $2$3 You can also set the amount, the order and the direction of the order of commands to show, by adding optional parameters 'amount', 'order' and 'reverse'. For example, to show the last 10 commands sorted by their names in the reversed order: history list 10 name true. Available switches for the 'order' parameter are: 'amount', 'recent', 'name', 'recentamount'. Available values for the 'reverse' parameter are 'true' or 'false'." +content="Show the last $1 commands from the shell's history ordered by $2$3 You can also set the amount, the order and the direction of the order of commands to show, by adding optional parameters 'amount', 'order' and 'reverse'. For example, to show the last 10 commands sorted by their names in the reversed order: `history list 10 name true`. Available switches for the 'order' parameter are: 'amount', 'recent', 'name', 'recentamount'. Available values for the 'reverse' parameter are 'true' or 'false'." template=True [History] topic="history find" usage="history find [term]" -content="Search for the selected term in the shell's commands' history. You can use here wildcard `*` for match any character. By default wildcard `*` is added before and after the term. For example, command `history find hi` will find command `history` but also `help history`". +content="Search for the selected term in the shell's commands' history. You can use here the wildcard `*` for match any character. By default the wildcard `*` is added before and after the term. For example, the command `history find hi` will find the command `history` but also `help history`". [Options] topic="options" usage="options ?subcommand?" -content="If entered without subcommand, show the list of available subcommands for options. Otherwise, execute the selected subcommand." +content="If entered without 'subcommand' parameter, show the list of available subcommands for 'options' command. Otherwise, execute the selected subcommand." [Options] topic="options list" usage="options list" -content="Show the list of all available shell's options with detailed information about them." +content="Show the list of all available shell's options with the detailed information about them." [Options] topic="options set" usage="options set [name] [value]" -content="Set the selected shell's option with name to the selected value. The value can't contain new line character." +content="Set the selected shell's option with the name to the selected value. The value can't contain the new line character." [Options] topic="options reset" usage="options reset [name or all]" -content="Reset the selected shell's option with name to the default value. If the name parameter is set to 'all', reset all shell's options to their default values." +content="Reset the selected shell's option with the name to the default value. If the name parameter is set to 'all', reset all shell's options to their default values." [Output] topic="output headers" usage="options set outputHeaders [unicode or ascii or none or hidden]" -content="Some commands starts its output with drawing headers, same for forms' sections for setting aliases and variables. It is possible to change the look of the headers with the shell's option outputHeaders. Possible values for that option: unicode (default): use Unicode characters to draw frame around the header, ascii: use ASCII characters for the frame, none: show only the header's text and hidden: hide the header completely." +content="Some commands starts its output with drawing headers, same for forms' sections for setting aliases and variables. It is possible to change the look of the headers with the shell's option outputHeaders. Possible values for that option: 'unicode' (default): use Unicode characters to draw frame around the header, 'ascii': use ASCII characters for the frame, 'none': show only the header's text and 'hidden': hide the header completely." [Plugins] topic="plugin" usage="plugin ?subcommand?" -content="If entered without subcommand, show the list of available subcommands for plugins. Otherwise, execute the selected subcommand." +content="If entered without 'subcommand' parameter, show the list of available subcommands for 'plugins' command. Otherwise, execute the selected subcommand." [Plugins] topic="plugin list" usage="plugin list ?all?" -content="Show the list of all enabled plugins. If parameter all added, show all installed plugins." +content="Show the list of all enabled plugins. If parameter 'all' added, show all installed plugins." [Plugins] topic="plugin remove" @@ -122,7 +122,7 @@ content="Show details (path, status, etc) for the plugin with the selected index [Plugins] topic="plugin add" usage="plugin add [path]" -content="Install the selected plugin in the shell. Path must be absolute or relative path to the plugin." +content="Install the selected plugin in the shell. The 'path' parameter must be an absolute or a relative path to the plugin." [Plugins] topic="plugin enable" @@ -137,7 +137,7 @@ content="Disable the selected plugin. Index must be the index of an installed pl [Prompt] topic="prompt" usage="set options promptCommand 'program ?arguments?'" -content="The shell's prompt can be set as output of a command. It is possible by setting the shell's option promptCommand. For example, to set the prompt to listing the current directory, you can type options set promptCommand 'ls -a .'. Please remember, that the command will be executed every time before you execute another command." +content="The shell's prompt can be set as the output of a command. It is possible by setting the shell's option promptCommand. For example, to set the prompt to listing the current directory, you can type `options set promptCommand 'ls -a .'`. Please remember, that the command will be executed every time before you execute another command." [Variables] topic="set" @@ -152,12 +152,12 @@ content="Remove the environment variable with the selected name." [Variables] topic="variable" usage="variable ?subcommand?" -content="If entered without subcommand, show the list of available subcommands for variables. Otherwise, execute the selected subcommand." +content="If entered without subcommand, show the list of available subcommands for 'variables' command. Otherwise, execute the selected subcommand." [Variables] topic="variable list" usage="variable list ?all?" -content="Show the list of all declared in shell environment variables in the current directory. If parameter all added, show all declared environment variables." +content="Show the list of all declared in shell environment variables in the current directory. If parameter 'all' added, show all declared environment variables." [Variables] topic="variable delete"