FUEL: README reformatted.
parent
4f6426bd40
commit
77d86b8550
|
@ -1,56 +1,54 @@
|
||||||
FUEL, Factor's Ultimate Emacs Library
|
FUEL, Factor's Ultimate Emacs Library -*- org -*-
|
||||||
-------------------------------------
|
-------------------------------------
|
||||||
|
|
||||||
FUEL provides a complete environment for your Factor coding pleasure
|
FUEL provides a complete environment for your Factor coding pleasure
|
||||||
inside Emacs, including source code edition and interaction with a
|
inside Emacs, including source code edition and interaction with a
|
||||||
Factor listener instance running within Emacs.
|
Factor listener instance running within Emacs.
|
||||||
|
|
||||||
FUEL was started by Jose A Ortega as an extension to Ed Cavazos'
|
FUEL was started by Jose A Ortega as an extension to Eduardo Cavazos'
|
||||||
original factor.el code.
|
original factor.el code. Eduardo is also responsible of naming the
|
||||||
|
beast.
|
||||||
|
|
||||||
Installation
|
* Installation
|
||||||
------------
|
|
||||||
|
|
||||||
FUEL comes bundled with Factor's distribution. The folder misc/fuel
|
FUEL comes bundled with Factor's distribution. The folder misc/fuel
|
||||||
contains Elisp code, and there's a fuel vocabulary in extras/fuel.
|
contains Elisp code, and there's a fuel vocabulary in extras/fuel.
|
||||||
|
|
||||||
To install FUEL, either add this line to your Emacs initialisation:
|
To install FUEL, either add this line to your Emacs initialisation:
|
||||||
|
|
||||||
(load-file "<path/to/factor/installation>/misc/fuel/fu.el")
|
(load-file "<path/to/factor/installation>/misc/fuel/fu.el")
|
||||||
|
|
||||||
or
|
or
|
||||||
|
|
||||||
(add-to-list load-path "<path/to/factor/installation>/fuel")
|
(add-to-list load-path "<path/to/factor/installation>/fuel")
|
||||||
(require 'fuel)
|
(require 'fuel)
|
||||||
|
|
||||||
If all you want is a major mode for editing Factor code with pretty
|
If all you want is a major mode for editing Factor code with pretty
|
||||||
font colors and indentation, without running the factor listener
|
font colors and indentation, without running the factor listener
|
||||||
inside Emacs, you can use instead:
|
inside Emacs, you can use instead:
|
||||||
|
|
||||||
(add-to-list load-path "<path/to/factor/installation>/fuel")
|
(add-to-list load-path "<path/to/factor/installation>/fuel")
|
||||||
(setq factor-mode-use-fuel nil)
|
(setq factor-mode-use-fuel nil)
|
||||||
(require 'factor-mode)
|
(require 'factor-mode)
|
||||||
|
|
||||||
Basic usage
|
* Basic usage
|
||||||
-----------
|
|
||||||
|
|
||||||
If you're using the default factor binary and images locations inside
|
If you're using the default factor binary and images locations inside
|
||||||
the Factor's source tree, that should be enough to start using FUEL.
|
the Factor's source tree, that should be enough to start using FUEL.
|
||||||
Editing any file with the extension .factor will put you in
|
Editing any file with the extension .factor will put you in
|
||||||
factor-mode; try C-hm for a summary of available commands.
|
factor-mode; try C-hm for a summary of available commands.
|
||||||
|
|
||||||
To start the listener, try M-x run-factor.
|
To start the listener, try M-x run-factor.
|
||||||
|
|
||||||
Many aspects of the environment can be customized:
|
Many aspects of the environment can be customized:
|
||||||
M-x customize-group fuel will show you how many.
|
M-x customize-group fuel will show you how many.
|
||||||
|
|
||||||
Quick key reference
|
* Quick key reference
|
||||||
-------------------
|
|
||||||
|
|
||||||
(Triple chords ending in a single letter <x> accept also C-<x> (e.g.
|
(Triple chords ending in a single letter <x> accept also C-<x> (e.g.
|
||||||
C-cC-eC-r is the same as C-cC-er)).
|
C-cC-eC-r is the same as C-cC-er)).
|
||||||
|
|
||||||
* In factor source files:
|
*** In factor source files:
|
||||||
|
|
||||||
- C-cz : switch to listener
|
- C-cz : switch to listener
|
||||||
- C-co : cycle between code, tests and docs factor files
|
- C-co : cycle between code, tests and docs factor files
|
||||||
|
@ -76,7 +74,7 @@ C-cC-eC-r is the same as C-cC-er)).
|
||||||
- C-cM-<, C-cC-d< : show callers of word at point
|
- C-cM-<, C-cC-d< : show callers of word at point
|
||||||
- C-cM->, C-cC-d> : show callees of word at point
|
- C-cM->, C-cC-d> : show callees of word at point
|
||||||
|
|
||||||
* In the listener:
|
*** In the listener:
|
||||||
|
|
||||||
- TAB : complete word at point
|
- TAB : complete word at point
|
||||||
- M-. : edit word at point in Emacs
|
- M-. : edit word at point in Emacs
|
||||||
|
@ -87,14 +85,14 @@ C-cC-eC-r is the same as C-cC-er)).
|
||||||
- C-ch : help for word at point
|
- C-ch : help for word at point
|
||||||
- C-ck : run file
|
- C-ck : run file
|
||||||
|
|
||||||
* In the debugger (it pops up upon eval/compilation errors):
|
*** In the debugger (it pops up upon eval/compilation errors):
|
||||||
|
|
||||||
- g : go to error
|
- g : go to error
|
||||||
- <digit> : invoke nth restart
|
- <digit> : invoke nth restart
|
||||||
- w/e/l : invoke :warnings, :errors, :linkage
|
- w/e/l : invoke :warnings, :errors, :linkage
|
||||||
- q : bury buffer
|
- q : bury buffer
|
||||||
|
|
||||||
* In the Help browser:
|
*** In the Help browser:
|
||||||
|
|
||||||
- h : help for word at point
|
- h : help for word at point
|
||||||
- a : find words containing given substring (M-x fuel-apropos)
|
- a : find words containing given substring (M-x fuel-apropos)
|
||||||
|
@ -109,7 +107,7 @@ C-cC-eC-r is the same as C-cC-er)).
|
||||||
- C-cz : switch to listener
|
- C-cz : switch to listener
|
||||||
- q : bury buffer
|
- q : bury buffer
|
||||||
|
|
||||||
* In crossref buffers
|
*** In crossref buffers
|
||||||
|
|
||||||
- TAB/BACKTAB : navigate links
|
- TAB/BACKTAB : navigate links
|
||||||
- RET/mouse click : follow link
|
- RET/mouse click : follow link
|
||||||
|
|
Loading…
Reference in New Issue