]> git.donarmstrong.com Git - dactyl.git/blobdiff - common/locale/en-US/starting.xml
finalize changelog for 7904
[dactyl.git] / common / locale / en-US / starting.xml
index 2a6d33d19f094f1b322a8fb3c05d827085b14964..0a9ce2b3af5b83a7b7abb8b5dfdf0c0073a68103 100644 (file)
 <h2 tag="startup-options">Command-line options</h2>
 
 <p>
-    Command-line options can be passed to &dactyl.appName; via the -&dactyl.name; &dactyl.host;
+    Command-line options can be passed to &dactyl.appName; via the <em>-&dactyl.name;</em> &dactyl.host;
     option. These are passed as single string argument.
     E.g., <tt>&dactyl.hostbin; -&dactyl.name; <str><t>++cmd</t> 'set exrc' <t>+u</t> 'tempRcFile' <t>++noplugin</t></str></tt>
 </p>
 
+<p>
+    The <em>-&dactyl.name;-remote</em> command-line option can be used to
+    execute a single Ex command in an already running Pentadactyl instance.
+</p>
+
 <item>
     <tags>+c</tags>
     <strut/>
     </description>
 </item>
 
+<item>
+    <tags>+purgecaches</tags>
+    <strut/>
+    <spec>+purgecaches</spec>
+    <description>
+        <p>
+            Purges &dactyl.appName; caches at startup. May occasionally be
+            necessary after making local changes to the source tree.
+        </p>
+    </description>
+</item>
+
 <h2 tag="initialization startup">Initialization</h2>
 
 <p>At startup, &dactyl.appName; completes the following tasks in order. </p>
     </li>
     <li>
         <p>
-            If <o>exrc</o> is set and the +u command-line option was not
+            If <o>exrc</o> is set and the <t>+u</t> command-line option was not
             specified, then any RC file in the current directory is also
             sourced.
         </p>
         </p>
 
         <ul>
-            <li><o>noloadplugins</o> is set,</li>
+            <li><o>loadplugins</o> is unset,</li>
             <li>the <t>++noplugin</t> command-line option was specified, or</li>
             <li>the <tt><t>+u</t>=NONE</tt> command-line option was specified.</li>
         </ul>
 
 <h2 tag="restarting">Restarting</h2>
 
+<item>
+    <tags>:reh :rehash</tags>
+    <spec>:reh<oa>ash</oa> <oa>arg</oa> …</spec>
+    <description>
+        <p>
+            Reload the &dactyl.appName; add-on, including all code, plugins,
+            and configuration. For users running directly from the development
+            repository, this is a good way to update to the latest version or
+            to test your changes.
+        </p>
+
+        <p>
+            Any arguments supplied are parsed as command-line arguments as
+            specified in <t>startup-options</t>.
+        </p>
+
+        <warning>
+            Not all plugins are designed to cleanly un-apply during a rehash.
+            While official plugins are safe, beware of possible instability
+            if you rehash while running third-party plugins.
+        </warning>
+    </description>
+</item>
+
 <item>
     <tags>:res :restart</tags>
-    <spec>:res<oa>tart</oa></spec>
+    <spec>:res<oa>tart</oa> <oa>arg</oa> …</spec>
     <description short="true">
         <p>Force &dactyl.host; to restart. Useful when installing extensions.</p>
+
+        <p>
+            Any arguments supplied are parsed as command-line arguments as
+            specified in <t>startup-options</t>.
+        </p>
     </description>
 </item>