common/locale/en-US/various.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="various"
   8     title="&dactyl.appName; Other"
   9     xmlns="&xmlns.dactyl;"
  10     xmlns:html="&xmlns.html;">
  11
  12 <h1>Other help</h1>
  13 <toc start="2"/>
  14
  15 <h2 tag="various">Various commands</h2>
  16
  17 <item>
  18     <tags>:comp :completions</tags>
  19     <spec>:comp<oa>letions</oa> <a>ex-command</a></spec>
  20     <description>
  21         <p>
  22             List the completion results for a given command substring.
  23         </p>
  24         <example><ex>:completions :set! <str delim="">browser.tabs.</str></ex></example>
  25     </description>
  26 </item>
  27
  28 <item>
  29     <tags>:contexts</tags>
  30     <spec>:contexts <a>ex-command</a></spec>
  31     <description>
  32         <p>
  33             Lists the completion contexts used during the completion of its
  34             arguments. These context names may be used to tune the function of
  35             the completion system via options like <o>autocomplete</o> and
  36             <o>wildcase</o>. Note that completion must be triggered in order
  37             for this command to be effective, so if auto-completion is not
  38             active, you'll need to press the <k name="Tab" mode="c"/> key at
  39             least once. You should also be aware that this command is only
  40             useful from the command line.
  41         </p>
  42     </description>
  43 </item>
  44
  45 <item>
  46     <tags>:fk :feedkeys</tags>
  47     <spec>feedkeys<oa>!</oa> <a>keys</a></spec>
  48     <description>
  49         <p>
  50             Fake key events. If <oa>!</oa> is given, key remappings are
  51             ignored, similarly to the <t>:map</t> command's <em>-builtin</em>
  52             option.
  53         </p>
  54
  55         <dl>
  56             <dt>-mode</dt> <dd>The mode in which to feed the keys (short name <em>-m</em>)</dd>
  57         </dl>
  58     </description>
  59 </item>
  60
  61 <item>
  62     <tags>:norm :normal</tags>
  63     <spec>:norm<oa>al</oa><oa>!</oa> <a>keys</a></spec>
  64     <description>
  65         <p>
  66             Execute key mappings for <a>keys</a> as if they were typed in
  67             Normal mode. If <oa>!</oa> is provided, only builtin key mappings
  68             are executed. This makes it possible to fake Normal mode key
  69             presses from scripts, key mappings, autocommands, and the command
  70             line.
  71         </p>
  72     </description>
  73 </item>
  74
  75 <item>
  76     <tags>:mkv :mkvimruntime</tags>
  77     <spec>:mkv<oa>imruntime</oa><oa>!</oa> <oa>dir</oa></spec>
  78     <description>
  79         <p>
  80             Creates and installs Vim ftdetect, ftplugin and syntax files. If
  81             <oa>dir</oa> is not given, the local Vim runtime path is guessed.
  82             An existing file will never be overwritten unless <oa>!</oa> is
  83             given.
  84         </p>
  85         <p>
  86             See <em>:help 'runtimepath'</em> and <em>:help after-directory</em>
  87             in Vim for an explanation of how best to manage personal changes to
  88             these files.
  89         </p>
  90     </description>
  91 </item>
  92
  93 <item>
  94     <tags><![CDATA[<redraw-screen> <C-l> :redr :redraw]]></tags>
  95     <strut/>
  96     <spec>:redr<oa>aw</oa></spec>
  97     <description>
  98         <p>Redraws the screen. Useful for updating the screen during the execution of a script or function.</p>
  99     </description>
 100 </item>
 101
 102 <item>
 103     <tags>:run :! :!cmd</tags>
 104     <strut/>
 105     <spec>:!<a>cmd</a></spec>
 106     <description>
 107         <p>
 108             Run an external command. Runs <a>cmd</a> through system()
 109             and displays its output. Any ‘!’ in <a>cmd</a> is replaced with
 110             the previous external command, so long as it is not preceded by a
 111             backslash and <o>banghist</o> is enabled.
 112         </p>
 113     </description>
 114 </item>
 115
 116 <item>
 117     <tags>:!!</tags>
 118     <spec>:!!</spec>
 119     <description short="true">
 120         <p>Repeat last <ex>:!<a>cmd</a></ex>.</p>
 121     </description>
 122 </item>
 123
 124 <item>
 125     <tags>:sil :silent</tags>
 126     <spec>:sil<oa>ent</oa> <a>command</a></spec>
 127     <description>
 128         <p>
 129             Execute a command silently. Normal messages and error messages
 130             generated by the command invocation will not be displayed and will
 131             not be added to the message history.
 132         </p>
 133     </description>
 134 </item>
 135
 136 <item>
 137     <tags>:verb :verbose</tags>
 138     <spec>:<oa>count</oa>verb<oa>ose</oa> <a>command</a></spec>
 139     <description>
 140         <p>
 141             Execute a command with <o>verbose</o> set to <oa>count</oa>. If
 142             <oa>count</oa> is not specified then 1 is used.
 143         </p>
 144     </description>
 145 </item>
 146
 147 <item>
 148     <tags>:ve :version</tags>
 149     <strut/>
 150     <spec>:ve<oa>rsion</oa><oa>!</oa></spec>
 151     <description>
 152         <p>
 153             Print &dactyl.appName; and &dactyl.host; version information. When
 154             <oa>!</oa> is provided, show the &dactyl.host; version page.
 155         </p>
 156     </description>
 157 </item>
 158
 159 <item>
 160     <tags>:yank :y</tags>
 161     <spec>:y[ank] :<a>cmd</a></spec>
 162     <spec>:y[ank] <a>js</a></spec>
 163     <description>
 164         <p>
 165             Yanks the output of the given Ex command <a>cmd</a> or JavaScript <a>js</a> to the clipboard.
 166         </p>
 167     </description>
 168 </item>
 169
 170 <h2 tag="online-help">Online help</h2>
 171
 172 <item>
 173     <tags><![CDATA[<open-help> <F1> :help :h help]]></tags>
 174     <spec>:h<oa>elp</oa> <oa>subject</oa></spec>
 175     <spec>&lt;F1></spec>
 176     <description>
 177         <p>
 178             Open a help page for <oa>subject</oa>. If <oa>subject</oa> is
 179             omitted, open the default page as specified in <o>helpfile</o>.
 180             If you're not sure of the exact topic you need help with, try
 181             <k name="Tab" mode="c"/> completion or <ex>:help overview</ex>.
 182         </p>
 183     </description>
 184 </item>
 185
 186 <item>
 187     <tags><![CDATA[<open-single-help> <A-F1> :helpall :helpa help-all]]></tags>
 188     <spec>:helpa<oa>ll</oa> <oa>subject</oa></spec>
 189     <spec>&lt;A-F1></spec>
 190     <description>
 191         <p>
 192             Open all help pages consolidated into a single page and scroll to
 193             <oa>subject</oa> if given.
 194         </p>
 195
 196         <p>See <ex>:help</ex>.</p>
 197     </description>
 198 </item>
 199
 200 <item>
 201     <tags>:lc :listcommands</tags>
 202     <spec>:listc<oa>ommands</oa> <oa>filter</oa></spec>
 203     <spec>:lc <oa>filter</oa></spec>
 204     <description>
 205         <p>
 206             List all Ex commands matching <oa>filter</oa> along with their
 207             short descriptions. The output contains links to the source code
 208             definitions.
 209         </p>
 210     </description>
 211 </item>
 212
 213 <item>
 214     <tags>:lk :listkeys</tags>
 215     <spec>:listk<oa>eys</oa> <oa>-mode <a>mode</a></oa> <oa>filter</oa></spec>
 216     <spec>:lk <oa>-mode <a>mode</a></oa> <oa>filter</oa></spec>
 217     <description>
 218         <p>
 219             List the key mappings defined for <a>mode</a> (Normal by default)
 220             matching <oa>filter</oa> along with their short descriptions. The
 221             output contains links to the source code definitions.
 222         </p>
 223     </description>
 224 </item>
 225
 226 <item>
 227     <tags>:lo :listoptions</tags>
 228     <spec>:listo<oa>ptions</oa> <oa>filter</oa></spec>
 229     <spec>:lo <oa>filter</oa></spec>
 230     <description>
 231         <p>
 232             List all options matching <oa>filter</oa> along with their short
 233             descriptions. The output contains links to the source code
 234             definitions.
 235         </p>
 236     </description>
 237 </item>
 238
 239 <tags>42</tags>
 240
 241 <p>
 242     What is the meaning of life, the universe and everything? Douglas Adams,
 243     the only person who knew what this question really was about is now dead,
 244     unfortunately. So now you might wonder what the meaning of death is…
 245 </p>
 246
 247 <h2 tag="uncategorized">Uncategorized help</h2>
 248
 249 <item>
 250     <tags><![CDATA[<C-[> <Esc>]]></tags>
 251     <strut/>
 252     <spec>&lt;Esc></spec>
 253     <description>
 254         <p>
 255             Exits Command-line, Insert, or Hints mode and returns to
 256             Normal mode. Focuses the content web page.
 257         </p>
 258     </description>
 259 </item>
 260
 261 <item>
 262     <tags><![CDATA[<Insert>]]> i caret-mode visual-mode</tags>
 263     <strut/>
 264     <spec>i</spec>
 265     <description>
 266         <p>
 267             Start Caret mode. This mode resembles Vim's Normal mode where the
 268             text cursor is visible on the web page. The <k mode="caret">v</k>
 269             key enters Visual mode, where text is selected as the cursor moves.
 270         </p>
 271         <p>
 272             You can see all mappings effective in Caret or Visual mode using
 273             the <ex>:listkeys</ex> command.
 274         </p>
 275     </description>
 276 </item>
 277
 278 </document>
 279
 280 <!-- vim:se sts=4 sw=4 et: -->