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

FUEL: README update.

db4
Jose A. Ortega Ruiz 2009-01-23 20:52:35 +01:00
parent 6e9f0dbfdd
commit b6b3e4fb54
1 changed files with 110 additions and 95 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

167
misc/fuel/README
View File

@ -1,4 +1,4 @@
FUEL, Factor's Ultimate Emacs Library -*- org -*- FUEL, Factor's Ultimate Emacs Library
------------------------------------- -------------------------------------
FUEL provides a complete environment for your Factor coding pleasure FUEL provides a complete environment for your Factor coding pleasure
@ -59,8 +59,7 @@ beast.
If you prefer to start Factor externally, you can also connect If you prefer to start Factor externally, you can also connect
remotely from Emacs. Here's how to proceed: remotely from Emacs. Here's how to proceed:
- In the factor listener, run FUEL: - In the factor listener, run FUEL: "fuel" run
"fuel" run
This will start a server listener in port 9000. This will start a server listener in port 9000.
- Switch to Emacs and issue the command 'M-x connect-to-factor'. - Switch to Emacs and issue the command 'M-x connect-to-factor'.
@ -69,7 +68,7 @@ beast.
*** Vocabulary creation *** Vocabulary creation
FUEL offers a basic interface with Factor's scaffolding utilities. FUEL offers a basic interface to Factor's scaffolding utilities.
To create a new vocabulary directory and associated files: To create a new vocabulary directory and associated files:
M-x fuel-scaffold-vocab M-x fuel-scaffold-vocab
@ -81,91 +80,107 @@ beast.
* 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 Commands in parenthesis can be invoked interactively with
- C-co : cycle between code, tests and docs factor files M-x <command>, not necessarily in a factor buffer.
- C-cs : switch to other factor buffer (M-x fuel-switch-to-buffer)
- C-cr : switch to listener and refresh all loaded vocabs
- C-x4s : switch to other factor buffer in other window
- C-x5s : switch to other factor buffer in other frame
- M-. : edit word at point in Emacs (see fuel-edit-word-method custom var) |-----------------+------------------------------------------------------------|
- M-, : go back to where M-. was last invoked | C-cz | switch to listener (run-factor) |
- M-TAB : complete word at point | C-co | cycle between code, tests and docs files |
- C-cC-eu : update USING: line | C-cr | switch to listener and refresh all loaded vocabs |
- C-cC-ev : edit vocabulary (M-x fuel-edit-vocabulary) | C-cs | switch to other factor buffer (fuel-switch-to-buffer) |
- C-cC-ew : edit word (M-x fuel-edit-word-at-point) | C-x4s | switch to other factor buffer in other window |
- C-cC-ed : edit word's doc (M-x fuel-edit-word-at-point) | C-x5s | switch to other factor buffer in other frame |
|-----------------+------------------------------------------------------------|
- C-cC-er : eval region | M-. | edit word at point in Emacs (fuel-edit-word) |
- C-M-r, C-cC-ee : eval region, extending it to definition boundaries | M-, | go back to where M-. was last invoked |
- C-M-x, C-cC-ex : eval definition around point | M-TAB | complete word at point |
- C-ck, C-cC-ek : run file | C-cC-eu | update USING: line (fuel-update-usings) |
| C-cC-ev | edit vocabulary (fuel-edit-vocabulary) |
- C-cC-da : toggle autodoc mode | C-cC-ew | edit word (fuel-edit-word-at-point) |
- C-cC-dd : help for word at point | C-cC-ed | edit word's doc (C-u M-x fuel-edit-word-doc-at-point) |
- C-cC-ds : short help word at point |-----------------+------------------------------------------------------------|
- C-cC-de : show stack effect of current sexp (with prefix, region) | C-cC-er | eval region |
- C-cC-dp : find words containing given substring (M-x fuel-apropos) | C-M-r, C-cC-ee | eval region, extending it to definition boundaries |
- C-cC-dv : show words in current file (with prefix, ask for vocab) | C-M-x, C-cC-ex | eval definition around point |
| C-ck, C-cC-ek | run file (fuel-run-file) |
- C-cM-<, C-cC-d< : show callers of word or vocabulary at point |-----------------+------------------------------------------------------------|
(M-x fuel-show-callers, M-x fuel-vocab-usage) | C-cC-da | toggle autodoc mode (fuel-autodoc-mode) |
- C-cM->, C-cC-d> : show callees of word or vocabulary at point | C-cC-dd | help for word at point (fuel-help) |
(M-x fuel-show-callees, M-x fuel-vocab-uses) | C-cC-ds | short help word at point (fuel-help-short) |
| C-cC-de | show stack effect of current sexp (with prefix, region) |
- C-cC-xs : extract innermost sexp (up to point) as a separate word | C-cC-dp | find words containing given substring (fuel-apropos) |
- C-cC-xr : extract region as a separate word | C-cC-dv | show words in current file (with prefix, ask for vocab) |
- C-cC-xi : replace word at point by its definition |-----------------+------------------------------------------------------------|
- C-cC-xv : extract region as a separate vocabulary | C-cM-<, C-cC-d< | show callers of word or vocabulary at point |
- C-cC-xw : rename all uses of a word | | (fuel-show-callers, fuel-vocab-usage) |
| C-cM->, C-cC-d> | show callees of word or vocabulary at point |
| | (fuel-show-callees, fuel-vocab-uses) |
|-----------------+------------------------------------------------------------|
| C-cC-xs | extract innermost sexp (up to point) as a separate word |
| | (fuel-refactor-extract-sexp) |
| C-cC-xr | extract region as a separate word |
| | (fuel-refactor-extract-region) |
| C-cC-xv | extract region as a separate vocabulary |
| | (fuel-refactor-extract-vocab) |
| C-cC-xi | replace word by its definition (fuel-refactor-inline-word) |
| C-cC-xw | rename all uses of a word (fuel-refactor-rename-word) |
|-----------------+------------------------------------------------------------|
*** In the listener: *** In the listener:
- TAB : complete word at point |------+----------------------------------------------------------|
- M-. : edit word at point in Emacs | TAB | complete word at point |
- C-cr : refresh all loaded vocabs | M-. | edit word at point in Emacs |
- C-ca : toggle autodoc mode | C-cr | refresh all loaded vocabs |
- C-cp : find words containing given substring (M-x fuel-apropos) | C-ca | toggle autodoc mode |
- C-cs : toggle stack mode | C-cp | find words containing given substring (M-x fuel-apropos) |
- C-cv : edit vocabulary | C-cs | toggle stack mode |
- C-ch : help for word at point | C-cv | edit vocabulary |
- C-ck : run file | C-ch | help for word at point |
| 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 |---------+-------------------------------------|
- <digit> : invoke nth restart | g | go to error |
- w/e/l : invoke :warnings, :errors, :linkage | <digit> | invoke nth restart |
- q : bury buffer | w/e/l | invoke :warnings, :errors, :linkage |
| q | bury buffer |
|---------+-------------------------------------|
*** In the help browser: *** In the help browser:
- h : help for word at point |-----------+----------------------------------------------------------|
- v : help for a vocabulary | h | help for word at point |
- a : find words containing given substring (M-x fuel-apropos) | v | help for a vocabulary |
- e : edit current article | a | find words containing given substring (M-x fuel-apropos) |
- ba : bookmark current page | e | edit current article |
- bb : display bookmarks | ba | bookmark current page |
- bd : delete bookmark at point | bb | display bookmarks |
- n/p : next/previous page | bd | delete bookmark at point |
- l : previous page | n/p | next/previous page |
- SPC/S-SPC : scroll up/down | l | previous page |
- TAB/S-TAB : next/previous link | SPC/S-SPC | scroll up/down |
- k : kill current page and go to previous or next | TAB/S-TAB | next/previous link |
- r : refresh page | k | kill current page and go to previous or next |
- c : clean browsing history | r | refresh page |
- M-. : edit word at point in Emacs | c | clean browsing history |
- C-cz : switch to listener | M-. | edit word at point in Emacs |
- q : bury buffer | C-cz | switch to listener |
| q | bury buffer |
|-----------+----------------------------------------------------------|
*** In crossref buffers *** In crossref buffers
- TAB/BACKTAB : navigate links |-----------------+-----------------------------|
- RET/mouse click : follow link | TAB/BACKTAB | navigate links |
- h : show help for word at point | RET/mouse click | follow link |
- q : bury buffer | h | show help for word at point |
| q | bury buffer |
|-----------------+-----------------------------|