9pfs/solanum-vs-hackint-and-charybdis
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc: Cleanup trailing whitespace

Browse source
This commit is contained in:
Matt Ullman 2016-03-29 10:09:52 -04:00
parent 2b535500f9
commit 5c0df0e743
4 changed files with 41 additions and 41 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
doc/ircd.conf.example
View file

@ -59,7 +59,7 @@ serverinfo {
#vhost = "192.0.2.6"; #vhost = "192.0.2.6";
/* for IPv6 */ /* for IPv6 */
#vhost6 = "2001:db8:2::6"; #vhost6 = "2001:db8:2::6";
/* ssl_private_key: our ssl private key */ /* ssl_private_key: our ssl private key */
ssl_private_key = "etc/ssl.key"; ssl_private_key = "etc/ssl.key";
@ -183,7 +183,7 @@ auth {
* flags = ...; below if it is. * flags = ...; below if it is.
*/ */
password = "letmein"; password = "letmein";
/* spoof: fake the users user@host to be be this. You may either /* spoof: fake the users user@host to be be this. You may either
* specify a host or a user@host to spoof to. This is free-form, * specify a host or a user@host to spoof to. This is free-form,
* just do everyone a favour and dont abuse it. (OLD I: = flag) * just do everyone a favour and dont abuse it. (OLD I: = flag)
@ -191,7 +191,7 @@ auth {
spoof = "I.still.hate.packets"; spoof = "I.still.hate.packets";
/* Possible flags in auth: /* Possible flags in auth:
* *
* encrypted | password is encrypted with mkpasswd * encrypted | password is encrypted with mkpasswd
* spoof_notice | give a notice when spoofing hosts * spoof_notice | give a notice when spoofing hosts
* exceed_limit (old > flag) | allow user to exceed class user limits * exceed_limit (old > flag) | allow user to exceed class user limits
@ -210,7 +210,7 @@ auth {
* need_sasl | require SASL id for user in this class * need_sasl | require SASL id for user in this class
*/ */
flags = kline_exempt, exceed_limit; flags = kline_exempt, exceed_limit;
/* class: the class the user is placed in */ /* class: the class the user is placed in */
class = "opers"; class = "opers";
}; };
@ -253,13 +253,13 @@ operator "god" {
user = "*god@127.0.0.1"; user = "*god@127.0.0.1";
/* password: the password required to oper. Unless ~encrypted is /* password: the password required to oper. Unless ~encrypted is
* contained in flags = ...; this will need to be encrypted using * contained in flags = ...; this will need to be encrypted using
* mkpasswd, MD5 is supported * mkpasswd, MD5 is supported
*/ */
password = "etcnjl8juSU1E"; password = "etcnjl8juSU1E";
/* rsa key: the public key for this oper when using Challenge. /* rsa key: the public key for this oper when using Challenge.
* A password should not be defined when this is used, see * A password should not be defined when this is used, see
* doc/challenge.txt for more information. * doc/challenge.txt for more information.
*/ */
#rsa_public_key_file = "/usr/local/ircd/etc/oper.pub"; #rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
@ -400,10 +400,10 @@ serverhide {
* as of this writing. * as of this writing.
* *
* As of charybdis 3.5, a matches parameter is allowed; if omitted, any result * As of charybdis 3.5, a matches parameter is allowed; if omitted, any result
* is considered a match. If included, a comma-separated list of *quoted* * is considered a match. If included, a comma-separated list of *quoted*
* strings is allowed to match queries. They may be of the format "0" to "255" * strings is allowed to match queries. They may be of the format "0" to "255"
* to match the final octet (e.g. 127.0.0.1) or "127.x.y.z" to explicitly match * to match the final octet (e.g. 127.0.0.1) or "127.x.y.z" to explicitly match
* an A record. The blacklist is only applied if it matches anything in the * an A record. The blacklist is only applied if it matches anything in the
* list. You may freely mix full IP's and final octets. * list. You may freely mix full IP's and final octets.
* *
* Consult your blacklist provider for the meaning of these parameters; they * Consult your blacklist provider for the meaning of these parameters; they

60
doc/reference.conf
View file

@ -28,15 +28,15 @@
* *
* Times/durations are written as: * Times/durations are written as:
* 12 hours 30 minutes 1 second * 12 hours 30 minutes 1 second
* *
* Valid units of time: * Valid units of time:
* month, week, day, hour, minute, second * month, week, day, hour, minute, second
* *
* Valid units of size: * Valid units of size:
* megabyte/mbyte/mb, kilobyte/kbyte/kb, byte * megabyte/mbyte/mb, kilobyte/kbyte/kb, byte
* *
* Sizes and times may be singular or plural. * Sizes and times may be singular or plural.
*/ */
/* Extensions: /* Extensions:
* *
@ -145,7 +145,7 @@ serverinfo {
* This should be an ipv6 IP only. * This should be an ipv6 IP only.
*/ */
#vhost6 = "2001:db7:2::6"; #vhost6 = "2001:db7:2::6";
/* ssl_private_key: our ssl private key */ /* ssl_private_key: our ssl private key */
ssl_private_key = "etc/ssl.key"; ssl_private_key = "etc/ssl.key";
@ -247,7 +247,7 @@ class "users" {
*/ */
cidr_ipv6_bitlen = 64; cidr_ipv6_bitlen = 64;
/* number_per_cidr: Number of connections to allow from a subnet of the /* number_per_cidr: Number of connections to allow from a subnet of the
* size given in cidr_ipv4_bitlen/cidr_ipv6_bitlen. * size given in cidr_ipv4_bitlen/cidr_ipv6_bitlen.
* 4 seems to be a good default to me. * 4 seems to be a good default to me.
*/ */
@ -309,19 +309,19 @@ listen {
/* port: the specific port to listen on. if no host is specified /* port: the specific port to listen on. if no host is specified
* before, it will listen on all available IPs. * before, it will listen on all available IPs.
* *
* sslport: the specific port to listen ssl connections on. if no * sslport: the specific port to listen ssl connections on. if no
* host is specified before, it will listen on all available IPs. * host is specified before, it will listen on all available IPs.
* *
* ports are seperated via a comma, a range may be specified using ".." * ports are seperated via a comma, a range may be specified using ".."
*/ */
/* port: listen on all available IPs, ports 5000 and 6665 to 6669 */ /* port: listen on all available IPs, ports 5000 and 6665 to 6669 */
port = 5000, 6665 .. 6669; port = 5000, 6665 .. 6669;
/* sslport: listen for ssl connections on all available IPs, port 9999 */ /* sslport: listen for ssl connections on all available IPs, port 9999 */
sslport = 9999; sslport = 9999;
/* host: set a specific IP/host the ports after the line will listen /* host: set a specific IP/host the ports after the line will listen
* on. This may be ipv4 or ipv6. * on. This may be ipv4 or ipv6.
*/ */
host = "192.0.2.6"; host = "192.0.2.6";
@ -355,7 +355,7 @@ auth {
* flags = ...; below if it is. * flags = ...; below if it is.
*/ */
password = "letmein"; password = "letmein";
/* spoof: fake the users user@host to be be this. You may either /* spoof: fake the users user@host to be be this. You may either
* specify a host or a user@host to spoof to. This is free-form, * specify a host or a user@host to spoof to. This is free-form,
* just do everyone a favour and dont abuse it. (OLD I: = flag) * just do everyone a favour and dont abuse it. (OLD I: = flag)
@ -363,7 +363,7 @@ auth {
spoof = "I.still.hate.packets"; spoof = "I.still.hate.packets";
/* Possible flags in auth: /* Possible flags in auth:
* *
* encrypted | password is encrypted with mkpasswd * encrypted | password is encrypted with mkpasswd
* spoof_notice | give a notice when spoofing hosts * spoof_notice | give a notice when spoofing hosts
* exceed_limit (old > flag) | allow user to exceed class user limits * exceed_limit (old > flag) | allow user to exceed class user limits
@ -383,7 +383,7 @@ auth {
* extend_chans | allow this user to join more channels than normal * extend_chans | allow this user to join more channels than normal
*/ */
flags = kline_exempt, exceed_limit; flags = kline_exempt, exceed_limit;
/* class: the class the user is placed in */ /* class: the class the user is placed in */
class = "opers"; class = "opers";
}; };
@ -395,7 +395,7 @@ auth {
*/ */
redirserv = "irc.example.net"; redirserv = "irc.example.net";
redirport = 6667; redirport = 6667;
user = "*.example.com"; user = "*.example.com";
/* class: a class is required even though it is not used */ /* class: a class is required even though it is not used */
@ -470,13 +470,13 @@ operator "god" {
user = "*@127.0.0.1"; user = "*@127.0.0.1";
/* password: the password required to oper. Unless ~encrypted is /* password: the password required to oper. Unless ~encrypted is
* contained in flags = ...; this will need to be encrypted using * contained in flags = ...; this will need to be encrypted using
* mkpasswd, MD5 is supported * mkpasswd, MD5 is supported
*/ */
password = "etcnjl8juSU1E"; password = "etcnjl8juSU1E";
/* rsa key: the public key for this oper when using Challenge. /* rsa key: the public key for this oper when using Challenge.
* A password should not be defined when this is used, see * A password should not be defined when this is used, see
* doc/challenge.txt for more information. * doc/challenge.txt for more information.
*/ */
#rsa_public_key_file = "/usr/local/ircd/etc/oper.pub"; #rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
@ -765,7 +765,7 @@ channel {
default_split_user_count = 0; default_split_user_count = 0;
/* split servers: when the amount of servers that have acknowledged /* split servers: when the amount of servers that have acknowledged
* theyve finished bursting is lower than this, consider ourselves * theyve finished bursting is lower than this, consider ourselves
* split. this must be set for automatic splitmode * split. this must be set for automatic splitmode
*/ */
default_split_server_count = 0; default_split_server_count = 0;
@ -880,7 +880,7 @@ serverhide {
* to match the final octet (e.g. 127.0.0.1) or "127.x.y.z" to explicitly match * to match the final octet (e.g. 127.0.0.1) or "127.x.y.z" to explicitly match
* an A record. The blacklist is only applied if it matches anything in the * an A record. The blacklist is only applied if it matches anything in the
* list. You may freely mix full IP's and final octets. * list. You may freely mix full IP's and final octets.
* *
* Consult your blacklist provider for the meaning of these parameters; they * Consult your blacklist provider for the meaning of these parameters; they
* are usually used to denote different ban types. * are usually used to denote different ban types.
*/ */
@ -1012,7 +1012,7 @@ general {
*/ */
default_floodcount = 10; default_floodcount = 10;
/* failed oper notice: send a notice to all opers on the server when /* failed oper notice: send a notice to all opers on the server when
* someone tries to OPER and uses the wrong password, host or ident. * someone tries to OPER and uses the wrong password, host or ident.
*/ */
failed_oper_notice = yes; failed_oper_notice = yes;
@ -1084,19 +1084,19 @@ general {
* displayed unconditionally. * displayed unconditionally.
*/ */
global_snotices = yes; global_snotices = yes;
/* dline reason: show the user the dline reason when they connect /* dline reason: show the user the dline reason when they connect
* and are dlined. * and are dlined.
*/ */
dline_with_reason = yes; dline_with_reason = yes;
/* kline delay: delay the checking of klines until a specified time. /* kline delay: delay the checking of klines until a specified time.
* Useful if large kline lists are applied often to prevent the * Useful if large kline lists are applied often to prevent the
* server eating CPU. * server eating CPU.
*/ */
kline_delay = 0 seconds; kline_delay = 0 seconds;
/* kline reason: show the user the reason why they are k/dlined /* kline reason: show the user the reason why they are k/dlined
* on exit. may give away who set k/dline when set via tcm. * on exit. may give away who set k/dline when set via tcm.
*/ */
kline_with_reason = yes; kline_with_reason = yes;
@ -1118,7 +1118,7 @@ general {
non_redundant_klines = yes; non_redundant_klines = yes;
/* warn no nline: warn opers about servers that try to connect but /* warn no nline: warn opers about servers that try to connect but
* we dont have a connect {} block for. Twits with misconfigured * we dont have a connect {} block for. Twits with misconfigured
* servers can get really annoying with this enabled. * servers can get really annoying with this enabled.
*/ */
warn_no_nline = yes; warn_no_nline = yes;
@ -1148,7 +1148,7 @@ general {
stats_o_oper_only=yes; stats_o_oper_only=yes;
/* stats P oper only: make stats P (ports) oper only /* stats P oper only: make stats P (ports) oper only
* NOTE: users doing stats P will never be given the ips that the * NOTE: users doing stats P will never be given the ips that the
* server listens on, simply the ports. * server listens on, simply the ports.
*/ */
stats_P_oper_only=no; stats_P_oper_only=no;
@ -1222,8 +1222,8 @@ general {
/* REMOVE ME. The following line checks you've been reading. */ /* REMOVE ME. The following line checks you've been reading. */
havent_read_conf = yes; havent_read_conf = yes;
/* max targets: the maximum amount of targets in a single /* max targets: the maximum amount of targets in a single
* PRIVMSG/NOTICE. set to 999 NOT 0 for unlimited. * PRIVMSG/NOTICE. set to 999 NOT 0 for unlimited.
*/ */
max_targets = 4; max_targets = 4;
@ -1237,7 +1237,7 @@ general {
* *
* +g - callerid - Server Side Ignore * +g - callerid - Server Side Ignore
* +D - deaf - Don't see channel messages * +D - deaf - Don't see channel messages
* +i - invisible - Not shown in NAMES or WHO unless you share a * +i - invisible - Not shown in NAMES or WHO unless you share a
* a channel * a channel
* +l - locops - See LOCOPS messages * +l - locops - See LOCOPS messages
* +Q - noforward - Unaffected by channel forwarding * +Q - noforward - Unaffected by channel forwarding
@ -1246,7 +1246,7 @@ general {
* +w - wallop - See oper and server generated WALLOPS * +w - wallop - See oper and server generated WALLOPS
* +z - operwall - See operwalls * +z - operwall - See operwalls
*/ */
/* oper only umodes: usermodes only opers may set */ /* oper only umodes: usermodes only opers may set */
oper_only_umodes = operwall, locops, servnotice; oper_only_umodes = operwall, locops, servnotice;
@ -1258,7 +1258,7 @@ general {
oper_snomask = "+s"; oper_snomask = "+s";
/* compression level: level of compression for compressed links between /* compression level: level of compression for compressed links between
* servers. * servers.
* *
* values are between: 1 (least compression, fastest) * values are between: 1 (least compression, fastest)
* and: 9 (most compression, slowest). * and: 9 (most compression, slowest).
@ -1339,7 +1339,7 @@ general {
}; };
modules { modules {
/* module path: paths to search for modules specified below and /* module path: paths to search for modules specified below and
* in /modload. * in /modload.
*/ */
path = "/usr/local/ircd/modules"; path = "/usr/local/ircd/modules";

4
doc/technical/hooks.txt
View file

@ -6,7 +6,7 @@ contrib/example_module.c, this document simply describes which hooks are
available. available.
There are various hook structures available that may be passed to hooks: There are various hook structures available that may be passed to hooks:
hook_data - struct Client *client; const void *arg1; hook_data - struct Client *client; const void *arg1;
const void *arg2; const void *arg2;
hook_data_int - struct Client *client; const void *arg1; int arg2; hook_data_int - struct Client *client; const void *arg1; int arg2;
hook_data_client - struct Client *client; struct Client *target; hook_data_client - struct Client *client; struct Client *target;
@ -114,7 +114,7 @@ The following hooks are called during various events related to clients.
oldsnomask = new snomask field oldsnomask = new snomask field
The following are for debugging and take struct hook_io_data for arguments. The following are for debugging and take struct hook_io_data for arguments.
These can be used for a variety of purposes, but are aimed at the developer These can be used for a variety of purposes, but are aimed at the developer
community. community.
"iosend" "iosend"

2
doc/technical/hostmask.txt
View file

@ -94,7 +94,7 @@ Section 3.3: Initialising and rehashing
To initialise, call init_host_hash(). This only needs to be done once on To initialise, call init_host_hash(). This only needs to be done once on
startup. startup.
On rehash, to wipe out the old unwanted conf, and free them if there are On rehash, to wipe out the old unwanted conf, and free them if there are
no references to them, call clear_out_address_conf(). no references to them, call clear_out_address_conf().
Section 3.4: Finding IP/host confs Section 3.4: Finding IP/host confs
---------------------------------- ----------------------------------