diff options
Diffstat (limited to 'common/locale/en-US/starting.xml')
| -rw-r--r-- | common/locale/en-US/starting.xml | 159 |
1 files changed, 159 insertions, 0 deletions
diff --git a/common/locale/en-US/starting.xml b/common/locale/en-US/starting.xml new file mode 100644 index 00000000..bd074d47 --- /dev/null +++ b/common/locale/en-US/starting.xml @@ -0,0 +1,159 @@ +<?xml version="1.0" encoding="UTF-8"?> +<?xml-stylesheet type="text/xsl" href="chrome://liberator/content/help.xsl"?> + +<!DOCTYPE document SYSTEM "chrome://liberator/content/liberator.dtd"> + +<document + name="starting" + title="&liberator.appname; Starting" + xmlns="http://vimperator.org/namespaces/liberator" + xmlns:html="http://www.w3.org/1999/xhtml"> +<h1 tag="starting">Starting &liberator.appname;</h1> + +<tags>startup-options</tags> + +<p> + Command-line options can be passed to &liberator.appname; via the -vimperator &liberator.host; + option. These are passed as single string argument. + E.g., firefox -vimperator <str>++cmd 'set exrc' +u 'tempRcFile' ++noplugin</str> +</p> + +<item> + <tags>+c</tags> + <spec>+c <a>command</a></spec> + <description> + <p> + Execute a single Ex command after all initialization has been performed. See + <t>initialization</t>. + </p> + + <p>This option can be specified multiple times.</p> + </description> +</item> + + +<item> + <tags>++cmd</tags> + <spec>++cmd <a>command</a></spec> + <description> + <p> + Execute a single Ex command before any initialization has been performed. See + <t>initialization</t>. + </p> + + <p>This option can be specified multiple times.</p> + </description> +</item> + + +<item> + <tags>+u</tags> + <spec>+u <a>rcfile</a></spec> + <description> + <p> + The file <a>rcfile</a> is used for user initialization commands. If <a>rcfile</a> is + "NORC" then no startup initialization is performed except for the loading of + plugins, i.e., steps 1. and 2. in <t>initialization</t> are skipped. If <a>rcfile</a> + is "NONE" then plugin loading is also skipped. + </p> + </description> +</item> + + +<item> + <tags>++noplugin</tags> + <spec>++noplugin</spec> + <description> + <p>Prevents plugin scripts from being loaded at startup. See <o>loadplugins</o>.</p> + </description> +</item> + + +<h2 tag="initialization startup">Initialization</h2> + +<p>At startup, &liberator.appname; completes the following tasks in order. </p> + +<ol> + <li> &liberator.appname; can perform user initialization commands. When + one of the following is successfully located, it is executed, + and no further locations are tried. + + <ol> + <li tag="$VIMPERATOR_INIT"> + <em>$VIMPERATOR_INIT</em> — May contain a single Ex command (e.g., + "<ex>:source <a>file</a></ex>"). + </li> + <li tag="$MY_VIMPERATORRC"> + <em>~/vimperatorrc</em> — Windows only. If this file exists, its contents + are executed and <em>$MY_VIMPERATORRC</em> set to its path. + </li> + <li> + <em>~/.vimperatorrc</em> — If this file exists, its contents are executed. + </li> + </ol> + </li> + <li> + If <o>exrc</o> is set and the +u command-line option was not + specified, then any RC file in the current directory is also + sourced. + </li> + <li> + All directories in <o>runtimepath</o> are searched for a + "plugin" subdirectory and all yet unloaded plugins are loaded. + For each plugin directory, all *.{js,vimp} files (including + those in further subdirectories) are sourced alphabetically. No + plugins will be sourced if: + + <ul> + <li><o>noloadplugins</o> is set.</li> + <li>the ++noplugin command-line option was specified.</li> + <li>the +u=NONE command-line option specified set.</li> + </ul> + + Any particular plugin will not be loaded if it has already been + loaded (e.g., by an earlier <ex>:loadplugins</ex> command). + </li> +</ol> + +The user's ~ (i.e., "home") directory is determined as follows: + +* On Unix and Mac, the environment variable <em>$HOME</em> is used. +* On Windows, &liberator.appname; checks for the existence of <em>%HOME%</em>, then +<em>%USERPROFILE%</em>, and then <em>%HOMEDRIVE%%HOMEPATH%</em>. It uses the first one +it finds. + +<h2 tag="save-settings">Saving settings</h2> + +<item> + <tags>:mkv :mkvimperatorrc</tags> + <spec>:mkv<oa>imperatorrc</oa><oa>!</oa> <oa>file</oa></spec> + <description> + <p> + Write current key mappings and changed options to <oa>file</oa>. If no + <oa>file</oa> is specified then <em>~/.vimperatorrc</em> is written unless this file + already exists. The special version <ex>:mkvimperatorrc!</ex> will overwrite + <oa>file</oa> if it exists. + </p> + + <p> + Warning: this differs from Vim's behavior which defaults to writing the file + in the current directory. + </p> + </description> +</item> + + +<h2 tag="restarting">Restarting</h2> + +<item> + <tags>:res :restart</tags> + <spec>:res<oa>tart</oa></spec> + <description> + <p>Force &liberator.host; to restart. Useful when installing extensions.</p> + </description> +</item> + + + +</document> +<!-- vim:se sts=4 sw=4 et: --> |