annotate README @ 77:e8c9d7d13866

Handle certain key sequences better.
author Matti Hamalainen <ccr@tnsp.org>
date Sat, 13 Dec 2008 11:19:19 +0200
parents 162951c382b8
children 8df3f73c5f16
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 ==========================================================
16
57ed9746ede7 Copyrights.
Matti Hamalainen <ccr@tnsp.org>
parents: 7
diff changeset
3 Written and designed by Matti 'ccr' Hämäläinen (C) Copyright 2008 TNSP
7
dba89c48ce02 Updated readme.
Matti Hamalainen <ccr@tnsp.org>
parents: 5
diff changeset
4
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 Distributed under DWETFYWTPL (Do What Ever The Fuck You Want
dba89c48ce02 Updated readme.
Matti Hamalainen <ccr@tnsp.org>
parents: 5
diff changeset
7 To Public License), see file COPYING for more information.
dba89c48ce02 Updated readme.
Matti Hamalainen <ccr@tnsp.org>
parents: 5
diff changeset
8
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 What is this?
dba89c48ce02 Updated readme.
Matti Hamalainen <ccr@tnsp.org>
parents: 5
diff changeset
11 -------------
44
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
12 A simple NCurses-based client compatible with NewbieNudes.com chatroom
60
fc8b5265a3d2 Improve grammar.
Matti Hamalainen <ccr@tnsp.org>
parents: 59
diff changeset
13 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
14 whistles, such as a input history.
7
dba89c48ce02 Updated readme.
Matti Hamalainen <ccr@tnsp.org>
parents: 5
diff changeset
15
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 Usage
dba89c48ce02 Updated readme.
Matti Hamalainen <ccr@tnsp.org>
parents: 5
diff changeset
18 -----
dba89c48ce02 Updated readme.
Matti Hamalainen <ccr@tnsp.org>
parents: 5
diff changeset
19 See the help, 'nnchat --help' for options. By default it connects
76
162951c382b8 Update docs.
Matti Hamalainen <ccr@tnsp.org>
parents: 66
diff changeset
20 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
21 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
22
dba89c48ce02 Updated readme.
Matti Hamalainen <ccr@tnsp.org>
parents: 5
diff changeset
23 Connect as registered user to members only chat:
66
11b45ba0132f Cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 60
diff changeset
24 > nnchat username password
7
dba89c48ce02 Updated readme.
Matti Hamalainen <ccr@tnsp.org>
parents: 5
diff changeset
25
dba89c48ce02 Updated readme.
Matti Hamalainen <ccr@tnsp.org>
parents: 5
diff changeset
26 Connect as guest to free for all main chat:
66
11b45ba0132f Cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 60
diff changeset
27 > nnchat -p 8002 AnonymousAndy ""
0
728243125263 Import.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
28
38
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
29
44
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
30 Keys
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
31 ----
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
32 left/right - Move cursor in the current buffer.
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
33 up/down - Browse input history.
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
34 ctrl+left/right - Move cursor through words.
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
35
52
8d9c065241b7 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 44
diff changeset
36 ctrl+l - Refresh/redraw screen.
8d9c065241b7 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 44
diff changeset
37
44
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
38 F1 - Toggle between insert and overwrite modes.
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
39 F2 - Clear current edit buffer.
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
40 F9 - Quit.
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
41
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
42
38
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
43 Installation
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
44 ------------
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
45 NNChat requires ncurses library.
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
46
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
47 1) Edit Makefile (optional)
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
48
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
49 2) make / gmake
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
50
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
51 3) ./nnchat --help