summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authormathieui <mathieui@mathieui.net>2012-04-18 00:42:31 +0200
committermathieui <mathieui@mathieui.net>2012-04-18 00:42:31 +0200
commit26a9876ae88fd111a064ba5946f2f0524adae06e (patch)
tree56b39582378b7659e7d95f243bc3f4f9e7196a3f /doc
parentd52f5ba40f4f894dfa43162c4e1785ec7345d780 (diff)
downloadpoezio-26a9876ae88fd111a064ba5946f2f0524adae06e.tar.gz
poezio-26a9876ae88fd111a064ba5946f2f0524adae06e.tar.bz2
poezio-26a9876ae88fd111a064ba5946f2f0524adae06e.tar.xz
poezio-26a9876ae88fd111a064ba5946f2f0524adae06e.zip
Document the command/quote behaviour
Diffstat (limited to 'doc')
-rw-r--r--doc/en/usage.txt8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/en/usage.txt b/doc/en/usage.txt
index 46e88a7e..8f8d3ad4 100644
--- a/doc/en/usage.txt
+++ b/doc/en/usage.txt
@@ -151,6 +151,14 @@ The commands described in this page are shown like this:
You can get the same help as below with the _/help_ command.
+NOTE: Use command parameters like this:
+
+* Do not use quotes if they are unnecessary (words without special chars)
+* If the command takes several agrguments, you need to put quotes around
+ arguments containing special chars such as backslashes or quotes
+* If the command always takes only one argument, then do not use quotes even
+ for words containing special chars
+
Global commands
~~~~~~~~~~~~~~~