]>
Commit | Line | Data |
---|---|---|
3bd189cb JR |
1 | .\" @(#)$Id ircd.8 2.0 (beta version) 29 Mar 1989 $ |
2 | .TH IRCD 8 "$Date: 2006/04/26 20:26:07 $" | |
3 | .SH NAME | |
4 | ircd \- The Internet Relay Chat Program Server | |
5 | .SH SYNOPSIS | |
6 | .hy 0 | |
7 | .IP \fBircd\fP | |
8 | [ | |
9 | .B \-abciqst | |
10 | ] [ | |
11 | .BI \-f " configfile" | |
12 | ] [ | |
13 | .BI \-x " debuglevel" | |
14 | ] [ | |
15 | .BI \-h " hostname" | |
16 | ] [ | |
17 | .BI \-T | |
18 | [ tunefile ] | |
19 | ] [ | |
20 | .BI \-p " mode" | |
21 | ] | |
22 | .IP \fBircd\fP | |
23 | .B \-v | |
24 | .SH DESCRIPTION | |
25 | .LP | |
26 | \fIircd\fP is the server (daemon) program for the Internet Relay Chat | |
27 | Program. The \fIircd\fP is a server in that its function is to "serve" | |
28 | the client program \fIirc(1)\fP with messages and commands. All commands | |
29 | and user messages are passed directly to the \fIircd\fP for processing | |
30 | and relaying to other ircd sites. The \fIirc(1)\fP program depends upon | |
31 | there being an \fIircd\fP server running somewhere (either on your local | |
32 | UNIX site or a remote ircd site) so that it will have somewhere to connect | |
33 | to and thus allow the user to begin talking to other users. | |
34 | ||
35 | \fIircd\fP will reread its configuration file whenever it received a hangup | |
36 | signal, SIGHUP. | |
37 | ||
38 | Sending an interrupt signal to \fIircd\fP process will cause it to restart. | |
39 | ||
40 | .SH OPTIONS | |
41 | .TP | |
42 | .B \-a | |
43 | Instructs the server to automatically die off if it loses all it's clients. | |
44 | .TP | |
45 | .B \-b | |
46 | If the ircd.tune file is corrupted, by default the server | |
47 | will not start. This option will make the server start | |
48 | anyways, with the default values (ignoring the corrupted | |
49 | file). | |
50 | .TP | |
51 | .B \-c | |
52 | This flag must be given if you are running ircd from \fI/dev/console\fP or | |
53 | any other situation where fd 0 isnt a tty and you want the server to fork | |
54 | off and run in the background. This needs to be given if you are starting | |
55 | \fIircd\fP from an \fIrc\fP (such as \fI/etc/rc.local\fP) file. | |
56 | .TP | |
57 | .B \-i | |
58 | The server was started by inetd and it should start accepting connections | |
59 | from standard input. The following inetd.conf-line could be used to start | |
60 | up ircd automatically when needed: | |
61 | .TP | |
62 | .B | |
63 | ircd stream tcp wait irc /etc/ircd ircd \-i | |
64 | ||
65 | allows inetd to start up ircd on request. | |
66 | .TP | |
67 | .B \-q | |
68 | Using this option stops the server from doing DNS lookups on all the | |
69 | servers in your \fIircd.conf\fP file when it boots. This can take a lengthy | |
70 | amount of time if you have a large number of servers and they are not all | |
71 | close by. | |
72 | .TP | |
73 | .B \-s | |
74 | When this option is specified, \fIiauth\fP will not be | |
75 | started. This means that the IRC daemon will perform "ident | |
76 | lookups" (RFC 1413) internally to attempt to authenticate | |
77 | incoming connections. No other authentication mechanism | |
78 | will be used. | |
79 | .TP | |
80 | .B \-t | |
81 | Instructs the server to direct debugging output to standard output and to | |
82 | not fork nor detach from terminal. | |
83 | .TP | |
84 | .BI \-f " filename" | |
85 | Specifies the ircd.conf file to be used for this ircdaemon. The option | |
86 | is used to override the default ircd.conf given at compile time. | |
87 | .TP | |
88 | .BI \-x " #" | |
89 | Defines the debuglevel for ircd. The higher the debuglevel, the more stuff | |
90 | gets directed to debugging file (or standard output if -t option was used | |
91 | as well). | |
92 | .TP | |
93 | .BI \-h " hostname" | |
94 | Allows the user to manually set the server name at startup. The default | |
95 | name is hostname.domainname. | |
96 | .TP | |
97 | .BI \-p " mode" | |
98 | Specify whether the server should enable built-in | |
99 | protections against various type of user abuse that is | |
100 | commonly found on big public networks. Possible modes are | |
101 | .BR strict " (default)," | |
102 | .BR on " and" | |
103 | .BR off " and" | |
104 | .BR standalone . | |
105 | The | |
106 | .B strict | |
107 | option enables the protections, and refuses to establish a | |
108 | link to a server not running with this option. This is | |
109 | useful to force all servers on an IRC network to enable | |
110 | them. | |
111 | The | |
112 | .B standalone | |
113 | option removes split checks and disallows any server to connect. | |
114 | .TP | |
115 | .BI \-T " tunefile" | |
116 | Specifies the ircd.tune file to be used for this ircdaemon. The option | |
117 | is used to override the default ircd.tune given at compile | |
118 | time. If no tune file is given, reading and writing of tune file is disabled. | |
119 | .TP | |
120 | .B \-v | |
121 | This option prevents the server from starting, and dumps | |
122 | some information about the version instead. | |
123 | .TP | |
124 | .SH | |
125 | If you plan to connect your \fIircd\fP server to an existing Irc-Network, | |
126 | you will need to alter your local IRC CONFIGURATION FILE (typically named | |
127 | "ircd.conf") so that it will accept and make connections to other \fIircd\fP | |
128 | servers. This file contains the hostnames, Network Addresses, and sometimes | |
129 | passwords for connections to other ircds around the world. Because | |
130 | description of the actual file format of the "ircd.conf" file is beyond the | |
131 | scope of this document, please refer to the file INSTALL in the IRC source | |
132 | files documentation directory. | |
133 | .LP | |
134 | BOOTING THE SERVER: The \fIircd\fP server can be started as part of the | |
135 | UNIX boot procedure or just by placing the server into Unix Background. | |
136 | Keep in mind that if it is *not* part of your UNIXES Boot-up procedure | |
137 | then you will have to manually start the \fIircd\fP server each time your | |
138 | UNIX is rebooted. This means if your UNIX is prone to crashing | |
139 | or going for for repairs a lot it would make sense to start the \fIircd\fP | |
140 | server as part of your UNIX bootup procedure. In some cases the \fIirc(1)\fP | |
141 | will automatically attempt to boot the \fIircd\fP server if the user is | |
142 | on the SAME UNIX that the \fIircd\fP is supposed to be running on. If the | |
143 | \fIirc(1)\fP cannot connect to the \fIircd\fP server it will try to start | |
144 | the server on it's own and will then try to reconnect to the newly booted | |
145 | \fIircd\fP server. | |
146 | .SH EXAMPLE | |
147 | .RS | |
148 | .nf | |
149 | tolsun% \fBircd\fP | |
150 | .fi | |
151 | .RE | |
152 | .LP | |
153 | Places \fIircd\fP into UNIX Background and starts up the server for use. | |
154 | Note: You do not have to add the "&" to this command, the program will | |
155 | automatically detach itself from tty. | |
156 | .LP | |
157 | .RS | |
158 | .nf | |
159 | tolsun% \fBircd \-v\fP | |
160 | ircd 2.9.3 AaCDEfFHiIkMsu_V1 | |
161 | zlib not used | |
162 | Tue Apr 1 1997 at 20:17:50 EDT #1 | |
163 | .fi | |
164 | .RE | |
165 | .LP | |
166 | This indicates that this binary is the version 2.9.3 of the | |
167 | software. AaCDEfFHiIkMsu_V1 are the compile time options | |
168 | which were used. This binary does not support compression | |
169 | of server\-server links (does not use zlib) and was compiled | |
170 | on April the 1st. | |
171 | .SH COPYRIGHT | |
172 | (c) 1988,1989 University of Oulu, Computing Center, Finland, | |
173 | .LP | |
174 | (c) 1988,1989 Department of Information Processing Science, | |
175 | University of Oulu, Finland | |
176 | .LP | |
177 | (c) 1988,1989,1990,1991 Jarkko Oikarinen | |
178 | .LP | |
179 | For full COPYRIGHT see LICENSE file with IRC package. | |
180 | .LP | |
181 | .RE | |
182 | .SH FILES | |
183 | "ircd.conf" | |
184 | .SH "SEE ALSO" | |
185 | iauth(8) irc(1) ircdwatch(8) | |
186 | .SH BUGS | |
187 | None... ;-) if somebody finds one, please send mail to ircd-bugs@irc.org | |
188 | .SH AUTHOR | |
189 | Jarkko Oikarinen, currently jto@tolsun.oulu.fi, | |
190 | manual page written by Jeff Trim, jtrim@orion.cair.du.edu, | |
191 | later modified by jto@tolsun.oulu.fi. |