|
29 | 29 | * [TLS/SSL](https://en.m.wikipedia.org/wiki/Transport_Layer_Security) protocol capable (via external TLS utilities).
|
30 | 30 | * Full chat history logging.
|
31 | 31 | * Multi-channel joining at server connection.
|
32 |
| -* Simple shortcut commands and full support for all IRC commands in the [RFC 2812](https://tools.ietf.org/html/rfc2812) standard: |
33 |
| - |
34 |
| -```shell |
35 |
| -<message> Send a PRIVMSG to the current channel. |
36 |
| -@<channel|nick> <message> Send a message to a specified channel or nick |
37 |
| -/<command> Send command to IRC server (see RFC 2812 for full list). |
38 |
| -/#<channel> Assign new default message channel. |
39 |
| -/? Print current message channel. |
40 |
| -``` |
41 |
| - |
| 32 | +* Simple command aliases and full support for all [RFC 2812](https://tools.ietf.org/html/rfc2812) commands. |
42 | 33 | * Color scheme definition via [ANSI 8-bit colors](https://en.wikipedia.org/wiki/ANSI_escape_code), allowing for uniform color definition across all shell applications.
|
43 | 34 |
|
44 | 35 | ## Installation & Usage
|
@@ -75,6 +66,26 @@ Consult `man kirc` for a full list and explanation of available `kirc` arguments
|
75 | 66 | kirc [-s hostname] [-p port] [-c channels] [-n nickname] [-r realname] [-u username] [-k password] [-a token] [-x command] [-w nick_width] [-o logfile] [-e|v|V]
|
76 | 67 | ```
|
77 | 68 |
|
| 69 | +### Command Aliases |
| 70 | + |
| 71 | +```shell |
| 72 | +<message> Send a PRIVMSG to the current channel. |
| 73 | +@<channel|nick> <message> Send a message to a specified channel or nick |
| 74 | +/<command> Send command to IRC server (see RFC 2812 for full list). |
| 75 | +/#<channel> Assign new default message channel. |
| 76 | +/? Print current message channel. |
| 77 | +``` |
| 78 | + |
| 79 | +### User Input Key Bindings |
| 80 | + |
| 81 | +* **CTRL+B** or **LEFT ARROW** moves the cursor one character to the left. |
| 82 | +* **CTRL+F** or **RIGHT ARROW** moves the cursor one character to the right. |
| 83 | +* **CTRL+A** moves the cursor to the end of the line. |
| 84 | +* **CTRL+E** or **HOME** moves the cursor to the start of the line. |
| 85 | +* **CTRL+W** deletes the previous word. |
| 86 | +* **CTRL+U** deletes the entire line. |
| 87 | +* **CTRL+K** deletes the from current character to end of line. |
| 88 | + |
78 | 89 | ## Transport Layer Security (TLS) Support
|
79 | 90 |
|
80 | 91 | There is no native TLS/SSL support. Instead, users can achieve this functionality by using third-party utilities (e.g. stunnel, [socat](https://linux.die.net/man/1/socat), ghosttunnel, etc).
|
@@ -154,10 +165,6 @@ Applying a new color scheme is easy! One of the quickest ways is to use an appli
|
154 | 165 | * **KISS** is an acronym for [Keep It Simple Stupid](https://en.wikipedia.org/wiki/KISS_principle), which is a design principle noted by the U.S. Navy in 1960s. The KISS principle states that most systems work best if they are kept simple rather than made complicated; therefore, simplicity should be a key goal in design, and unnecessary complexity should be avoided.
|
155 | 166 | * **POSIX** is an acronym for [Portable Operating System Interface](https://opensource.com/article/19/7/what-posix-richard-stallman-explains), which is a family of standards specified by the IEEE Computer Society for maintaining compatibility between operating systems. The *C99* Standard is preferred over other versions (e.g. *C89* or *C11*) since this currently the only one specified by [POSIX](https://pubs.opengroup.org/onlinepubs/9699919799/utilities/c99.html).
|
156 | 167 |
|
157 |
| -## Known Bugs |
158 |
| - |
159 |
| -Some users may experience abnormal *BACKSPACE* key press behavior, particularly when trying to return to a previous line being editted. This has been confirmed to be an [upstream issue](https://github.com/mcpcpc/kirc/issues/39) and has been reported accordingly to the known impacted terminal emulators. While we wait for the upstream fixes, I would recommend using [urxvt](https://wiki.archlinux.org/index.php/Rxvt-unicode) or a terminal multiplexer (such as [screen](https://www.gnu.org/software/screen/) or [tmux](https://github.com/tmux/tmux/wiki)), which seemed to have resolved this by setting the [terminfo](https://osr507doc.sco.com/en/man/html.M/terminfo.M.html) `<bw>` flag as default. Alternatively, you can try to set terminfo `<bw>` flag manually by passing the command escape sequence `echo -e "\x1b[?45h"` or using the *tputs* function before starting *kirc*. |
160 |
| - |
161 | 168 | ## Contact
|
162 | 169 |
|
163 | 170 | For any further questions or concerns, feel free to reach out to me, [mcpcpc](https://github.com/mcpcpc), on `#kirc`
|
|
0 commit comments