home *** CD-ROM | disk | FTP | other *** search
/ Aminet 10 / aminetcdnumber101996.iso / Aminet / comm / bbs / clchat414.lha / CLChat414 / Client / CLChatGUI.doc < prev    next >
Text File  |  1995-12-25  |  22KB  |  612 lines
  1.  
  2.  
  3. CLChatGUI
  4. *********
  5.  
  6. Welcome to the CLChatGUI, a full-featured GUI client to the
  7. CLChatSystem for AmiTCP.  The CLChatSystem, which is
  8. originally part of the Connectline BBS package, provides a
  9. multoi-server, IRC-like chat system with multiple channels, private
  10. messaging, operator privileges and more.
  11.  
  12. Within Connectline, also online user and Hydra file transfer
  13. protocol chat user may join the chat.  See the `CLChatServer
  14. Documentation' for more information about Connectline.
  15.  
  16. Connecting
  17. **********
  18.  
  19. Installation is fairly simply.  Simply put the archive contents
  20. somewhere on your harddisk.  Note that you need MUI 2.3 or better!
  21.  
  22. Before you can use CLChatGUI, you must connect to a chat server
  23. running CLChatD.
  24.  
  25. When started, CLChatGUI will prompt you for a server name and a port
  26. number to connect to.
  27.  
  28. If you are connected to a LAN, you should ask your network adminstrator
  29. for both server name and port number.
  30.  
  31. If you are connected to the Internet, see ARCnet for a good choice of
  32. servers to connect to.
  33.  
  34. You must also specify a Nickname and your Realname.  The nickname
  35. is a kind of username used within the chat system.  It may be up to 15
  36. byte long and must consist of letters, digits and the characters .
  37. and _. The realname is used for informational purposes only.
  38.  
  39. Note that the server may reject your connection attempt because the
  40. entered nickname is invalid or already in use by another chat user.
  41. Change your nick and retry the connection.
  42.  
  43. CLChatGUI keeps a history of the last servers you have connected to.
  44. You may choose from the history by clicking on the popup button right
  45. from the server name string gadget.  The history is saved within the
  46. configuration file.
  47.  
  48. Local chat
  49. **********
  50.  
  51. If you start the client on a machine running the CLChatServer, it
  52. will not connect using AmiTCP, but directly link to the chat server to
  53. reduce overhead.
  54.  
  55. If you want to avoid this behaviour, e.g. for testing purposes, start
  56. CLChatGUI with the TCPMode keyword or specify the
  57. TCPMode tooltype.
  58.  
  59. Using CLChatGUI
  60. ***************
  61.  
  62. After connecting to the chat server, the main window opens.  It
  63. consists of a channel selection gadget, a topic gadget, the main output
  64. window, your input string gadget and the user operation gadget group.
  65. It also features a menu bar with several options and shortcuts for
  66. server commands.
  67.  
  68. You send text to the chat server by simply entering it in the input
  69. gadget.  Commands are also send to the server by entering them in the
  70. input gadget.  You may want to use the /HELP command to learn about
  71. available server commands.  The input gadget is normally automatically
  72. activated; if it is not, simply press SPACE to activate it.  A
  73. history of the last 100 lines entered is kept; you may use
  74. Cursor/UP or Cursor/DOWN for accessing entries in the history.
  75.  
  76. Changing channels is done by entering a new channel name in the channel
  77. selection gadget.  Note that the server will automatically create a
  78. channel if it does not exist. Already existing channels may be selected
  79. with the popup listview right of the channel gadget. The popup button
  80. has a hidden keyboard shortcut h which opens the channel selection
  81. listview.
  82.  
  83. If you have channel operator status, you may change the current
  84. channel's topic by entering a new one in the topic gadget.  The
  85. contents of this gadget are automatically updated if someone else
  86. changes the topic.
  87.  
  88. User operations
  89. ***************
  90.  
  91. The user listview displays all users currently logged into the chat
  92. server and the name of the channel they are currently on. Users with
  93. channel operator privilege are marked with a @, users with chat
  94. operator privilege are marked with a ! before the name.
  95.  
  96. Double clicking on an entry in the user listview requests a /WHOIS
  97. user command from the server.  Pressing the Dialog button opens a
  98. special so-called dialog window.  A dialog window works much like the
  99. main windows, but every text entered within a dialog window is send
  100. directly as a private message to the user.  Also, any incoming private
  101. messages from this user are displayed in the dialog window and not the
  102. main window.  If the Auto checkbox is selected, a new dialog window
  103. is created for the originator of every incoming private message.
  104.  
  105. If you have channel or chat operator privilege, you may also use the
  106. OP, DEOP and KICK buttons to perform the requested operation on
  107. the selected user.
  108.  
  109. Via the PING button you can request a PING request from the selected
  110. user. If the user is running the GUI client, too, you will eventually
  111. receive a reply stating the round-tripe time from you to the remote
  112. user. This is usefull for TCP connections only.
  113.  
  114. If you have a TCP connection, you may also use the Send Files option
  115. to directly send files to the remote user; see FileTransfer for more
  116. information about this operation.
  117.  
  118. Setting the AWAY checkmark causes the AWAY message to be printed, and
  119. every private message to you will automatically respond with Nick is
  120. away (AWAY message).
  121.  
  122. Setup
  123. *****
  124.  
  125. In the setup window, you may modify several operation attributes.
  126.  
  127.     Autoconnect will cause an automatic connection attempt each time
  128. the CLChatGUI is started. Setting Auto Reconnect will cause
  129. automatic reconnect attempts if the connections drops.
  130.  
  131.     File Receive Path specifies the path you want incoming CLFT
  132. files to go (See FileTransfer.). Setting Auto Receive will start a
  133. CLFT receive session without prompting you for confirmation.
  134.  
  135.     Max. Number of Lines specifies how many lines of incoming text
  136. will be stored for the output listview.
  137.  
  138. You may log all or some of the chat server output to a log file; you may
  139. individually select Private, Server or normal Text messages to be
  140. stored in the log file.
  141.  
  142. The Event Handling checkboxes set the reaction of special events.
  143. You may set Deiconify to automatically deiconify the application on
  144. the given event, and DisplayBeep to just have the screen beep.
  145.  
  146. The message section allows you to specify standard texts send to the
  147. chat for given operations. The AWAY message is set when you select
  148. the AWAY checkbox in the main window, the BACK message is send
  149. when you clear the checkbox. The KICK message is a default kick
  150. reason if you kick users using the KICK button below the user
  151. listview.
  152.  
  153. You may create several different configuration files using the
  154. Save... and Load... items from the menu bar.  If you create
  155. icons for the configurations, you can start CLChatGUI by simply
  156. doubly clicking on the configuration icon.
  157.  
  158. FileTransfer
  159. ************
  160.  
  161. If you connect via AmiTCP, you may also use the CLFT protocol to
  162. directly send files to users linked to the chat network (comparable to
  163. the IRC `DCC protocol').  Simply select the user you want to send to,
  164. press the Send files button and a filerequester will open. You can
  165. also directly drop Workbench icons onto the user listview to have the
  166. correspondending files to be send to the currently selected user. If
  167. you have dialog windows open, you may also directly send files by
  168. dropping Workbench icons onto the dialog window.
  169.  
  170. When you have selected files, a CLFT request will be send to the
  171. remote user, and the CLFT sender window will open on your side,
  172. awaiting a connect from the receiving site.  The receiver will then
  173. eventually connect to you via TCP and grab the files offered to him.
  174.  
  175. If you receive incoming CLFT requests, a requester will open showing
  176. you the originator of the request, the number of files to be send and a
  177. list of the files to be transfered.  You may accept or reject the
  178. request, or you may change to destination directory.  Use the
  179. Setup window to change the default path in which incoming files are
  180. stored.  If you have Auto Receive set, no prompt will appear, but
  181. receiving will start immediately.
  182.  
  183. Incoming files are tagged with a filenote designating the originator
  184. nick and IP address for later identification.  If an equally named file
  185. already exists, the file name is postpended with ".2", ".3" etc.
  186.  
  187. You may abort file transfers at any time by clicking on the close
  188. gadget of the receive or send window.  All transfers currently waiting
  189. or in progress will automatically terminate if you quite CLChatGUI.
  190. Note that you cannot send files to users which are connected via TelNet
  191. or the Connectline ANSI client.
  192.  
  193. ARexx commands
  194. **************
  195.  
  196.     CLChatGUI features an ARexx port. The port name is
  197. CLCHATCLIENT.nr, with nr starting at 1 and increasing for
  198. every instance of the program started.
  199.  
  200. Besides the builtin MUI commands (see the `MUI User Guide'),
  201. CLChatGUI current features two commands:
  202.  
  203. SEND TEXT/F
  204.      Sends the given text string as it was entered in the input string
  205.      gadget.  Note that you may also send server commands this way.
  206.  
  207. RECONNECT
  208.      Cause the CLChatGUI to reconnect to the current server.
  209.  
  210. Server Commands
  211. ***************
  212.  
  213. Below is a list of normally available server commands. Don't forget to
  214. use the /HELP command to learn if your server supports a different
  215. command set.
  216.  
  217.    * /CHANNEL [name]
  218.      Join or create a channel
  219.  
  220.    * /INFO [name]
  221.      Show all or specific channel
  222.  
  223.    * /WHO
  224.      List users in channel
  225.  
  226.    * /USERS
  227.      List all users in chat. Note that the output from this command is
  228.      silently interpreted by the client and not displayed in the output
  229.      window.
  230.  
  231.    * /USERS S
  232.      List all users in chat together with the servers they are on
  233.  
  234.    * /WHOIS nick
  235.      Show info about user
  236.  
  237.    * /MSG nick msg
  238.      Send private msg to nick
  239.  
  240.    * /NICK [nick]
  241.      View or change your nick
  242.  
  243.    * /ME msg
  244.      Send action string
  245.  
  246.    * /VERSION
  247.      Show server version
  248.  
  249.    * /SERVERS
  250.      Show other servers connected to your local server
  251.  
  252.     Operator only commands:
  253.  
  254.    * /OP nick
  255.      Give operator state to nick
  256.  
  257.    * /DEOP nick
  258.      Remove operator state from nick
  259.  
  260.    * /TOPIC topic
  261.      Set topic of channel
  262.  
  263.    * /KICK nick reason
  264.      Kick nick out of channel
  265.  
  266. There are also special Chat operator commands which are not visible
  267. to the normal user or channel operator.  Use the /HELP command to
  268. obtain a list of chat operator commands directly from the server.
  269.  
  270. ARCnet
  271. ******
  272.  
  273.     ARCnet, the Amiga Relay Chat Network, is a Internet based
  274. network of CLChatServers available for public usage. As the time of
  275. writing, the following servers were connected to the network:
  276.  
  277.    * anarchy.tue.schwaben.de
  278.  
  279.    * clchat.shiny.it
  280.  
  281.    * wade1.ab.umd.edu
  282.  
  283.    * monet.nfinity.com
  284.  
  285. All servers run the CLChatServer on port 5555. All these servers are
  286. online 24h/day.
  287.  
  288. Check out http://monet.nfinity.com/arcnet/" for up-to-date
  289. information about the ArcNet server list.
  290.  
  291. Copyright
  292. *********
  293.  
  294. The CLChatSystem (CLChatServer, CLChatD , CLChatLink and
  295. CLChatGUI) is (C) 1994-1995 Oliver Wagner, All Rights Reserved.
  296.  
  297. The package may be distributed freely as long as all files are
  298. distributed as a whole archive and are not modified in any way.
  299.  
  300.     CLChatGUI is a MUI application.  MUI is (C) 1993-95 Stefan
  301. Stuntz.
  302.  
  303.     AmiTCP is (C) 1994-1995 NSDI Inc.
  304.  
  305. Please send bug-reports, suggestions and comments via E-Mail to
  306. owagner@lsd.wupper.de.
  307.  
  308. Updates are placed on AmiNet; they can also be downloaded via
  309. anonymous FTP directly from pluribus.wupper.de.  You can also check
  310. out anonymous FTP at the servers listed in the ARCnet reference if they
  311. have a better link to your host.
  312.  
  313. History
  314. *******
  315.  
  316. Version 1.7
  317.         * Fixed a bug where small windows caused the the line formatter
  318.           to loop infinitely
  319.  
  320.         * added /SERVERS command to server command menu
  321.  
  322.         * default setting was saved to ENVARC only, so attempting to
  323.           load defaults without quitting caused the old defaults from
  324.           ENV to be read in
  325.  
  326. Version 2.0
  327.         * added CLFT file transfer capability
  328.  
  329.         * added /USERS S command to server command menu
  330.  
  331.         * miscellaneous internal fixes & cleanup work
  332.  
  333.         * now TCPMode can be used as a workbench icon tooltype, too
  334.  
  335. Version 2.1
  336.         * scroller now does not jump to the bottom when new entries are
  337.           appended if it not already was there.
  338.  
  339.         * smoothed out removing of lines in the main listview.
  340.  
  341.         * added PING option to test round trip time to another user.
  342.           Note that his works with the GUI client only!
  343.  
  344.         * fixed workbench startup bug: always attempted to load the
  345.           executable itself as a settings file thus ignoring any
  346.           default settings in ENV:.
  347.  
  348.         * added new option Auto Reconnect to automatically attempt
  349.           to reconnect if the server connections breaks down.
  350.  
  351.         * nick changes are now tracked and correspondending dialog
  352.           windows are updated with the new nickname
  353.  
  354.         * changed ping frequency back to 15s to reduce IP load
  355.  
  356.         * miscellaneous internal fixes & cleanup work
  357.  
  358. Version 2.2 (internal)
  359. Version 2.3
  360.         * smoothed out scroller handling a bit; will now jump to the
  361.           bottom on window resizes, and will jump as long as no more
  362.           than two lines are scrolled up
  363.  
  364.         * file transfer tasks now run with priority 1 for maximum
  365.           performance
  366.  
  367.         * added better icon created by `NEUMANN'
  368.  
  369.         * minor speedup in listview display hook
  370.  
  371.         * added missing cycle chain for option window
  372.  
  373. Version 2.4
  374.         * now activating any output window automatically actives the
  375.           correspondending input string gadget
  376.  
  377. Version 2.5
  378.         * fixed bug with lines > 255 chars to be corrupted upon listview
  379.           insertion
  380.  
  381.         * fixed several types in texts
  382.  
  383.         * now file transfer can be initiated by dropping icons onto a
  384.           dialog window
  385.  
  386.         * will no longer change topic string gadget contents while user
  387.           is editing it
  388.  
  389. Version 2.6 (internal)
  390. Version 2.7 (internal)
  391. Version 2.8
  392.         * changed prefix entries to be more clearly
  393.  
  394.         * fixed several hidden internal race conditions regarding CLFT
  395.           cleanup which could case enf-hits or visits to india
  396.  
  397.         * option window is now a register group
  398.  
  399.         * added CLFT auto receive option
  400.  
  401.         * added logging capability
  402.  
  403.         * added PING and SEND FILE buttons to the user dialog windows
  404.  
  405.         * it is now possible to enter commands in the user dialog
  406.           windows
  407.  
  408.         * added server history feature
  409.  
  410.         * added AWAY feature
  411.  
  412.         * added AWAY, BACK and KICK message configurability
  413.  
  414.         * fixed topic gadget to always update when the window is
  415.           deactivated even if it is the active object
  416.  
  417. Version 2.9
  418.         * changed "««" within dialog window to "IN"
  419.  
  420.         * fixed various problems with dialog window listview handling
  421.           (no proper flushing, no proper jump-to-bottom)
  422.  
  423.         * now dialog windows will automatically be activated when
  424.           "DIALOG" is select for an user for whom a window already
  425.           exists
  426.  
  427.         * removed AmiTCP dependancy due to time() from net.lib. Now has
  428.           it's own, even faster time() implementation using
  429.           timer.device's GetSysTime()
  430.  
  431. Version 2.11
  432.         * fixed word-wrap bug
  433.  
  434.         * added "CLFT Auto Close Window" option
  435.  
  436.         * several internal cleanups
  437.  
  438. Version 2.12 (not released)
  439.         * fixed CLFT Receive abort bug
  440.  
  441.         * added internal text commands "/PING nick", "/QUERY nick",
  442.           "/AWAY <text>" and "/SEND nick" as shortcuts for the
  443.           equivalent GUI operations
  444.  
  445. Version 2.13
  446.         * fixed CLFT Receive accessing the wrong SocketBase
  447.  
  448. Version 2.14 (not released)
  449.         * added regular quit operation including a preference
  450.           definition for the default quit reason string if clchatgui is
  451.           closed by close gadget, rexx command or CX exchange.  /QUIT
  452.           now causes CLChatGUI to terminate itself.
  453.  
  454.         * added version query. Syntax is "/VERSION user", version
  455.           without any parameters get's send to the server as usal,
  456.           querying the server version.
  457.  
  458.         * added proper error returns for wrong parameters with the
  459.           internal text commands.
  460.  
  461.         * added Auto-Away capability, setting the user automatically
  462.           /AWAY after X minutes of inactivity.
  463.  
  464.         * cleaned up User listview refresh. Now refreshes less
  465.           frequently and keeps the previous selection state upon list
  466.           changes. Now sorted alphabetically and by user state.
  467.  
  468.         * the clft send file requester now no longer rejects icon files.
  469.  
  470. Version 2.15
  471.         * now quits with message "Changing Server" when changing server
  472.           using the "Change Server" menu item.
  473.  
  474.         * updated the built-in default server list.
  475.  
  476. Version 2.16
  477.         * fixed auto-away timeout to not be reset by input done in
  478.           dialog windows.
  479.  
  480. Version 2.17
  481.         * Auto-Away has now a checkmark for turning it on/off.
  482.  
  483.         * added auto away warning message.
  484.  
  485.         * Added Auto-Unaway upon message entering.
  486.  
  487.         * fixed options window cycle chain.
  488.  
  489.         * added a reset handler to gracefully terminate the server link
  490.           upon CAA-reset.
  491.  
  492.         * added Autojoin channel feature.
  493.  
  494.         * fixed a bug in CLFT which caused file names which where
  495.           ERROR_OBJECT_IN_USE to be not bumped accordingly.
  496.  
  497.         * now the CLFT process check MUI events more regularly, and
  498.           outputs current cps in the gauge display.
  499.  
  500.         * no more AWAY respone for VERSION query replies.
  501.  
  502. Version 2.18 (Release Version of 2.17)
  503. Version 2.19
  504.         * added support for private channels, including SetPriv/ClrPriv
  505.           buttons for channel and Allow/Disallow buttons for the user
  506.           listview.
  507.  
  508.         * added VERSION request button to the user listview.
  509.  
  510.         * the user listview buttons are now using the tiny MUI font.
  511.  
  512.         * now dialog windows have a input string history, too.
  513.  
  514.         * fixed automatic string gadget activation when clicking into
  515.           dialog windows.
  516.  
  517. Version 2.20
  518.         * fixed CLFT windows to properly open on the screen the main
  519.           window is on.
  520.  
  521.         * added DCC support for IRC compatibility. Note that /DCC SEND
  522.           doesn't work correctly if no filename is specified on the
  523.           command line.  Requires DCC.xxx.AS225.
  524.  
  525.         * "Send files" from dialog windows didn't worked correctly.
  526.  
  527.         * various internal fixes.
  528.  
  529. Version 2.21 (internal only)
  530. Version 2.22
  531.         * added support for ircII formating codes: CTRL-B, CTRL-_ and
  532.           CTRL-V. You need to turn of Input Filtering in IControl Prefs
  533.           to use these.
  534.  
  535.         * now, the CLFT incoming requester will also appear on the right
  536.           screen.
  537.  
  538.         * CLFT send is now compatible with file requester
  539.           implementations which don't correctly return fr_NumArgs == 1
  540.           when only a single file is selected.
  541.  
  542. Version 2.23
  543.         * some internal cleanup (i.e. the main module is no longer
  544.           compiled with NOCONSTLIBBASE to save speed & size)
  545.  
  546.         * now autounaway is only triggered by public messages.  This
  547.           also fixes the bug that /AWAY doesn't work correctly when
  548.           autounaway is active.
  549.  
  550. Version 2.24
  551.         * now bums the nickname to "nick1", "nick2" etc. if nickname is
  552.           in use during login.
  553.  
  554.         * small internal cleanups.
  555.  
  556. Version 2.25 (not released)
  557.         * stupid bug in AWAY loop protection fixed.
  558.  
  559. Version 2.26
  560.         * now /SEND can accept file names as well (e.g. "/SEND nick
  561.           ram:arc.lha").
  562.  
  563.         * no longer crashes upon receiving ^C in TCPMode
  564.  
  565. Version 2.27
  566.         * removed now unnecessary /USERS request upon receiving
  567.           [LINK] or [UNLINK] messages.
  568.  
  569.         * no longer crashes when trying to send something in the connect
  570.           window via the server command menu.
  571.  
  572.         * now reacts on ^C in local mode as well.
  573.  
  574.         * the "Auto-AWAY in 1 Minute" now also occurs in local mode.
  575.  
  576. Version 2.28 (not released)
  577.         * can now play a sound instead of simply beeping. Uses
  578.           sound.datatype, so can load everything you've got a data type
  579.           for.
  580.  
  581. Version 2.29
  582.         * fixed e-mail & http addresses in info requester.
  583.  
  584. Version 2.30
  585.         * fixed the default server list.
  586.  
  587.         * added a default sound setting for OS 3.x machines.
  588.  
  589.         * added a sample sound file courtesy of Sandro Catallo.
  590.  
  591.         * recompiled with SAS/C 6.56.
  592.  
  593.         * fixed some MUI3 stuff.
  594.  
  595. Index
  596. *****
  597.  
  598.  
  599.  
  600.  ARCnet                                 ARCnet
  601.  ARexx commands                         ARexx commands
  602.  Connecting                             Connecting
  603.  Copyright                              Copyright
  604.  FileTransfer                           FileTransfer
  605.  History                                History
  606.  Local chat                             Connecting
  607.  Server Commands                        Server Commands
  608.  Setup                                  Setup
  609.  User operations                        Using CLChatGUI
  610.  Using CLChatGUI                        Using CLChatGUI
  611.  
  612.