summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README41
1 files changed, 25 insertions, 16 deletions
diff --git a/README b/README
index e86043c..72ba086 100644
--- a/README
+++ b/README
@@ -1,4 +1,4 @@
-ptyim, routes terminal input through an input method via pseudottys
+ptyim, routes terminal input through an input method via pseudottys.
Installation:
$ make
@@ -14,6 +14,9 @@ Shell:
Controls:
'^K' (0x0B Vertical Tab) to toggle input method
'`' (0x80 Backtick) cancel input
+ '^[^[' (0x1B ESC) x 2 cancel input
+ *note: This will send 1 escape to the running program in
+ *addition to cancelling im input
Backspace (0x7F DEL) delete last input char
Enter (0x0D Carriage Retrun) pass the im buffer through
@@ -23,24 +26,29 @@ Configuration:
IM_PREVIEW and IM_PREVIEW_ENTRIES in "im.h" sets the number of preview
entries displayed and or disables previews entirely
- im_key_ranges in "im.h" determines which characters are put into the im
- buffer
+ im_key_ranges and im_selector_ranges in "im.h" determines which
+ characters are put into the im buffer
#include boshiamy.h in "im.h" can be replaced with any other im file you
would like to use. Refer to imtable.h for format questions.
--------------------------------=[How it Works]=--------------------------------
+ptyim allows for an input method to be used without any sort of desktop
+environment. All it requires is a terminal, even a physical terminal
+(given it can display the characters being used)
-[xterm, linux console]
- user | ^ Program
- input v | output
-[ ptyim ]
- IM | ^ Program
- output v | Output
-[ pseudoterminal ]
- stdin | ^
- v |stdout
-[bash(session leader)]
+ptyim ibus/fcitx whatever
+
+[xterm, linux console] [x11,wayland ]
+ user | ^ Program |
+ input v | output v keypresses
+[ ptyim ] vs. [ fcitx, ibus ]
+ IM | ^ Program | IM
+ output v | Output v output
+[ pseudoterminal ] [xterm ]
+ stdin | ^ stdin | ^
+ v |stdout v | stdout
+[bash(session leader)] [bash ]
Terminal Emulators, Tmux, Screen, etc. all make use of linux pseudoterminals,
@@ -85,11 +93,12 @@ vitetris
telnet
towel.blinkenlights.nl
ranger
- pageup/pagedown does not work when the im is turned on
vim
- If the im is turned on, it will start in vreplace mode
+less
+ sometimes im preview is inserted in the middle of less output
TODO:
- Smarter handling of escape code sequences to fix the above
+ mutex of output to only display the im when the program is finished
+ writing to the terminal
------------------------------=[Acknowledgements]=------------------------------
I would like to thank jdh8 on github for creating the ibus-table format boshiamy
file I used to make boshiamy.h