Mercurial > hg > nnchat
comparison doc/index.html @ 674:650e7a5c74c5
Add homepage and adjust Makefiles.
| author | Matti Hamalainen <ccr@tnsp.org> |
|---|---|
| date | Mon, 19 Dec 2016 19:01:27 +0200 |
| parents | |
| children | 534b5d90255b |
comparison
equal
deleted
inserted
replaced
| 673:358cdc4c9178 | 674:650e7a5c74c5 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html> | |
| 3 <head> | |
| 4 <meta charset="UTF-8"> | |
| 5 <meta http-equiv="Content-type" content="text/html;charset=UTF-8"> | |
| 6 <title>NNChat client</title> | |
| 7 <link rel="stylesheet" href="readme.css" type="text/css" /> | |
| 8 </head> | |
| 9 <body> | |
| 10 <div id="messageBox"></div> | |
| 11 <div id="contents"> | |
| 12 <div id="header"> | |
| 13 <img src="logo.png" alt="NNChat" /> | |
| 14 <div class="copyright"> | |
| 15 © Copyright 2008 - 2015 Anonymous Finnish Guy | |
| 16 </div> | |
| 17 </div> | |
| 18 <div id="license"> | |
| 19 Distributed under DWETFYWTPL (Do What Ever The Fuck You Want | |
| 20 To Public License), see file <a href="COPYING">COPYING</a> for more information. | |
| 21 <b>NOTICE! There is NO guarantee or warranty of ANY KIND, nor guarantee of | |
| 22 applicability. This software is provided freely and free of charge, and | |
| 23 as a unofficial 3rd-party development it may or may not remain compatible | |
| 24 with the NN chat protocol.</b> | |
| 25 </div> | |
| 26 | |
| 27 <h2>About</h2> | |
| 28 <p> | |
| 29 A simple NCurses-based client compatible with NewbieNudes.com chatroom | |
| 30 protocol. There is a basic line-editing interface with some bells and | |
| 31 whistles, such as a input history, logging to file, ignore lists, | |
| 32 persistent configuration, etc. | |
| 33 </p> | |
| 34 <p> | |
| 35 The original Flash-based chat client can be accessed through NN website. | |
| 36 </p> | |
| 37 | |
| 38 <!-- BEGIN --> | |
| 39 <table> | |
| 40 <tr><td><a href="shot_unix1.png"><img src="sm_shot_unix1.png" /></a></td><td><a href="shot_windows1.png"><img src="sm_shot_windows1.png" /></a></td></tr> | |
| 41 </table> | |
| 42 | |
| 43 | |
| 44 <h2>Download</h2> | |
| 45 <p> | |
| 46 Currently only Windows version is distributed, although the software is | |
| 47 mainly developed and used under Linux and other UNIX-style platforms. | |
| 48 Windows binaries are compiled with 32-bit MinGW and MSI installer created | |
| 49 with Freeware version of Caphyon's Advanced Installer. | |
| 50 </p> | |
| 51 | |
| 52 <table> | |
| 53 <tr> | |
| 54 <th><a href="nncsetup-1.3.6.msi">Download Windows installer | |
| 55 for NNChat v1.3.6</a></th> | |
| 56 <td>32-bit and 64-bit Windows XP, Vista or Win7.</td> | |
| 57 </tr> | |
| 58 <tr> | |
| 59 <th><a href="nnchat-1.5.2.tar.gz">Sourcecode tar.gz for NNChat v1.5.2</a></th> | |
| 60 <td>For generic UNIX, Linux, *BSD. Requires GNU Make, GCC 4.x + binutils and NCurses.</td> | |
| 61 </tr> | |
| 62 </table> | |
| 63 | |
| 64 <h3>Installation on Windows</h3> | |
| 65 <ol> | |
| 66 <li>Run the installer provided above.</li> | |
| 67 <li>Two (2) new icons should appear on desktop (and under Start - Programs - | |
| 68 NNChat), one for each of NN's chatrooms respectively.</li> | |
| 69 <li>Click one of them, enter your username and password.</li> | |
| 70 <li>See keyboard / command instructions below.</li> | |
| 71 </ol> | |
| 72 | |
| 73 <!-- END --> | |
| 74 | |
| 75 <h2>Usage</h2> | |
| 76 <h3>Keys</h3> | |
| 77 <table border="0"> | |
| 78 <tr><th>left/right arrow</th><td>Move cursor in the current edit buffer.</td></tr> | |
| 79 <tr><th>home/end</th><td>Move cursor to beginning or the end of the current edit buffer.</td></tr> | |
| 80 | |
| 81 <tr><th>arrow up/down</th> </th><td>Browse input history.</td></tr> | |
| 82 <tr><th>ctrl+left/right arrow </th><td>Skip cursor through words.</td></tr> | |
| 83 | |
| 84 <tr><th>ins </th><td>Toggle between insert and overwrite modes.</td></tr> | |
| 85 <tr><th>del </th><td>Delete one character at cursor position.</td></tr> | |
| 86 <tr><th>backspace </th><td>Delete one character left to the cursor position.</td></tr> | |
| 87 | |
| 88 <tr><th>tab(ulator) </th><td>Try to complete a command or username. For example "an<tab>" | |
| 89 would check the userlist for usernames beginning with | |
| 90 "an" and replace this with the first match. Subsequent | |
| 91 tab-keypresses will "cycle" around other matches. | |
| 92 Commands must start with "/".</td></tr> | |
| 93 | |
| 94 <tr><th>F2 </th><td>Clear current edit buffer.</td></tr> | |
| 95 <tr><th>F5 </th><td>Toggle ignore mode on/off.</td></tr> | |
| 96 <tr><th>F6 </th><td>Toggle "only friends allowed to PRV you" mode on/off.</td></tr> | |
| 97 | |
| 98 <tr><th>ESC+[1..9] </th><td>Switch between sub-windows / buffers. 1 is the main room, 2..9 are PRV buffers.</td></tr> | |
| 99 <tr><th>Alt+[1..9] </th><td>Same as ESC+[1..9]</td></tr> | |
| 100 | |
| 101 <tr><th>ctrl+L </th><td>Refresh/redraw screen.</td></tr> | |
| 102 </table> | |
| 103 | |
| 104 <h3>Commands</h3> | |
| 105 <p> | |
| 106 In addition to normal NN commands (such as /prvon, /prvoff, etc.) NNChat | |
| 107 supports following list of internal commands. | |
| 108 </p> | |
| 109 <p> | |
| 110 <b>Remember that ALL these commands can be autocompleted via Tab key!</b> | |
| 111 For example, just type /c<tab> and it will be expaned to /close. | |
| 112 Hit Tab second time and it will "cycle" to /color, etc. | |
| 113 </p> | |
| 114 <table border="0"> | |
| 115 <tr><th>/w <user><br /> | |
| 116 /profile <user></th><td>Open profile of given username | |
| 117 via system default web browser.</td></tr> | |
| 118 | |
| 119 <tr><th>/ignore [user] </th><td>Toggle user to/from ignore. "/ignore" without specified | |
| 120 username will list users currently on the ignore list. | |
| 121 When ignore mode is ENABLED (via function key F5), | |
| 122 no messages or actions from users on the list will be | |
| 123 displayed. However, they will go into log file, if | |
| 124 logging is active.</td></tr> | |
| 125 | |
| 126 <tr><th>/friend [user] </th><td>Add or remove user to/from friend list. "/friend" without specified | |
| 127 username will list users currently on the friends list. | |
| 128 Names on the friends list will be highlighted differently | |
| 129 and cannot be placed on ignore.</td></tr> | |
| 130 | |
| 131 <tr><th>/color <color> </th><td>Changes your current user color visible to OTHER people | |
| 132 using the regular NN chat. Of course, this does not | |
| 133 affect this client in any way, as user colors are | |
| 134 ignored. Color must be specified as a hexadecimal value, | |
| 135 for example 006080.</td></tr> | |
| 136 | |
| 137 <tr><th>/save </th><td>Save current configuration (username, password, color, etc.) | |
| 138 Notice that this may be a risk, if your computer | |
| 139 has several users as just starting the client will | |
| 140 automatically log into the chat with your username and | |
| 141 password!</td></tr> | |
| 142 | |
| 143 <tr><th>/names</th><td>Lists all users on the chat currently.</td></tr> | |
| 144 | |
| 145 <tr><th>/list</th><td>Alias for NN server-side command /listallusers</td></tr> | |
| 146 | |
| 147 | |
| 148 <tr><th>/query <user></th><td>Start a PRV chat ("query") with the specified user.</td></tr> | |
| 149 | |
| 150 <tr><th>/close [user]</th><td>Close the specified PRV buffer / window or if no argument given ("/close"), then just close the current "window".</td></tr> | |
| 151 | |
| 152 <tr><th>/win [number]</th><td>Switch to given window, or show information about current "window".</td></tr> | |
| 153 | |
| 154 <tr><th>/quit</th><td>Quit the chat.</td></tr> | |
| 155 | |
| 156 </table> | |
| 157 | |
| 158 <p> | |
| 159 Enjoy! -- Anonymous Finnish Guy | |
| 160 </p> | |
| 161 </div> | |
| 162 </body> | |
| 163 </html> |