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