Skip to content

Commit 9e7a454

Browse files
authored
released at 0.2.5
1 parent 68166e1 commit 9e7a454

File tree

6 files changed

+891
-883
lines changed

6 files changed

+891
-883
lines changed

.github/CONTRIBUTING

Lines changed: 0 additions & 21 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 38 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

Makefile

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,27 @@
11
.POSIX:
2-
2+
ALL_WARNING = -Wall -Wextra -pedantic
3+
ALL_LDFLAGS = $(LDFLAGS)
4+
ALL_CFLAGS = $(CPPFLAGS) $(CFLAGS) -std=c99 $(ALL_WARNING)
35
PREFIX = /usr/local
6+
LDLIBS = -lm
47
BINDIR = $(PREFIX)/bin
5-
MANPREFIX = $(PREFIX)/share/man
8+
MANDIR = $(PREFIX)/share/man
69

710
all: kirc
8-
9-
kirc: kirc.o Makefile
10-
$(CC) -o kirc kirc.o $(LDFLAGS)
11-
12-
.c.o:
13-
$(CC) $(CPPFLAGS) $(CFLAGS) -c $<
14-
1511
install: all
1612
mkdir -p $(DESTDIR)$(BINDIR)
17-
mkdir -p $(DESTDIR)$(MANPREFIX)/man1
13+
mkdir -p $(DESTDIR)$(MANDIR)/man1
1814
cp -f kirc $(DESTDIR)$(BINDIR)
15+
cp -f kirc.1 $(DESTDIR)$(MANDIR)/man1
1916
chmod 755 $(DESTDIR)$(BINDIR)/kirc
20-
version=$$(sed -n '/#define VERSION/{s/^[^"]*"//;s/".*//;p;q}' kirc.c); \
21-
sed "s/VERSION/$$version/g" kirc.1 > $(DESTDIR)$(MANPREFIX)/man1/kirc.1
22-
chmod 644 $(DESTDIR)$(MANPREFIX)/man1/kirc.1
23-
24-
uninstall:
25-
rm -f $(DESTDIR)$(BINDIR)/kirc
26-
rm -f $(DESTDIR)$(MANPREFIX)/man1/kirc.1
27-
17+
chmod 644 $(DESTDIR)$(MANDIR)/man1/kirc.1
18+
kirc: kirc.o
19+
$(CC) $(ALL_LDFLAGS) -o kirc kirc.o $(LDLIBS)
20+
kirc.o: kirc.c
21+
$(CC) $(ALL_CFLAGS) -c kirc.c
2822
clean:
2923
rm -f kirc *.o
30-
24+
uninstall:
25+
rm -f $(DESTDIR)$(BINDIR)/kirc
26+
rm -f $(DESTDIR)$(MANDIR)/man1/kirc.1
3127
.PHONY: all install uninstall clean

README

