summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorShawn Wallace <yungwallace@live.com>2025-04-17 12:00:20 -0400
committerShawn Wallace <yungwallace@live.com>2025-04-17 12:00:20 -0400
commit03b7f70873cc7a3401e9b526d97c1812eefe8bdd (patch)
tree2865821f63ef0e84e333be59545955ea60d898c9 /doc
parent922607221b8e5b2683babb9ebeba9372e97b836c (diff)
Document built in command switch behavior
Diffstat (limited to 'doc')
-rw-r--r--doc/pages/commands.asciidoc5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/pages/commands.asciidoc b/doc/pages/commands.asciidoc
index 6b5a48e5..e386ed61 100644
--- a/doc/pages/commands.asciidoc
+++ b/doc/pages/commands.asciidoc
@@ -4,6 +4,11 @@ Some commands take an exclamation mark (*!*), which can be used to force
the execution of the command (i.e. to quit a modified buffer, the
command *q!* has to be used). Aliases are mentioned below each command.
+For all commands that accept switches, a parameter beginning with
+a single dash (*-*) will be interpreted as a switch. Any unknown switches
+will cause an error. To force the remaining parameters to not be interpreted as
+switches even if they begin with a dash, you can pass two dashes (*--*) as a parameter.
+
*doc* <topic>::
*alias* help +
display documentation about a topic. The completion list displays the