README - sob - simple output bar
 (HTM) git clone git://git.codemadness.org/sob
 (DIR) Log
 (DIR) Files
 (DIR) Refs
 (DIR) README
 (DIR) LICENSE
       ---
       README (1575B)
       ---
            1 sob
            2 ===
            3 
            4 Simple output bar.
            5 
            6 
            7 Dependencies
            8 ------------
            9 
           10 - C compiler
           11 - libc
           12 
           13 
           14 Features
           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 
           31 Install
           32 -------
           33 
           34         $ make
           35         # make install
           36 
           37 optionally copy the scripts from the scripts/ directory to:
           38 "$HOME/.sob/scripts/".
           39 
           40 
           41 Usage
           42 -----
           43 
           44         printf 'initial input' | sob -p 'Prompt: ' > file
           45 
           46 the interface will be printed to stderr (fd 2), the input will be printed to
           47 stdout (fd 1).
           48 
           49 Sob will interpret the "initial input" as keys so the keybinds in config.h
           50 will work. For example:
           51 
           52         printf 'hai\x01' | sob > /dev/null
           53 
           54 Will have the initial input "hai" and move the cursor to the beginning of the
           55 line (\x01 is Ctrl-a).
           56 
           57 
           58 Scripting
           59 ---------
           60 
           61 Sob will write to the process stdin using a pipe. What it writes depends on
           62 the context. It can be the current word (line_wordpipeto) or line (line_pipeto).
           63 
           64 Environment 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 
           70 Author
           71 ------
           72 
           73 Hiltjo Posthuma <hiltjo@codemadness.org>, don't hesitate to contact me for
           74 bug reports or patches!
           75 
           76 
           77 License
           78 -------
           79 ISC, see LICENSE file.