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>:mks :mksyntax</tags>
  77     <spec>:mks<oa>yntax</oa><oa>!</oa> <oa>path</oa></spec>
  78     <description>
  79         <p>
  80             Generate a Vim syntax file. If <oa>path</oa> is not given, the local
  81             Vim runtime path is guessed. If <oa>path</oa> is a directory, the
  82             file <str delim="">&dactyl.name;.vim</str> in that directory is
  83             used. An existing file will never be overwritten unless
  84             <oa>bang</oa> is given.
  85         </p>
  86     </description>
  87 </item>
  88
  89 <item>
  90     <tags><![CDATA[<redraw-screen> <C-l> CTRL-L :redr :redraw]]></tags>
  91     <strut/>
  92     <spec>:redr<oa>aw</oa></spec>
  93     <description>
  94         <p>Redraws the screen. Useful for updating the screen during the execution of a script or function.</p>
  95     </description>
  96 </item>
  97
  98 <item>
  99     <tags>:run :! :!cmd</tags>
 100     <strut/>
 101     <spec>:!<a>cmd</a></spec>
 102     <description>
 103         <p>
 104             Run an external command. Runs <a>cmd</a> through system()
 105             and displays its output. Any ‘!’ in <a>cmd</a> is replaced with
 106             the previous external command, so long as it is not preceded by a
 107             backslash and <o>banghist</o> is enabled.
 108         </p>
 109     </description>
 110 </item>
 111
 112 <item>
 113     <tags>:!!</tags>
 114     <spec>:!!</spec>
 115     <description short="true">
 116         <p>Repeat last <ex>:!<a>cmd</a></ex>.</p>
 117     </description>
 118 </item>
 119
 120 <item>
 121     <tags>:sil :silent</tags>
 122     <spec>:sil<oa>ent</oa> <a>command</a></spec>
 123     <description>
 124         <p>
 125             Execute a command silently. Normal messages and error messages
 126             generated by the command invocation will not be displayed and will
 127             not be added to the message history.
 128         </p>
 129     </description>
 130 </item>
 131
 132 <item>
 133     <tags>:verb :verbose</tags>
 134     <spec>:<oa>count</oa>verb<oa>ose</oa> <a>command</a></spec>
 135     <description>
 136         <p>
 137             Execute a command with <o>verbose</o> set to <oa>count</oa>. If
 138             <oa>count</oa> is not specified then 1 is used.
 139         </p>
 140     </description>
 141 </item>
 142
 143 <item>
 144     <tags>:ve :version</tags>
 145     <strut/>
 146     <spec>:ve<oa>rsion</oa><oa>!</oa></spec>
 147     <description>
 148         <p>
 149             Print &dactyl.appName; and &dactyl.host; version information. When
 150             <oa>!</oa> is provided, show the &dactyl.host; version page.
 151         </p>
 152     </description>
 153 </item>
 154
 155 <item>
 156     <tags>:yank :y</tags>
 157     <spec>:y[ank] :<a>cmd</a></spec>
 158     <spec>:y[ank] <a>js</a></spec>
 159     <description>
 160         <p>
 161             Yanks the output of the given Ex command <a>cmd</a> or JavaScript <a>js</a> to the clipboard.
 162         </p>
 163     </description>
 164 </item>
 165
 166 <h2 tag="online-help">Online help</h2>
 167
 168 <item>
 169     <tags><![CDATA[<open-help> <F1> :help :h help]]></tags>
 170     <spec>:h<oa>elp</oa> <oa>subject</oa></spec>
 171     <spec>&lt;F1></spec>
 172     <description>
 173         <p>
 174             Open a help page for <oa>subject</oa>. If <oa>subject</oa> is
 175             omitted, open the default page as specified in <o>helpfile</o>.
 176             If you're not sure of the exact topic you need help with, try
 177             <k name="Tab" mode="c"/> completion or <ex>:help overview</ex>.
 178         </p>
 179     </description>
 180 </item>
 181
 182 <item>
 183     <tags><![CDATA[<open-single-help> <A-F1> :helpall :helpa help-all]]></tags>
 184     <spec>:helpa<oa>ll</oa> <oa>subject</oa></spec>
 185     <spec>&lt;A-F1></spec>
 186     <description>
 187         <p>
 188             Open all help pages consolidated into a single page and scroll to
 189             <oa>subject</oa> if given.
 190         </p>
 191
 192         <p>See <ex>:help</ex>.</p>
 193     </description>
 194 </item>
 195
 196 <item>
 197     <tags>:lc :listcommands</tags>
 198     <spec>:listc<oa>ommands</oa> <oa>filter</oa></spec>
 199     <spec>:lc <oa>filter</oa></spec>
 200     <description>
 201         <p>
 202             List all Ex commands matching <oa>filter</oa> along with their
 203             short descriptions. The output contains links to the source code
 204             definitions.
 205         </p>
 206     </description>
 207 </item>
 208
 209 <item>
 210     <tags>:lk :listkeys</tags>
 211     <spec>:listk<oa>eys</oa> <oa>-mode <a>mode</a></oa> <oa>filter</oa></spec>
 212     <spec>:lk <oa>-mode <a>mode</a></oa> <oa>filter</oa></spec>
 213     <description>
 214         <p>
 215             List the key mappings defined for <a>mode</a> (Normal by default)
 216             matching <oa>filter</oa> along with their short descriptions. The
 217             output contains links to the source code definitions.
 218         </p>
 219     </description>
 220 </item>
 221
 222 <item>
 223     <tags>:lo :listoptions</tags>
 224     <spec>:listo<oa>ptions</oa> <oa>filter</oa></spec>
 225     <spec>:lo <oa>filter</oa></spec>
 226     <description>
 227         <p>
 228             List all options matching <oa>filter</oa> along with their short
 229             descriptions. The output contains links to the source code
 230             definitions.
 231         </p>
 232     </description>
 233 </item>
 234
 235 <tags>42</tags>
 236
 237 <p>
 238     What is the meaning of life, the universe and everything? Douglas Adams,
 239     the only person who knew what this question really was about is now dead,
 240     unfortunately. So now you might wonder what the meaning of death is...
 241 </p>
 242
 243 <h2 tag="uncategorized">Uncategorized help</h2>
 244
 245 <item>
 246     <tags><![CDATA[<C-[> <Esc>]]></tags>
 247     <strut/>
 248     <spec>&lt;Esc></spec>
 249     <description>
 250         <p>
 251             Exits Command-line, Insert, or Hints mode and returns to
 252             Normal mode. Focuses the content web page.
 253         </p>
 254     </description>
 255 </item>
 256
 257 <item>
 258     <tags><![CDATA[<Insert> i]]></tags>
 259     <strut/>
 260     <spec>i</spec>
 261     <description>
 262         <p>
 263             Start Caret mode. This mode resembles the Vim's Normal mode where
 264             the text cursor is visible on the web page. The <k link="false">v</k> key
 265             enters Visual mode, where text is selected as the cursor moves.
 266         </p>
 267     </description>
 268 </item>
 269
 270 </document>
 271
 272 <!-- vim:se sts=4 sw=4 et: -->