annotate README @ 157:3287901f9b78

Update documentation.
author Matti Hamalainen <ccr@tnsp.org>
date Wed, 03 Nov 2010 13:27:55 +0200
parents a094a9b8cad9
children 8bb12c22fe05
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
105
a094a9b8cad9 Updated.
Matti Hamalainen <ccr@tnsp.org>
parents: 88
diff changeset
4 (C) Copyright 2008-2010 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
157
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
15 whistles, such as a input history, logging to file, ignore lists,
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
16 persistent configuration, etc.
7
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
dba89c48ce02 Updated readme.
Matti Hamalainen <ccr@tnsp.org>
parents: 5
diff changeset
19 Usage
dba89c48ce02 Updated readme.
Matti Hamalainen <ccr@tnsp.org>
parents: 5
diff changeset
20 -----
157
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
21 See the help, 'nnchat --help' for available command line options. By
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
22 default the client connects to passion pit (TCP port 8003). By using
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
23 other ports (option -p) you can connect to "members only" (8003) and
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
24 free for all "main room" (8002) chats.
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 registered user to members only chat:
66
11b45ba0132f Cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 60
diff changeset
27 > nnchat username password
7
dba89c48ce02 Updated readme.
Matti Hamalainen <ccr@tnsp.org>
parents: 5
diff changeset
28
dba89c48ce02 Updated readme.
Matti Hamalainen <ccr@tnsp.org>
parents: 5
diff changeset
29 Connect as guest to free for all main chat:
66
11b45ba0132f Cleanups.
Matti Hamalainen <ccr@tnsp.org>
parents: 60
diff changeset
30 > nnchat -p 8002 AnonymousAndy ""
0
728243125263 Import.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
31
38
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
32
44
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
33 Keys
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
34 ----
157
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
35 arrow left/right - Move cursor in the current buffer.
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
36 arrow up/down - Browse input history.
44
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
37 ctrl+left/right - Move cursor through words.
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
38
52
8d9c065241b7 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 44
diff changeset
39 ctrl+l - Refresh/redraw screen.
8d9c065241b7 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 44
diff changeset
40
44
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
41 F1 - Toggle between insert and overwrite modes.
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
42 F2 - Clear current edit buffer.
157
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
43 F4 - Toggle ignore mode on/off.
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
44 F8 - Toggle private chat mode on/off.
44
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
45 F9 - Quit.
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
46
dfe6b835a745 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 38
diff changeset
47
157
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
48 Commands
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
49 --------
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
50 /to <user> - Set target for private chat. Example: "/to foobar"
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
51 will set target to user "foobar". After this, pressing
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
52 function key F8 will toggle between private mode and
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
53 public.
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
54
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
55 /ignore [user] - Toggle user to/from ignore. "/ignore" without specified
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
56 username will list users currently on the ignore list.
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
57 When ignore mode is ENABLED (via function key F4),
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
58 no messages or actions from users on the list will be
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
59 displayed. However, they will go into log file, if
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
60 logging is active.
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
61
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
62 /color <color> - Changes your current user color visible to OTHER people
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
63 using the regular NN chat. Of course, this does not
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
64 affect this client in any way, as user colors are
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
65 ignored.
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
66
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
67 /save - Save current configuration (username, password, etc.)
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
68 Notice that this may be a risk, if your computer
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
69 has several users as just starting the client will
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
70 automatically log into the chat with your username and
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
71 password!
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
72
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
73 /who - Lists all users on the chat currently.
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
74
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
75
38
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
76 Installation
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
77 ------------
157
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
78 NNChat requires a curses library, preferably ncurses. It is
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
79 also possible to compile NNChat for Windows via MinGW and use
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
80 PDCurses instead, but this includes certain complexities in
3287901f9b78 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 105
diff changeset
81 build process (see Makefile.w32)
38
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
82
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
83 1) Edit Makefile (optional)
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
84
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
85 2) make / gmake
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
86
Matti Hamalainen <ccr@tnsp.org>
parents: 18
diff changeset
87 3) ./nnchat --help