home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / p / pozchat / !PozChat / Docs / Instruct < prev    next >
Text File  |  1996-10-01  |  14KB  |  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             -