README (1575B)
1sob 2=== 3 4Simple output bar. 5 6 7Dependencies 8------------ 9 10- C compiler 11- libc 12 13 14Features 15-------- 16 17- Small (in size and memory), not much dependencies. 18- UTF-8 input and output support. 19 - Support for characters that are bigger than 1 column. 20- Custom prompt (including color support). 21- Easy to write custom completion scripts or special actions. 22- Custom action on SIGWINCH (window resize). 23- Familiar and customizable keybinds (in config.h). 24- Example scripts for: 25 - History list. 26 - Nickname completion (for IRC). 27 - Word completion. 28 - Yank line (xsel). 29 30 31Install 32------- 33 34 $ make 35 # make install 36 37optionally copy the scripts from the scripts/ directory to: 38"$HOME/.sob/scripts/". 39 40 41Usage 42----- 43 44 printf 'initial input' | sob -p 'Prompt: ' > file 45 46the interface will be printed to stderr (fd 2), the input will be printed to 47stdout (fd 1). 48 49Sob will interpret the "initial input" as keys so the keybinds in config.h 50will work. For example: 51 52 printf 'hai\x01' | sob > /dev/null 53 54Will have the initial input "hai" and move the cursor to the beginning of the 55line (\x01 is Ctrl-a). 56 57 58Scripting 59--------- 60 61Sob will write to the process stdin using a pipe. What it writes depends on 62the context. It can be the current word (line_wordpipeto) or line (line_pipeto). 63 64Environment variables set for scripts (see config.h): 65 66$SOBLINE the current text of the line. 67$SOBWRITE the string also written to the process stdin. 68 69 70Author 71------ 72 73Hiltjo Posthuma <hiltjo@codemadness.org>, don't hesitate to contact me for 74bug reports or patches! 75 76 77License 78------- 79ISC, see LICENSE file.