diff --git a/common/locale/en-US/all.xml b/common/locale/en-US/all.xml index ccb98583..52586868 100644 --- a/common/locale/en-US/all.xml +++ b/common/locale/en-US/all.xml @@ -12,29 +12,29 @@ - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + diff --git a/common/locale/en-US/cmdline.xml b/common/locale/en-US/cmdline.xml index 1f911d34..825f56b1 100644 --- a/common/locale/en-US/cmdline.xml +++ b/common/locale/en-US/cmdline.xml @@ -152,6 +152,7 @@ +

Ex command lines

@@ -212,7 +213,73 @@

-
+ + +

Ex command-line arguments

+ +

+ Most Ex commands accept a number of options and arguments. Arguments and + options are generally separated by spaces, and treat a number of + characters, including \, ', ", and |, + specially. Moreover, certain arguments have their own special characters. + For instance, when using :set to change a stringlist + option, the comma character is used to separate elements of said list. Or + when calling :autocmd, the pattern given may be negated by + prefixing it with a !. In order to use these characters in + command arguments, stripped of their special meaning, they must be quoted. +

+ +

+ &dactyl.appName; offers four distinct quoting styles, each with its own + distinct advantages and disadvantages. The first, and most basic, is the + automatic quoting applied to the commands listed in :bar. When + any of these commands is invoked, their final argument is always + interpreted literally. No characters have special meaning whatsoever, and + no care need be taken to quote anything. Additionally, the following three + optional quoting characters are available: +

+ +
+
\
+
+ This is the most basic quoting character. When it is encountered + outside of single or double quotes, it forces the next character to be + interpreted literally. So, for instance, \\\, + \'', \aa, and + \␣. +
+
'
+
+ Any character inside single quotes aside from the ' character itself + is interpreted literally. To include a literal single quote, it must + be doubled. So, 'foo\ ''bar\\ baz\' ⇒ foo\ 'bar\\ baz\ +
+
"
+
+ Any character inside of double quotes except for " and + \ is interpreted literally. A literal double quote may be + included by preceding it with a backslash. Any other occurrence of a + backslash starts an escape sequence as in JavaScript strings. Among + the available escape sequences are: +
+
\n
A newline character.
+
\t
A tab character.
+
\0nn
Where each n is a digit between 0 and 7, represents an octal character code.
+
\xdd
Where each d is a digit between 0 and F, represents a hexidecimal character code.
+
\uxxxx
Where each x is a digit between 0 and F, a Unicode character at code-point xxxx.
+
+
+
+ +

+ Many Ex commands accept option arguments in addition to regular arguments. + Option arguments begin with a hyphen (-), and often have a short + form and a long form, such as -name and -n. Most options + accept arguments, which come after the option separated by either a space + or an equal sign. For instance, the following three forms, + -name=foo, -name foo, and + -n foo, are all acceptable and entirely equivalent. +

diff --git a/pentadactyl/TODO b/pentadactyl/TODO index bbf5e43d..8b83f75f 100644 --- a/pentadactyl/TODO +++ b/pentadactyl/TODO @@ -25,7 +25,6 @@ BUGS: (recent Mercurial regressions): FEATURES: -9 Add quoting help tag 8 Document Caret and Visual modes. 8 replace global variables with plugin scoped user options 8 fix local options diff --git a/pentadactyl/locale/en-US/all.xml b/pentadactyl/locale/en-US/all.xml index 32e54296..b0335c24 100644 --- a/pentadactyl/locale/en-US/all.xml +++ b/pentadactyl/locale/en-US/all.xml @@ -7,7 +7,7 @@ xmlns="&xmlns.dactyl;" xmlns:html="&xmlns.html;"> - +