Skip to content

Commit

Permalink
0.1.9 (#79)
Browse files Browse the repository at this point in the history
* cleanup

* cleanup

* add commands to readme

* add CTRL+H

* handUserInput: change else-if to switch

* add ? back into to optarg

* add comments

* add CTCP ACTION

* CTCP: add VERSION, CLIENTINFO, and PING support

* CTCP: add TIME

* version: bump to 0.1.9

* remove -w argument

* change: static to dynamic nick width

* man page: remove -w argument

* change: : NIC_MIN to NIC_MAX

* version: add copyright info

* main: remove return(0) after -v

* handleUserInput: remove last printf

* remove media from master branch

* README: add CTCP to features

* README: add TLS definition

* fix: CTCP TIME command

* rawParser: fix for channel name not printing

* rawParser: refactor

* handleUserInput: add CTCP ACTION alias

* handleUserInput: fix spacing

* messageWrap: change strlen to strnlen

* raw: replace strlen with strnlen

* paramPrintPriv: new ACTION message color

* fix ACTION message indicator

* README: add CPCT ACTION command

Co-authored-by: Michael Czigler <mcpcpc@users.noreply.github.com>
  • Loading branch information
mcpcpc and mcpcpc authored Oct 28, 2020
1 parent 25986a3 commit bcab03c
Show file tree
Hide file tree
Showing 5 changed files with 208 additions and 132 deletions.
Binary file removed .github/kirc.png
Binary file not shown.
Binary file removed .github/tty.gif
Binary file not shown.
25 changes: 15 additions & 10 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
-->

<h3 align="center">
<img src="https://raw.githubusercontent.com/mcpcpc/kirc/master/.github/kirc.png" alt="kirc" height="170px">
<img src="https://raw.githubusercontent.com/mcpcpc/kirc/gh-pages/kirc.png" alt="kirc" height="170px">
</h3>

<p align="center">KISS for IRC, a tiny IRC client written in POSIX C99.</p>
Expand All @@ -19,16 +19,17 @@
</p>

<p align="center">
<img src=".github/tty.gif" width="550">
<img src="https://raw.githubusercontent.com/mcpcpc/kirc/gh-pages/tty.gif" width="550">
</p>

## Features

* Excellent cross-platform compatibility.
* Asynchronous user input and server messager handling.
* No dependencies other than a C99 compiler.
* Native SASL PLAIN and EXTERNAL authentication support.
* TLS/SSL protocol capable (via external TLS utilities).
* Simple Authentication and Security Layer (SASL) procotol support.
* Client-to-client protocol (CTCP) support.
* Transport Layer Security (TLS) protocol support (via external utilities).
* Full chat history logging.
* Multi-channel joining at server connection.
* Simple command aliases and full support for all RFC 2812 commands.
Expand Down Expand Up @@ -65,16 +66,17 @@ make install
Consult `man kirc` for a full list and explanation of available `kirc` arguments.

```shell
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]
kirc [-s hostname] [-p port] [-c channels] [-n nickname] [-r realname] [-u username] [-k password] [-a token] [-x command] [-o logfile] [-e|v|V]
```

### Command Aliases

```shell
<message> Send a PRIVMSG to the current channel.
@<channel|nick> <message> Send a message to a specified channel or nick
/<command> Send command to IRC server (see RFC 2812 for full list).
/#<channel> Assign new default message channel.
<message> Send a PRIVMSG to the current channel.
@<channel|nick> <message> Send a message to a specified channel or nick
@@<channel|nick> <message> Send a CTCP ACTION message to a specified channel or nick
/<command> Send command to IRC server (see RFC 2812 for full list).
/#<channel> Assign new default message channel.
```

### User Input Key Bindings
Expand All @@ -86,7 +88,10 @@ kirc [-s hostname] [-p port] [-c channels] [-n nickname] [-r realname] [-u usern
* **CTRL+W** deletes the previous word.
* **CTRL+U** deletes the entire line.
* **CTRL+K** deletes the from current character to end of line.
* **CTRL+C** Force quit kirc
* **CTRL+C** Force quit kirc.
* **CTRL+D** deletes the character to the right of cursor.
* **CTRL+T** swap character at cursor with previous character.
* **CTRL+H** equivalent to backspace.

## Support Documentation

Expand Down
3 changes: 0 additions & 3 deletions kirc.1
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,6 @@ Specifies the USER connection username
.BI \-k " pass"
Specifies the PASS connection password
.TP
.BI \-w " nick_width"
Specifies max character width printed in the left column
.TP
.BI \-x " command"
Specifies additional commands to send to the host after initial connection.
.TP
Expand Down
Loading

1 comment on commit bcab03c

@kdkasad
Copy link
Contributor

@kdkasad kdkasad commented on bcab03c Oct 29, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd recommend leaving the changelog out of the commit and instead putting it in an annotated tag. That way the git log is cleaner, but the changelog is still visible for the specific version.

edit: nevermind. I just realized that's the commit history of the merge.

Please sign in to comment.