starting.xml

starting
Starting Pentadactyl

Contents

  1. Command-line options
  2. Initialization
  3. Saving settings
  4. Restarting

startup-options
Command-line options

Command-line options can be passed to Pentadactyl via the -pentadactyl Firefox option. These are passed as single string argument. E.g., firefox -pentadactyl ++cmd 'set exrc' +u 'tempRcFile' ++noplugin

+c
+c {command}

Execute a single Ex command after all initialization has been performed. See initialization.

This option can be specified multiple times.

++cmd
++cmd {command}

Execute a single Ex command before any initialization has been performed. See initialization.

This option can be specified multiple times.

+u
+u {rcfile}

The file {rcfile} is used for user initialization commands. If {rcfile} is NORC then no startup initialization is performed except for the loading of plugins, i.e., steps 1. and 2. in initialization are skipped. If {rcfile} is NONE then plugin loading is also skipped.

++noplugin
++noplugin

Prevents plugin scripts from being loaded at startup. See 'loadplugins'.

initializationstartup
Initialization

At startup, Pentadactyl completes the following tasks in order.

  1. Pentadactyl first searches for user initialization commands in the following locations. The first of these to be found is executed, after which no further locations are searched.

    1. $PENTADACTYL_INIT
      $PENTADACTYL_INIT
      May contain a single Ex command (e.g., ":source {file}").
    2. $MY_PENTADACTYLRC
      ~/_pentadactylrc
      Windows only. If this file exists, its contents are executed and $MY_PENTADACTYLRC set to its path.
    3. pentadactylrc
      ~/.pentadactylrc
      If this file exists, its contents are executed.

  2. If 'exrc' is set and the +u command-line option was not specified, then any RC file in the current directory is also sourced.

  3. All directories in 'runtimepath' are searched for a ‘plugins’ subdirectory and all yet unloaded plugins are loaded. For each plugins directory, all *.{js,penta} files (including those in further subdirectories) are sourced alphabetically. No plugins will be sourced if,

    Any plugin which was already loaded (e.g., by an earlier invocation of the :loadplugins command) will be skipped.

The user's home directory is determined as follows:

save-settings
Saving settings

:mkp:mkpentadactylrc
:mkp[entadactylrc][!] [file]

Write current key mappings and changed options to [file]. If no [file] is specified then ~/.pentadactylrc is written unless this file already exists. The special version :mkpentadactylrc! will overwrite [file] if it exists.

Warning: This behavior differs differs from that of Vim, which defaults to writing the file in the current directory.

restarting
Restarting

:reh:rehash
:reh[ash] [arg] …

Reload the Pentadactyl 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.

Any arguments supplied are parsed as command-line arguments as specified in startup-options.

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.

:res:restart
:res[tart]

Force Firefox to restart. Useful when installing extensions.