annotate README @ 100:ed4067c10a8a

Remove useless buffer usage from error reporting function.
author Matti Hamalainen <ccr@tnsp.org>
date Tue, 17 Nov 2009 23:09:10 +0200
parents 7bf0915c965e
children a094a9b8cad9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
d83c544c8077 TRICKS -> README
Matti Hamalainen <ccr@tnsp.org>
parents: 0
diff changeset
1 NNChat - extremely simple NN chat applet compatible client
d83c544c8077 TRICKS -> README
Matti Hamalainen <ccr@tnsp.org>
parents: 0
diff changeset
2 ==========================================================
88
7bf0915c965e Readability.
Matti Hamalainen <ccr@tnsp.org>
parents: 82
diff changeset
3 Written and designed by Matti 'ccr' Hämäläinen
7bf0915c965e Readability.
Matti Hamalainen <ccr@tnsp.org>
parents: 82
diff changeset
4 (C) Copyright 2008-2009 TNSP
7
dba89c48ce02 Updated readme.
Matti Hamalainen <ccr@tnsp.org>
parents: 5
diff changeset
5
dba89c48ce02 Updated readme.
Matti Hamalainen <ccr@tnsp.org>
parents: 5
diff changeset
6
dba89c48ce02 Updated readme.
Matti Hamalainen <ccr@tnsp.org>
parents: 5
diff changeset
7 Distributed under DWETFYWTPL (Do What Ever The Fuck You Want
dba89c48ce02 Updated readme.
Matti Hamalainen <ccr@tnsp.org>
parents: 5
diff changeset
8 To Public License), see file COPYING for more information.
dba89c48ce02 Updated readme.
Matti Hamalainen <ccr@tnsp.org>
parents: 5
diff changeset
9
dba89c48ce02 Updated readme.
Matti Hamalainen <ccr@tnsp.org>
parents: 5
diff changeset
10
dba89c48ce02 Updated readme.
Matti Hamalainen <ccr@tnsp.org>
parents: 5
diff changeset
11 What is this?
dba89c48ce02 Updated readme.
Matti Hamalainen <ccr@tnsp.org>
parents: 5
diff changeset
12 -------------
44
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
13 A simple NCurses-based client compatible with NewbieNudes.com chatroom
60
fc8b5265a3d2 Improve grammar.
Matti Hamalainen <ccr@tnsp.org>
parents: 59
diff changeset
14 protocol. There is a basic line-editing interface with some bells and
44
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
15 whistles, such as a input history.
7
dba89c48ce02 Updated readme.
Matti Hamalainen <ccr@tnsp.org>
parents: 5
diff changeset
16
dba89c48ce02 Updated readme.
Matti Hamalainen <ccr@tnsp.org>
parents: 5
diff changeset
17
dba89c48ce02 Updated readme.
Matti Hamalainen <ccr@tnsp.org>
parents: 5
diff changeset
18 Usage
dba89c48ce02 Updated readme.
Matti Hamalainen <ccr@tnsp.org>
parents: 5
diff changeset
19 -----
dba89c48ce02 Updated readme.
Matti Hamalainen <ccr@tnsp.org>
parents: 5
diff changeset
20 See the help, 'nnchat --help' for options. By default it connects
76
162951c382b8 Update docs.
Matti Hamalainen <ccr@tnsp.org>
parents: 66
diff changeset
21 to the Members Only chat (TCP port 8005). By using other ports (option -p)
7
dba89c48ce02 Updated readme.
Matti Hamalainen <ccr@tnsp.org>
parents: 5
diff changeset
22 you can connect to Passion Pit (8003) and free for all (8002) chats.
dba89c48ce02 Updated readme.
Matti Hamalainen <ccr@tnsp.org>
parents: 5
diff changeset
23
dba89c48ce02 Updated readme.
Matti Hamalainen <ccr@tnsp.org>
parents: 5
diff changeset
24 Connect as registered user to members only chat:
66
11b45ba0132f Cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 60
diff changeset
25 > nnchat username password
7
dba89c48ce02 Updated readme.
Matti Hamalainen <ccr@tnsp.org>
parents: 5
diff changeset
26
dba89c48ce02 Updated readme.
Matti Hamalainen <ccr@tnsp.org>
parents: 5
diff changeset
27 Connect as guest to free for all main chat:
66
11b45ba0132f Cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 60
diff changeset
28 > nnchat -p 8002 AnonymousAndy ""
0
728243125263 Import.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
29
38
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
30
44
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
31 Keys
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
32 ----
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
33 left/right - Move cursor in the current buffer.
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
34 up/down - Browse input history.
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
35 ctrl+left/right - Move cursor through words.
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
36
52
8d9c065241b7 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 44
diff changeset
37 ctrl+l - Refresh/redraw screen.
8d9c065241b7 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 44
diff changeset
38
44
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
39 F1 - Toggle between insert and overwrite modes.
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
40 F2 - Clear current edit buffer.
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
41 F9 - Quit.
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
42
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
43
38
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
44 Installation
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
45 ------------
88
7bf0915c965e Readability.
Matti Hamalainen <ccr@tnsp.org>
parents: 82
diff changeset
46 NNChat requires a curses library, preferably ncurses. For Windows
7bf0915c965e Readability.
Matti Hamalainen <ccr@tnsp.org>
parents: 82
diff changeset
47 version, PDCurses can be used instead.
38
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
48
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
49 1) Edit Makefile (optional)
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
50
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
51 2) make / gmake
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
52
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
53 3) ./nnchat --help