- ngIRCd GIT Updates - lists.barton.de

Alexander Barton : Rename Channel_Free() to Free_Channel(), it is a local function
by alex＠arthur.barton.de 05 Jan '09

05 Jan '09

Module: ngircd.git Branch: master Commit: a11e895045a52f4b57cfc69a8f051af6f0c25997 URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=a11e8950… Author: Alexander Barton <alex(a)barton.de> Date: Mon Jan 5 13:53:33 2009 +0100 Rename Channel_Free() to Free_Channel(), it is a local function --- src/ngircd/channel.c | 8 ++++---- 1 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/ngircd/channel.c b/src/ngircd/channel.c index 9a59712..8caa81a 100644 --- a/src/ngircd/channel.c +++ b/src/ngircd/channel.c @@ -58,7 +58,7 @@ static bool Remove_Client PARAMS(( int Type, CHANNEL *Chan, CLIENT *Client, CLIE static CL2CHAN *Get_First_Cl2Chan PARAMS(( CLIENT *Client, CHANNEL *Chan )); static CL2CHAN *Get_Next_Cl2Chan PARAMS(( CL2CHAN *Start, CLIENT *Client, CHANNEL *Chan )); static void Delete_Channel PARAMS(( CHANNEL *Chan )); -static void Channel_Free PARAMS(( CHANNEL *Chan )); +static void Free_Channel PARAMS(( CHANNEL *Chan )); GLOBAL void @@ -148,7 +148,7 @@ Channel_InitPredefined( void ) static void -Channel_Free(CHANNEL *chan) +Free_Channel(CHANNEL *chan) { array_free(&chan->topic); Lists_Free(&chan->list_bans); @@ -168,7 +168,7 @@ Channel_Exit( void ) c = My_Channels; while (c) { c_next = c->next; - Channel_Free(c); + Free_Channel(c); c = c_next; } @@ -1104,7 +1104,7 @@ Delete_Channel(CHANNEL *Chan) My_Channels = chan->next; LogDebug("Freed channel structure for \"%s\".", Chan->name); - Channel_Free(Chan); + Free_Channel(Chan); } /* Delete_Channel */

1 0

Alexander Barton : Clean up channel allocation table on shutdown/restart.
by alex＠arthur.barton.de 05 Jan '09

05 Jan '09

Module: ngircd.git Branch: master Commit: 175f0af979bfdb6dfde1535dd7de6a452cf98e32 URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=175f0af9… Author: Alexander Barton <alex(a)barton.de> Date: Mon Jan 5 12:58:37 2009 +0100 Clean up channel allocation table on shutdown/restart. Silly bug: the condition of a while() loop in the Channel_Exit() function used the wrong variable and therefore got never executed ... This bug is in the code since the beginning (see commit bb19cfda in 2002); shame on me! --- src/ngircd/channel.c | 7 +++---- 1 files changed, 3 insertions(+), 4 deletions(-) diff --git a/src/ngircd/channel.c b/src/ngircd/channel.c index ba5e725..9a59712 100644 --- a/src/ngircd/channel.c +++ b/src/ngircd/channel.c @@ -1,6 +1,6 @@ /* * ngIRCd -- The Next Generation IRC Daemon - * Copyright (c)2001-2008 by Alexander Barton (alex(a)barton.de) + * Copyright (c)2001-2009 Alexander Barton (alex(a)barton.de) * * 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 @@ -174,10 +174,9 @@ Channel_Exit( void ) /* Free Channel allocation table */ cl2chan = My_Cl2Chan; - while( c ) - { + while (cl2chan) { cl2chan_next = cl2chan->next; - free( cl2chan ); + free(cl2chan); cl2chan = cl2chan_next; } } /* Channel_Exit */

1 0

Florian Westphal : Add Channel_Free().
by alex＠arthur.barton.de 05 Jan '09

05 Jan '09

Module: ngircd.git Branch: master Commit: 40a0e9abbe8cfd959dd920f2af32976f1eda1a6a URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=40a0e9ab… Author: Florian Westphal <fw(a)strlen.de> Date: Sun Jan 4 22:50:49 2009 +0100 Add Channel_Free(). Central function to free a channel structure and all its resources (invite/ban lists, topic, ...). --- src/ngircd/channel.c | 36 +++++++++++++++++++++--------------- 1 files changed, 21 insertions(+), 15 deletions(-) diff --git a/src/ngircd/channel.c b/src/ngircd/channel.c index b93f223..ba5e725 100644 --- a/src/ngircd/channel.c +++ b/src/ngircd/channel.c @@ -57,7 +57,8 @@ static CL2CHAN *Add_Client PARAMS(( CHANNEL *Chan, CLIENT *Client )); static bool Remove_Client PARAMS(( int Type, CHANNEL *Chan, CLIENT *Client, CLIENT *Origin, const char *Reason, bool InformServer )); static CL2CHAN *Get_First_Cl2Chan PARAMS(( CLIENT *Client, CHANNEL *Chan )); static CL2CHAN *Get_Next_Cl2Chan PARAMS(( CL2CHAN *Start, CLIENT *Client, CHANNEL *Chan )); -static bool Delete_Channel PARAMS(( CHANNEL *Chan )); +static void Delete_Channel PARAMS(( CHANNEL *Chan )); +static void Channel_Free PARAMS(( CHANNEL *Chan )); GLOBAL void @@ -146,6 +147,17 @@ Channel_InitPredefined( void ) } /* Channel_InitPredefined */ +static void +Channel_Free(CHANNEL *chan) +{ + array_free(&chan->topic); + Lists_Free(&chan->list_bans); + Lists_Free(&chan->list_invites); + + free(chan); +} + + GLOBAL void Channel_Exit( void ) { @@ -154,11 +166,9 @@ Channel_Exit( void ) /* free struct Channel */ c = My_Channels; - while( c ) - { + while (c) { c_next = c->next; - array_free(&c->topic); - free( c ); + Channel_Free(c); c = c_next; } @@ -1070,7 +1080,7 @@ Get_Next_Cl2Chan( CL2CHAN *Start, CLIENT *Client, CHANNEL *Channel ) /** * Remove a channel and free all of its data structures. */ -static bool +static void Delete_Channel(CHANNEL *Chan) { CHANNEL *chan, *last_chan; @@ -1083,23 +1093,19 @@ Delete_Channel(CHANNEL *Chan) last_chan = chan; chan = chan->next; } - if (!chan) - return false; - Log(LOG_DEBUG, "Freed channel structure for \"%s\".", Chan->name); - - array_free(&chan->topic); - Lists_Free(&chan->list_bans); - Lists_Free(&chan->list_invites); + assert(chan != NULL); + if (!chan) + return; /* maintain channel list */ if (last_chan) last_chan->next = chan->next; else My_Channels = chan->next; - free(chan); - return true; + LogDebug("Freed channel structure for \"%s\".", Chan->name); + Channel_Free(Chan); } /* Delete_Channel */

1 0

Alexander Barton : Free topic array on channel deletion.
by alex＠arthur.barton.de 04 Jan '09

04 Jan '09

Module: ngircd.git Branch: branch-0-12-x Commit: b00a08ef405746ecbdb8b44ba825d1c5a254dfb0 URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=b00a08ef… Author: Alexander Barton <alex(a)barton.de> Date: Sun Jan 4 15:22:32 2009 +0100 Free topic array on channel deletion. The topic array in the CHANNEL structure must be free()'d before the channel itself becomes deleted. (backport of commit 18efc7469c of master branch) --- src/ngircd/channel.c | 6 +++--- 1 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/ngircd/channel.c b/src/ngircd/channel.c index 32f911a..44133e4 100644 --- a/src/ngircd/channel.c +++ b/src/ngircd/channel.c @@ -1027,9 +1027,9 @@ Delete_Channel( CHANNEL *Chan ) Log( LOG_DEBUG, "Freed channel structure for \"%s\".", Chan->name ); - /* Invite- und Ban-Lists aufraeumen */ - Lists_Free( &chan->list_bans ); - Lists_Free( &chan->list_invites ); + array_free(&chan->topic); + Lists_Free(&chan->list_bans); + Lists_Free(&chan->list_invites); /* Neu verketten und freigeben */ if( last_chan ) last_chan->next = chan->next;

1 0

Alexander Barton : Clean up (reformat and comment) Delete_Channel() function.
by alex＠arthur.barton.de 04 Jan '09

04 Jan '09

Module: ngircd.git Branch: master Commit: 0659503afd8b8ea4909e4609a7ae65d20de47091 URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=0659503a… Author: Alexander Barton <alex(a)barton.de> Date: Sun Jan 4 15:25:07 2009 +0100 Clean up (reformat and comment) Delete_Channel() function. --- src/ngircd/channel.c | 27 ++++++++++++++++----------- 1 files changed, 16 insertions(+), 11 deletions(-) diff --git a/src/ngircd/channel.c b/src/ngircd/channel.c index 6958831..b93f223 100644 --- a/src/ngircd/channel.c +++ b/src/ngircd/channel.c @@ -1067,35 +1067,40 @@ Get_Next_Cl2Chan( CL2CHAN *Start, CLIENT *Client, CHANNEL *Channel ) } /* Get_Next_Cl2Chan */ +/** + * Remove a channel and free all of its data structures. + */ static bool -Delete_Channel( CHANNEL *Chan ) +Delete_Channel(CHANNEL *Chan) { - /* delete channel structure */ - CHANNEL *chan, *last_chan; last_chan = NULL; chan = My_Channels; - while( chan ) - { - if( chan == Chan ) break; + while (chan) { + if (chan == Chan) + break; last_chan = chan; chan = chan->next; } - if( ! chan ) return false; + if (!chan) + return false; - Log( LOG_DEBUG, "Freed channel structure for \"%s\".", Chan->name ); + Log(LOG_DEBUG, "Freed channel structure for \"%s\".", Chan->name); array_free(&chan->topic); Lists_Free(&chan->list_bans); Lists_Free(&chan->list_invites); /* maintain channel list */ - if( last_chan ) last_chan->next = chan->next; - else My_Channels = chan->next; - free( chan ); + if (last_chan) + last_chan->next = chan->next; + else + My_Channels = chan->next; + free(chan); return true; } /* Delete_Channel */ + /* -eof- */

1 0

Alexander Barton : Free topic array on channel deletion.
by alex＠arthur.barton.de 04 Jan '09

04 Jan '09

Module: ngircd.git Branch: master Commit: 18efc7469c5923a298a218ee2d17f518cff184fa URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=18efc746… Author: Alexander Barton <alex(a)barton.de> Date: Sun Jan 4 15:22:32 2009 +0100 Free topic array on channel deletion. The topic array in the CHANNEL structure must be free()'d before the channel itself becomes deleted. --- src/ngircd/channel.c | 6 +++--- 1 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/ngircd/channel.c b/src/ngircd/channel.c index 29b8bec..6958831 100644 --- a/src/ngircd/channel.c +++ b/src/ngircd/channel.c @@ -1086,9 +1086,9 @@ Delete_Channel( CHANNEL *Chan ) Log( LOG_DEBUG, "Freed channel structure for \"%s\".", Chan->name ); - /* free invite and ban lists */ - Lists_Free( &chan->list_bans ); - Lists_Free( &chan->list_invites ); + array_free(&chan->topic); + Lists_Free(&chan->list_bans); + Lists_Free(&chan->list_invites); /* maintain channel list */ if( last_chan ) last_chan->next = chan->next;

1 0

Alexander Barton : Fix spelling in some documents.
by alex＠arthur.barton.de 01 Jan '09

01 Jan '09

Module: ngircd.git Branch: master Commit: fd9266df78e32104af3fa72eb5528b5615a2030e URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=fd9266df… Author: Alexander Barton <alex(a)barton.de> Date: Thu Jan 1 17:56:42 2009 +0100 Fix spelling in some documents. --- ChangeLog | 18 +++++++++--------- NEWS | 10 +++++----- doc/README-AUX.txt | 4 ++-- doc/README-BeOS.txt | 2 +- doc/Zeroconf.txt | 2 +- doc/sample-ngircd.conf | 6 +++--- man/ngircd.conf.5.tmpl | 4 ++-- 7 files changed, 23 insertions(+), 23 deletions(-) diff --git a/ChangeLog b/ChangeLog index 8d730bf..6e1fcc7 100644 --- a/ChangeLog +++ b/ChangeLog @@ -16,8 +16,8 @@ ngIRCd Release 13 (2008-12-25) - Make the test suite work on OpenSolaris. ngIRCd 13~rc1 (2008-11-21): - - New version numer scheme :-) - - Initial support for IRC services, using a RFC1459 styel interface, + - New version number scheme :-) + - Initial support for IRC services, using a RFC1459 style interface, tested with IRCServices (http://www.ircservices.za.net/) version 5.1.13. For this to work, ngIRCd now supports server-server links conforming to RFC 1459. New ngircd.conf(5) option: ServiceMask. @@ -49,7 +49,7 @@ ngIRCd 0.12.1 (2008-07-09) - Update ngIRCd manual pages - Add option aliases -V (for --version) and -h (for --help). - Fix 'no-ipv6' compile error. - - Make Listen parameter a comma-seperated list of addresses. This also + - Make Listen parameter a comma-separated list of addresses. This also obsoletes ListenIPv4 and ListenIPv6 options. If Listen is unset, it is treated as Listen="::,0.0.0.0". Note: ListenIPv4 and ListenIPv6 options are still recognized, @@ -59,11 +59,11 @@ ngIRCd 0.12.0 (2008-05-13) - Fix Bug: 85: "WHO #SecretChannel" that user is not a member of now returns proper RPL_ENDOFWHO_MSG instead of nothing. (Ali Shemiran) - - Fix complie on FreeBSD 5.4 and AIX. - - If bind() fails, also print ip address and not just the port number. + - Fix compile on FreeBSD 5.4 and AIX. + - If bind() fails, also print IP address and not just the port number. ngIRCd 0.12.0-pre2 (2008-04-29) - - IPv6: Add config options to disabe ipv4/ipv6 support. + - IPv6: Add config options to disable ipv4/ipv6 support. - Don't include doc/CVS.txt in distribution archive, use doc/GIT.txt now! - Documentation: get rid of some more references to CVS, switch to GIT. - Get rid of cvs-version.* and CVSDATE definition. @@ -106,11 +106,11 @@ ngIRCd 0.11.0 (2008-01-15) - Use dotted-decimal IP address if hostname is >= 64. - Add support for /STAT u (server uptime) command. - New [Server] configuration Option "Bind" allows to specify - the source ip adress to use when connecting to remote server. + the source IP address to use when connecting to remote server. - New configuration option "MaxNickLength" to specify the allowed maximum length of user nick names. Note: must be unique in an IRC network! - Enhanced the IRC+ protocol to support an enhanced "server handshake" and - enable server to recognice numeric 005 (ISUPPORT) and 376 (ENDOFMOTD). + enable server to recognize numeric 005 (ISUPPORT) and 376 (ENDOFMOTD). See doc/Protocol.txt for details. - Re-added doc/SSL.txt to distribution -- got lost somewhere!? - Fixes the wrong logging output when nested servers are introduced @@ -439,7 +439,7 @@ ngIRCd 0.7.0 (2003-05-01) - Better error reporting to clients on connect. - Enhanced manual pages ngircd(8) and ngircd.conf(5). - Documentation is now installed in $(datadir)/doc/ngircd. - - Enhanced hanling of NJOIN in case of nick collisions. + - Enhanced handling of NJOIN in case of nick collisions. ngIRCd 0.6.1, 2003-01-21 diff --git a/NEWS b/NEWS index 92a6b35..869b1d6 100644 --- a/NEWS +++ b/NEWS @@ -13,8 +13,8 @@ ngIRCd Release 13 (2008-12-25) ngIRCd 13~rc1 (2008-11-21): - - New version numer scheme :-) - - Initial support for IRC services, using a RFC1459 styel interface, + - New version number scheme :-) + - Initial support for IRC services, using a RFC1459 style interface, tested with IRCServices (http://www.ircservices.za.net/) version 5.1.13. For this to work, ngIRCd now supports server-server links conforming to RFC 1459. New ngircd.conf(5) option: ServiceMask. @@ -33,7 +33,7 @@ ngIRCd Release 13 (2008-12-25) ngIRCd 0.12.1 (2008-07-09) - Add option aliases -V (for --version) and -h (for --help). - - Make Listen parameter a comma-seperated list of addresses. This also + - Make Listen parameter a comma-separated list of addresses. This also obsoletes ListenIPv4 and ListenIPv6 options. If Listen is unset, it is treated as Listen="::,0.0.0.0". Note: ListenIPv4 and ListenIPv6 options are still recognized, @@ -42,7 +42,7 @@ ngIRCd 0.12.1 (2008-07-09) ngIRCd 0.12.0 (2008-05-13) ngIRCd 0.12.0-pre2 (2008-04-29) - - IPv6: Add config options to disabe ipv4/ipv6 support. + - IPv6: Add config options to disable ipv4/ipv6 support. ngIRCd 0.12.0-pre1 (2008-04-20) - Add IPv6 support. @@ -61,7 +61,7 @@ ngIRCd 0.11.0 (2008-01-15) - Add support for /STAT u (server uptime) command. - New [Server] configuration Option "Bind" allows to specify - the source ip adress to use when connecting to remote server. + the source IP address to use when connecting to remote server. - New configuration option "MaxNickLength" to specify the allowed maximum length of user nick names. Note: must be unique in an IRC network! - Numeric 317: implemented "signon time" (displayed in WHOIS result). diff --git a/doc/README-AUX.txt b/doc/README-AUX.txt index 68eea21..b524294 100644 --- a/doc/README-AUX.txt +++ b/doc/README-AUX.txt @@ -37,7 +37,7 @@ The following software packages are needed: ftp://arthur.barton.de/pub/unix/aux/libraries/libUTIL-2.1.tar.gz This library contains functions that are common on other UNIX - systems but not on A/UX e.g. memmove(), strerror() und strdup(). + systems but not on A/UX e.g. memmove(), strerror() and strdup(). After installation of these packages just do a "./configure" and "make" to @@ -60,7 +60,7 @@ A few hints in case of errors: the 'config.status' script. Better rename /bin/sh to /bin/sh.AUX and replace it by a symbolic link to /bin/ksh (ln -s /bin/ksh /bin/sh as root). - These procedure should'nt cause you into problems and is recommended + These procedure shouldn't cause you into problems and is recommended even if you don't use ngIRCd. -- diff --git a/doc/README-BeOS.txt b/doc/README-BeOS.txt index ea3816d..9e8df38 100644 --- a/doc/README-BeOS.txt +++ b/doc/README-BeOS.txt @@ -24,7 +24,7 @@ mit diesem Fehler ab: select(): Bad file descriptor! Es sieht leider so aus, als ob das select() von BeOS nicht mit File-Handles -von Pipes verschiedener Prozesse umgehen kann: sobald der Resolver asyncron +von Pipes verschiedener Prozesse umgehen kann: sobald der Resolver asynchron gestartet wird, also Pipe-Handles im select() vorhanden sind, fuehrt das zu obiger Meldung. diff --git a/doc/Zeroconf.txt b/doc/Zeroconf.txt index 04a3232..1208922 100644 --- a/doc/Zeroconf.txt +++ b/doc/Zeroconf.txt @@ -20,7 +20,7 @@ To use this features you can use one of two APIs: of the newer Avahi[5] library. When calling the configure script using the "--with-zeroconf" switch the -avalable API will be autodetected and the required additional libraries will +available API will be autodetected and the required additional libraries will be linked to the ngircd binary as required. ngIRCd then registers a DNS-SD service for each port it is listening on using diff --git a/doc/sample-ngircd.conf b/doc/sample-ngircd.conf index 041542e..526e880 100644 --- a/doc/sample-ngircd.conf +++ b/doc/sample-ngircd.conf @@ -56,7 +56,7 @@ # Diffie-Hellman parameters ;SSLDHFile = /usr/local/etc/ngircd/ssl/dhparams.pem - # comma seperated list of IP addresses on which the server should + # comma separated list of IP addresses on which the server should # listen. Default values are: # "0.0.0.0" or (if compiled with IPv6 support) "::,0.0.0.0" # so the server listens on all IP addresses of the system by default. @@ -212,13 +212,13 @@ # Connect to the remote server using TLS/SSL (Default: false) ;SSLConnect = yes - # Define a (case insensitive) mask matching nick names that sould be + # Define a (case insensitive) mask matching nick names that should be # treated as IRC services when introduced via this remote server. # REGULAR SERVERS DON'T NEED this parameter, so leave it empty # (which is the default). # When you are connecting IRC services which mask as a IRC server # and which use "virtual users" to communicate with, for example - # "NickServ" amd "ChanServ", you should set this parameter to + # "NickServ" and "ChanServ", you should set this parameter to # something like "*Serv". ;ServiceMask = *Serv diff --git a/man/ngircd.conf.5.tmpl b/man/ngircd.conf.5.tmpl index d456bb4..b8aa7bd 100644 --- a/man/ngircd.conf.5.tmpl +++ b/man/ngircd.conf.5.tmpl @@ -102,7 +102,7 @@ Cipher Suites will not be available. .TP \fBListen\fR A comma separated list of IP address on which the server should listen. -If unset, the defaults value is "0.0.0.0" or, if nIRCcd was compiled +If unset, the defaults value is "0.0.0.0" or, if ngIRCd was compiled with IPv6 support, "::,0.0.0.0". So the server listens on all configured IP addresses and interfaces by default. .TP @@ -112,7 +112,7 @@ to all users connecting to the server. .TP \fBMotdPhrase\fR A simple Phrase (<256 chars) if you don't want to use a MOTD file. -If this variabke is set, no \fBMotdFile\fR will be read at all which can be +If this variable is set, no \fBMotdFile\fR will be read at all which can be handy if the daemon should run inside a chroot directory. .TP \fBServerUID\fR

1 0

Alexander Barton : Allow pre-defined server local channels ("&").
by alex＠arthur.barton.de 30 Dez '08

30 Dez '08

Module: ngircd.git Branch: master Commit: 0e4e22a7a671d1e8efbc44bffd80062191f75c38 URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=0e4e22a7… Author: Alexander Barton <alex(a)barton.de> Date: Tue Dec 30 19:23:03 2008 +0100 Allow pre-defined server local channels ("&"). --- src/ngircd/conf.c | 7 +++---- 1 files changed, 3 insertions(+), 4 deletions(-) diff --git a/src/ngircd/conf.c b/src/ngircd/conf.c index c82ac2b..fc12cd9 100644 --- a/src/ngircd/conf.c +++ b/src/ngircd/conf.c @@ -1,6 +1,6 @@ /* * ngIRCd -- The Next Generation IRC Daemon - * Copyright (c)2001,2002 Alexander Barton (alex(a)barton.de) + * Copyright (c)2001-2008 Alexander Barton (alex(a)barton.de) * * 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 @@ -1168,11 +1168,10 @@ Handle_Channelname(struct Conf_Channel *new_chan, const char *name) size_t size = sizeof(new_chan->name); char *dest = new_chan->name; - /* - * channels must begin with &, +, or '#', if it is + /* Channels names must begin with "&" or "#", if it is * missing, add a '#'. This is only here for user convenience. */ - if (*name && *name != '#') { + if (*name && *name != '#' && *name != '&') { *dest = '#'; --size; ++dest;

1 0

Alexander Barton : Spell check and enhance ngIRCd manual pages.
by alex＠arthur.barton.de 30 Dez '08

30 Dez '08

Module: ngircd.git Branch: master Commit: 9d20397470e579e603897dc4e3a80538e278491f URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=9d203974… Author: Alexander Barton <alex(a)barton.de> Date: Tue Dec 30 19:20:09 2008 +0100 Spell check and enhance ngIRCd manual pages. --- man/ngircd.8.tmpl | 5 ++- man/ngircd.conf.5.tmpl | 77 +++++++++++++++++++++++++---------------------- 2 files changed, 44 insertions(+), 38 deletions(-) diff --git a/man/ngircd.8.tmpl b/man/ngircd.8.tmpl index 2fc7a9b..bd5b67d 100644 --- a/man/ngircd.8.tmpl +++ b/man/ngircd.8.tmpl @@ -64,15 +64,16 @@ The system wide default configuration file. .RS Default "message of the day" (MOTD). .RE +.SH HINTS +It's wise to use "ngircd \-\-configtest" to validate the configuration file +after changing it. .SH AUTHOR Alexander Barton, .UR mailto:alex@barton.de -alex(a)barton.de .UE .br Homepage: .UR http://ngircd.barton.de/ -http://ngircd.barton.de/ .UE .SH "SEE ALSO" .BR ngircd.conf (5), diff --git a/man/ngircd.conf.5.tmpl b/man/ngircd.conf.5.tmpl index 616a358..d456bb4 100644 --- a/man/ngircd.conf.5.tmpl +++ b/man/ngircd.conf.5.tmpl @@ -12,6 +12,9 @@ is the configuration file of the .BR ngircd (8) Internet Relay Chat (IRC) daemon which you should adept to your local preferences and needs. +.PP +Most variables can be modified while the ngIRCd daemon is already running: +It will reload its configuration when a HUP signal is received. .SH "FILE FORMAT" The file consists of sections and parameters. A section begins with the name of the section in square brackets and continues until the next section @@ -58,7 +61,9 @@ section is used to define the server main configuration, like the server name and the ports on which the server should be listening. .TP \fBName\fR -Server name in the IRC network, must contain at least one dot ("."). +Server name in the IRC network. This is an individual name of the IRC +server, it is not related to the DNS host name. It must be unique in the +IRC network and must contain at least one dot (".") character. .TP \fBInfo\fR Info text of the server. This will be shown by WHOIS and LINKS requests for @@ -70,11 +75,12 @@ command. .TP \fBPorts\fR Ports on which the server should listen. There may be more than one port, -separated with ','. Default: 6667. +separated with commas (","). Default: 6667. .TP \fBSSLPorts\fR -Same as \fBPorts\fR , except that ngircd will expect incoming connections -to be SSL/TLS encrypted. Default: None +Same as \fBPorts\fR , except that ngIRCd will expect incoming connections +to be SSL/TLS encrypted. Common port numbers for SSL-encrypted IRC are 6669 +and 6697. Default: none. .TP \fBSSLKeyFile\fR Filename of SSL Server Key to be used for SSL connections. This is required for @@ -84,20 +90,20 @@ SSL/TLS support. (OpenSSL only:) Password to decrypt private key. .TP \fBSSLCertFile\fR -Certificate of the private key +Certificate file of the private key. .TP \fBSSLDHFile\fR Name of the Diffie-Hellman Parameter file. Can be created with gnutls "certtool \-\-generate-dh-params" or "openssl dhparam". -If this file is not present, it will be generated on startup when ngircd -was compiled with gnutls support (this may take some time). If ngircd +If this file is not present, it will be generated on startup when ngIRCd +was compiled with gnutls support (this may take some time). If ngIRCd was compiled with OpenSSL, then (Ephemeral)-Diffie-Hellman Key Exchanges and several Cipher Suites will not be available. .TP \fBListen\fR -A comma seperated list of IP address on which the server should listen. -If unset, the defaults value is "0.0.0.0", or, if ngircd was compiled -with IPv6 support, "::,0.0.0.0", so the server listens on all configured +A comma separated list of IP address on which the server should listen. +If unset, the defaults value is "0.0.0.0" or, if nIRCcd was compiled +with IPv6 support, "::,0.0.0.0". So the server listens on all configured IP addresses and interfaces by default. .TP \fBMotdFile\fR @@ -106,8 +112,8 @@ to all users connecting to the server. .TP \fBMotdPhrase\fR A simple Phrase (<256 chars) if you don't want to use a MOTD file. -If it is set no MotdFile will be read at all which can be handy if the -daemon should run inside a chroot directory. +If this variabke is set, no \fBMotdFile\fR will be read at all which can be +handy if the daemon should run inside a chroot directory. .TP \fBServerUID\fR User ID under which the server should run; you can use the name of the user @@ -168,35 +174,35 @@ Should IRC Operators be allowed to use the MODE command even if they are not(!) channel-operators? Default: no. .TP \fBOperServerMode\fR -If OperCanUseMode is enabled, this may lead the compatibility problems with +If \fBOperCanUseMode\fR is enabled, this may lead the compatibility problems with Servers that run the ircd-irc2 Software. This Option "masks" mode requests by non-chanops as if they were coming from the server. Default: no. .TP \fBPredefChannelsOnly\fR If enabled, no new channels can be created. Useful if you do not want to have channels other than those defined in -the config file. -Default: No. +[Channel] sections in the configuration file. +Default: no. .TP \fBNoDNS\fR -If set to true, ngircd will not make DNS lookups when clients connect. -If you configure ngircd to connect to other servers, ngircd may still +If set to true, ngIRCd will not make DNS lookups when clients connect. +If you configure the daemon to connect to other servers, ngIRCd may still perform a DNS lookup if required. -Default: false. +Default: no. .TP \fBNoIdent\fR -If ngircd is compiled with IDENT support this can be used to disable IDENT +If ngIRCd is compiled with IDENT support this can be used to disable IDENT lookups at run time. -Default: false. +Default: no. .TP \fBConnectIPv4\fR -Set this to no if you do not want ngircd to connect to other irc servers using ipv4. -This allows use of ngircd in ipv6-only setups. -Default: Yes. +Set this to no if you do not want ngIRCd to connect to other IRC servers using +IPv4. This allows usage of ngIRCd in IPv6-only setups. +Default: yes. .TP \fBConnectIPv6\fR -Set this to no if you do not want ngircd to connect to other irc servers using ipv6. -Default: Yes. +Set this to no if you do not want ngIRCd to connect to other irc servers using IPv6. +Default: yes. .TP \fBMaxConnections\fR Maximum number of simultaneous in- and outbound connections the server is @@ -217,7 +223,7 @@ note that all servers in an IRC network MUST use the same maximum nick name length! .TP \fBSSLConnect\fR -Connect to the remote server using TLS/SSL (Default: false) +Connect to the remote server using TLS/SSL. Default: false. .SH [OPERATOR] .I [Operator] sections are used to define IRC Operators. There may be more than one @@ -258,21 +264,21 @@ IRC name of the remote server. Internet host name (or IP address) of the peer. .TP \fBBind\fR -IP address to use as source IP for the outgoing connection. Default ist +IP address to use as source IP for the outgoing connection. Default is to let the operating system decide. .TP \fBPort\fR Port of the remote server to which ngIRCd should connect (active). If no port is assigned to a configured server, the daemon only waits for -incoming connections (passive). +incoming connections (passive, default). .TP \fBMyPassword\fR Own password for this connection. This password has to be configured as -"PeerPassword" on the other server. Must not have ':' as first character. +\fBPeerPassword\fR on the other server. Must not have ':' as first character. .TP \fBPeerPassword\fR Foreign password for this connection. This password has to be configured as -"MyPassword" on the other server. +\fBMyPassword\fR on the other server. .TP \fBGroup\fR Group of this server (optional). @@ -282,13 +288,13 @@ Disable automatic connection even if port value is specified. Default: false. You can use the IRC Operator command CONNECT later on to create the link. .TP \fBServiceMask\fR -Define a (case insensitive) mask matching nick names that sould be treated as +Define a (case insensitive) mask matching nick names that should be treated as IRC services when introduced via this remote server. REGULAR SERVERS DON'T NEED this parameter, so leave it empty (which is the default). .PP .RS When you are connecting IRC services which mask as a IRC server and which use -"virtual users" to communicate with, for example "NickServ" amd "ChanServ", +"virtual users" to communicate with, for example "NickServ" and "ChanServ", you should set this parameter to something like "*Serv". .SH [CHANNEL] Pre-defined channels can be configured in @@ -304,7 +310,7 @@ There may be more than one block. .TP \fBName\fR -Name of the channel, including channel prefix ("#"). +Name of the channel, including channel prefix ("#" or "&"). .TP \fBTopic\fR Topic for this channel. @@ -316,7 +322,8 @@ Initial channel modes. Sets initial channel key (only relevant if mode k is set). .TP \fBMaxUsers\fR -Set maximum user limit for this channel (only relevant if mode l is set). +Set maximum user limit for this channel (only relevant if channel mode "l" +is set). .SH HINTS It's wise to use "ngircd \-\-configtest" to validate the configuration file after changing it. See @@ -325,12 +332,10 @@ for details. .SH AUTHOR Alexander Barton, .UR mailto:alex@barton.de -alex(a)barton.de .UE .br Homepage: .UR http://ngircd.barton.de/ -http://ngircd.barton.de/ .UE .SH "SEE ALSO" .BR ngircd (8)

1 0

Florian Westphal : man ngircd.conf: line break missing before the SSLConnect description
by fw＠arthur.barton.de 29 Dez '08

29 Dez '08

Module: ngircd.git Branch: master Commit: 307cdce90819ec3371d18c1f46374462220d6fa3 URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=307cdce9… Author: Florian Westphal <fw(a)strlen.de> Date: Mon Dec 29 23:34:20 2008 +0100 man ngircd.conf: line break missing before the SSLConnect description reported by Christoph Biedl. --- man/ngircd.conf.5.tmpl | 1 + 1 files changed, 1 insertions(+), 0 deletions(-) diff --git a/man/ngircd.conf.5.tmpl b/man/ngircd.conf.5.tmpl index 3c6c278..616a358 100644 --- a/man/ngircd.conf.5.tmpl +++ b/man/ngircd.conf.5.tmpl @@ -215,6 +215,7 @@ Default: 10. Maximum length of an user nick name (Default: 9, as in RFC 2812). Please note that all servers in an IRC network MUST use the same maximum nick name length! +.TP \fBSSLConnect\fR Connect to the remote server using TLS/SSL (Default: false) .SH [OPERATOR]

1 0