steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

FUEL: README reformatted.

db4
Jose A. Ortega Ruiz 2009-01-04 15:59:54 +01:00
parent 4f6426bd40
commit 77d86b8550
1 changed files with 74 additions and 76 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
misc/fuel/README
View File

@ -1,15 +1,15 @@
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.
@ -31,8 +31,7 @@ inside Emacs, you can use instead:
(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.
@ -44,13 +43,12 @@ 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