# HG changeset patch
# User Matti Hamalainen <ccr@tnsp.org>
# Date 1288783675 -7200
# Node ID 3287901f9b781b8d82818a4e14c599a952f14ac8
# Parent  0a9fe14882dcebb480842d5ccb6b4a7a836e126e
Update documentation.

diff -r 0a9fe14882dc -r 3287901f9b78 README
--- a/README	Wed Nov 03 12:26:10 2010 +0200
+++ b/README	Wed Nov 03 13:27:55 2010 +0200
@@ -12,14 +12,16 @@
 -------------
 A simple NCurses-based client compatible with NewbieNudes.com chatroom
 protocol. There is a basic line-editing interface with some bells and
-whistles, such as a input history.
+whistles, such as a input history, logging to file, ignore lists,
+persistent configuration, etc.
 
 
 Usage
 -----
-See the help, 'nnchat --help' for options. By default it connects
-to the passion pit (TCP port 8003). By using other ports (option -p)
-you can connect to "members only" (8003) and "free for all" (8002) chats.
+See the help, 'nnchat --help' for available command line options. By
+default the client connects to passion pit (TCP port 8003). By using
+other ports (option -p) you can connect to "members only" (8003) and
+free for all "main room" (8002) chats.
 
 Connect as registered user to members only chat:
 > nnchat username password
@@ -30,21 +32,53 @@
 
 Keys
 ----
-left/right        - Move cursor in the current buffer.
-up/down           - Browse input history.
+arrow left/right  - Move cursor in the current buffer.
+arrow up/down     - Browse input history.
 ctrl+left/right   - Move cursor through words.
 
 ctrl+l            - Refresh/redraw screen.
 
 F1                - Toggle between insert and overwrite modes.
 F2                - Clear current edit buffer.
+F4                - Toggle ignore mode on/off.
+F8                - Toggle private chat mode on/off.
 F9                - Quit.
 
 
+Commands
+--------
+/to <user>        - Set target for private chat. Example: "/to foobar"
+                    will set target to user "foobar". After this, pressing
+                    function key F8 will toggle between private mode and
+                    public.
+
+/ignore [user]    - Toggle user to/from ignore. "/ignore" without specified
+                    username will list users currently on the ignore list.
+                    When ignore mode is ENABLED (via function key F4),
+                    no messages or actions from users on the list will be
+                    displayed. However, they will go into log file, if
+                    logging is active.
+
+/color <color>    - Changes your current user color visible to OTHER people
+                    using the regular NN chat. Of course, this does not
+                    affect this client in any way, as user colors are
+                    ignored.
+
+/save             - Save current configuration (username, password, etc.)
+                    Notice that this may be a risk, if your computer
+                    has several users as just starting the client will
+                    automatically log into the chat with your username and
+                    password!
+
+/who              - Lists all users on the chat currently.
+
+
 Installation
 ------------
-NNChat requires a curses library, preferably ncurses. For Windows
-version, PDCurses can be used instead.
+NNChat requires a curses library, preferably ncurses. It is
+also possible to compile NNChat for Windows via MinGW and use
+PDCurses instead, but this includes certain complexities in
+build process (see Makefile.w32)
 
 1) Edit Makefile (optional)