Skip to content

Commit cb459a3

Browse files
authored
0.1.4 (#54)
* cleanup style * remove keyboard_hit() function * integrate kline input hander * add new input indicators * only use edit function * improve function names * fix input printing * fix new line behavior after user input * fix /? command * remove Known Bugs, add commands * add arrow key information * remove left and right brackets around commands * add missing language fence * fix typo * remove duplicate ioctl instance * Update README.md * Update README.md * fix direct message color * Delete example2.png * Delete example.png * remove extra line * fix line printing * more cleanup and better colors * refactor Co-authored-by: Michael Czigler <[email protected]>
1 parent 35dc8dc commit cb459a3

File tree

4 files changed

+389
-90
lines changed

4 files changed

+389
-90
lines changed

.github/example.png

-657 KB
Binary file not shown.

.github/example2.png

-942 KB
Binary file not shown.

README.md

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -29,16 +29,7 @@
2929
* [TLS/SSL](https://en.m.wikipedia.org/wiki/Transport_Layer_Security) protocol capable (via external TLS utilities).
3030
* Full chat history logging.
3131
* 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.
4233
* 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.
4334

4435
## Installation & Usage
@@ -75,6 +66,26 @@ Consult `man kirc` for a full list and explanation of available `kirc` arguments
7566
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]
7667
```
7768

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+
7889
## Transport Layer Security (TLS) Support
7990

8091
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
154165
* **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.
155166
* **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).
156167

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-
161168
## Contact
162169

163170
For any further questions or concerns, feel free to reach out to me, [mcpcpc](https://github.com/mcpcpc), on `#kirc`

0 commit comments

Comments
 (0)