[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/inf-ruby 9f0cea55f0 073/265: Extend usage section
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/inf-ruby 9f0cea55f0 073/265: Extend usage section |
Date: |
Sat, 9 Jul 2022 21:59:15 -0400 (EDT) |
branch: elpa/inf-ruby
commit 9f0cea55f0999fec01695fb4c462d8a9aac1c52a
Author: Bozhidar Batsov <bozhidar@tradeo.com>
Commit: Bozhidar Batsov <bozhidar@tradeo.com>
Extend usage section
---
README.md | 27 ++++++++++++++++++++++++++-
1 file changed, 26 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index d0164ec660..2ad32430cd 100644
--- a/README.md
+++ b/README.md
@@ -89,7 +89,32 @@ Prelude user you can start using it right away.
## Usage
-You can fire up a REPL from everywhere with <kbd>M-x inf-ruby</kbd>.
+A Ruby process can be fired up with <kbd>M-x inf-ruby</kbd>.
+
+Customization: When entered, this mode runs `comint-mode-hook` and
+`inf-ruby-mode-hook` (in that order).
+
+You can send text to the inferior ruby process from other buffers containing
+Ruby source.
+
+* `ruby-switch-to-inf` switches the current buffer to the ruby process buffer.
+* `ruby-send-definition` sends the current definition to the ruby process.
+* `ruby-send-region` sends the current region to the ruby process.
+* `ruby-send-definition-and-go' and `ruby-send-region-and-go` switch to the
ruby process buffer after sending their text.
+
+Commands:
+
+* Return after the end of the process' output sends the text from the
+end of process to point.
+* Return before the end of the process' output copies the sexp ending at point
+to the end of the process' output, and sends it.
+* Delete converts tabs to spaces as it moves back.
+* Tab indents for ruby; with argument, shifts rest
+of expression rigidly with the current line.
+* <kbd>C-M-q</kbd> does <kbd>Tab</kbd> on each line starting within following
expression.
+* Paragraphs are separated only by blank lines. `#`start comments.
+* If you accidentally suspend your process, use
+`comint-continue-subjob` to continue it.
### Keymap
- [nongnu] elpa/inf-ruby 98fac55a80 049/265: Define inf-ruby-switch-from-compilation, (continued)
- [nongnu] elpa/inf-ruby 98fac55a80 049/265: Define inf-ruby-switch-from-compilation, ELPA Syncer, 2022/07/09
- [nongnu] elpa/inf-ruby fc1dffaeed 052/265: inf-ruby-prompt-format: Include debugger prompt, ELPA Syncer, 2022/07/09
- [nongnu] elpa/inf-ruby ebceb38165 058/265: inf-ruby-prompt-format: Fix not to match single operator chars, ELPA Syncer, 2022/07/09
- [nongnu] elpa/inf-ruby c749e54eee 063/265: Support Bond completion, ELPA Syncer, 2022/07/09
- [nongnu] elpa/inf-ruby b12e05a6bb 068/265: Add funtion switching to compilation mode., ELPA Syncer, 2022/07/09
- [nongnu] elpa/inf-ruby 8fe1c3d80a 061/265: Bump the version, ELPA Syncer, 2022/07/09
- [nongnu] elpa/inf-ruby a6daf44f67 067/265: Changed 'bundle exec irb' to 'bundle console', ELPA Syncer, 2022/07/09
- [nongnu] elpa/inf-ruby b767d52caf 066/265: inf-ruby-console-gem: Pass -r arguments in the bundle exec case, too, ELPA Syncer, 2022/07/09
- [nongnu] elpa/inf-ruby d18e63e44e 102/265: Not real need for the third argument, ELPA Syncer, 2022/07/09
- [nongnu] elpa/inf-ruby 3a68ee2bb1 086/265: Touch up docstrings, change the signatures of inf-ruby-complete[-or-tab], ELPA Syncer, 2022/07/09
- [nongnu] elpa/inf-ruby 9f0cea55f0 073/265: Extend usage section,
ELPA Syncer <=
- [nongnu] elpa/inf-ruby 870e27f1ee 125/265: Detect pry gem in case to run bundle exec pry., ELPA Syncer, 2022/07/09
- [nongnu] elpa/inf-ruby 6c85470ce4 110/265: inf-ruby-implementations: use '--noreadline', ELPA Syncer, 2022/07/09
- [nongnu] elpa/inf-ruby 524a86c90b 089/265: Set PAGER locally unless it's set, fixes #33, ELPA Syncer, 2022/07/09
- [nongnu] elpa/inf-ruby 2d65630b7d 100/265: Introduce `ruby-switch-to-last-ruby-buffer', ELPA Syncer, 2022/07/09
- [nongnu] elpa/inf-ruby 2cb21b9f58 090/265: Make PAGER override unconditional, ELPA Syncer, 2022/07/09
- [nongnu] elpa/inf-ruby 23929579a6 124/265: Merge pull request #57 from bbatsov/compilation-warnings, ELPA Syncer, 2022/07/09
- [nongnu] elpa/inf-ruby e4cf0593da 116/265: inf-ruby-console-gem: require the main file if it exists, ELPA Syncer, 2022/07/09
- [nongnu] elpa/inf-ruby 27acc75257 113/265: inf-ruby-console-rails: prompt for the environment, ELPA Syncer, 2022/07/09
- [nongnu] elpa/inf-ruby 0697315485 109/265: Merge pull request #52 from abicky/support-dir-without-traiing-slash, ELPA Syncer, 2022/07/09
- [nongnu] elpa/inf-ruby 451aa1d858 145/265: Merge pull request #71 from jasonko/master, ELPA Syncer, 2022/07/09