Otherware

home *** CD-ROM | disk | FTP | other *** search

/ Otherware / Otherware_1_SB_Development.iso / mac / util / comm / ircle10.sit / ircle Users Manual < prev

Wrap

Text File | 1992-09-06 | 30.4 KB | 683 lines

--------------------------------------------------------------------- ircle Users Manual --------------------------------------------------------------------- Version 1.0, Sept. 1992 Welcome to the Internet Relay Network, Macintosh User! ircle is an IRC client program that lets you talk with people all over the world via the IRC (Internet Relay Chat) network. All you need is a Macintosh with a network connection and the MacTCP driver, and you have to be able (technically) to connect to an IRC server. Contents of this file: Getting Started The Server ircle Windows and Messages Commands CTCP and DCC commands ircle Menus Further Reading Beware of Pitfalls What is still to be done The inevitable legal stuff Credits Getting Started -------------- Maybe you know already IRC. You might have used it from a Unix, VMS, or VM machine, probably using Telnet from your Mac to log in to that machine. Then you hopefully will have little doubt about how to use ircle, and you may as well skip this manual and just try it out. You will notice that there are probably many windows, one of them per channel you're on, and that you switch channels by just switching windows; that you have the most important commands available on shortcut keys, but you can use all commands like in a text-only environment too. To all others who don't know IRC it is here to be explained what data they have to enter into the fields of the dialog which will be presented to them after they have chosen a name for the preferences file at the first program startup. (Subsequently it is possible to start ircle by double-clicking on the preferences file and skip these dialogs.) The preferences file is absolutely necessary, the program will not run without the user having specified one first. The settings are the following: - Server: The hostname or IP address of your server. See below on more information. - Port: The port number of your server. By now, the port used by IRC servers should always be 6667, but a different number can be entered in case there are special applications such as site-specific local servers that use a different port. Usually you don't have to worry about this. - Nickname: Your most important user-specific thing. This is the name by which you will be known to other people on IRC, as each line of text you send to the network will on other users' screens be prefixed by your nickname. Choose a name that you like, and that consists of printable characters with no spaces and is at most 9 characters long. But be aware of the fact that no two people on the network may use the same nick at one time. You will be presented an error message if a collision occurs and may not proceed until you have chosen another nickname (see below on the appropriate commands). Also be aware of the NickServ, which is a database that holds the nicknames of regular IRC users and will inform you if you have chosen a nick that has been registered by some other user. Nicknames are not owned, but it is considered bad behaviour to ignore NickServ and proceed with some other user's nick. NickServ will inform you about how to register your own nick too. - E-Mail address: When IRC was Unix-specific, the servers kept track of users by their login names. However, on a machine (Mac or MSDOS) without user logins, this is senseless, but the server needs this information. As it can also be used by other IRC users to figure out who you are (to send you mail, for example), you should enter a valid account name (provided you have one, which is assumed to be the case if your site is Internet-connected :-) Some servers try to verify this name; I am not sure if that works with ircle too, when in doubt check with your server administrator (see /admin command). NOTE that if you pass an address of the form person@site.domain, the server will ignore the part after the @ and replace it with the actual machine it is called from, in this case of the Mac, and the /whois command will give the wrong address person@Mac.domain (with Mac replaced by the name your Mac is assigned) or sometimes person@1.2.3.4 (with a raw IP address). Nevertheless this information is valuable, see below on the /ctcp finger command. - User name: This should be your real name but most people add comments to that name. Not too long a line, please :-) - Auto-exec: Here you can enter commands that are to be processed on startup (usually /join, /topic, sometimes /ignore). They have to be separated with a semicolon, e.g. /join #MyChannel;/toipc #MyChannel I'm back! (New users best leave this field blank.) - Notifications: ircle is able to run in the background (under System 7 or MultiFinder), and it can have more than one conversation window, so it is convenient to get notified of the fact that something happens in a background window. You may choose which notification you would like in which situation, from a flashing icon in the menu bar and a sound being played. The Server ---------- The IRC network consists of a number of servers all over the world, which are interconnected, and clients that can connect to this servers. To use IRC you have to know the address (hostname or IP number) of a server which you can use, and this should be the server which can be reached from your site at minimum delay and network load (usually the geographically closest). The simplest case for finding a server is when you or some other people at your site have already used IRC: look at the screen when the connection is started. The server will give its name with the welcome message: *** Your host is server-name [full-host.name], running version xxxx. Enter the full host name into your preferences dialog. Or you ask one of the local network gurus, who probably will know a server address, especially in big organizations which probably have a server themselves. If that doesn't work, follow the method suggested by Helen Trillian Rose (in the file 'IRC Advice', which you should read completely anyway). A complete list of servers gets sometimes posted in the alt.irc newsgroup. NOTE that you need the technical possibility to connect to a server. For example, if your site has a local network running TCP/IP but no connection to the Internet, you can not use IRC. If you site has an Internet connection but no IRC server on the local network, you will need to connect to a server outside it, but many sites explicitly inhibit non-local connections for certain machines. In that case, you should *politely* (!!!) ask your network administrator for lifting that restriction. (Usually the reason for such restrictions is users, especially on PCs open to the 'public' e.g. in university computing centers, abusing network access for FTPing large amounts of data from the other end of the world. Restricting network access is in fact the only way of dealing with this problem, but maybe there is a person willing to start a local and therefore reachable IRC server. :-) Some sites still are reluctant to allow the use of IRC because of fear that it may put too much load on the network. This is usually not the case, however, and you should try to settle the case with the responsibles using reasonable arguments. ircle Windows and Messages -------------------------- The first window you will see after successfully calling a server is called the message window. You will recognize it by its title: it is your nickname. The server will give you a few lines of welcome and MOTD messages. Then, at the bottom of the screen, there is a small box containing two lines of Monaco-9 called the status/input window. (In fact *this* window pops up first.) Everything you type on the keyboard will appear in the input line, and it will be processed on hitting the Return key. Above is the status line giving general information about you and the server: Mister talking to #Hmgpf noc.belwue.de Flsh Log FT(1) 10:31:12 'Mister' - your nick '#Hmgpf' - current target to wich mesages are sent 'noc.belwue.de' - your server. Will be replaced by 'Err(n)' if an error occurs in the connection between server and client. 'Flsh' will appear when you are flushing messages (see below on menus). 'Log' will appear when you are logging messages to a file. 'FT(n)' indicates that n DCC Filetransfers are in progress. The input line is the most non-Mac-like thing in ircle but this is influenced by the fact that other IRC clients use a similar input line. You can place the input cursor with the mouse (one click will not suffice as it first activates the window) and move it with the cursor keys. The up/down keys allow for recalling the last entered lines (limited to 5000 chars). IRC conversation is done by 'channels' and 'private messages'. Channels have names beginning with a # character. You can list the channels currenttly in use with the /list command. When you join a channel (with the /join command), all messages you type get sent to all people on that channel, and you will see all messages by that persons in the form <grumbl> Is anybody out there? In ircle every channel corresponds to a window. When you join a channel, a new window will pop up having the name of that channel. It will present you with a topic (if set) and a list of people on that channel. Private messages are exchanged between to people. They appear in the window like *bubbl* Where is Prof. Smith tomorrow? and the window they appear in is usually the frontmost window, regardless of the channel(s) the sender is on, unless there is a query window of that nick. It is intended that private messages are exchanged via query windows. They are opened with the /query command and look like channel windows with a nickname as title. Conversation between you and that nickname is done via private messages. There is a third means of conversation, the DCC CHAT connection, which is a window with a title consisting of a nick surrounded by = signs. See below on DCC CHAT. A NOTICE is a message that is generated as automated response to certain commands by servers or other client programs (but may be sent by users, too). It looks like -uni-karlsruhe.de- This is the University of Karlsruhe, Germany. (For experienced users: If your server still supports WALLOPS they will as usual look like !jerk! Oops, obsolete server; but this information is getting out of date. WALL is not supported by this client.) Watch out for messages in the message window of the form /WORD/sender/target/arguments/ or /NUM/sender/target/arguments/, where NUM is a 3-digit number. The former are generated by servers sending erroneous commands to a client (which should not happen in any case, that could be a server bug), the latter are normal status messages that should be processed by the client but are not because of implementor's laziness. Somebody could tell me if such things occur. You can obtain a window full of helpful information by giving a /help command or via the About box. When you close a channel window you will leave the channel. Closing a query window or the help window will do nothing more than closing the window, and closing a DCC CHAT window will close that connection. Closing the message window will merely hide it until a message appears in it. All windows can hold up to 10000 characters' worth of messages. If this number is exceeded, 3000 characters from the top will be deleted, so you always have access to at least the most recent 7000 characters of that conversation. You can mark text in a window with the mouse and Copy it via the Edit menu to the clipboard for further use. Commands ---------- Having completed a line of input, you let it be processed by hitting the Return key. Then it is determined if the line consists of a command or a message. Commands are lines which start with the / (slash) character followed by the command name and optional parameters, e.g. /join #tuebingen (this is the command that will get you on a channel). Messages are everything not starting with a slash. Messages are sent to the frontmost window, more precise to that (channel or query or DCC CHAT connection) that runs over the frontmost window, the message type and target being determined by the window type and name. And here is a list of IRC commands (given in lowercase letters, but they are not case-sensitive, as nicks and channel names are not either): /admin name - will give you administrative info about the specified server (which may be a server name or a nick, in the latter case giving info about that user's server). This always should at least include an E-Mail address of a person responsible for that server, to be contacted if problems occur. /away message - marks you as being away, which will display a 'G' (gone) instead of 'H' (here) in the /who command and the specified message on /whois and private messages. /away without argument removes the away status. /bye (text) - will quit IRC after sending the optional text to all channels you're on. /quit, /exit or /signoff will do as well. Sometimes a server will respond with an error message, but this can be safely ignored. /ctcp target command - performs the Client-To-Client-Protocol. This is supported only by modern clients and not vital, but has some useful functions. 'target' should be a nickname, to whom the command is sent. The user does not see the message, but his client program responds (usually) with a NOTICE containing an answer. See below on CTCP commands. /date server - display date and time as seen by the specified server. /time is the same. /dcc command nick - performs Direct-Client-Connection functions. These are supported only by modern clients, when in doubt use /ctcp clientinfo first. See below. /help - pops up a window with helpful information, including a list of commands with short descriptions. The server will list its known commands into the message window but without usage information, so that list might not be very useful. /ignore pattern - marks specific users to be ignored. Messages from them will not be displayed on your windows. If you feel harrassed by someone, this should be the first thing to be done. 'pattern' may be of the form nick!user@host and may contain the ? and * wildcards, matching any character or any sequence of characters, respectively. user and host are the ones given by /whois. If either no nick or no user@host is provided, a * will be inserted for the missing parts. /ignore without parameters lists all ignore patterns currently in effect. /ignore -pattern removes a pattern, which must be exactly the same as given in the list. /ignore +pattern causes a user to not just be ignored but answered by a NOTICE to each message. (This may be considered rude by some people, but there are client programs which have this feature built-in with no choice.) Note that having many ignore patterns may slow down the program. Ignore patterns are not saved if you leave the program. /info - displays info about IRC and your server. /invite nick channel - invite person to a channel. For invite-only channels (see /mode), this is the only way to join a channel. /join channel - will join a channel. Currently (server version 2.7), all channel names start with a # character. If no window comes up after this, there may be a connection or server-related problem. /join without an argument joins the channel you were last /invite'd to. /channel is an alias for /join. /kick channel nick - kicks a person from channel. The victim may re-join unless banned (see /mode). /kill nick - removes nick from the IRC network completely. This command can only be used by operators and should really not be used at all. /leave channel - leaves a channel. On ircle this is equivalent to closing a channel window. /part will do, too. /links server - show server connections. (Warning: Long list to come!) Useful for operators only. /list channel - Shows channel name, number of users and topic. Without argument, lists all channels. /lusers - show statistics on the users on the network. /me action - sends an action description. Example: /me switches off the air conditioning. This will be presented to other users on the channel as Mister switches off the air conditioning. with 'Mister' replaced by your nickname. There are some contrary opinions about this being necessary, but I did it because the actual implementation is shorter than this paragraph. Note that this uses CTCP protocol which is not recognized by older clients. You should end the sentence with a period. /mode channel par - sets a channel mode. 'par' can be +x (sets flag x), +x nick (sets flag x on nick), -x or -x nick removes flag, respectively. More than one flag may be given at once. The flags are (server version 2.7): p - private channel (name not made public) s - secret channel (never listed) i - invite-only channel m - moderated channel (talking requires channel operator status) t - only channel operators may set topic l n - limit channel to max. n users. b nick - ban nick (nick may not enter). o nick - nick is channel operator. /mode can be set by channel operators only. /motd - show server's message of the day. /msg nick message - send nick a private message. This can be done more easily via /query too. /names channel - give a list of names on the channel. 'channel' may contain wildcards. /nick newnick - changes your nickname. This must be done if the server rejects your nickname setting. /notice target text - sends a NOTICE, which is just like a normal message ('target' may be a channel or nick) except that it may not generate automated responses. (This rule is to prevent loops, as automated responses of any kind are NOTICEs.) /query nick - opens a query window. What is sent to that window will be a private message to the specified nick. /query without an argument will query the person who sent you the last private message. /stats par server - give information about the server's configuration. Will be needed by operators only. /summon user@host - summon specified user to IRC. This will work only if the specified host is running a server and has this feature enabled. Otherwise, a Talk program will do too :-) /topic channel text - set the channel topic. /type - type a text file to the current chanel. You will be presented a file selection box. The contents of the file are sent in the background, one line at a time as if typed (usually rather slow - no bug but feature). Note that dumping large files on a channel without being asked to do so is considered bad behaviour. /version server - show server version. /wallops text - sends text to all IRC operators online. This command is already taken out of many servers and will surely be removed with the next release, so you should not use it anymore. If you want to talk to operators specifically, /join #Twilight_Zone instead. (And don't harrass them too much, most of them have work to do.) /who channel - list users on channel. Without an argument, the current channel is assumed. When talking no channel, all IRC users are listed (very long list!) /whois nick - gives detailed information about a user, specifically which login name on which machine he is and what he has entered as his real name. Sometimes this information is useless because the user may be using a 'public client' or a Mac or MSDOS box which has no login names. In this case you will get bogus names or raw IP addresses instead of an account usable as E-Mail address. In case the other part is using ircle, you can get more information with /ctcp finger (s.b.) /whois without an argument will use the nick who sent you the last message or joined most recently a channel. /whowas nick - like /whois but displays information of users not on IRC at this moment. Note that commands for the exclusive use by operators are not mentioned here. They should know them anyway. :-) CTCP and DCC ------------ /ctcp nick command sends a special message containing a command, which will be processed by the other part's client program. Some clients do not support this. 'command' may be: clientinfo - list all known CTCP commands along with description. If you get no answer on this, the other part has CTCP and DCC not implemented. finger - gives user information. If the other part uses a Unix client, this will respond with the information returned by the finger command. If the other part is using ircle, this will return the E-Mail address the user has entered in the preferences field. Provided this address is valid, it can be used for mailing him or launching a finger, which will not work with the information returned by /whois. It also returns the idle time (in seconds) of the user, big numbers usually indicating the user being away or not caring. version - tells which client version and environment the other part is using. action - is used by the /me command. dcc - is used by the /dcc command, NOT by the user - this could confuse the client. Clients may implement other CTCP commands as well which they will tell on the clientinfo command. Commands which are responded generate a NOTICE with the original command and the response text in it. The Direct-Client-Connection (DCC) protocol establishes connections between clients, bypassing the server network for efficiency or security reasons. It is invoked by /dcc command nick. 'command' may be: chat - opens a DCC CHAT connection to nick. Messages exchanged via this connection are not sent over IRC but directly to the other client. Therefore this is the most secure method of communication, as nobody even with a 'hacked' or bogus server can even accidentally see it. (But be aware that there just is no method of tap-proof communication on the Internet, though.) send, tsend - transfers a file. You will be presented a file select box. The file will be sent over a direct connection to the other part. For Macintosh files, this will transfer the data fork only, so to transfer programs or other files with resource fork you have to BinHex them. (this is the same problem as with FTP; in fact /dcc send is just a convenient replacement for FTP, working almost the same way.) If the file contains text, you should use tsend instead of send, which will convert the file to ISO charset (see below) with LFs instead of CRs (this is what Un*x clients use). send will send the file unchanged (binary mode). File transfer runs in the background without disturbing communication (well, slowing down a bit :-) get, tget - accept an incoming file transfer. When you get a message for a DCC SEND request, you should answer with /dcc get nick, which will receive the offered file after you have selected a name for it with the usual file selector. Use tget if the file contains text information (s.a.) close type nick - will abandon a DCC connection. /dcc without parameters will list all DCC connections currently in effect. No two connections of the same type to the same nick may be in effect at one time; before re-opening a failed connection you must close it. Other DCC commands present in other clients are not implemented. For TALK there is already a wonderful program for the Macintosh (by Peter Lewis) which you can use instead. Each DCC request must be answered by the other part. If this is not done, the connection will not be established. How the answer is done depends on the client. With ircle, a CHAT request is to be answered with a CHAT, and a SEND request to be answered with a GET. NOTE that for DCC to work, TCP/IP connections between the two clients have to be established. This may be technically impossible due to the reasons mentioned above under 'Servers', and connections may fail because of bad links even with the server connection remaining up. In such cases you will get an error message. ircle Menus ----------- Although ircle is controlled by command lines like all IRC clients, there are some features to be controlled by menus in the standard Macintosh manner. These are the menus: Apple: contains the standard About information box. File: Open connection will connect to the server if no connection is established, which can happen after an error. Close window will do just that, beware of accidentally leaving channels! Preferences will pop up the yet familiar dialog. Start/stop logging lets you log all conversation to a file. When not logging, you can enter the file name. When logging, this stops logging and closes the file. Note that all messages go into one log file, regardless of the window. (This will be changed in future versions.) Flush server output: Some commands get responded with long lists. If you don't want to see them completely, with this you can cancel the list. Note that the messages still get sent to the client, only not displayed. Quit will quit the program. When connected, an alert gives you the chance to cancel. Edit: Copy copies the selection range from any window to the clipboard. Paste processes clipboard contents as it were typed, usually sending the clipboard to a channel. Select all selects a whole window. Commands: These items are just shortcuts for important commands. They do nothing but paste the command name into the input line. Shortcuts: Define will open a dialog that lets you define 10 strings that can be pasted into the input line via Command-1 through Command-0. Uses for this are frequently used channel names, nicknames or greetings. These are stored in the preferences file. Font: You can select your favorite font and size of text. This will affect the frontmost window and every window opened afterwards, as well as it will be stored in the preferences file. The status and input lines are always Monaco-9 as they have to be a fixed size font. Note that IRC was devised on text terminals and sometimes needs fixed size fonts, e.g. by users sending 'big fonts' (composed of several lines) or the /list command. These things look best in a fixed size font such as Monaco or Courier. Windows: Contains all channel, query and DCC windows for direct selection. These have no shortcuts, but Command-comma will rotate windows so that you never have to use the mouse. Almost all menu commands have shortcut keys. They are as closely as possible oriented on Macintosh standards. There is no Save command needed and Command-S is used for the /whois command. (Those of you who know the pre-releases of ircle, beware! Cmd-W will now close a window!) Further Reading --------------- If you don't know it already, please read the file 'COPYING'. New users of IRC should read the texts from various sources I have included in the file 'Advice on IRC'. Some notes on etiquette may look pedantic but they are needed, as they are all too often broken. Hold on to that rules and make IRC life friendlier to all users. All regular users of IRC wo have access to Usenet should watch the alt.irc newsgroup. There is a wonderful paper on IRC by Elizabeth Reid, available on may FTP servers under names like 'IRC-Thesis' (originally titled: 'Electropolis'.) This can also be recommended to read for people who want to know about IRC but are not actively involved. Beware of Pitfalls ----------------- Known bugs and limitations of this client: - This client is designed for server version 2.7. By now, all older servers are taken off the network. 2.8 is planned but most probably will not include features requiring support this client has not. - The protocol defines that the ISO/ANSI 8-bit character set is to be used on IRC, so ircle maps characters between that and the Macintosh charset. However, there are in both sets characters which have no representation in the other set. These are mapped to nonbreaking spaces. The most important are the accented vowels, which are correctly mapped. But most users tend to limit themselves to 7-bit ASCII, it seems. (I could tell many stories of German umlaut representation in mail and news...) - DCC filetransfer, as it was originally conceived, uses transparent (binary) transfer mode. As it is often used for text files, ircle has also a text transfer mode which maps characters to the ISO set and CRs (on the Mac) to LFs (on transmission), to be compatible with Un*x. But this may fail in more exotic environments. - A KILL by an operator includes a sometimes long 'path' argument, which will not be displayed in the alert (as it is of interest to other operators only). Unfortunately, this may result in the rest of the line, which gives a reason for the kill, being truncated. (I am one of those who think no good of operator kills anyway and who support the kill command being abolished, so I didn't bother fixing it.) - Very long lines generated by some users and certain commands get broken into two lines, most times midway through a word :-) - A serious flaw is that ircle sometimes is not able to recognize connection errors. I was not able to fix this, unfortunately. What is still to be done ------------------------ - that I have work left for the next version :-) Most important, the window sizes and positions being stored in the prefs file. A list of all users on a channel which is permanently displayed and updated could also be of use. Better connection error handling. Automatic reconnection, maybe to other servers too. The inevitable legal stuff ----------------------- This program is Copyright (C) 1992 Olaf Titz (e-Mail: s_titz@iravcl.ira.uka.de) Portions Copyright (C) 1992 Peter N. Lewis. Portions Copyright (C) 1988 Symantec Corporation. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 or (at your option) any later version. See the file COPYING. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. (Note that I am in no way connected to the FSF other than by supporting their ideas of free software.) Some names mentioned in this manual are registered trademarks of the respective owners. Credits ------- Thanks to all the people who have supported me writing this program by contributing ideas, advice, documentation and beta-bug hunting. Especially I'd like to mention the following: Martin Allert (et_aller@rzmain.rz.uni-ulm.de) Peter N. Lewis (peter@cujo.curtin.edu.au) Jussi-Pekka Mantere (Jussi-Pekka.Mantere@apple.fi) Klaus Zeuge (sojge@minsk.docs.uu.se) and the authors of the 2.7 server and the IRCII client: Jarkko Oikarinen (jto@tolsun.oulu.fi) Darren Reed (avalon@coombs.anu.edu.au) Michael Sandrof Troy Rollo (troy@plod.cbme.unsw.oz.au) and others who are not mentioned here but are not forgotten. :-) ---------------------------------------------------------------------