emacs-elpa-diffs
[Top][All Lists]
Advanced

[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
 



reply via email to

[Prev in Thread] Current Thread [Next in Thread]