
			      ------------------- 
			    _L_A_N_C_h_a_t _f_o_r _L_i_n_u_x _v_1_._0_._1
                              -------------------
		  
		  Ultimate Local Area Network Chatting Program      
		    (c) Mateusz Skoczewski <melun@xox.pl>
                  LANChat Home Page: http://lanchat.republika.pl
                                  

-----------------
TABLE OF CONTENTS
-----------------

    1. Disclaimer
    2. What is LANChat
    3. Installation
    4. Console Overview
    5. Commands summary
    6. Features
    7. Windows LANChat compatibility 
       and differences 
    8. Obtaining LANChat 
    9. FAQ
   10. Feedback


11.. DDiissccllaaiimmeerr
  
    The Linux LANChat and related utilities are free software; you can redistribute
it and/or modify it under the terms of the GNU Library general Public License 
as published by the Free Software Foundation; See the file COPYING for copying 
conditions.

    Version 1.0.1 is considered a beta release. This means it may not be
stable and may have a lot of bugs:) I'm not liable for any damage caused by
the use of this program. (_DO NOT_ RUN LANCHAT AS ROOT)

    Linux version of LANChat is based on LANChat 4.0 Specification by Piotr Kowalski 
(goro@vc.pl) so it's fully compatible with GORO's Windows LC 4.0
In my network only I have a Linux so I can't test LANChat on the two Linux 
computers, so I don't know his behavior (and how (or if) he works if there is
only Linux LANChat run without his older brother windows LANChat:) 

22.. WWhhaatt iiss LLAANNCChhaatt
    
    LANChat a network-chatting program. It allows you to chat with your friends 
over a TCP/IP based Local Area Network. It doesn't need any type of server
to run. All users are equal. LANChat is a not client-server application. 
All your machines act like independent servers. To communicate LANChat uses
broadcast UDP messages so they don't travel over the Internet (only to the 
closest router). LANChat need C-class addressing type (theoretically max 254 
users). By using LANChat you can talk with windows and Linux users in your 
local area network. You can use LANChat over networks connected by the BRIDGE.  

33.. IInnssttaallllaattiioonn

Program needs ncurses library (minimum ncurses version 1.9.4) 
You can get the latest version from the anonymous FTP archive sunsite.unc.edu

Check and edit the lanchat.h 'customization area' supplied with the package. 
It's very likely that you won't need any modifications to the lanchat.h.

Run 'make' and wait for a successful compile. 

Enjoy :)

44.. CCoonnssoollee OOvveerrvviieeww

- On the top is the window topic bar. You will see there LANChat version 
  or if the topic is set actual topic

- On the left - "online list" - users that are online. (A) over the nickname
  means that user is now away 

- On the bottom, input box. You enter your text here, it can be a 'to-say' 
  quote or a system command (see commands reference for details). 

55.. CCoommmmaannddss ssuummmmaarryy

Commands are similar to IRC commands.

/away <reason> 
  
  Marks you as "away".  Whenever someone (click on your nickname - windows or 
  type /sa command - Linux) they automatically see whatever message
  you set. Away users have "(A)" - away indicator over they nicknames on 
  "online list" Writing something marks you as no longer being away.

/whois nickname 
  
  Shows more detailed information about the nickname specified.
  This info includes the users nickname, host, server, LANChat version,
  away status, operating system and IP.
  
/topic <new-topic>

  Every conversation should have its topic. The topic is shown in LANChat's
  topic bar.

/sa  
  Show users away reasons set by /away command.
 
/status 
  Show some usage statistics like bytes and packets received actual topic 
  and topic-time

/msg "nickname" <body>

  Sends a private message to the nickname specified.

/me <body> 
  
  This command can be used to send a description of what you are doing
  or how you are feeling or just about anything concerning you

/pop "nickname" <body>  
  
  Sends a pop-message, windows LANChat will display message-box with the body
  and "OK" button so when user press OK LANChat will show you that your pop-up
  has been received. Linux LANChat just shows the body and produce short "beep"
  sound.  
    
/nick <new-nick> 

  Changes your nickname to whatever you like. The nickname may be at
  most 19 characters and at last 3. If you specify a nickname that is already 
  in use, you will be prompted to enter a new nickname. (not in version 1.0.2:)

  Remember user names are NOT case sensitive. 
  Henry, henry, HENrY, means the same user!
  
/clear  
  
  Clears screen and sends mother-attack alert message.
  
/credits 
  
  Show some credits
  
/help  
  
  Shows some short commands summary
  
/quit 
 
  Close LANChat session and exit program.

66.. FFeeaattuurreess

a) Logging - log all received messages (except MSG - private messages) to 
   the files created in lanchat/logs directory. 
   LANChat logs directory should be writable for user that is using LANChat! 

b) timed outs - You can see 'timed out' message like "John timed out." 
   when the John's computer hanged (windows:)

77.. WWiinnddoowwss LLAANNCChhaatt ccoommppaattiibbiilliittyy aanndd ddiiffffeerreenncceess 
  
  Linux LANChat is fully compatible with windows LANChat 4.0 and his 
  successors 4.1, 4.2 and LANChat Pro 2

- In windows LANChat every user has its color so his messages are displayed
  in his own one. In Linux LANChat all messages are gray, You can set your
  color in lanchat.h file (user customization section) and this color will
  be use to display your messages in windows LANChat main box.    

- When you send pop-up message from Linux to windows, windows LANChat create
  separate dialog box with the pop-up body and "OK" button. If you receive 
  "pop-up has been received" message it means that user pressed "OK" button.
  When you send pop-up from Linux to Linux on the spot you'll see that pop-up
  has been received cause Linux LANChat do not wait until user press "OK"
  button. He haven't OK button at all he at once display pop-up body and produce
  "beep" from speaker.       

- You can't send pop to windows users (RTF)

- Chatrooms are not implemented

88.. OObbttaaiinniinngg LLAANNCChhaatt

 Get the latest version from the web: 

 http://friko4.onet.pl/ki/lanchat - LANChat Homepage
 http://lanchat.republika.pl
 

99.. FFAAQQ

 Q: My lanchat doesn't receive anything...
 A: See ROUTE text file
 
 Q: LANChat shows me as 127.0.0.1 localhost@localdomain
 A: Do you have your <ip, hostname> entry in the /etc/hosts file?

1100.. FFeeeeddbbaacckk

Bugs are usual.. else something is wrong and you better report it as a bug!

Thank you for using LANChat.
melun@xox.pl
