aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 38f8d8cd232affdfb1676836fba9e7a0f6a9bbc6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# kirc

kirc (KISS for IRC) is a tiny IRC client written in POSIX C99.

## Installation

Building and installing from source:

	git clone https://github.com/mcpcpc/kirc
	cd kirc
	make
	make install

## Usage

Consult `man kirc` for a full list and explanation of available arguments.

    kirc [-s hostname] [-p port] [-c channels] [-n nickname] [-r realname]
         [-u username] [-k password] [-a token] [-o logfile] [-e|x|v|V]

## Command Aliases

    <message>                   send PRIVMSG to the current channel.
    @<channel|nick> <message>   send PRIVMSG to a specified channel or nick.
    @@<channel|nick> <message>  send CTCP ACTION message to a specified channel
                                or nick (if no channel or nick is specified, the
                                message will be sent to the default channel).
    /<command>                  send command to the IRC server (see RFC 2812).
    /#<channel>                 assign new default message channel.

## Key Bindings

    CTRL+B or LEFT ARROW        move the cursor one character to the left.
    CTRL+F or RIGHT ARROW       move the cursor one character to the right.
    CTRL+P or UP ARROW          move to previous record in the input history buffer.
    CTRL+N or DOWN ARROW        move to next record in the input history buffer.
    CTRL+E                      move the cursor to the end of the line.
    CTRL+A or HOME              move the cursor to the start of the line.
    CTRL+W                      delete the previous word.
    CTRL+U                      delete the entire line.
    CTRL+K                      delete the from current character to end of line.
    CTRL+D                      delete the character to the right of cursor.
    CTRL+C                      force quit kirc.
    CTRL+T                      swap character at cursor with previous character.
    CTRL+H                      equivalent to backspace.

## Support Documentation

Please refer to the [official homepage](http://kirc.io/docs.html) for examples, 
troubleshooting and use cases.

## Contact

For any further questions or concerns, feel free to send me an 
[email](michaelczigler[at]mcpcpc[dot]com).