Lines changed: 63 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -1,99 +1,63 @@
1-
<!-- vim: syntax=Markdown -->
2-
<!--
3-
Title: KISS for IRC (kirc)
4-
Description: A tiny IRC client written in POSIX C99.
5-
Author: mcpcpc
6-
-->
7-
8-
<h3 align="center">
9-
<img src="https://raw.githubusercontent.com/mcpcpc/kirc/gh-pages/kirc.png" alt="kirc" height="170px">
10-
</h3>
11-
12-
<p align="center">KISS for IRC, a tiny IRC client written in POSIX C99.</p>
13-
14-
<p align="center">
15-
<a href="./LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg"></a>
16-
<a href="https://github.com/mcpcpc/kirc/releases"><img src="https://img.shields.io/github/v/release/mcpcpc/kirc.svg"></a>
17-
<a href="https://repology.org/metapackage/kirc"><img src="https://repology.org/badge/tiny-repos/kirc.svg" alt="Packaging status"></a>
18-
<a href="https://www.codacy.com/manual/mcpcpc/kirc/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=mcpcpc/kirc&amp;utm_campaign=Badge_Grade"><img src="https://app.codacy.com/project/badge/Grade/5616c0ed4b2f4209826038dbc270dbf5" alt="Codacy status"></a>
19-
</p>
20-
21-
## Features
22-
23-
* Excellent cross-platform compatibility.
24-
* Asynchronous user input and server messager handling.
25-
* No dependencies other than a C99 compiler.
26-
* Simple Authentication and Security Layer (SASL) procotol support.
27-
* Client-to-client protocol (CTCP) support.
28-
* Transport Layer Security (TLS) protocol support (via external utilities).
29-
* Full chat history logging.
30-
* Multi-channel joining at server connection.
31-
* Simple command aliases and full support for all RFC 2812 commands.
32-
* Easy color scheme definition via ANSI 8-bit colors.
33-
34-
## Installation & Usage
35-
36-
Building and installing on **KISS Linux** using the Community repository:
37-
38-
```shell
39-
kiss b kirc
40-
kiss i kirc
41-
```
42-
43-
Building and installing on **Arch** and **Arch-based** distros using the AUR:
44-
45-
```shell
46-
git clone https://aur.archlinux.org/kirc-git.git
47-
cd kirc
48-
makepkg -si
49-
```
50-
51-
Building and installing from source (works on **Raspbian**, **Debian**, **Ubuntu** and many other Unix distributions):
52-
53-
```shell
54-
git clone https://github.com/mcpcpc/kirc.git
55-
cd kirc
56-
make
57-
make install
58-
```
59-
60-
### Usage
61-
62-
Consult `man kirc` for a full list and explanation of available `kirc` arguments.
63-
64-
```shell
65-
kirc [-s hostname] [-p port] [-c channels] [-n nickname] [-r realname] [-u username] [-k password] [-a token] [-x command] [-o logfile] [-e|v|V]
66-
```
67-
68-
### Command Aliases
69-
70-
```shell
71-
<message> Send a PRIVMSG to the current channel.
72-
@<channel|nick> <message> Send a message to a specified channel or nick
73-
@@<channel|nick> <message> Send a CTCP ACTION 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-
```
77-
78-
### User Input Key Bindings
79-
80-
* **CTRL+B** or **LEFT ARROW** moves the cursor one character to the left.
81-
* **CTRL+F** or **RIGHT ARROW** moves the cursor one character to the right.
82-
* **CTRL+E** moves the cursor to the end of the line.
83-
* **CTRL+A** or **HOME** moves the cursor to the start of the line.
84-
* **CTRL+W** deletes the previous word.
85-
* **CTRL+U** deletes the entire line.
86-
* **CTRL+K** deletes the from current character to end of line.
87-
* **CTRL+C** Force quit kirc.
88-
* **CTRL+D** deletes the character to the right of cursor.
89-
* **CTRL+T** swap character at cursor with previous character.
90-
* **CTRL+H** equivalent to backspace.
91-
92-
## Support Documentation
93-
94-
Please refer to the official [Support Documention](https://mcpcpc.github.io/kirc/documentation.html) for examples, troubleshooting and use cases.
95-
96-
## Contact
97-
98-
For any further questions or concerns, feel free to reach out to me, [mcpcpc](https://github.com/mcpcpc), on `#kirc`
99-
or `#kisslinux` Freenode IRC channels.
1+
kirc
2+
====
3+
4+
kirc (KISS for IRC) is a tiny IRC client written in POSIX C99.
5+
6+
Installation
7+
------------
8+
9+
Building and installing from source:
10+
11+
git clone https://github.com/mcpcpc/kirc
12+
cd kirc
13+
make
14+
make install
15+
16+
Usage
17+
-----
18+
19+
Consult `man kirc` for a full list and explanation of available arguments.
20+
21+
kirc [-s hostname] [-p port] [-c channels] [-n nickname] [-r realname]
22+
[-u username] [-k password] [-a token] [-x command] [-o logfile]
23+
[-e|v|V]
24+
25+
Command Aliases
26+
---------------
27+
28+
<message> send PRIVMSG to the current channel.
29+
@<channel|nick> <message> send message to a specified channel or nick.
30+
@@<channel|nick> <message> send CTCP ACTION message to a specified channel or nick.
31+
/<command> send command to the IRC server (see RFC 2812).
32+
/#<channel> assign new default message channel.
33+
34+
Key Bindings
35+
------------
36+
37+
CTRL+B or LEFT ARROW move the cursor one character to the left.
38+
CTRL+F or RIGHT ARROW move the cursor one character to the right.
39+
CTRL+P or UP ARROW move to previous record in the input history buffer.
40+
CTRL+N or DOWN ARROW move to next record in the input history buffer.
41+
CTRL+E move the cursor to the end of the line.
42+
CTRL+A or HOME move the cursor to the start of the line.
43+
CTRL+W delete the previous word.
44+
CTRL+U delete the entire line.
45+
CTRL+K delete the from current character to end of line.
46+
CTRL+D delete the character to the right of cursor.
47+
CTRL+C force quit kirc.
48+
CTRL+T swap character at cursor with previous character.
49+
CTRL+H equivalent to backspace.
50+
51+
Support Documentation
52+
---------------------
53+
54+
Please refer to the official for examples, troubleshooting and use cases.
55+
56+
https://mcpcpc.github.io/kirc/documentation.html
57+
58+
Contact
59+
-------
60+
61+
For any further questions or concerns, feel free to email me at:
62+
63+
michaelczigler [at] mcpcpc [dot] com

0 commit comments

Comments
 (0)