5. Installation and customization

Once you've unpacked the archive, you need to make sure that the file `light.el' is in your emacs load-path. Then put

(require 'light)

in your `.emacs' file. Restart emacs; then you can set all of the lightning completion options via customization: run

M-x customize-group lightning-completion

5.1 Customizable options

A list of customizable options

5.1 Customizable options

Here is a list of the customizable options for lightning completion, with pointers to relevant sections of this documentation. Use this command:

M-x customize-group lightning-completion

to customize any of these options.

lc-complete-idle-time-default

Default value: 0.5. Effect: when in lightning completion mode, after this much idle time (in seconds) has elapsed, try to complete. See section 1. Overview, See section 3. Key bindings.

toggle-lightning-completion

Default value: off. Effect: toggle whether lightning completion is potentially active in the minibuffer. If on, you should customize lightning-completion-list to specify contexts in which to use lightning completion. See section 4.1 Enabling automatic lightning completion.

lightning-completion-list

Default value: all off. Effect: toggle lightning completion in, and specify the idle-time for, specific contexts: files, functions, commands, variables, user variables, lisp objects, info menu items, buffer names, query replace, miscellany. See section 4.1 Enabling automatic lightning completion.

lc-clean-up

Default value: nil. Effect: If on, when there is no valid completion, remove the invalid characters. If off, just give warning when no valid completion. See section 3. Key bindings.

lc-ignored-file-extensions

Default value: equal to completion-ignored-extensions. Description: a list of strings like ".dvi" and ".o"; files ending in these strings are ignored when doing lightning completion on file names. See section 6.1 Ignoring some files.

lc-dark-commands

Default value: nil. Description: list of commands for which lightning completion is disabled. See section 4.2 Settings for lightning completion.

lc-dark-recursive-minibufs

Default value: nil. Effect: If a number N, then don't use lightning completion when recursion-depth is bigger than N. If nil, then no restrictions on when to use lightning completion. See section 4.2 Settings for lightning completion.

lc-override-flag

Default value: nil. Effect: If non-nil, override other local maps when using lightning completion. You may want to turn this on if using outline mode or some other minor mode which uses C-c as prefix. This may not be necessary, though.

lc-keep-key

Default value: SPC. Description: Key to keep current completion in lightning completion mode. See section 3. Key bindings.

lc-del-key

Default value: DEL. Description: Key to delete last completion unit in lightning completion mode. See section 3. Key bindings.

lc-stop-key

Default value: C-c. Description: Key to exit lightning completion mode. See section 3. Key bindings.

lc-quote-key

Default value: C-q. Description: Key to quote next character in lightning completion mode. See section 3. Key bindings.

lc-help-key

Default value: C-h. Description: Help key in lightning completion mode. See section 3. Key bindings.

lc-cycle-key

Default value: C-f. Description: Key to cycle to next completion in lightning completion mode. See section 3. Key bindings.

lc-back-cycle-key

Default value: C-b. Description: Key to cycle to previous completion in lightning completion mode. See section 3. Key bindings.

lc-display-key

Default value: TAB. Description: Key to display all completions in lightning completion mode. See section 3. Key bindings.

lc-ctrl-x-c-is-completion

Default value: nil. Effect: if on, C-x c is the prefix key for the various lightning completion commands. See section 2. Completion functions.

lc-ctrl-backslash-completes-a-la-mode

Default value: nil. Effect: if on, C-\ runs the function completing-insert-according-to-mode. See section 2. Completion functions.