home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / p / pozchat / !PozChat / Docs / Instruct < prev    next >
Encoding:
Text File  |  1996-10-01  |  13.3 KB  |  483 lines
  1. !PozChat v0.90 by James Porritt
  2. ===============================
  3.  
  4. Release
  5. =======
  6.  
  7. This release (0.90) of the program is freeware, although it could
  8. conceivably become shareware in the future. In any case please I would be
  9. pleased to hear from anyone who runs it seriously.
  10.  
  11. Version 0.90 is quite a break-away from previous versions, and is due to its
  12. parallel development with the Unix version.
  13.  
  14. If you are upgrading from a previous version (before 0.90), then I would
  15. advise NOT dragging !PozChat over an old version, but to have a brand new
  16. copy.
  17.  
  18. Overview
  19. ========
  20.  
  21. This talker provides a lot of the features which I like in talkers, and is
  22. easy for a beginner to start on. I want a talker which I can talk on straight
  23. away, without having to wade through pages of introduction and tons of stuff
  24. on location, story, etc.
  25.  
  26. Connecting and Talking
  27. ======================
  28.  
  29. To connect merely telnet to the port defined in the preferences window.
  30.  
  31. You will be asked for an account name. If the name you enter does not have an
  32. account then you will be logged straight in as a guest, otherwise you will be
  33. asked for the password.
  34.  
  35. Talking is merely a matter of typing the text you want to say.
  36.  
  37. When you first connect you will be in group Public, and only people in that
  38. group will be able to hear what you say. To see who is on the talker type:
  39. .who
  40.  
  41. You can also check who is on the talker without even having to connect, by
  42. telnetting to port defined in the preferences window.
  43.  
  44.  
  45. Commands
  46. ========
  47.  
  48. A user can only access a command if his privilege is greater than or equal
  49. to that of the command. If not then the talker will appear not to be aware of
  50. that command.
  51.  
  52. NOTE: All user and group names as well as commands are case insensitive.
  53.  
  54. .QUIT
  55.     Quits the talker.
  56.     Minimum privilege - 0.
  57.  
  58. .HELP [<command>|<help file>]
  59.     Help facility.
  60.     Minimum privilege - 0.
  61.     
  62. .COMMANDS
  63.     Lists all known commands.
  64.     Minimum privilege - 0.
  65.  
  66. .INFO
  67.     Gets account info on <user>.
  68.     Minimum privilege - 0.
  69.     
  70. .EXAMINE <user>
  71.     Examines <user> on line.
  72.     Minimum privilege - 0.    
  73.     
  74. .WHO
  75.     Lists who is on the talker.
  76.     Minimum privilege - 0.    
  77.  
  78. .EMOTE <action>
  79.     Express an <action>, eg ".EMOTE waves" from user "Poz" would display:
  80.     "Poz waves".
  81.     Minimum privilege - 0.
  82.     
  83. .WHISPER <user> <message>
  84.     Whisper <message> to <user>.
  85.     Minimum privilege - 0.
  86.     
  87. .GROUPTELL <group> <message>
  88.     Whisper <message> to people in <group> only.
  89.     Minimum privilege - 0.
  90.     
  91. .COMMENT [<message>]
  92.     Sets your comment to <message>. If <message> is ommited your last
  93.     comment is removed.
  94.     Minimum privilege - 0.
  95.  
  96. .COMMENTS
  97.     Lists all users comments.
  98.     Minimum privilege - 0.
  99.  
  100. .GROUP <group>
  101.     Changes to <group>.
  102.     Minimum privilege - 0.
  103.     
  104. .GROUPS
  105.     Lists the groups currently on the talker.
  106.     Minimum privilege - 0.
  107.  
  108. .EVICT <user>
  109.     Evicts a user from a group.
  110.     Minimum privilege - 0.
  111.  
  112. .JOIN <user>
  113.     Joins a user in a group.
  114.     Minimum privilege - 0.
  115.  
  116. .GMASTER <user>
  117.     Makes someone else the group master.
  118.     Minimum privilege - 0.
  119.  
  120. .GNAME <name>
  121.     Changes the current group name to <name>.
  122.     Minimum privilege - 0.    
  123.  
  124. .TIME
  125.     Displays local time.
  126.     Minimum privilege - 0.
  127.  
  128. .CREDITS
  129.     Shows a list of credits for the talker.
  130.     Minimum privilege - 0.        
  131.  
  132. .SET
  133.     Sets user related flags. See the note on flags below.
  134.     Minimum privilege - 0.
  135.     
  136. .UNSET
  137.     Unsets user related flags. See the note on flags below.
  138.     Minimum privilege - 0.
  139.  
  140. .IGNORE <user>
  141.      Prevents you from hearing, or being whispered to by <user>.
  142.     Minimum privilege - 0.
  143.  
  144. .UNIGNORE <user>
  145.      Stops ignoring <user>
  146.     Minimum privilege - 0. 
  147.  
  148. .SHOUT <message>
  149.     Shout <message> to everyone on the talker.
  150.     Minimum privilege - 1.
  151.     
  152. .LOCK
  153.     Locks a group.
  154.     Minimum privilege - 1.
  155.  
  156. .UNLOCK
  157.     Unlocks a group.
  158.     Minimum privilege - 1.
  159.     
  160. .INVITE <user>
  161.     Invites a user.
  162.     Minimum privilege - 1.
  163.     
  164. .UNINVITE <user>
  165.     Uninvites a user.
  166.     Minimum privilege - 1.
  167.  
  168. .INVITES <user>
  169.     See who is invited to all the locked groups.
  170.     Minimum privilege - 1.
  171.  
  172. .PASSWORD
  173.     Enters the password changing procedure.
  174.     Minimum privilege - 1.
  175.  
  176. .SETINFO
  177.     Sets account information. Currently the 'age', 'comments',
  178.     'interests' and 'next around' fields can be set.
  179.     Minimum privilege - 1.
  180.     
  181. .WAKE <user>
  182.     Wake <user> up.
  183.     Minimum privilege - 1.         
  184.  
  185. .GAG <username>
  186.     Gags a user from shouting.
  187.     Minimum privilege - 3.
  188.     
  189. .UNGAG <username>
  190.     Ungags <username>, enabling them to shout.
  191.     Minimum privilege - 3.
  192.  
  193. .NAME <oldname> <newname>
  194.     Changes <oldname>'s name to <newname>.
  195.     Minimum privilege - 5.
  196.  
  197. .WARN <username> <message>
  198.     Warns <username> 
  199.     Minimum privilege - 7.
  200.  
  201. .KICK <username> [<message>]
  202.     Kicks <username> off the talker, and tells him <message>.
  203.     Minimum privilege - 7.
  204.     
  205. .STATS
  206.     Displays some talker statistics.
  207.     Minimum privilege - 9.
  208.     
  209. .INVIS
  210.     Makes you invisible.
  211.     Minimum privilege - 9.
  212.     
  213. .VIS
  214.     Makes you visible again.
  215.     Minimum privilege - 9.
  216.  
  217. .BANUSER <user>
  218.     Suspends a <user>s account.
  219.     Minimum privilege - 9.
  220.     
  221. .UNBANUSER <user>
  222.     Re-enables a <user>s account.
  223.     Minimum privilege - 9.    
  224.             
  225. .ALERT <message>
  226.     Alerts the whole talker with <message>.
  227.     Minimum privilege - 9.
  228.  
  229. .SPY <group>
  230.     Spys on a group.
  231.     Minimum privilege - 9.
  232.     
  233. .UNSPY <group>
  234.     Stops spying on a group.
  235.     Minimum privilege - 9.
  236.     
  237. .SPYING
  238.     Lists the groups you are spying on.
  239.     Minimum privilege - 9.
  240.  
  241. .SETPRIVS <user> <priv>
  242.     Temporarily set <user>'s privs to <priv>.
  243.     Minimum privilege - 9.    
  244.         
  245. .RESTART
  246.     Allows external restart of talker.
  247.     Minimum privilege - 9.
  248.     
  249. .SHUTDOWN
  250.     Shutsdown the talker.
  251.     Minimum privilege - 9.
  252.  
  253. .TSET
  254.     Sets talker related flags. See the note on flags below.
  255.     Minimum privilege - 9.
  256.     
  257. .TUNSET
  258.     Unsets talker related flags. See the note on flags below.
  259.     Minimum privilege - 9.
  260.  
  261. .TLOCK
  262.     Locks the talker from further connections.
  263.     Minimum privilege - 9.
  264.  
  265. .TUNLOCK
  266.     Unlocks the talker allowing connections.
  267.     Minimum privilege - 9.
  268.  
  269. A list of commands can be found in the talker by typing .commands.
  270.  
  271. There do exist various shorthand ways of performing some of these commands.
  272. They are as following:
  273.  
  274. "<message>" would send "<username>   : <message>" to the current group.
  275.  
  276. "`<message>" would send "<username>   : <message>" to the current group.
  277.  
  278. ": <message>"  would send "<username> <message>" to the current group.
  279.  
  280. ":: <message>" would send either "<username>'s <message>" or 
  281. "<username>' <message>" (depending on which is gramatically correct) to
  282. the current group.
  283.  
  284. ";<message>" would send "<username><message>" to the current group.
  285.  
  286. "! <message>" would send "<username>   !<message>" to everyone on the talker.
  287.  
  288. "> <otheruser> <message>" would send "<username>   > <message>" to user
  289. <otheruser>
  290.  
  291. ">> <groupname> <message>" would send "<username>   >> <message>" to group
  292. <groupname>"
  293.  
  294. "< <otheruser> <message>" would send "<username> <message>" to user
  295. <otheruser>
  296.  
  297. "<< <groupname> <message>" would send "<username> <message>" to group
  298. <groupname>
  299.  
  300. Online Help
  301. ===========
  302.  
  303. Help is provided on all commands by typing: .help <command>, and you can
  304. addhelp on any item by putting a file with that name into the
  305. <PozChat$Files>.Help directory.
  306.  
  307. Accounts
  308. ========
  309.  
  310. Accounts can be created/changed with a text editor, and putting the
  311. relevantly named account into the Accounts directory located inside the main
  312. !PozChat directory. In previous versions of !PozChat an accounts window has
  313. existed which has allowed 'simpler' editing of accounts, but since I've
  314. changed the way accounts are stored the window has been removed from this
  315. version.
  316.  
  317. Flags
  318. =====
  319.  
  320. A quick note on which flags can be set with which commands.
  321.  
  322. .SET/.UNSET
  323.  
  324.   VT100 - sets wether important text is displayed in bold or not.
  325.   CR    - sets wether carriage returns are sent as well as line feeds.
  326.   ECHO  - sets wether user input is echoed.
  327.   BEEP  - sets wether the users terminal beeps whenever anyone connects.
  328.  
  329. .TSET/.TUNSET
  330.  
  331.   BEEP            - Makes the host computer beep whenever anyone connects
  332.   GUESTVT100      }
  333.   GUESTCR         } Sets what flags are set in the guest account
  334.   GUESTECHO       }
  335.   GUESTBEEP       }
  336.   
  337. .TSET
  338.   
  339.   LOG <value>     - Sets the talker log level to <value>
  340.   CHATPORT <port> - Sets the port the talker starts on.
  341.   WHOPORT <port>  - Sets the port the .who information is available on.
  342.  
  343. .TUNSET
  344.  
  345.   LOG             - Stops talker logging
  346.  
  347.  
  348.  
  349. Advanced Connection
  350. ===================
  351.  
  352. The .who, .info and .quit commands are available from the login prompt. This
  353. is to enable you to see who is connected before you logon.
  354.  
  355. Preceding your username with special characters will change the action of
  356. your login. Putting a '*' before your name will kick you off the talker if
  357. you already have a connection to it. You might need this if your client
  358. crashes unexpectedly and you want to log in again quickly. A '_' before your
  359. username will log you in invisibly, should that facility be available to you.
  360.  
  361. Priviliges
  362. ==========
  363.  
  364. Note that .SETPRIVS only temporarily sets a users privileges. For security of
  365. the talker I thought it best if privileges in the account file can only
  366. be set from the main account window.
  367.  
  368. Groups
  369. ======
  370.  
  371. Groups can be entered with the group command. If you try to enter a group
  372. which doesnt exist, then it is created and you become the group master of
  373. that group. If you are a group master then you can .lock/.unlock the group,
  374. from being entered from outside. See below for details. Group 'Public' is
  375. special because no one can be the master of it or lock it. It can however be
  376. locked by people with a privilege level of 9.
  377.  
  378. When a group is locked from being entered from the outside, all people in the
  379. group at that time are given leave to come and go from it as they wish. Other
  380. people can be added/removed to this list, by anyone in the locked group using
  381. the .invite/.uninvite commands.
  382.  
  383. To remove someone from a group use .evict. Note that you either have to have
  384. a privilege level of 5 or greater or be the group master. If someone is
  385. evicted from a locked group, then they are also uninvited from that group. 
  386.  
  387. Note that if a user has a privilege level of 9, then they automatically have
  388. group master privileges.
  389.  
  390. Users with a privilege level of 9 can see what is being said in a group they
  391. arent in by using the .spy command. Note that if a group you are spying on
  392. becomes empty then you will automatically stop spying on it, even if it
  393. becomes active again in the future.
  394.  
  395. Visibility
  396. ==========
  397.  
  398. Users can make themselves invisible with the .invis command. This means that
  399. they become invisible to users with a privilege level less than 9. Invisible
  400. users can not speak, and they in turn can not be whisperd to, gagged or
  401. ignored by people who cant see them. Visibility is achieved again by use of
  402. the .vis command. 
  403.  
  404. When the .invis command is used you appear to those that can not see you to
  405. log out of the talker, by means of a disconnection message. A log in message
  406. is also faked when you re-emerge.
  407.  
  408. User Interface
  409. ==============
  410.  
  411. The !PozChat icon on the iconbar displays the total number of users connected
  412. below it. Clicking select on it brings up the main window, from which various
  413. user statistics can be obtained. There is also an option to kick the user
  414. off. At the moment it doesnt tell them or anyone else why!
  415.  
  416. Clicking adjust on the !PozChat icon on the Icon bar brings up the talker
  417. control window. From this it is possible to broadcast a message to everyone
  418. on the talker.
  419.  
  420. From the menu a preferences window can be brought up to configure various
  421. aspects of the talker. The options on here are mirrored by the .TSET/.TUNSET
  422. command.
  423.  
  424. From the preferences window you can also switch on logging, which at the
  425. moment logs relatively few things, but eventually could log everything from
  426. the talker starting and stopping, to all conversation being logged.
  427.  
  428. Configuration
  429. =============
  430.  
  431. All text files used by the talker itself, are stored in <PozChat$Files>. By
  432. default this is set to !PozChat.Files although you could conceivably change
  433. this to something else. When you first telnet to the talker you see the file:
  434. <PozChat$Files>.Intro After you successfully connect, you see the file:
  435. <PozChat$Files>.Welcome
  436.  
  437. Updates
  438. =======
  439.  
  440. This program will be updated as and when I find bugs with it, or become aware
  441. of how things could be better implemented, or extra features added. Please
  442. feel free to email me, telling me of any problems or suggestions to do with
  443. !PozChat.
  444.  
  445. There a likely to be quite a few updates to this talker, as I have a tendancy
  446. of releasing software and then finding a bug in it. :*) If you are quite
  447. enthused by this program, that why not email me and you can perhaps become a
  448. beta tester?
  449.  
  450. This talker has a Unix counterpart. Please contact me if you are interested
  451. in such a beast!
  452.  
  453. Thanks
  454. ======
  455.  
  456. Some bits of this talker are very like (in spirit, not code!) to a talker
  457. written by Nick Waterman and the Nilex programming team. My thanks go to him
  458. for creating a no-nonsense style for a talker for people who dont want MUD on
  459. their faces :*)
  460.  
  461. My thanks also to Kevin Wheatley (HxPro) for the source code to his talker
  462. which I was able to reference to see how he had implemented certain things,
  463. as my C programming skills arent perfect yet. :*)
  464.  
  465. A big thank-you to Julian Smith for maintaining the code for DeskLib, which
  466. proved invaluable for programming the WIMP interface, as well as providing
  467. debugging windows!
  468.  
  469. An infinitely big thank you to David Good for actually running the talker on
  470. his computer, for a glorius 3 months in 1996.
  471.  
  472. Thanks for bug spotting go to:
  473.  
  474. Gareth Long
  475. David Good
  476. Joseph Heenan
  477. William Turner
  478.  
  479. ===========================================================================
  480.  
  481. James 'Poz' Porritt 1/10/1996
  482.  
  483. I can be contacted at: j.m.porritt@dur.ac.uk