09b3ad3931617890ccd8446bb168aa04ae1df843
[ircu2.10.12-pk.git] / doc / irc.1
1 .\" @(#)irc.1 2.6 7 Oct 90
2 .TH IRC 1 "7 October 1990"
3 .SH NAME
4 irc \- User Interface to Internet Relay Chat Protocol
5 .SH SYNOPSIS
6 \fBirc\fP [\fB-p\fP \fIportnum\fP] [\fB-c\fP \fIchannel\fP] [ \fInickname\fP [ \fIserver\fP ]]
7 .SH DESCRIPTION
8 .LP
9 \fBIrc\fP is a user interface to the Internet Relay Chat, a CB-like
10 interactive discussion environment.  It is structured into \fIchannels\fP,
11 which are public discussion forums, and also allows for private intercommunication.
12 Each participant has a \fInickname\fP, which is the one specified in the command
13 line or else his login name.
14 .LP
15 Once invoked, \fBirc\fP connects as a client to the specified server,
16 \fIserver\fP or to the default one (see below).  The screen splits into a dialogue
17 window (the major part
18 of the screen) and a command line, from which messages can be sent and
19 commands given to control irc.
20 .SH COMMAND SYNTAX
21 The syntax of irc commands is of the form \fB/COMMAND\fP.  The most notable
22 ones are listed below.  For an uptodate list, use the \fBHELP\fP command
23 of \fBirc\fP.  Case is ignored.
24 .IP "\fB/ADMIN\fR [\fIserver\fP]"
25 Prints administrative information about an IRC \fIserver\fP.
26 .IP "\fB/AWAY\fP [\fImessage\fP]"
27 Mark yourself as being away (with an automatic reply \fImessage\fP
28 if specified)
29 .IP "\fB/BYE\fR, \fB/EXIT\fR, \fB/QUIT\fR"
30 Terminate the session
31 .IP "\fB/CHANNEL\fR [\fIchannel\fP]"
32 Join another \fIchannel\fP
33 .IP "\fB/CLEAR\fR"
34 Clear the screen
35 .IP "\fB/HELP\fR [\fIcommand\fP]"
36 Display a brief description of the \fIcommand\fP (or list all commands, if none
37 specified).
38 .IP "\fB/SUMMON\fR \fIuser\fP"
39 Allows to summon a \fIuser\fP specified as a full Internet address, i.e.,
40 \fIlogin@host.domain\fP, to an IRC dialogue session (in much the same
41 way as the talk(1) command).  It is usable ONLY if the irc daemon runs on
42 the target machine (host.domain).
43 .IP "\fB/TOPIC\fR \fItopic\fP"
44 Sets the \fItopic\fP for the current channel
45 .IP "\fB/WHO\fR [\fIchannel\fP|*]"
46 Lists all users of IRC if no argument, of the specified \fIchannel\fP or of the
47 current channel (*).
48 .SH ARGUMENTS
49 .IP "\fB-p\fP \fIportnum\fP"
50 TCP/IP "port number.  Default is 6667 and this option should seldom if ever"
51 be used.
52 .IP "\fB-c\fP \fIchannel\fP"
53 \fIChannel\fP number to join upon beginning of the session.  Default is no channel.
54 .IP "\fInickname\fP"
55 \fINickname\fP used in the session (can be changed with the \fB/NICK\fP command).
56 Default is user login name.
57 .IP "\fIserver\fP"
58 \fIServer\fP to connect to.  Default is specified in the irc system configuration
59 file, and can be superseded with the environment variable IRCSERVER.
60 .SH EXAMPLE
61 .RS
62 .nf
63 tolmoon% \fBirc -p6667 Wizard tolsun\fP
64 .fi
65 .RE
66 .LP
67 connects you to irc server in host tolsun (port 6667) with nickname Wizard
68 .SH COPYRIGHT
69 Copyright (c) 1988 University of Oulu, Computing Center, Finland.
70 .nf
71 Copyright (c) 1988,1989,1990 Jarkko Oikarinen
72 .nf
73 All rights reserved.
74 For full COPYRIGHT see LICENSE file with IRC package.
75 .SH "SEE ALSO"
76 ircd(8)
77 .SH BUGS
78 What bugs ?
79 .SH AUTHOR
80 Jarkko Oikarinen <jto@tolsun.oulu.fi>
81 .nf
82 Manual page updated by Michel Fingerhut <Michel.Fingerhut@ircam.fr>