common/locale/en-US/cmdline.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <?xml-stylesheet type="text/xsl" href="dactyl://content/help.xsl"?>
   3
   4 <!DOCTYPE document SYSTEM "dactyl://content/dtd">
   5
   6 <document
   7     name="cmdline"
   8     title="&dactyl.appName; Command-line"
   9     xmlns="&xmlns.dactyl;"
  10     xmlns:html="&xmlns.html;">
  11
  12 <h1 tag="command-line-mode command-line mode-cmdline">Command-line mode</h1>
  13 <toc start="2"/>
  14
  15 <p>
  16     &dactyl.appName;'s command-line mode is perhaps its most
  17     powerful interface. In this mode, the command input bar at the
  18     bottom of the window is given the keyboard focus for any of a
  19     variety of required inputs. In addition to access to almost
  20     every aspect of &dactyl.appName; and &dactyl.host;, the command
  21     line provides power and comprehensive completion for all of its
  22     commands, along with concise descriptions for each command and
  23     all of its arguments. Couple this with persistent, searchable
  24     command history, and you have a very efficient interface for
  25     easily performing simple and complex tasks.
  26 </p>
  27
  28 <p>
  29     Included among the several command-line modes are Ex command
  30     mode (the standard mode for entering commands), find mode (for
  31     searching the current page), prompt mode (for selecting files,
  32     confirming actions), and hint mode (for selecting links and
  33     other items on a page).
  34 </p>
  35
  36 <item>
  37     <tags>:</tags>
  38     <strut/>
  39     <spec>:</spec>
  40     <description>
  41         <p>
  42             Opens the command line in Ex mode. This is the mode used
  43             for entering the various commands listed in
  44             <t>ex-cmd-index</t>.
  45         </p>
  46     </description>
  47 </item>
  48
  49 <h2 tag="cmdline-editing">Command-line editing</h2>
  50
  51 <item>
  52     <tags><![CDATA[c_<C-i>]]></tags>
  53     <spec>&lt;C-i></spec>
  54     <description short="true">
  55         <p>Launch the external editor. See the <o>editor</o> option.</p>
  56     </description>
  57 </item>
  58
  59 <item>
  60     <tags><![CDATA[c_<C-c>]]></tags>
  61     <spec>&lt;C-c></spec>
  62     <description short="true">
  63         <p>Quit Command-line mode without executing.</p>
  64     </description>
  65 </item>
  66
  67 <item>
  68     <tags><![CDATA[c_<C-]>]]></tags>
  69     <spec>&lt;C-]></spec>
  70     <description short="true">
  71         <p>Expand a command-line abbreviation.</p>
  72     </description>
  73 </item>
  74
  75 <item>
  76     <tags><![CDATA[c_<Up>]]></tags>
  77     <strut/>
  78     <spec>&lt;Up></spec>
  79     <description>
  80         <p>
  81             Recall from command history the previous command line
  82             which begins with the current input value.
  83         </p>
  84     </description>
  85 </item>
  86
  87 <item>
  88     <tags><![CDATA[c_<Down>]]></tags>
  89     <strut/>
  90     <spec>&lt;Down></spec>
  91     <description>
  92         <p>
  93             Recall from command history the next command line
  94             which begins with the current input value.
  95         </p>
  96     </description>
  97 </item>
  98
  99 <item>
 100     <tags><![CDATA[c_<C-p> c_<S-Up> c_<PageUp>]]></tags>
 101     <spec>&lt;S-Up></spec>
 102     <strut/>
 103     <spec>&lt;PageUp></spec>
 104     <description>
 105         <p>Recall the previous command line from the history list.</p>
 106     </description>
 107 </item>
 108
 109 <item>
 110     <tags><![CDATA[c_<C-n> c_<S-Down> c_<PageDown>]]></tags>
 111     <spec>&lt;S-Down></spec>
 112     <spec>&lt;PageDown></spec>
 113     <description>
 114         <p>Recall the next command line from the history list.</p>
 115     </description>
 116 </item>
 117
 118 <h2 tag="cmdline-completion">Command-line completion</h2>
 119
 120 <item>
 121     <tags><![CDATA[c_<Tab>]]></tags>
 122     <strut/>
 123     <spec>&lt;Tab></spec>
 124     <description>
 125         <p>
 126             Complete the word in front of the cursor according to the behavior
 127             specified in <o>wildmode</o>. If <o>wildmode</o> contains
 128             <str>list</str> and there are multiple matches then the completion
 129             menu window is opened.
 130         </p>
 131     </description>
 132 </item>
 133
 134 <item>
 135     <tags><![CDATA[c_<S-Tab>]]></tags>
 136     <strut/>
 137     <spec>&lt;S-Tab></spec>
 138     <description>
 139         <p>Complete the previous full match when <o>wildmode</o> contains <str>full</str>.</p>
 140     </description>
 141 </item>
 142
 143 <item>
 144     <tags><![CDATA[c_<A-Tab>]]></tags>
 145     <strut/>
 146     <spec>&lt;A-Tab></spec>
 147     <description>
 148         <p>
 149             Similar to <k name="Tab" mode="c"/>, but the completion behavior is
 150             specified by the <o>altwildmode</o> option.
 151         </p>
 152     </description>
 153 </item>
 154
 155 <item>
 156     <tags><![CDATA[c_<A-S-Tab>]]></tags>
 157     <strut/>
 158     <spec>&lt;A-S-Tab></spec>
 159     <description>
 160         <p>The <k name="S-Tab" mode="c"/> equivalent for <o>altwildmode</o>.</p>
 161     </description>
 162 </item>
 163
 164 <h2 tag="cmdline-lines">Ex command lines</h2>
 165
 166 <item>
 167     <tags>:bar</tags>
 168     <strut/>
 169     <description>
 170         <p>
 171             Multiple commands, separated by a <em>|</em> can be
 172             given in a single command line and will be executed consecutively.
 173             <em>|</em> can be included as an argument to a command by escaping
 174             it with a backslash. E.g.
 175             <code><ex>:map \|</ex> <ex>:echo <str>bar</str></ex><k name="CR"/></code>
 176
 177             Several commands process the entire command-line string literally.
 178             These commands will include any <em>|</em> as part of their
 179             argument string and so cannot be followed by another command. The
 180             list of these commands is:
 181             <ul>
 182                 <li><ex>:abbreviate</ex></li>
 183                 <li><ex>:autocmd</ex></li>
 184                 <li><ex>:cabbreviate</ex></li>
 185                 <li><ex>:cmap</ex></li>
 186                 <li><ex>:cnoremap</ex></li>
 187                 <li><ex>:command</ex></li>
 188                 <li><ex>:delmacros</ex></li>
 189                 <li><ex>:delmarks</ex></li>
 190                 <li><ex>:delqmarks</ex></li>
 191                 <li><ex>:delstyle</ex></li>
 192                 <li><ex>:echo</ex></li>
 193                 <li><ex>:echoerr</ex></li>
 194                 <li><ex>:echomsg</ex></li>
 195                 <li><ex>:elseif</ex></li>
 196                 <li><ex>:execute</ex></li>
 197                 <li><ex>:highlight</ex></li>
 198                 <li><ex>:iabbreviate</ex></li>
 199                 <li><ex>:if</ex></li>
 200                 <li><ex>:imap</ex></li>
 201                 <li><ex>:inoremap</ex></li>
 202                 <li><ex>:javascript</ex></li>
 203                 <li><ex>:let</ex></li>
 204                 <li><ex>:map</ex></li>
 205                 <li><ex>:marks</ex></li>
 206                 <li><ex>:nmap</ex></li>
 207                 <li><ex>:nnoremap</ex></li>
 208                 <li><ex>:noremap</ex></li>
 209                 <li><ex>:open</ex></li>
 210                 <li><ex>:qmarks</ex></li>
 211                 <li><ex>:silent</ex></li>
 212                 <li><ex>:style</ex></li>
 213                 <li><ex>:styledisable</ex></li>
 214                 <li><ex>:styleenable</ex></li>
 215                 <li><ex>:styletoggle</ex></li>
 216                 <li><ex>:tabopen</ex></li>
 217                 <li><ex>:toolbarhide</ex></li>
 218                 <li><ex>:toolbarshow</ex></li>
 219                 <li><ex>:toolbartoggle</ex></li>
 220                 <li><ex>:vmap</ex></li>
 221                 <li><ex>:vnoremap</ex></li>
 222                 <li><ex>:winopen</ex></li>
 223                 <li><ex>:yank</ex></li>
 224             </ul>
 225         </p>
 226     </description>
 227 </item>
 228
 229 <h3 tag="cmdline-arguments">Ex command-line arguments</h3>
 230
 231 <p>
 232     Most Ex commands accept a number of options and arguments. Arguments and
 233     options are generally separated by spaces, and treat a number of
 234     characters, including <em>\</em>, <em>'</em>, <em>"</em>, and <em>|</em>,
 235     specially.  Moreover, certain arguments have their own special characters.
 236     For instance, when using <ex>:set</ex> to change a <t>stringlist</t>
 237     option, the comma character is used to separate elements of said list. Or
 238     when calling <ex>:autocmd</ex>, the pattern given may be negated by
 239     prefixing it with a <em>!</em>. In order to use these characters in
 240     command arguments, stripped of their special meaning, they must be quoted.
 241 </p>
 242
 243 <p tag="cmdline-quoting quoting">
 244     &dactyl.appName; offers four distinct quoting styles, each with its own
 245     distinct advantages and disadvantages. The first, and most basic, is the
 246     automatic quoting applied to the commands listed in <ex>:bar</ex>. When
 247     any of these commands is invoked, their final argument is always
 248     interpreted literally. No characters have special meaning whatsoever, and
 249     no care need be taken to quote anything. Additionally, the following three
 250     optional quoting characters are available:
 251 </p>
 252
 253 <dl dt="width: 8em;">
 254     <dt>\</dt>
 255     <dd>
 256         This is the most basic quoting character. When it is encountered
 257         outside of single or double quotes, it forces the next character to be
 258         interpreted literally. So, for instance, <tt>\\</tt> ⇒ <tt>\</tt>,
 259         <tt>\'</tt> ⇒ <tt>'</tt>, <tt>\a</tt> ⇒ <tt>a</tt>, and
 260         <tt>\␣</tt> ⇒ <tt>␣</tt>.
 261     </dd>
 262     <dt>'</dt>
 263     <dd>
 264         Any character inside single quotes aside from the ' character itself
 265         is interpreted literally. To include a literal single quote, it must
 266         be doubled. So, <code>'foo\ ''bar\\ baz\' ⇒ foo\ 'bar\\ baz\</code>
 267     </dd>
 268     <dt>"</dt>
 269     <dd>
 270         Any character inside of double quotes except for <em>"</em> and
 271         <em>\</em> is interpreted literally. A literal double quote may be
 272         included by preceding it with a backslash. Any other occurrence of a
 273         backslash starts an escape sequence as in JSON strings.
 274         Among the available escape sequences are:
 275         <dl dt="width: 8em;">
 276             <dt>\n</dt> <dd>A newline character.</dd>
 277             <dt>\t</dt> <dd>A tab character.</dd>
 278             <dt>\uxxxx</dt> <dd>Where each <em>x</em> is a digit between 0 and F, a Unicode character at code-point <em>xxxx</em>.</dd>
 279         </dl>
 280     </dd>
 281 </dl>
 282
 283 <p tag="cmdline-options">
 284     Many Ex commands accept option arguments in addition to regular arguments.
 285     Option arguments begin with a hyphen (<em>-</em>), and often have a short
 286     form and a long form, such as <em>-name</em> and <em>-n</em>. Most options
 287     accept arguments, which come after the option separated by either a space
 288     or an equal sign. For instance, the following three forms,
 289     <em>-name=<str>foo</str></em>, <em>-name <str>foo</str></em>, and
 290     <em>-n <str>foo</str></em>, are all acceptable and entirely equivalent.
 291 </p>
 292
 293 </document>
 294
 295 <!-- vim:se sts=4 sw=4 et: -->