|
| 1 | +# kirc |
| 2 | + |
| 3 | +kirc (KISS for IRC) is a tiny IRC client written in POSIX C99. |
| 4 | + |
| 5 | +## Installation |
| 6 | + |
| 7 | +Building and installing from source: |
| 8 | + |
| 9 | + git clone https://github.com/mcpcpc/kirc |
| 10 | + cd kirc |
| 11 | + make |
| 12 | + make install |
| 13 | + |
| 14 | +## Usage |
| 15 | + |
| 16 | +Consult `man kirc` for a full list and explanation of available arguments. |
| 17 | + |
| 18 | + kirc [-s hostname] [-p port] [-c channels] [-n nickname] [-r realname] |
| 19 | + [-u username] [-k password] [-a token] [-o logfile] [-e|x|v|V] |
| 20 | + |
| 21 | +## Command Aliases |
| 22 | + |
| 23 | + <message> send PRIVMSG to the current channel. |
| 24 | + @<channel|nick> <message> send PRIVMSG to a specified channel or nick. |
| 25 | + @@<channel|nick> <message> send CTCP ACTION message to a specified channel |
| 26 | + or nick (if no channel or nick is specified, the |
| 27 | + message will be sent to the default channel). |
| 28 | + /<command> send command to the IRC server (see RFC 2812). |
| 29 | + /#<channel> assign new default message channel. |
| 30 | + |
| 31 | +## Key Bindings |
| 32 | + |
| 33 | + CTRL+B or LEFT ARROW move the cursor one character to the left. |
| 34 | + CTRL+F or RIGHT ARROW move the cursor one character to the right. |
| 35 | + CTRL+P or UP ARROW move to previous record in the input history buffer. |
| 36 | + CTRL+N or DOWN ARROW move to next record in the input history buffer. |
| 37 | + CTRL+E move the cursor to the end of the line. |
| 38 | + CTRL+A or HOME move the cursor to the start of the line. |
| 39 | + CTRL+W delete the previous word. |
| 40 | + CTRL+U delete the entire line. |
| 41 | + CTRL+K delete the from current character to end of line. |
| 42 | + CTRL+D delete the character to the right of cursor. |
| 43 | + CTRL+C force quit kirc. |
| 44 | + CTRL+T swap character at cursor with previous character. |
| 45 | + CTRL+H equivalent to backspace. |
| 46 | + |
| 47 | +## Support Documentation |
| 48 | + |
| 49 | +Please refer to the [official homepage](http://kirc.io/docs.html) for examples, |
| 50 | +troubleshooting and use cases. |
| 51 | + |
| 52 | +## Contact |
| 53 | + |
| 54 | +For any further questions or concerns, feel free to send me an |
| 55 | +[email](michaelczigler[at]mcpcpc[dot]com). |
0 commit comments