diff options
Diffstat (limited to 'ngircd/doc')
| -rw-r--r-- | ngircd/doc/Bopm.txt | 53 | ||||
| -rw-r--r-- | ngircd/doc/Capabilities.txt | 28 | ||||
| -rw-r--r-- | ngircd/doc/Commands.txt | 996 | ||||
| -rw-r--r-- | ngircd/doc/Container.md | 83 | ||||
| -rw-r--r-- | ngircd/doc/Contributing.txt | 60 | ||||
| -rw-r--r-- | ngircd/doc/FAQ.md | 176 | ||||
| -rw-r--r-- | ngircd/doc/HowToRelease.txt | 89 | ||||
| -rw-r--r-- | ngircd/doc/Makefile.am | 92 | ||||
| -rw-r--r-- | ngircd/doc/Modes.txt | 95 | ||||
| -rw-r--r-- | ngircd/doc/PAM.txt | 49 | ||||
| -rw-r--r-- | ngircd/doc/Platforms.txt | 179 | ||||
| -rw-r--r-- | ngircd/doc/Protocol.txt | 265 | ||||
| -rw-r--r-- | ngircd/doc/QuickStart.md | 126 | ||||
| -rw-r--r-- | ngircd/doc/README-AUX.txt | 67 | ||||
| -rw-r--r-- | ngircd/doc/README-BeOS.txt | 53 | ||||
| -rw-r--r-- | ngircd/doc/README-Interix.txt | 44 | ||||
| -rw-r--r-- | ngircd/doc/RFC.txt | 32 | ||||
| -rw-r--r-- | ngircd/doc/SSL.md | 81 | ||||
| -rw-r--r-- | ngircd/doc/Services.txt | 152 | ||||
| -rw-r--r-- | ngircd/doc/sample-ngircd.conf.tmpl | 426 | ||||
| -rw-r--r-- | ngircd/doc/src/Doxyfile | 93 | ||||
| -rw-r--r-- | ngircd/doc/src/Makefile.am | 25 | ||||
| -rw-r--r-- | ngircd/doc/src/footer.inc.html | 12 |
23 files changed, 0 insertions, 3276 deletions
diff --git a/ngircd/doc/Bopm.txt b/ngircd/doc/Bopm.txt deleted file mode 100644 index 338e5cb..0000000 --- a/ngircd/doc/Bopm.txt +++ /dev/null @@ -1,53 +0,0 @@ - - ngIRCd - Next Generation IRC Server - http://ngircd.barton.de/ - - (c)2001-2014 Alexander Barton and Contributors. - ngIRCd is free software and published under the - terms of the GNU General Public License. - - -- BOPM.txt -- - - -I. Introduction -~~~~~~~~~~~~~~~~ - -Citing <http://wiki.blitzed.org/BOPM>: "BOPM is an open source open proxy -monitor, designed for use with hybrid-based ircds, although it can be used -with slight modification on any server which has the ability to show connects -to opers and that supports KLINEs." - -Starting with Release 17, ngIRCd supports all required log messages that -BOPM requires to be useful. - -II. Installation -~~~~~~~~~~~~~~~~~ - -Install BOPM as usual, please see the BOPM documentation for details. -Afterwards adjust the following configuration parameters that are important -for ngIRCd: - -a) BOPM "IRC" section: - - 1) Set "server" and "port" accordingly, - - 2) adjust the "oper" line to match an [Operator] block in ngircd.conf, - - 3) change "mode" to "+ci" or "+c". - - 4) Set "connregex" to the following string, everything in one line(!): - "Client connecting: ([^ ]+) \\(([^@]+)@([^\\)]+)\\) \\[([0-9\\.]+)\\].*"; - and comment out all the other "connregex" examples (that is, prepend a - "#" character). - - 5) Set "kline" to "GLINE *@%h :Open proxy found on your host!"; - and comment out all the other "kline" examples. - -b) BOPM "scanner" section: - - Make sure you configure a valid "target_ip" and "target_port" for the - configured scanners to test. And please note that you CAN'T USE the port - of ngIRCd, because ngIRCd doesn't send any banner message by default! - - So you need a service what sends a banner, so for example POP3, SMTP, - IMAP, or SSH daemons should work ... diff --git a/ngircd/doc/Capabilities.txt b/ngircd/doc/Capabilities.txt deleted file mode 100644 index 0f160ed..0000000 --- a/ngircd/doc/Capabilities.txt +++ /dev/null @@ -1,28 +0,0 @@ - - ngIRCd - Next Generation IRC Server - http://ngircd.barton.de/ - - (c)2001-2012 Alexander Barton and Contributors. - ngIRCd is free software and published under the - terms of the GNU General Public License. - - -- Capabilities.txt -- - - -This document lists and describes the "IRC capabilities" that ngIRCd supports -and can be requested by a IRC/IRCv3 client that supports the "CAP" command. - -ngIRCd implements the "IRC Client Capabilities Extension" as described here: -<http://ircv3.net/specs/core/capability-negotiation-3.1.html> - - -I. Supported Capabilities -~~~~~~~~~~~~~~~~~~~~~~~~~ - -* "multi-prefix" - - When requested, the multi-prefix client capability will cause the IRC - server to send all possible prefixes which apply to a user in NAMES and - WHO output. - - See <http://ircv3.net/specs/extensions/multi-prefix-3.1.html>. diff --git a/ngircd/doc/Commands.txt b/ngircd/doc/Commands.txt deleted file mode 100644 index 0ca8703..0000000 --- a/ngircd/doc/Commands.txt +++ /dev/null @@ -1,996 +0,0 @@ - - ngIRCd - Next Generation IRC Server - http://ngircd.barton.de/ - - (c)2001-2019 Alexander Barton and Contributors. - ngIRCd is free software and published under the - terms of the GNU General Public License. - - -- Commands.txt -- - - -This file lists all commands available on ngIRCd. It is written in a format -that is human readable as well as machine parseable and therefore can be used -as "help text file" of the daemon. - -In short, the daemon reads this file on startup and parses it as following -when an user issues a "HELP <cmd>" command: - - 1. Search the file for a line "- <cmd>", - 2. Output all subsequent lines that start with a TAB (ASCII 9) character - to the client using NOTICE commands, treat lines containing a single "." - after the TAB as empty lines. - 3. Break at the first line not starting with a TAB character. - -This format allows to have information to each command stored in this file -which will not be sent to an IRC user requesting help which enables us to -have additional annotations stored here which further describe the origin, -implementation details, or limits of the specific command which are not -relevant to an end-user but administrators and developers. - -A special "Intro" block is returned to the user when the HELP command is -used without a command name: - - -- Intro - This is ngIRCd, a server software for Internet Relay Chat (IRC) - networks. You can find more information about ngIRCd on its homepage: - <http://ngircd.barton.de> - . - Use "HELP COMMANDS" to get a list of all available commands and - "HELP <command-name>" to get help for a specific IRC command, for - example "HELP quit" or "HELP privmsg". - - -Connection Handling Commands -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -- CAP - CAP LS - CAP LIST - CAP REQ <capabilities> - CAP ACK <capabilities> - CAP NAK <capabilities> - CAP CLEAR - CAP END - . - List, request, and clear "IRC Capabilities". - . - Using this command, an IRC client can request additional "IRC - capabilities" during login or later on, which influences the - communication between server and client. Normally, these commands - aren't directly used by humans, but automatically by their client - software. And please note that issuing such commands manually can - irritate the client software used, because of the "non-standard" - behavior of the server! - . - - CAP LS: list all available capabilities. - - CAP LIST: list active capabilities of this connection. - - CAP REQ: Request particular capabilities. - - CAP ACK: Acknowledge a set of capabilities to be enabled/disabled. - - CAP NAK: Reject a set of capabilities. - - CAP CLEAR: Clear all set capabilities. - - CAP END: Indicate end of capability negotiation during login, - ignored in an fully registered session. - - Please note that the <capabilities> must be given in a single - parameter but whitespace separated, therefore a command could look - like this: "CAP REQ :capability1 capability2 capability3" for example. - - References: - - <http://ircv3.net/specs/core/capability-negotiation-3.1.html> - - <http://ngircd.barton.de/doc/Capabilities.txt> - - doc/Capabilities.txt - -- CHARCONV - CHARCONV <client-charset> - . - Set client character set encoding to <client-charset>. - . - After receiving such a command, the server translates all message - data received from the client using the set <client-charset> to the - server encoding (UTF-8), and all message data which is to be sent to - the client from the server encoding (UTF-8) to <client-charset>. - . - This enables older clients and clients using "strange" character sets - to transparently participate in channels and direct messages to - clients using UTF-8, which should be the default today. - - References: - - IRC+, <http://ngircd.barton.de/doc/Protocol.txt> - - IRC+, doc/Protocol.txt - -- NICK - NICK <nickname> - NICK <nickname> [<hops>] - NICK <nickname> <hops> <username> <host> <servertoken> <usermodes> <realname> - . - Set or change the <nickname> of a client (first form) and register - remote clients (second and third form; servers only). - - References: - - RFC 1459, 4.1.2 "Nick message" (old client and server protocol) - - RFC 2812, 3.1.2 "Nick message" (client protocol) - - RFC 2813, 4.1.3 "Nick" (server protocol) - -- PASS - PASS <password> - PASS <password> <version> <flags> [<options>] - . - Set a connection <password>. This command must be the first command - sent to the server, even before the NICK/USER or SERVER commands. - . - The first form is used by user sessions or (old) RFC 1459 servers, - the second form is used by RFC 2812 or IRC+ compliant servers and - enables the server to indicate its version and supported protocol - features. - - References: - - RFC 1459, 4.1.1 "Password message" (old client and server protocol) - - RFC 2812, 3.1.1 "Password message" (client protocol) - - RFC 2813, 4.1.1 "Password message" (server protocol) - - IRC+, <http://ngircd.barton.de/doc/Protocol.txt> - - IRC+, doc/Protocol.txt - -- PING - PING <token> [<target>] - . - Tests the presence of a connection to a client or server. - . - If no <target> has been given, the local server is used. User clients - can only use other servers as <target>, no user clients. - . - A PING message results in a PONG reply containing the <token>, which - can be arbitrary text. - - Please note: - The RFCs state that the <token> parameter is used to specify the - origin of the PING command when forwarded in the network, but this - is not the case: the sender is specified using the prefix as usual, - and the parameter is used to identify the PONG reply in practice. - - References: - - RFC 2812, 3.7.2 "Ping message" - -- PONG - PONG <target> [<token>] - . - Reply to a "PING" command, indicate that the connection is alive. - . - The <token> is the arbitrary text received in the "PING" command and - can be used to identify the correct PONG sent as answer. - . - When the "PONG" command is received from a user session, the <target> - parameter is ignored; otherwise the PONG is forwarded to this client. - - References: - - RFC 2812, 3.7.3 "Pong message" - -- QUIT - QUIT [<quit-message>] - . - Terminate a user session. - . - When received from a user, the server acknowledges this by sending - an "ERROR" message back to the client and terminates the connection. - . - When a <quit-message> has been given, it is sent to all the channels - that the client is a member of when leaving. - - References: - - RFC 2812, 3.1.7 "Quit" - - RFC 2813, 4.1.5 "Quit" - -- USER - USER <username> <hostname> <unused> <realname> - . - Register (and authenticate) a new user session with a short <username> - and a human-readable <realname>. - . - The parameter <hostname> is only used when received by an other server - and ignored otherwise; and the parameter <unused> is always ignored. - But both parameters are required on each invocation by the protocol - and can be set to arbitrary characters/text when not used. - . - If <username> contains an "@" character, the full <username> is used - for authentication, but only the first part up to this character is - set as "user name" for this session. - - References: - - RFC 2812, 3.1.3 "User message" - -- WEBIRC - WEBIRC <password> <username> <hostname> <ip-address> - . - Allow Web-to-IRC gateway software (for example) to set the correct - user name and host name of users instead of their own. - . - It must be the very first command sent to the server, even before - USER and NICK commands! - . - The <password> must be set in the server configuration file to prevent - unauthorized clients to fake their identity; it is an arbitrary string. - - References: - - IRC+, <http://ngircd.barton.de/doc/Protocol.txt> - - IRC+, doc/Protocol.txt - - -General Commands -~~~~~~~~~~~~~~~~ - -- AWAY - AWAY [<message>] - . - Provides the server with a message to automatically send in reply to a - PRIVMSG directed at the user, but not to a channel they are on. - . - If <message> is omitted, the away status is removed. - - References: - - RFC 2812, 4.1 "Away" - -- HELP - HELP [<command>] - . - Show help information for a specific IRC <command>. The <command> name - is case-insensitive. - . - Use the command "HELP Commands" to get a list of all available commands. - - The HELP command isn't specified by any RFC but implemented by most - daemons. If no help text could be read in, ngIRCd outputs a list of all - implemented commands when receiving a plain "HELP" command as well as - on "HELP Commands". - - ngIRCd replies using "NOTICE" commands like ircd 2.10/2.11; other - implementations are using numerics 704, 705, and 706. - -- MODE - MODE <nickname> [{+|-}<mode>[<mode>] [{+|-}<mode>[<mode>] [...]]] - MODE <channel> [{+|-}<mode>[<mode>] [<arg> [<arg> [...]]] [{+|-}<mode>[<mode>] [<arg> [<arg> [...]]] [...]]] - . - Set and get user and channel modes. - . - When no mode parameters are given, the currently set user or channel - modes are returned. Otherwise the modes are adjusted accordingly - and the changes will be reported back to the client. - . - All user and channel "modes" are indicated by single case-sensitive - characters. - . - Please note that a user can only get and set his own modes, and not - all user "levels" are allowed to change all channel modes ... - . - The mode parameters can become quite complex, especially when dealing - with channel modes that require additional arguments: - . - {+|-}<mode(s}> -- set or unset one or more modes. - +<mode(s)> -<mode(s)> -- set some modes and unset others. - +<modes> <arg1> <arg2> -- set (at least) two modes with arguments. - . - Some examples: - . - MODE nick +i -- set user to "invisible". - MODE #chan +tn -- set "topic lock" and "no external messages". - MODE #chan -t +l 50 -- remove "topic lock", set "user limit" to 50. - MODE #chan +ov nick1 nick2 -- set "channel op" and "voice" mode - to nick1 and nick2 in channel #chan. - . - A complete list of all modes supported by ngIRCd can be found online - here: <http://ngircd.barton.de/doc/Modes.txt>. - - References: - - RFC 2811, 4. "Channel Modes" - - RFC 2812, 3.1.5 "User mode message" - - RFC 2812, 3.2.3 "Channel mode message" - - <http://ngircd.barton.de/doc/Modes.txt> - - doc/Modes.txt - -- NOTICE - NOTICE <target>[,<target>[,...]] <message> - . - Send a <message> to a given <target>, which can be a user or a - channel, but DON'T report any error. - . - The "NOTICE" command exactly behaves like the "PRIVMSG" command, but - doesn't report any errors it encounters (like an unknown <target>). - Please see the help text of the "PRIVMSG" command for a detailed - description of the parameters! - - References: - - RFC 2812, 2.3.1 "Message format in Augmented BNF" - - RFC 2812, 3.3 "Sending messages" - - RFC 2812, 3.3.2 "Notice" - -- PRIVMSG - PRIVMSG <target>[,<target>[,...]] <message> - . - Send a <message> to a given <target>, which can be a user or a - channel, and report all errors. - . - The <target> must follow one of these syntax variants: - . - - <nickname> - - <channel> - - <user>[%<host>]@<server> - - <user>%<host> - - <nickname>!<user>@<host> - . - If the <target> is a user, a private message is sent directly to this - user; if it resolves to a channel name, a public message is sent - to all the members of that channel. - . - In addition, IRC Ops can use these two forms to specify the <target>: - . - - #<hostmask> - - $<servermask> - . - The <mask> can contain the wildcard characters "*" and "?", but must - contain at least one dot (".") and no wildcard after the last one. - Then, the <message> is sent to all users matching this <mask>. - . - All warnings and errors are reported back to the initiator using - numeric status codes, which is the only difference to the "NOTICE" - command, which doesn't report back any errors or warnings at all. - . - Please note that clients often use "MSG" as an alias to PRIVMSG, and - a command "QUERY <nick> [<message>]" to initiate private chats. Both - are command extensions of the client and never sent to the server. - - References: - - RFC 2812, 2.3.1 "Message format in Augmented BNF" - - RFC 2812, 3.3 "Sending messages" - - RFC 2812, 3.3.1 "Private messages" - -Status and Informational Commands -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -- ADMIN - ADMIN [<target>] - . - Show administrative information about an IRC server in the network. - . - <target> can be a server name, the nickname of a client connected to - a specific server, or a mask matching a server name in the network. - The server of the current connection is used when <target> is omitted. - - References: - - RFC 2812, 3.4.9 "Admin command" - -- INFO - INFO [<target>] - . - Show the version, birth & online time of an IRC server in the network. - . - <target> can be a server name, the nickname of a client connected to - a specific server, or a mask matching a server name in the network. - The server of the current connection is used when <target> is omitted. - - References: - - RFC 2812, 3.4.10 "Info command" - -- ISON - ISON <nickname> [<nickname> [...]] - . - Query online status of a list of nicknames. The server replies with - a list only containing nicknames actually connected to a server in - the network. If no nicknames of the given list are online, an empty - list is returned to the client requesting the information. - - Please note that "all" IRC daemons even parse separate nicknames in - a single parameter (like ":nick1 nick2"), and therefore ngIRCd - implements this behavior, too. - - References: - - RFC 2812, 4.9 "Ison message" - -- LINKS - LINKS [[<target>] <mask>] - . - List all servers currently registered in the network matching <mask>, - or all servers if <mask> has been omitted, as seen by the server - specified by <target> or the local server when <target> is omitted. - . - <target> can be a server name, the nickname of a client connected to - a specific server, or a mask matching a server name in the network. - - References: - - RFC 2812, 3.4.5 "Links message" - -- LUSERS - LUSERS [<mask> [<target>]] - . - Return statistics about the number of clients (users, servers, - services, ...) in the network as seen by the server <target>. - . - <target> can be a server name, the nickname of a client connected to - a specific server, or a mask matching a server name in the network. - The server of the current connection is used when <target> is omitted. - - Please note that ngIRCd ignores the <mask> parameter entirely: it - is not possible to get information for a part of the network only. - - References: - - RFC 2812, 3.4.2 "Lusers message" - -- MOTD - MOTD [<target>] - . - Show the "Message of the Day" (MOTD) of an IRC server in the network. - . - <target> can be a server name, the nickname of a client connected to - a specific server, or a mask matching a server name in the network. - The server of the current connection is used when <target> is omitted. - - References: - - RFC 2812, 3.4.1 "Motd message" - -- NAMES - NAMES [<channel>[,<channel>[,...]] [<target>]] - . - Show the list of users that are members of a particular <channel> - (and that are visible for the client requesting this information) as - seen by the server <target>. More than one <channel> can be given - separated by "," (but not whitespaces!). - . - If <channel> has been omitted, all visible users are shown, grouped - by channel name, and all visible users not being members of at least - one channel are shown as members of the pseudo channel "*". - . - <target> can be a server name, the nickname of a client connected to - a specific server, or a mask matching a server name in the network. - The server of the current connection is used when <target> is omitted. - - References: - - RFC 2812, 3.2.5 "Names message" - -- STATS - STATS [<query> [<target>]] - . - Show statistics and other information of type <query> of a particular - IRC server in the network. - . - The following <query> types are supported (case-insensitive where - applicable): - . - - g Network-wide bans ("G-Lines"). - - k Server-local bans ("K-Lines"). - - L Link status (servers and user links). - - l Link status (servers and own link). - - m Command usage count. - - u Server uptime. - . - <target> can be a server name, the nickname of a client connected to - a specific server, or a mask matching a server name in the network. - The server of the current connection is used when <target> is omitted. - . - To use "STATS L" the user must be an IRC Operator. - - References: - - RFC 2812, 3.4.4 "Stats message" - -- TIME - TIME [<target>] - . - Show the local time of an IRC server in the network. - . - <target> can be a server name, the nickname of a client connected to - a specific server, or a mask matching a server name in the network. - The server of the current connection is used when <target> is omitted. - - References - - RFC 2812, 3.4.6 "Time message" - -- TRACE - TRACE [<target>] - . - Find the route to a specific server and send information about its - peers. Each server that processes this command reports back to the - sender about it: the replies from pass-through servers form a chain - which shows the route to the destination. - . - <target> can be a server name, the nickname of a client connected to - a specific server, or a mask matching a server name in the network. - The server of the current connection is used when <target> is omitted. - - References: - - RFC 2812, 3.4.8 "Trace message" - -- USERHOST - USERHOST <nickname> [<nickname> [...]] - . - Show flags and the hostmasks (<user>@<host>) of the <nickname>s, - separated by spaces. The following flags are used: - . - - "-" The client is "away" (the mode "+a" is set on this client). - - "+" Client seems to be available, at least it isn't marked "away". - - "*" The client is an IRC operator (the mode "+o" is set). - - References: - - RFC 2812, 4.8 "Userhost message" - -- VERSION - VERSION [<target>] - . - Show version information about a particular IRC server in the network. - . - <target> can be a server name, the nickname of a client connected to - a specific server, or a mask matching a server name in the network. - The server of the current connection is used when <target> is omitted. - . - Please note: in normal operation, the version number ends in a dot - (".", for example "ngIRCd-20.1."). If it ends in ".1" (for example - "ngIRCd-20.1.1", same version than before!), the server is running in - debug-mode; and if it ends in ".2", the "network sniffer" is active! - Keep your privacy in mind ... - - References: - - RFC 2812, 3.4.3 "Version message" - -- WHO - WHO [<mask> ["o"]] - . - Show a list of users who match the <mask>, or all visible users when - the <mask> has been omitted. (Special case: the <mask> "0" is - equivalent to "*") - . - If the flag "o" is given, the server will only return information about - IRC Operators. - - References: - - RFC 2812, 3.6.1 "Who query" - -- WHOIS - WHOIS [<target>] <mask>[,<mask>[,...]] - . - Query information about users matching the <mask> parameter(s) as seen - by the server <target>; up to 3 <masks> are supported. - . - <target> can be a server name, the nickname of a client connected to a - specific server, or a mask matching a server name in the network. The - server of the current connection is used when <target> is omitted. - - References: - - RFC 2812, 3.6.2 "Whois query" - -- WHOWAS - WHOWAS <nickname>[,<nickname>[,...]] [<count> [<target>]] - . - Query information about nicknames no longer in use in the network, - either because of nickname changes or disconnects. The history is - searched backwards, returning the most recent entry first. If there - are multiple entries, up to <count> entries will be shown (or all of - them, if no <count> has been given). - . - <target> can be a server name, the nickname of a client connected to a - specific server, or a mask matching a server name in the network. The - server of the current connection is used when <target> is omitted. - - References: - - RFC 2812, 3.6.3 "Whowas" - - -Channel Commands -~~~~~~~~~~~~~~~~ - -- INVITE - INVITE <nickname> <channel> - . - Invite <nickname> to join channel <channel>. - . - <channel> does not have to exist, but if it does, only members of the - channel are allowed to invite other users. If the channel mode "+i" - is set, only channel "half-ops" (and above) may invite other clients, - and if channel mode "+V" is set, nobody can invite other users. - - References: - - RFC 2812, 3.2.7 "Invite message" - -- JOIN - JOIN {<channel>[,<channel>[,...]] [<key>[,<key>[,...]]] | 0} - . - Makes the client join the <channel> (comma-separated list), specifying - the channel keys ("passwords"). A <channel-key> is only needed if the - <channel> has the mode "+k" set. - . - If the channel(s) do not exist, then they will be created. - . - Using "JOIN 0" parts all channels at once. - - References: - - RFC 2812, 3.2.1 "Join message" (client protocol) - - RFC 2813, 4.2.1 "Join message" (server protocol) - -- KICK - KICK <channel>[,<channel>[,...]] <nickname>[,<nickname>[,...]] [<reason>] - . - Remove users(s) with <nickname>(s) from <channel>(s). - . - There must be either exactly one <channel> parameter and multiple - <nickname> parameters, or as many <channel> parameters as there are - <nickname> parameters. The <reason> is shown to the users being - kicked, and the nickname of the current user is used when <reason> - is omitted. - - References: - - RFC 2812, 3.2.8 "Kick command" - -- LIST - LIST [<mask>[,<mask>[,...]] [<server>]] - . - List all visible channels matching the <mask> (comma-separated list), - or all channels when no <mask> was specified. - . - If <server> is given, the command will be forwarded to <server> for - evaluation. - - References: - - RFC 2812, 3.2.6 "List message" - -- PART - PART <channel>[,<channel>[,...]] [<part-message>] - . - Leave <channel> (comma-separated list), optionally with sending a - <part-message> to all the other channel members. - - References: - - RFC 2812, 3.2.2 "Part message" - -- TOPIC - TOPIC <channel> [<topic>] - . - Change or view the topic of a channel. - . - The topic for channel <channel> is returned if there is no <topic> - given. If the <topic> parameter is present, the topic for that - channel will be changed, if this action is allowed for the user - requesting it. If the <topic> parameter is an empty string, the - topic for that channel will be removed. - - References: - - RFC 2812, 3.2.4 "Topic message" - - -Administrative Commands -~~~~~~~~~~~~~~~~~~~~~~~ - -- CONNECT - CONNECT <server> [<port> [<remote-server> [<my-pwd> <peer-pwd>]]] - . - Instructs the current server, or <remote-server> if specified, - to connect to the server named <server>, which must be configured - in the server configuration file. - . - To use this command, the user must be an IRC Operator. To establish - a connection on a <remote-server>, you must have remote IRC operator - privileges. - . - If <port>, <my-pwd> and <peer-pwd> are given, these values override - the ones specified in the server configuration file. - - References: - - RFC 2812, 3.4.7 "Connect message" - -- DIE - DIE [<message>] - . - Instructs the server to shut down. - . - The optional (and non-standard) <message> text is sent to each client - connected to this server before all connections are closed. - . - To use this command, the user must be an IRC Operator. - - References: - - RFC 2812, 4.3 "Die message" - -- DISCONNECT - DISCONNECT <server> - . - Disconnect and disable a locally linked server. - . - To use this command, the user must be an IRC Operator. - - References: - - This command is not specified in the IRC RFCs, it is an extension - of ngIRCd. - -- GLINE - GLINE <nick!user@hostmask> [<timeout> :<reason>] - . - This command provides timed G-Lines (network-wide bans). - . - If a client matches a G-Line, it cannot connect to any server on - the IRC network for <timeout> seconds. When <timeout> is 0, it make - the G-Line permanent. - . - If no <timeout> and no <reason> is given, the G-Line is removed. - . - To use this command, the user must be an IRC Operator. - . - "STATS g" can be used to list all currently active G-Lines. - - References: - - This command is not specified in the IRC RFCs, it is an extension - of ngIRCd. - -- KILL - KILL <nickname> <reason> - . - Forcibly remove all users with a given <nickname> from the IRC - network and display the given <reason> to them. - . - This command is used internally between servers, too, for example - to disconnect duplicate <nickname>'s after a "net split". - . - To use this command, the user must be an IRC Operator. - - References: - - RFC 2812, 3.7.1 "Kill message" - -- KLINE - KLINE <nick!user@hostmask> [<timeout> :<reason>] - . - This command provides timed K-Lines (server-local bans). - . - If a client matches a K-Line, it cannot connect to this server for - <timeout> seconds. When <timeout> is 0, it makes the K-Line permanent. - . - If no <timeout> and no <reason> is given, the K-Line is removed. - . - To use this command, the user must be an IRC Operator. - . - "STATS k" can be used to list all currently active K-Lines. - - References: - - This command is not specified in the IRC RFCs, it is an extension - of ngIRCd. - -- OPER - OPER <name> <password> - . - Authenticates a user named <name> as an IRC operator on the current - server/network. - . - This operator <name> must be configured in the server configuration. - . - Please note that <name> is NOT related to a nickname at all! - - References: - - RFC 2812, 3.1.4 "Oper message" - -- REHASH - REHASH - . - Causes the server to re-read and re-process its configuration file(s). - . - While rehashing, no new connections are accepted, but all already - established connections stay connected. - . - To use this command, the user must be an IRC Operator. - - References: - - RFC 2812, 4.2 "Rehash message" - -- RESTART - RESTART - . - Restart the server. - . - While restarting, all connections are reset and no new connections - are accepted. - . - To use this command, the user must be an IRC Operator. - - References: - - RFC 2812, 4.4 "Restart message" - -- WALLOPS - WALLOPS <message> - . - Sends <message> to all users with user mode "+w". - . - To use this command, the user must be an IRC Operator. - - References: - - RFC 2812, 4.7 "Operwall message" - -IRC Service Commands -~~~~~~~~~~~~~~~~~~~~ - -- SERVICE - SERVICE <name> <reserved1> <distribution> <type> <reserved2> <info> - SERVICE <name> <servertoken> <distribution> {<type>|+<modes>} <hops> <info> - . - Register a new service in the network. - . - The first form is used by directly linked services and isn't supported - by ngIRCd at the moment. The second form announces services connected - to remote "pseudo-servers" ("services hubs"). - . - The <distribution> and <type> parameters are ignored by ngIRCd. - - References: - - RFC 2812, 3.1.6 "Service message" - - RFC 2813, 4.1.4 "Service message" - -- SERVLIST - SERVLIST [<mask> [<type>]] - . - List all IRC services currently registered in the network. - . - The optional <mask> and <type> parameters can be used to limit the - listing to services matching the <mask> and that are of type <type>. - . - Please note that ngIRCd doesn't use any service types at the moment - and therefore all services are of type "0". - - References: - - RFC 2812, 3.5.1 "Servlist message" - -- SQUERY - SQUERY <target>[,<target>[,...]] <message> - . - Send a <message> to a given <target> IRC service, and report all - errors. - . - The "SQUERY" command exactly behaves like the "PRIVMSG" command, but - enforces that the <target> of the <message> is an IRC service. - Please see the help text of the "PRIVMSG" command for a detailed - description of the parameters! - . - If a user wants to interact with IRC services, he should use "SQUERY" - instead of "PRIVMSG" or "NOTICE": only "SQUERY makes sure that no - regular user, which uses the nickname of an IRC service, receives - the command in error, for example during a "net split"! - - References: - - RFC 2812, 2.3.1 "Message format in Augmented BNF" - - RFC 2812, 3.3 "Sending messages" - - RFC 2812, 3.3.2 "Notice" - -- SVSNICK - SVSNICK <oldnick> <newnick> - . - Forcefully change foreign user nicknames. This command is allowed - for servers only. - . - The "SVSNICK" command is forwarded to the server to which the user - with nickname <oldnick> is connected to, which in turn generates a - regular "NICK" command that then is sent to the client, so no special - support in the client software is required. - - References: - - ngIRCd GIT commit e3f300d3231f - - -Server Protocol Commands -~~~~~~~~~~~~~~~~~~~~~~~~ - -- CHANINFO - CHANINFO <channel> +<modes> [[<key> <limit>] <topic>] - . - CHANINFO is used by servers to inform each other about a channel: - its modes, channel key, user limits and its topic. - . - Note: even when <modes> don't include "k" (key) or "l" (limit), both - parameters must be given when used; use "*" for "no key" and 0 for - "no limit" for the unused parameter in this case. - . - The CHANINFO command is allowed on server-links only. - - References: - - IRC+, <http://ngircd.barton.de/doc/Protocol.txt> - - IRC+, doc/Protocol.txt - -- ERROR - ERROR [<message> [<> [...]]] - . - Inform a client or a server about an error condition. The first - parameter, if given, is logged by the server receiving the message, - all other parameters are silently ignored. - . - This command is silently ignored on non-server and non-service links - and shouldn't be used by regular IRC clients. - . - The ERROR message is also sent before terminating a regular client - connection. - - References: - - RFC 2812, 3.7.4 "Error message" - -- METADATA - METADATA <target> <key> <value> - . - The METADATA command is used on server-links to update "metadata" - information of clients, like the hostname, the info text ("real name"), - or the user name. - . - The METADATA command is allowed on server-links only. - - References: - - IRC+, <http://ngircd.barton.de/doc/Protocol.txt> - - IRC+, doc/Protocol.txt - -- NJOIN - NJOIN <channel> [<mode>]<nick>[,[<mode>]<nick>[,...]] - . - The NJOIN command is used on server-links to add users with <nick> - and <mode> to a <channel> while peering. - . - The NJOIN command is allowed on server-links only. - - References: - - RFC 2813, 4.2.2 "Njoin message" - -- SERVER - SERVER <servername> <info> - SERVER <servername> <hopcount> <info> - SERVER <servername> <hopcount> <token> <info> - . - The first form registers the local connection as a new server in the - network, the second (RFC 1459) and third (RFC 2812) form announce a - new remote server in the network. - . - The SERVER command is allowed on unregistered or server-links only. - - References: - - RFC 1459, 4.1.4 "Server message" - - RFC 2813, 4.1.2 "Server message" - -- SQUIT - SQUIT <server> <comment> - . - Disconnects an IRC Server from the network. - . - This command is used on server-links, but can be used by IRC Operators - to forcefully disconnect servers from the network, too. - - References: - - RFC 2812, 3.1.8 "Squit" - - RFC 2813, 4.1.6 "Server quit message" - -Dummy Commands -~~~~~~~~~~~~~~ - -- SUMMON - SUMMON <user> [<target> [<channel>]] - . - This command was intended to call people into IRC who are directly - connected to the terminal console of the IRC server -- but is - deprecated today. Therefore ngIRCd doesn't really implement this - command and always returns an error message, regardless of the - parameters given. - - References: - - RFC 2812, 4.5 "Summon message" - -- USERS - USERS [<target>] - . - This command was intended to list users directly logged in into the - console of the IRC server -- but is deprecated today. Therefore ngIRCd - doesn't really implement this command and always returns an error - message, regardless of the parameters given. - - References: - - RFC 2812, 4.6 "Users" - -- GET - GET [...] - . - Fake HTTP GET command. When received, the connection is shut down - immediately again to protect against crazy web browsers ... - - References: - - ngIRCd GIT commit 33e8c2480649 - -- POST - POST [...] - . - Fake HTTP POST command. When received, the connection is shut down - immediately again to protect against crazy web browsers ... - - References: - - ngIRCd GIT commit 33e8c2480649 diff --git a/ngircd/doc/Container.md b/ngircd/doc/Container.md deleted file mode 100644 index b50f2e9..0000000 --- a/ngircd/doc/Container.md +++ /dev/null @@ -1,83 +0,0 @@ -# [ngIRCd](https://ngircd.barton.de) - Container How-To - -The ngIRCd daemon can be run as a containerized application, for example using -Docker or Podman (the latter being preferred and used in the examples below). -The container definition file, also known as "Docker file", is bundled with this -distribution as `contrib/Dockerfile` and based on the official "stable-slim" -container of the Debian project (see https://hub.docker.com/_/debian). - -## Building the container - -You can use the following command to build the ngIRCd container image: - -```bash -podman build --format=docker -f contrib/Dockerfile . -``` - -The `Dockerfile` includes a `HEALTHCHECK` directive, which is not supported by -the default OCI 1.0 image format, therefore we use the "docker" format here. - -If you are using Git, you can tag the built image like this (use the ID of the -newly built image!): - -```bash -tag=$(git describe --tags | sed 's/rel-//g') -podman tag <container_id> "ngircd:${tag}" -``` - -## Running the container - -You can use this command to run the ngIRCd container using Podman, for example: - -```bash -podman run --name=ngircd --detach \ - -p 127.0.0.1:6667:6667 \ - ngircd:<tag> -``` - -This creates and starts a new container named "ngircd" from the image -"ngircd:<tag>" (you habe to substitute _<tag>_ with the real tag name here!) and -maps the host port 6667 on localhost to the port 6667 inside of the container. - -### Configuring the container - -The ngIRCd inside of the container is installed inside of `/opt/ngircd/` and the -default drop-in directory is `/opt/ngircd/etc/ngircd.conf.d`. Therefore you can -map a host folder to this drop-in directory inside of the container and place -drop-in configuration file(s) in the host path like this: - -```bash -mkdir -p /host/path/to/ngircd/conf.d -touch /host/path/to/ngircd/conf.d/my.conf -podman run --name=ngircd --detach \ - -p 127.0.0.1:6667:6667 \ - -v "/host/path/to/ngircd/conf.d:/opt/ngircd/etc/ngircd.conf.d" \ - ngircd:<tag> -``` - -### Testing the configuration - -As with the native daemon, it is a very good idea to validate the configuration -of the daemon after making changes. - -With Docker and Podman, you can pass arguments to the `ngircd` binary inside of -the container by simply appending it to the "run" command line like this: - -```bash -podman run --rm -it \ - -v "/host/path/to/ngircd/conf.d:/opt/ngircd/etc/ngircd.conf.d" \ - ngircd:<tag> \ - --configtest -``` - -### Reloading the daemon configuration in a running container - -To activate changed configuration of ngIRCd, you can either restart the -container (which will disconnect all currently connected clients) or signal -`ngircd`(8) inside of the running container to reload its configuration file(s). - -The latter can be done with this command, for example: - -```bash -podman exec -it ngircd /bin/bash -c 'kill -HUP $(/usr/bin/pidof -s ngircd)' -``` diff --git a/ngircd/doc/Contributing.txt b/ngircd/doc/Contributing.txt deleted file mode 100644 index dd2b297..0000000 --- a/ngircd/doc/Contributing.txt +++ /dev/null @@ -1,60 +0,0 @@ - - ngIRCd - Next Generation IRC Server - http://ngircd.barton.de/ - - (c)2001-2015 Alexander Barton and Contributors. - ngIRCd is free software and published under the - terms of the GNU General Public License. - - -- Contributing.txt -- - - -If you want to contribute to ngIRCd, please read the following paragraphs to -get an idea of how to do it the best :-) - - - Use GIT - - The source code of ngIRCd is maintained using GIT, see doc/GIT.txt. So if - remotely possible, use GIT for your work, too. It makes your and our lives - much easier ;-) - - - Don't forget to include documentation - - When adding features and new configuration options, don't forget to not - only code the features but to describe them in doc/sample-ngircd.conf, - man/ngircd.8.tmp and/or man/ngircd.conf.5.tmpl as well! - - - Be present on IRC - - If you intend to code some new features or do some code cleanups or better - documentation, please be present on <irc://irc.barton.de/#ngircd> and - discuss your plans early! So other developers have an idea on what others - are working on, can offer help, and can synchronize their own work. - - - Check and validate your work! - - Use "make check" to validate your work, and use "make distcheck" to - validate the resulting archives, especially when adding/removing files! - - - Send patches in "unified diff" format - - Please send patches in "unified" format, that is, use "diff -u". - Or even better: use GIT ("git diff"), see above. - - - Send patches to the mailing list - - If you have some code to present, send the patch(es) and/or pointers to - your GIT repository to the official ngIRCd mailing list for review, not - only to #ngircd: so it becomes archived and more people have a chance to - review your patch. - - Sure it is a good idea to post some notes to #ngircd, too! :-) - - And this is open source, your work must not be 100% finished and perfect, - work in progress is interesting, too: "release early, release often"! - -- Use GitHub to create "Pull Requests" - - ngIRCd is hosted on GitHub (<https://github.com/ngircd>), so please use the - tools available there and open issues (comment!) and create pull requests! - See <https://help.github.com/articles/using-pull-requests/> for details. diff --git a/ngircd/doc/FAQ.md b/ngircd/doc/FAQ.md deleted file mode 100644 index 2a0ae1d..0000000 --- a/ngircd/doc/FAQ.md +++ /dev/null @@ -1,176 +0,0 @@ -# [ngIRCd](https://ngircd.barton.de) - FAQ, Tips & Tricks - -# General - -## Is it possible to link ngIRCd with other non-ngIRCd servers? - -Yes and no. Back in the beginning (2001, 2002, ...) the server-server protocol -used by ngIRCd was compatible to the original ircd used by IRCNet at that time, -version 2.10.3p3. And most probably this is still the case today, although not -actively tested for a long time. - -Please note that newer ircd versions (2.11.x) are *not* compatible any more! - -And other server-server protocols were never supported. - -## Is there a homepage with further information and downloads? - -Yes. Please visit https://ngircd.barton.de :-) - -## Why should I use ngIRCd instead of the original one? - -The `README.md` file and the [homepage](https://ngircd.barton.de) list a few -advantages of ngIRCd: - -- Well arranged (lean) configuration file. -- Simple to build, install, configure, and maintain. -- Supports IPv6 and SSL. -- Can use PAM for user authentication. -- Lots of popular user and channel modes are implemented. -- Supports "cloaking" of users. -- No problems with servers that have dynamic IP addresses. -- Freely available, modern, portable and tidy C source. -- Wide field of supported platforms, including AIX, A/UX, FreeBSD, HP-UX, - IRIX, Linux, macOS, NetBSD, OpenBSD, Solaris and Windows with WSL or Cygwin. - -# Building and Compilation - -## The `./configure` script is missing in the source directory!? - -When using sources checked out via *Git*, the `configure` script as well as the -`Makefile.in` templates must be generated using the GNU *automake*, *autoconf* -and *pkg-config* tools. To simplify this task run the `./autogen.sh` script -which will execute the required commands for you; then continue with executing -the `./configure` script as usual. - -Please see the `INSTALL.md` file for details! - -## Error message `aclocal: command not found` - -GNU *automake* is missing on your system but required for building Git versions -of ngIRCd. Install GNU automake 1.6 or later and try again. - -## Error message `autoheader: command not found`? - -GNU *autoconf* is missing on your system but required for building Git versions -of ngIRCd. Install GNU autoconf 2.52 or later and try again. - -## Error message `automake: configure.in: AM_INIT_AUTOMAKE must be used`? - -Most probably you are using version 1.5 of GNU automake which seems to be -incompatible to the build system of ngIRCd. Solution: upgrade to at least -version 1.6 of GNU automake. - -(If you are using Debian 3.0 "Woody" you can try to downgrade to version 1.4 of -GNU automake shipped with this distribution; it should work, too.) - -# Troubleshooting ngIRCd Runtime Issues - -Always start with: - -1. Make sure that ngIRCd parsed its configuration file as it was intended! - Run `ngircd --configest` and double-check its output! - -2. Check the logs of your system, especially the entries generated by ngIRCd! - Where you can find the log messages depends on your system and your setup: - it can be plain text files in `/var/log/` (syslog) or the systemd journal - database, for example. - -3. Ensure that the daemon started up successfully, is actually running and did - not stop/crash in the meantime. You can check this with your service - manager (like `systemctl status ngircd` on Linux systems using systemd) or - using `pgrep -l ngircd` to check for "ngircd" processes. If ngIRCd is not - running, try to restart the service and check the service status and the - logs (syslog, systemd journal) again! - -## Where is the log file stored? - -See introduction to this section above :-) - -## "Connection refused" errors - -1. Is the daemon really running? See introduction to this section above! - -2. Does ngIRCd listen on the correct interface(s) and port(s)? On Linux, you - can check this with `sudo ss -ltnp|awk '/ngircd/{print $4}`, for example. - Check your `Listen` and `Ports` settings in the `[Global]` (and `[SSL]`) - sections and the startup messages of the daemon, especially the lines - stating "Now listening on xxx:yyy (socket zzz)"! - -3. Are you able to connect to the ngIRCd service locally from the system the - daemon runs on? Test all the interface IP addresses you expect ngIRCd to - listen on, for example with a regular IRC client or tools like `telnet` or - `nc` ("net cat"): `telnet localhost 6667`, `nc 192.168.1.2 6667`, ... - - If all the above works as expected, the issue most probably is not with - ngIRCd or its configuration but the network layer. - -4. Are the port(s) ngIRCd listens on open and not blocked by a firewall? Check - the logs of your firewall solution (on the server itself and all firewalls - "in front of it") and use tools like `tcpdump` to check the network layer! - -## Issues related to running ngIRCd inside of a `chroot` environment - -**I cannot connect to remote peers when I use the chroot option, the following -is logged: `Can't resolve example.com: unknown error!`** - -See next question blow ... - -**When running ngIRCd inside a chroot, no IP addresses can be translated in DNS -names, errors like "Name or service not known" are logged!** - -On Linux/glibc with chroot enabled you need to put some libraries inside -the chroot as well, notably `libnss_dns`; maybe others. Unfortunately, even -linking ngIRCd statically does not help this. So you can either copy -all the required files into the chroot directory: - -``` bash -mkdir -p ./chroot/etc ./chroot/lib -cp -a /etc/hosts /etc/resolv.conf /etc/nsswitch.conf ./chroot/etc/ -cp -a /lib/libresolv* /lib/libnss_* ./chroot/lib/ -``` - -Or you can try to link ngIRCd against an other C library (like dietlibc) that do -not depend on NSS modules and these files. - -# IRC Features - -## I have added an `[Oper]` section, but how do I log in as an IRC operator? - -You can use the `/OPER <name> <password>` command in your IRC client to become -an IRC operator as defined in an `[Oper]` block in your configuration file. - -ngIRCd will also log all OPER requests (using syslog), and if an OPER command -fails you can look there to determine why it did not work (bad password, -unauthorized host mask, ...). - -Please keep in mind that the "name" in the `/OPER` command is *not* related to -your nick name at all! - -## I am an IRC operator, but MODE doesn't work! - -By default, IRC operators are still not allowed to use `/MODE` globally. - -If you set `OperCanUseMode = yes` in your configuration, then IRC operators can -use the `/MODE` command for changing modes even when they are not joined to the -specific channel. - -## How can I "auto-op" users in channels? - -ngIRCd can't do this: you would have to use some "IRC Services", like -[Atheme](http://atheme.net/atheme.html) or [Anope](http://www.anope.org). - -See `doc/Services.txt` for setup instructions. - -# Bugs!? - -## Is there a list of known bugs and desired feature enhancements? - -Yes. Have a look at the bug tracking system (GitHub issues) for ngIRCd located -at <https://github.com/ngircd/ngircd/issues>. There you can file bug reports and -feature requests as well as search the bug database. - -## What should I do if I found a bug? - -Please file a bug report at <https://github.com/ngircd/ngircd/issues/new>! -The authors will be notified automagically :-) diff --git a/ngircd/doc/HowToRelease.txt b/ngircd/doc/HowToRelease.txt deleted file mode 100644 index 3551423..0000000 --- a/ngircd/doc/HowToRelease.txt +++ /dev/null @@ -1,89 +0,0 @@ - - ngIRCd - Next Generation IRC Server - http://ngircd.barton.de/ - - (c)2001-2024 Alexander Barton and Contributors. - ngIRCd is free software and published under the - terms of the GNU General Public License. - - -- HowToRelease.txt -- - - -I. Introduction -~~~~~~~~~~~~~~~ - -Creating a new ngIRCd release requires a few steps to follow: the source -tree must be in a releasable state (be up to date, include all required -patches, be tested on as many platforms as possible), a name for the new -release must be chosen, and all the files describing the release must be -updated accordingly. - -Since ngIRCd release 13 (2009-12-25) we use "simple" release numbers for -major releases (e.g. "13", "17", "42", ...) introducing new features and -sub-releases for bug fixes only (e.g. "14.1", "22.3", ...). - -When creating pre-releases or release candidates, please use the tilde ("~") -character to separate the "postfix" in the release number (e.g. "17~rc2" -or "123.4~rc6"). - -The release/version number of a build is automatically generated using the -GIT "describe" command, see git-describe(1). Therefore it is required that -a new release is tagged in the GIT tree and that the configure script is -up-to-date (e.g. using ./autogen.sh) before generating the archives! - - -II. How to prepare a new ngIRCd release? -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -a) Make sure you have working versions of GNU autoconf and GNU automake - installed on the system you use for generating the release: - as of May 2020 we are using GNU autoconf 2.69 and GNU automake 1.11.6 - which seem to work just fine. - NOTE: new releases of GNU automake DO NOT work, as they lack support for - the "ansi2knr" wrapper and "de-ANSI-fication" support! - -b) Make sure the source tree is in a releasable state ;-) - - Are all branches & patches merged? Check GitHub issues, pull requests - and milestones! - - Run as many tests as you can! - - Is the AUTHORS.md file up to date? This command may be helpful: - "( grep '>$' AUTHORS.md; git shortlog -se|cut -c8-|sed 's/^/- /' ) \ - | grep -Ev '(alex@barton.de|fw@strlen.de)' \ - | LC_ALL=de_DE.UTF-8 sort -u" - -c) Update the files describing the new release: - - ChangeLog - - NEWS - -d) Update the version numbers in the following files: - - contrib/de.barton.ngircd.metainfo.xml - - contrib/ngircd.spec - -e) Generate a new Debian change log entry in the following file, e.g. using - the Debian "dch" tool of the "devscripts" package: - - contrib/Debian/changelog - -f) Commit the above changes to GIT: "git add", "git commit" - -g) Create a new signed GIT tag for the new release: "git tag -s". - Please note that we don't use the tilde ("~") here, instead use a simple - hyphen ("-") as delimiter: e.g. "rel-16" "rel-17-rc1", "rel-18-pre2", ... - -h) Run "./autogen.sh" to update the ./configure script with the correct - release number (autogenerated using "git describe", see above). - -i) Run "./configure" to rebuild all generated Makefiles. - -j) Run "make distcheck" (and "make dist-tarZ && make dist-xz") to generate all - of the distribution archives. - -k) Sign the distribution archive(s) using GnuPG: "gpg -b <archivefile>" - -l) Upload and distribute the newly generated ngIRCd release archive(s) - and GnuPG signatures (to the website, its mirrors, and GitHub). - -m) Update the ngIRCd website and its mirrors! - -n) Write an announcement to the mailing list, Twitter, ... - -o) Relax :-) diff --git a/ngircd/doc/Makefile.am b/ngircd/doc/Makefile.am deleted file mode 100644 index d37c9b3..0000000 --- a/ngircd/doc/Makefile.am +++ /dev/null @@ -1,92 +0,0 @@ -# -# ngIRCd -- The Next Generation IRC Daemon -# Copyright (c)2001-2024 Alexander Barton (alex@barton.de) and Contributors -# -# 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 -# the Free Software Foundation; either version 2 of the License, or -# (at your option) any later version. -# Please read the file COPYING, README and AUTHORS for more information. -# - -.tmpl: - $(AM_V_GEN)sed \ - -e "s@:ETCDIR:@${sysconfdir}@" \ - -e "s@:DOCDIR:@${docdir}@" \ - <$< >$@ - -SUFFIXES = .tmpl - -static_docs = \ - Bopm.txt \ - Capabilities.txt \ - Commands.txt \ - Container.md \ - Contributing.txt \ - FAQ.md \ - HowToRelease.txt \ - Modes.txt \ - PAM.txt \ - Platforms.txt \ - Protocol.txt \ - README-AUX.txt \ - README-BeOS.txt \ - README-Interix.txt \ - RFC.txt \ - Services.txt \ - SSL.md - -doc_templates = sample-ngircd.conf.tmpl - -generated_docs = sample-ngircd.conf - -toplevel_docs = ../AUTHORS.md ../COPYING ../ChangeLog ../INSTALL.md ../NEWS ../README.md - -SUBDIRS = src - -EXTRA_DIST = $(static_docs) $(doc_templates) - -CLEANFILES = $(generated_docs) - -maintainer-clean-local: - rm -f Makefile Makefile.in - -all: $(generated_docs) - -install-data-hook: $(static_docs) $(toplevel_docs) $(generated_docs) - $(MKDIR_P) -m 755 $(DESTDIR)$(sysconfdir) - @if [ ! -f $(DESTDIR)$(sysconfdir)/ngircd.conf ]; then \ - ${MAKE} install-config; \ - fi - $(MKDIR_P) -m 755 $(DESTDIR)$(docdir) - for f in $(static_docs) $(toplevel_docs); do \ - $(INSTALL) -m 644 -c $(srcdir)/$$f $(DESTDIR)$(docdir)/; \ - done - for f in $(generated_docs); do \ - $(INSTALL) -m 644 -c $$f $(DESTDIR)$(docdir)/; \ - done - -install-config: - $(INSTALL) -m 600 -c sample-ngircd.conf $(DESTDIR)$(sysconfdir)/ngircd.conf - @echo; \ - echo " ** NOTE: Installed sample configuration file:"; \ - echo " ** \"$(DESTDIR)$(sysconfdir)/ngircd.conf\""; \ - echo - -uninstall-hook: - rm -rf $(DESTDIR)$(docdir) - @if cmp --silent sample-ngircd.conf $(DESTDIR)$(sysconfdir)/ngircd.conf; then \ - ${MAKE} uninstall-config; \ - else \ - echo; \ - echo " ** NOTE: Not uninstalling changed configuration file:"; \ - echo " ** \"$(DESTDIR)$(sysconfdir)/ngircd.conf\""; \ - echo; \ - fi - -uninstall-config: - rm -f $(DESTDIR)$(sysconfdir)/ngircd.conf - -.PHONY: install-config uninstall-config - -# -eof- diff --git a/ngircd/doc/Modes.txt b/ngircd/doc/Modes.txt deleted file mode 100644 index 92e6613..0000000 --- a/ngircd/doc/Modes.txt +++ /dev/null @@ -1,95 +0,0 @@ - - ngIRCd - Next Generation IRC Server - http://ngircd.barton.de/ - - (c)2001-2015 Alexander Barton and Contributors. - ngIRCd is free software and published under the - terms of the GNU General Public License. - - -- Modes.txt -- - - -This document lists the different user modes, channel modes, and channel -user modes that ngIRCd supports. - - -I. User Modes -~~~~~~~~~~~~~ - -User modes are attributes a user has in the network, regardless of the -channels he is using at the moment. - - mode since description - - a 0.3.0 User is away. - b 20 User blocks private messages and notices. - B 20 User is flagged as a "bot". - c 17 IRC operator wants to receive connect/disconnect NOTICEs. - C 19 Only users that share a channel are allowed to send messages. - F 22 Relaxed flood protection (only settable by IRC Operators). - i 0.0.1 User is "invisible". - I 23 No channels are shown on WHOIS (IRC Ops can always see those). - o 0.0.1 User is IRC operator. - q 20 User is protected, can not be kicked from a channel. - r 0.0.1 User is restricted. - R (1) 19 User is registered (e.g. by NickServ). - s 0.4.0 User wants to receive server notices. - w 0.11.0 User wants to receive WALLOPS messages. - x 17 Hostname of this user is "cloaked". - -II. Channel Modes -~~~~~~~~~~~~~~~~~ - -Channel modes are attributes of specific channels which are valid for all -users joined (or trying to join) to this channel. Some modes add and remove -users to lists (e.g. "invite list", "ban list"), others have parameters -(like "channel key"), most are simple flags (like "moderated"). - - mode since description - - b 0.5.0 Add/remove a host mask to the ban list. - e 19 Add/remove a host mask to the exception list. - i 0.5.0 Channel is "invite only". - I 0.5.0 Add/remove a host mask to the invite list. - k 0.6.0 Channel has a "key" (a password). - l 0.6.0 Channel has a user limit. - m 0.3.0 Channel is moderated, only "voiced" users can send messages. - M 20 Only registered users (and IRC Ops) can send messages. - n 0.3.0 Channel doesn't allow messages of users not being members. - N 23 Users can't change their nickname while on this channel. - O 18 Only IRC operators are allowed to join this channel. - P 0.5.0 Channel is "persistent". - Q 20 Nobody can be kicked from the channel. - r (1) 19 Channel is "registered" (e.g. by ChanServ). - R 19 Only registered users are allowed to join this channel. - s 0.9.0 Channel is "secret". - t 0.3.0 Only ChanOps are allowed to modify the channel topic. - V 20 Channel doesn't allow invites. - z 16 Only users connected via SSL are allowed to join the channel. - -III. Channel User Modes -~~~~~~~~~~~~~~~~~~~~~~~ - -Channel user modes are attributes that a particular user has in a specific -channel of which he is a member. - - mode since description - - q 20 User is channel owner. This mode can only be set by an IRC - service, other owner or IRC operator. Channel owners can - promote other users to all levels: q, a, o, h, v. Prefix: "~". - a 20 User is channel admin and can promote other users to v, h, o. - Prefix: "&". - o 0.2.0 User is channel operator and can op/kick/... other members. - Prefix: "@". - h 20 User is half op and can set channel modes imntvIbek and kick - voiced and normal users. Prefix: "%". - v 0.2.0 User is "voiced" and can speak even if channel is moderated. - Prefix: "+". - - -Notes -~~~~~ - -(1) This mode is not set by ngIRCd itself but by services. ngIRCd handles - the mode transparently and possibly adjusts its behavior. diff --git a/ngircd/doc/PAM.txt b/ngircd/doc/PAM.txt deleted file mode 100644 index 818c4f1..0000000 --- a/ngircd/doc/PAM.txt +++ /dev/null @@ -1,49 +0,0 @@ - - ngIRCd - Next Generation IRC Server - http://ngircd.barton.de/ - - (c)2001-2013 Alexander Barton and Contributors. - ngIRCd is free software and published under the - terms of the GNU General Public License. - - -- PAM.txt -- - - -ngIRCd can optionally be compiled to use PAM, the Pluggable Authentication -Modules library, for user authentication. When compiled with PAM support, -ngIRCd will authenticate all users connecting to the daemon using the -configured PAM modules in an asynchronous child process. - -To enable PAM, you have to pass the command line parameter "--with-pam" to -the "configure" script. Please see the PAM documentation ("man 7 pam") for -details and information about configuring PAM and its individual modules. - -A very simple -- and quite useless ;-) -- example would be: - - /etc/pam.d/ngircd: - auth required pam_debug.so - -Here the "pam_debug" module will be called each time a client connects to -the ngIRCd and has sent its PASS, NICK, and USER commands. - -The PAM library used by the ngIRCd daemon must be able to access its -configuration file, so don't forget to check permissions and run something -like this: "chmod 644 /etc/pam.d/ngircd". - -Please note ONE VERY IMPORTANT THING: - -All the PAM modules are executed with the privileges of the user ngIRCd -is running as. Therefore a lot of PAM modules aren't working as expected, -because they need root privileges ("pam_unix", for example)! -Only PAM modules not(!) requiring root privileges (such as "pam_pgsql", -"pam_mysql", "pam_opendirectory" ...) can be used in conjunction with ngIRCd. - -More Examples: - - * Use an own "password file" for ngIRCd: - - Note: you can use the htpasswd(1) utility of Apache to manage password - files used by pam_pwdfile, see "man htpasswd"! - - /etc/pam.d/ngircd: - auth required pam_pwdfile.so pwdfile=/etc/ngircd/ngircd.passwd diff --git a/ngircd/doc/Platforms.txt b/ngircd/doc/Platforms.txt deleted file mode 100644 index f982c0c..0000000 --- a/ngircd/doc/Platforms.txt +++ /dev/null @@ -1,179 +0,0 @@ - - ngIRCd - Next Generation IRC Server - http://ngircd.barton.de/ - - (c)2001-2024 Alexander Barton and Contributors. - ngIRCd is free software and published under the - terms of the GNU General Public License. - - -- Platforms.txt -- - - -This file lists the status of all platforms on which ngIRCd has been tested. -Included is the date and version of the last test and the name of the tester -or maintainer. - -If you successfully compiled and tested ngIRCd on a platform that isn't listed -here, please write to the mailing list so that this list can be updated. The -script "./contrib/platformtest.sh" should output a summary that is suitable -for inclusion here. Thanks for your help! - - - the executable works ("runs") as expected --+ - tests run successfully ("make check") --+ | - ngIRCd compiles ("make") --+ | | - ./configure works --+ | | | - | | | | -Platform Compiler ngIRCd Date Tester C M T R * ---------------------------- ------------ ---------- -------- -------- - - - - - -aarch64/apple/darwin A-clang 12.0 26 20-12-10 goetz N Y Y Y 3 -aarch64/apple/darwin23.4.0 A-clang 15.0 27~rc1 24-04-13 alex Y Y Y Y 3 -aarch64/unknown/linux-gnu gcc 12.2.0 27~rc1 24-04-21 alex Y Y Y Y 1 -alpha/unknown/netbsd3.0 gcc 3.3.3 CVSHEAD 06-05-07 fw Y Y Y Y 3 -armv6l/unk./linux-gnueabi gcc 4.7.2 20.2 13-03-08 goetz Y Y Y Y 5 -armv6l/unk./linux-gnueabihf gcc 4.6.3 21~rc2 13-10-26 pi Y Y Y Y 5 -armv7l/unk./linux-gnueabi gcc 4.4.3 19.1 12-04-29 goetz Y Y Y Y 5 -armv7l/unk./linux-gnueabihf gcc 4.6.3 22~rc1-3 14-10-10 alex Y Y Y Y 5 -armv7l/unk./linux-gnueabihf gcc 4.8.2 21.1 14-07-15 goetz Y Y Y Y 5 -armv7l/unk./linux-gnueabihf gcc 4.9.2 23 16-01-10 alex Y Y Y Y 5 -hppa/unknown/openbsd3.5 gcc 2.95.3 CVSHEAD 04-05-25 alex Y Y Y Y -hppa/unknown/openbsd5.4 gcc 4.2.1 22~rc1-3 14-10-10 alex Y Y y Y 3 -hppa1.1/unknown/linux-gnu gcc 3.3.3 0.8.0 04-05-30 alex Y Y Y Y -hppa2.0/unknown/linux-gnu gcc 3.3.5 13~rc1 08-12-02 alex Y Y Y Y -hppa2.0w-hp-hpux11.11 gcc 4.2.3 14.1 09-07-22 goetz Y Y Y Y -i386/apple/darwin9.7.0 gcc 4.0.1 14.1 09-08-04 alex Y Y Y Y 3 -i386/apple/darwin10.8.0 gcc 4.2.1 19 12-02-26 alex Y Y Y Y 3 -i386/apple/darwin11.3.0 gcc 4.2.1 19 12-02-26 alex Y Y Y Y 3 -i386/pc/linux-gnu gcc 4.1.2 13~rc1 08-12-05 alex Y Y Y Y 1 -i386/pc/linux-gnu gcc 4.4.5 22~rc1-3 14-10-10 alex Y Y Y Y 1 -i386/pc/minix clang 3.4 23 16-01-06 goetz Y Y N Y -i386/pc/solaris2.9 gcc 3.2.2 CVSHEAD 04-02-24 alex Y Y Y Y -i386/pc/solaris2.11 gcc 4.8.2 24 17-01-21 goetz Y Y Y Y 4 -i386/unknown/freebsd5.2.1 gcc 3.3.3 0.8.0 04-05-30 alex Y Y Y Y -i386/unknown/freebsd6.2 gcc 3.4.6 20~rc1 12-11-13 alex Y Y Y Y 3 -i386/unknown/freebsd7.3 gcc 4.2.1 24~rc1-7 17-01-20 alex Y Y Y Y 3 -i386/unknown/netbsdelf1.5.2 egcs-1.1.2 21 13-11-25 goetz Y Y N Y -i386/unknown/netbsdelf1.6.2 gcc 2.95.3 18 11-07-10 goetz Y Y Y Y -i386/unknown/netbsdelf3.0.1 gcc 3.3.3 0.10.0-p1 06-08-30 alex Y Y Y Y 3 -i386/unknown/netbsdelf4.0 gcc 4.1.2 24~rc1-7 17-01-20 alex Y Y Y Y 3 -i386/unknown/netbsdelf5.0.2 gcc 4.1.3 19 12-02-26 alex Y Y Y Y 3 -i386/unknown/openbsd3.5 gcc 2.95.3 23 15-11-27 goetz Y Y y Y 3 -i386/unknown/openbsd3.9 gcc 3.3.5 0.10.0-p1 06-08-30 alex Y Y Y Y 3 -i386/unknown/openbsd4.1 gcc 3.3.5 16 10-04-11 alex Y Y Y Y 3 -i386/unknown/openbsd5.3 gcc 4.2.1 21 13-11-28 goetz Y Y Y Y 3 -i386/unknown/openbsd5.4 gcc 4.2.1 21 13-11-28 goetz Y Y Y Y 3 -i586/pc/haiku gcc 2.95.3 19.2~138 12-10-11 user Y Y N N -i586/pc/interix3.5 gcc 3.3 23 16-01-29 alex Y Y N Y -i686/pc/cygwin gcc 4.9.3 23 16-01-06 alex Y Y Y Y -i686/pc/linux-gnu gcc 2.6.3 23 16-01-06 goetz Y Y y Y 1 -i686/pc/linux-gnu gcc 2.7.2.1 23 15-11-30 goetz Y Y N Y 1 -i686/pc/linux-gnu gcc 2.95.2 23 15-12-23 goetz Y Y Y Y 1 -i686/pc/linux-gnu gcc 2.95.4 0.8.0 04-05-30 alex Y Y Y Y 1 -i686/pc/linux-gnu gcc 3.3.5 14.1 09-08-04 alex Y Y Y Y 1 -i686/pc/linux-gnu gcc 4.3.2 14.1 09-08-04 alex Y Y Y Y 1 -i686/pc/minix gcc 4.4.6 21~rc2 13-10-27 alex Y Y N N -i686/unknown/gnu0.3 gcc 4.4.5 19 12-02-29 alex Y Y Y Y -i686/unknown/gnu0.5 gcc 4.9.1 22~rc1-3 14-10-11 alex Y Y Y Y -i686/unknown/gnu0.9 gcc 12.2.0 27~rc1 24-04-21 alex Y Y Y Y -i686/unkn./kfreebsd7.2-gnu gcc 4.3.4 15 09-12-02 alex Y Y Y Y 3 -m68k/apple/aux3.0.1 gcc 2.7.2 17 10-11-07 alex Y Y N Y -m68k/apple/aux3.0.1 Orig. A/UX 17 10-11-07 alex Y Y N Y 2 -m68k/apple/aux3.1.1 gcc 2.7.2 19 12-02-26 alex Y Y N Y -m68k/apple/aux3.1.1 Orig. A/UX 19 12-02-26 alex Y Y N Y 2 -m68k/hp/hp-ux9.10 Orig. HPUX 0.7.x-CVS 03-04-30 goetz Y Y Y Y -m88k/dg/dgux5.4R3.10 gcc 2.5.8 CVSHEAD 04-03-15 alex Y Y ? ? -mips/sgi/irix6.5 SGI 25 19-12-29 goetz Y Y ? ? -mipsel/openwrt/linux-uclibc gcc 4.8 24~9-g619a 18-01-28 goetz - - - Y 6 -mipsel/unknown/linux-gnu gcc 4.1.2 18 11-07-05 goetz Y Y N Y 1 -mipsel/unknown/linux-gnu gcc 4.4.5 21 13-11-24 goetz Y Y Y Y 1 -mipsel/unknown/netbsd8.0 gcc 5.5.0 25 19-08-09 root Y Y y Y 3 -powerpc/apple/darwin6.8 gcc 3.1 21 14-01-03 goetz Y Y Y Y -powerpc/apple/darwin7.9.0 gcc 3.3 22 15-03-22 goetz Y Y Y Y 3 -powerpc/apple/darwin8.11.0 gcc 4.0.1 26 20-07-08 goetz Y Y Y Y 3 -powerpc/apple/darwin9.8.0 gcc 4.0.1 21 14-01-04 goetz Y Y Y Y 3 -powerpc/unknown/linux-gnu gcc 3.3.3 0.8.0 04-05-30 alex Y Y Y Y -powerpc/unknown/openbsd3.6 gcc 2.95.3 0.10.0 06-10-08 alex Y Y N Y -sparc/sun/solaris2.6 gcc 2.95.3 0.7.x-CVS 03-04-22 alex Y Y Y Y -sparc/sun/solaris2.7 gcc 3.3 0.8.0 04-05-30 alex Y Y Y Y -sparc/unkn./netbsdelf1.6.1 gcc 2.95.3 0.8.0 04-05-30 alex Y Y Y Y -sparc/unknown/openbsd5.5 gcc 4.2.1 21.1 14-05-03 goetz Y Y Y Y 3 -x86_64/apple/darwin10.8.0 gcc 4.2.1 21~rc2 13-10-30 alex Y Y Y Y 3 -x86_64/apple/darwin12.3.0 gcc 4.2.1 20.2 13-04-01 alex Y Y Y Y 3 -x86_64/apple/darwin13.0.0 A-clang 5.0 21 14-01-02 alex Y Y Y Y 3 -x86_64/apple/darwin14.5.0 A-clang 6.1 23~rc1 15-09-06 alex Y Y Y Y 3 -x86_64/apple/darwin15.6.0 A-clang 8.0 23~38-g455 16-11-04 alex Y Y Y Y 3 -x86_64/apple/darwin16.5.0 A-clang 8.1 25~rc1-7-g 18-11-04 alex Y Y Y Y 3 -x86_64/apple/darwin17.7.0 A-clang 10.0 25~rc1 18-11-04 alex Y Y Y Y 3 -x86_64/apple/darwin18.2.0 A-clang 10.0 25~rc1-11 19-01-23 alex Y Y Y Y 3 -x86_64/apple/darwin19.4.0 A-clang 11.0 26~rc1 20-05-10 alex Y Y Y Y 3 -x86_64/apple/darwin19.6.0 A-clang 12.0 26 20-10-20 alex Y Y Y Y 3 -x86_64/apple/darwin20.1.0 A-clang 12.0 26 21-01-01 alex Y Y Y Y 3 -x86_64/apple/darwin23.4.0 A-clang 15.0 27~rc1 24-04-21 alex Y Y Y Y 3 -x86_64/unknown/dragonfly3.4 gcc 4.7.2 21 13-11-12 goetz Y Y N Y 3 -x86_64/unkn./freebsd8.1-gnu gcc 4.4.5 19 12-02-26 alex Y Y Y Y 3 -x86_64/unknown/freebsd8.4 gcc 4.2.1 24~rc1-7 17-01-20 alex Y Y Y Y 3 -x86_64/unknown/freebsd9.2 gcc 4.2.1 22~rc1-3 14-10-10 alex Y Y Y Y 3 -x86_64/unknown/freebsd10.3 F-clang 3.4 24 17-01-20 goetz Y Y Y Y 3 -x86_64/unknown/freebsd11.0 F-clang 3.8 24 17-01-21 goetz Y Y Y Y 3 -x86_64/unknown/freebsd12.1 F-clang 8.0 26 20-08-28 alex Y Y Y Y 3 -x86_64/unknown/freebsd14.0 F-clang 16.0 27~rc1 24-04-21 alex Y Y Y Y 3 -x86_64/unknown/haiku gcc 7.3.0 25~rc1-11 19-01-06 alex Y Y N Y -x86_64/unknown/haiku gcc 13.2.0 27~rc1 24-04-21 user Y Y Y Y -x86_64/unknown/linux-gnu clang 3.3 21 14-01-07 alex Y Y Y Y 1 -x86_64/unknown/linux-gnu clang 3.4 22~rc1-3 14-10-11 alex Y Y Y Y 1 -x86_64/pc/linux-gnu D-clang 14.0 27~rc1 24-04-21 alex Y Y Y Y 1 -x86_64/pc/linux-gnu gcc 4.4.5 24~rc1-7 17-01-20 alex Y Y Y Y 1 -x86_64/unknown/linux-gnu gcc 4.7.2 23~rc1-3 15-11-15 alex Y Y Y Y 1 -x86_64/pc/linux-gnu gcc 4.8.4 24~rc1-7 17-01-20 alex Y Y Y Y 1 -x86_64/pc/linux-gnu gcc 4.9.2 24~rc1-7 17-01-20 alex Y Y Y Y 1 -x86_64/unknown/linux-gnu gcc 5.3.0 23 15-12-14 goetz Y Y Y Y 1 -x86_64/pc/linux-gnu [WSL] gcc 5.4.0 24 18-03-07 goetz Y Y y Y 7 -x86_64/pc/linux-gnu gcc 6.2.1 24~rc1-7 17-01-20 alex Y Y Y Y 1 -x86_64/pc/linux-gnu gcc 6.3.0 25~rc1-11 19-01-23 alex Y Y Y Y 1 -x86_64/pc/linux-gnu gcc 8.3.0 26 20-08-28 alex Y Y Y Y 1 -x86_64/pc/linux-gnu gcc 11.4.0 27~rc1 24-04-21 alex Y Y Y Y 1 -x86_64/pc/linux-gnu gcc 12.2.0 27~rc1 24-04-21 alex Y Y Y Y 1 -x86_64/pc/linux-gnu gcc 13.2.1 27~rc1 24-04-21 alex Y Y Y Y 1 -x86_64/pc/solaris2.11 gcc 10.3.0 27~rc1 24-04-26 alex Y Y y Y 5 -x86_64/unknown/linux-gnu icc 16 23 16-01-13 goetz Y Y Y Y 1 -x86_64/unknown/linux-gnu nwcc 0.8.2 21 13-12-01 goetz Y Y Y Y 1 -x86_64/unknown/linux-gnu Open64 21.1 14-03-27 goetz Y Y Y Y 1 -x86_64/unknown/linux-gnu Sun C 5.12 21.1 14-03-27 goetz Y Y Y Y 1 -x86_64/unknown/netbsd9.0 gcc 7.4.0 26 20-08-28 alex Y Y y Y 3 -x86_64/unknown/netbsd10.0 gcc 10.5.0 27~rc1 24-04-21 alex Y Y Y Y 3 -x86_64/unknown/openbsd4.7 gcc 3.3.5 20~rc1 12-02-26 alex Y Y Y Y 3 -x86_64/unknown/openbsd4.8 gcc 4.2.1 22~rc1-3 14-10-10 alex Y Y y Y 3 -x86_64/unknown/openbsd5.1 gcc 4.2.1 21 13-12-28 alex Y Y Y Y 3 -x86_64/unknown/openbsd5.5 gcc 4.2.1 22~rc1-3 14-10-10 alex Y Y Y Y 3 -x86_64/unknown/openbsd6.6 gcc 4.2.1 26 20-08-28 alex Y Y Y Y 3 -x86_64/unknown/openbsd6.6 O-clang 8.0 26 20-08-28 alex Y Y Y Y 3 -x86_64/unknown/openbsd6.7 gcc 4.2.1 26 20-09-26 goetz Y Y y Y 3 -x86_64/unknown/openbsd7.4 O-clang 13.0 27~rc1 24-04-21 alex Y Y Y Y 3 - - -* Notes -~~~~~~~ - -(1) */*/linux-gnu (Linux platforms): - ngIRCd has been tested with various Linux distributions, such as ArchLinux, - Debian, Gentoo, Red Hat (Fedora) and SuSE using Linux kernels 2.2.x, 2.4.x, - 2.6.x, 3.x, 4.x and 5.x, with various versions of the GNU C compiler - (starting with 2.95.x) and Clang. The eldest glibc used was glibc-2.0.7. - ngIRCd compiled and ran on all of these systems successfully. - Current Linux kernels (starting with 2.6.x) and glibc's support the more - efficient epoll() IO interface, see (5) below. - -(2) This compiler is a pre-ANSI C compiler (K&R), therefore the source code is - automatically converted using the included ansi2knr tool while building. - -(3) Using the kqueue() IO interface. - -(4) Using the /dev/poll IO interface. - -(5) Using the epoll() IO interface. - -(6) ngIRCd has been cross-compiled with gcc 4.8 on Ubuntu x86-64 for - MIPSEL Linux OpenWRT distribution (uclibc), for the target computer - Vocore2, where the created binary ran well. - -(7) This actually is Windows 10 running Windows Subsystem for Linux (WSL). diff --git a/ngircd/doc/Protocol.txt b/ngircd/doc/Protocol.txt deleted file mode 100644 index b920b45..0000000 --- a/ngircd/doc/Protocol.txt +++ /dev/null @@ -1,265 +0,0 @@ - - ngIRCd - Next Generation IRC Server - http://ngircd.barton.de/ - - (c)2001-2019 Alexander Barton and Contributors. - ngIRCd is free software and published under the - terms of the GNU General Public License. - - -- Protocol.txt -- - - -I. Compatibility -~~~~~~~~~~~~~~~~ - -The ngIRCd implements the Internet Relay Chat (IRC) protocol version 2.10 -as defined in RFC ("request for comment") 1459 and 2810-2813. These (and -probably further relevant RFCs) are listed in doc/RFC.txt. - -Unfortunately, even the "original" ircd doesn't follow these specifications -in all details. But because the ngIRCd should be a fully compatible -replacement for this server ("ircd") it tries to emulate these differences. - -If you don't like this behavior please ./configure the ngIRCd using the -"--enable-strict-rfc" command line option. But keep in mind: not all IRC -clients are compatible with a server configured that way, some can't even -connect at all! Therefore this option usually isn't desired for "normal -server operation". - -In addition, ngIRCd implements some "IRCv3" features. This includes: - - IRCv3 Client Capability Negotiation - - IRCv3.1 multi-prefix Extension - - IRCv3.2 userhost-in-names Extension -Please see the IRCv3 homepage for more information: <https://ircv3.net>. - - -II. The IRC+ Protocol -~~~~~~~~~~~~~~~~~~~~~ - -Starting with version 0.5.0, the ngIRCd extends the original IRC protocol -as defined in RFC 2810-2813. This enhanced protocol is named "IRC+". It is -backwards compatible to the "plain" IRC protocol and will only be used by -the ngIRCd if it detects that the peer supports it as well. - -The "PASS" command is used to detect the protocol and peer versions see -RFC 2813 (section 4.1.1) and below. - - -II.1 Register new server link - - Command: PASS - Parameters: <password> <version> <flags> [<options>] - Used by: servers only (with these parameters) - -<password> is the password for this new server link as defined in the server -configuration which is sent to the peer or received from it. - -<version> consists of two parts and is at least 4, at most 14 characters -long: the first four bytes contain the IRC protocol version number, whereas -the first two bytes represent the major version, the last two bytes the -minor version (the string "0210" indicates version 2.10, e.g.). - -The following optional(!) 10 bytes contain an implementation-dependent -version number. Servers supporting the IRC+ protocol as defined in this -document provide the string "-IRC+" here. - -Example for <version>: "0210-IRC+". - -<flags> consists of two parts separated with the character "|" and is at -most 100 bytes long. The first part contains the name of the implementation -(ngIRCd sets this to "ngircd", the original ircd to "IRC", e.g.). The second -part is implementation-dependent and should only be parsed if the peer -supports the IRC+ protocol as well. In this case the following syntax is -used: "<serverversion>[:<serverflags>]". - -<serverversion> is an ASCII representation of the clear-text server version -number, <serverflags> indicates the supported IRC+ protocol extensions (and -may be empty!). - -The following <serverflags> are defined at the moment: - -- C: The server supports the CHANINFO command. - -- L: INVITE- and BAN-lists should be synchronized between servers: if the - peer understands this flag, it will send "MODE +I" and "MODE +b" - commands after the server link has been established. - -- H: The server supports the "enhanced server handshake", see section II.2 - for a detailed description. - -- M: Changing client "metadata" (hostname, real name, ...) using the - METADATA command is supported. - -- o: IRC operators are allowed to change channel- and channel-user-modes - even if they aren't channel-operator of the affected channel. - -- S: The server supports the SERVICE command (on this link). - -- X: Server supports XOP channel modes (owner, admin, halfop) and supports - these user prefixes in CHANINFO commands, for example. - -- Z: Compressed server links are supported by the server. - -Example for a complete <flags> string: "ngircd|0.7.5:CZ". - -The optional parameter <options> is used to propagate server options as -defined in RFC 2813, section 4.1.1. - - -II.2 Enhanced Server Handshake - -The "enhanced server handshake" is used when both servers support this IRC+ -extension, which is indicated by the 'H' flag in the <serverflags> sent with -the PASS command, see section II.1. - -It basically means, that after exchanging the PASS and SERVER commands the -server is not registered in the network (as usual), but that IRC numerics -are exchanged until the numeric 376 (ENDOFMOTD) is received. Afterwards the -peer is registered in the network as with the regular IRC protocol. - -A server implementing the enhanced server handshake (and indicating this -using 'H' in the <serverflags>) MUST ignore all unknown numerics to it -silently. - -In addition, such a server should at least send the numeric 005 (ISUPPORT) -to its peer, containing the following information. Syntax: <key>=<value>, -one token per IRC parameter. If the server has to send more than 12 token -it must send separate ISUPPORT numerics (this is a limitation of the IRC -protocol which allows at max 15 arguments per command). - - - NICKLEN: Maximum nickname length. Default: 9. - - CASEMAPPING: Case mapping used for nick- and channel name comparing. - Default: "ascii", the chars [a-z] are lowercase of [A-Z]. - - PREFIX: List of channel modes a person can get and the respective prefix - a channel or nickname will get in case the person has it. The order of the - modes goes from most powerful to least powerful. Default: "(ov)@+" - - CHANTYPES: Supported channel prefixes. Default: "#". - - CHANMODES: List of channel modes for 4 types, separated by comma (","): - Mode that adds or removes a nick or address to a list, mode that changes - a setting (both have always has a parameter), mode that changes a setting - and only has a parameter when set, and mode that changes a setting and - never has a parameter. For example "bI,k,l,imnPst". - - CHANLIMIT: Maximum number of channels allowed to join by channel prefix, - for example "#:10". - -Please see <http://www.irc.org/tech_docs/005.html> for details. - -The information exchanged using ISUPPORT can be used to detect configuration -incompatibilities (different maximum nickname length, for example) and -therefore to disconnect the peer prior to registering it in the network. - - -II.3 Exchange channel-modes, topics, and persistent channels - - Command: CHANINFO - Parameters: <channel> +<modes> [[<key> <limit>] <topic>] - Used by: servers only - -CHANINFO is used by servers to inform each other about a channel: its -modes, channel key, user limits and its topic. The parameter combination -<key> and <limit> is optional, as well as the <topic> parameter, so that -there are three possible forms of this command: - - CHANINFO <channel> +<modes> - CHANINFO <channel> +<modes> <topic> - CHANINFO <channel> +<modes> <key> <limit> <topic> - -If the channel already exists on the server receiving the CHANINFO command, -it only adopts the <modes> (or the <topic>) if there are no modes (or topic) -already set. It there are already values set the server ignores the -corresponding parameter. - -If the channel doesn't exists at all it will be created. - -The parameter <key> must be ignored if a channel has no key (the parameter -<modes> doesn't list the "k" channel mode). In this case <key> should -contain "*" because the parameter <key> is required by the CHANINFO syntax -and therefore can't be omitted. The parameter <limit> must be ignored when -a channel has no user limit (the parameter <modes> doesn't list the "l" -channel mode). In this case <limit> should be "0". - - -II.4 Update webchat/proxy client information - - Command: WEBIRC - Parameters: <password> <username> <hostname> <ip-address> [<ignored>] - Used by: unregistered clients only - -The WEBIRC command is used by some Web-to-IRC gateways to set the correct -user name and host name of users instead of their own. It must be the very -first command sent to the server, even before USER and NICK commands! - -The <password> must be set in the server configuration file to prevent -unauthorized clients to fake their identity; it is an arbitrary string. - -Optionally, a 5th parameter is accepted to comply with an IRCv3 extension, -see <https://github.com/ircv3/ircv3-ideas/issues/12>, but ignored. - - -II.5 Client character encoding conversion - - Command: CHARCONV - Parameters: <client-charset> - Used by: registered clients - Replies: RPL_IP_CHARCONV, ERR_IP_CHARCONV - -A client can set its character set encoding using the CHARCONV command: -after receiving such a command, the server translates all message data -received from the client using the set <client-charset> to the server -encoding (UTF-8), and all message data which is to be sent to the client -from the server encoding (UTF-8) to <client-charset>. - -The list of supported client character sets is implementation dependent. - -If a client sets its <client-charset> to the server encoding (UTF-8), -it disables all conversions; the connection behaves as if no CHARCONV -command has been sent at all in this session. - - -II.6 Update client "metadata" - - Command: METADATA - Parameters: <target> <key> <value> - Used by: servers only - -The METADATA command is used on server-links to update "metadata" information -of clients, like the hostname, the info text ("real name"), or the user name. - -The server updates its client database according to the received <key> and -<value> parameters, and passes the METADATA command on to all the other -servers in the network that support this command (see section II.1 "Register -new server link", <serverflag> "M"), even if it doesn't support the given -<key> itself: unknown <key> names are ignored silently! - -The following <key> names are defined: - - - "accountname": the account name of a client (can't be empty) - - "certfp": the certificate fingerprint of a client (can't be empty) - - "cloakhost": the cloaked hostname of a client - - "host": the hostname of a client (can't be empty) - - "info": info text ("real name") of a client - - "user": the user name of a client (can't be empty) - - -III. Numerics used by IRC+ Protocol -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The IRC+ protocol uses numerics in the range 800-899 which aren't used by -RFC 2812 and hopefully don't clash with other implementations ... - -Numerics 800-849 are used for status and success messages, and numerics -850-899 are failure and error messages. - - -III.1 IRC+ status and success numerics - -801 - RPL_IP_CHARCONV - %1 :Client encoding set" - - %1 client character set - - -III.2 IRC+ failure and error numerics - -851 - ERR_IP_CHARCONV - :Can't initialize client encoding diff --git a/ngircd/doc/QuickStart.md b/ngircd/doc/QuickStart.md deleted file mode 100644 index abea9cd..0000000 --- a/ngircd/doc/QuickStart.md +++ /dev/null @@ -1,126 +0,0 @@ -# [ngIRCd](https://ngircd.barton.de) - Quick Start - -This *Quick Start* document explains how to configure ngIRCd, the lightweight -Internet Relay Chat (IRC) server, using some "real world" scenarios. - -## Introduction - -The ngIRCd daemon can be run without any configuration file using built-in -defaults. These defaults are probably sufficient for very simple single-node -setups, but most probably need further tweaking for more "advanced" setups. - -You can check the current settings by running `ngircd --configtest`. This -command not only shows the settings, it shows error, warning and hints, if it -detects any. - -Therefore it is definitely best practice to *always run this check* after -making any changes to the configuration file(s) and double-check that -everything was parsed as expected! - -### Configuration File and Drop-in Directory - -After installing ngIRCd, a sample configuration file should have been set up if -none existed already. By default, when installing from sources, the file is -named `/usr/local/etc/ngircd.conf` (other common names, especially for -distribution packages, are `/etc/ngircd.conf` or `/etc/ngircd/ngircd.conf`). -Run the command `ngircd --configtest` to check the name of the configuration -file which is used by default on your local system. - -In addition, ngIRCd supports configuration file snippets in a "drop-in" -directory which is configured with the `IncludeDir` variable in the `[Options]` -section and has a built-in default value (like `/etc/ngircd/ngircd.conf.d/`). -All configuration files matching the `*.conf` pattern are read-in from this -directory after the main `ngircd.conf` file. - -It is a good idea to not edit the default `ngircd.conf` file but to create one -ore more new files in this include directory, overriding the defaults as -needed. This way you don't get any clashes when updating ngIRCd to newer -releases. - -You can find the template of the sample configuration file in the `doc/` -directory as `sample-ngircd.conf` and -[online](https://ngircd.barton.de/doc/sample-ngircd.conf) on the homepage. It -contains all available options. - -## Configuration File Syntax - -The configuration consists of sections and parameters. - -A section begins with the name of the section in square brackets (like -`[Example]`) and continues until the next section begins. Sections contain -parameters of the form `name = value`. - -Section and parameter names are not case sensitive. - -Please see the `ngircd.conf`(5) manual page for an in-depth description of the -configuration file, its syntax and all supported configuration options. - -The sample configuration file uses comments beginning with `#` *or* `;` -- this -is only for the better understanding of the file, both comment styles are -equal. The lines commented out with `;` show example or default settings, -whereas the lines using `#` are descriptions of the options. - -## Simple Single-Instance Server - -A good starting point is to configure a valid (and unique!) IRC server name -(which is *not* related to a host name, it is purely a unique *server ID* that -must contain at least one dot "."). - -This looks like this: - -``` ini -[Global] -Name = my.irc.server -``` - -This results in the following *warning* in the logs when starting the daemon: -`No administrative information configured but required by RFC!` -- which works, -but is a bit ugly. So let's fix that by adding some *admin info*: - -``` ini -[Global] -Name = irc.example.net -AdminInfo1 = Example IRC Server -AdminInfo2 = Anywhere On Earth -AdminEMail = admin@irc.example.net -``` - -*Please Note*: The server `Name` looks like a DNS host name, but it is not: in -fact it is not related to your server's fully qualified domain name (FQDN) in -any way and can be an arbitrary string -- but it *must* contain at least -one dot (".") character! - -## Add a Local IRC Operator - -Some IRC commands, like `REHASH` which reloads the server configuration on the -fly, require the user to authenticate to the daemon to become an *IRC -Operator* first. - -So let's configure an *Operator* account in the configuration file (in -addition to what we configured above): - -``` ini -[Operator] -# ID of the operator (may be different of the nickname) -Name = BigOp -# Password of the IRC operator -Password = secret -# Optional Mask from which /OPER will be accepted -;Mask = *!ident@somewhere.example.com -``` - -Now you can use the IRC command `OPER BigOp secret` to get *IRC Operator* -status on that server. - -Please choose a sensible password, and keep in mind that the *name* is not -related to the *nickname* used by the user at all! - -We don't make use of the `Mask` setting in the example above (commented out -with the `;` character), but it is a good idea to enable it whenever possible! - -And you can have as many *Operator blocks* as you like, configuring multiple -different IRC Operators. - -## Configuring SSL/TLS Encryption - -Please see the file `SSL.md` for details. diff --git a/ngircd/doc/README-AUX.txt b/ngircd/doc/README-AUX.txt deleted file mode 100644 index b90c681..0000000 --- a/ngircd/doc/README-AUX.txt +++ /dev/null @@ -1,67 +0,0 @@ - - ngIRCd - Next Generation IRC Server - - (c)2001-2005 Alexander Barton, - alex@barton.de, http://www.barton.de/ - - ngIRCd is free software and published under the - terms of the GNU General Public License. - - - -- README-AUX.txt -- - - -Since version 0.2.2-pre Apple's A/UX belongs to the officially supported -platforms. It is not restricted in any way. - -Since version 0.5.0 ngIRCd's source compiles with the native A/UX c -compiler. GNU C isn't a must-have anymore. - -The following software packages are needed: - - - GNU sed - Source: - http://www.rezepte-im-web.de/appleux/sed-3.02.tar.gz - http://arthur.barton.de/pub/unix/aux/tools/sed-3.02.tar.gz - - A/UX comes with /bin/sed which isn't supporting all functions needed - by GNU automake/autoconf. - - Warning: When installing GNU sed please make sure that A/UX doesn't - use the old one anymore which means set the $PATH or replace /bin/sed - at all. - - - libUTIL.a - Source: - ftp://ftp.mayn.de/pub/really_old_stuff/apple/apple_unix/Sys_stuff/libUTIL-2.1.tar.gz> - http://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() and strdup(). - - -After installation of these packages just do a "./configure" and "make" to -compile ngIRCd on A/UX. - - -A few hints in case of errors: - - - Either there's an 'install' on your system which is completely broken - (so 'configure' uses its own shell script) or use a fully functionable one. - There's at least one binary "out there" causing problems. The one - of the GNU fileutils works fine: - http://arthur.barton.de/pub/unix/aux/tools/fileutils-4.0.tar.gz - - - The precompiled binary of the old 'bash' shouldn't be installed within - /bin (better do this in /usr/local/bin) because 'configure' would - choose it as its shell which wouldn't work. - - - Because of limitations of /bin/sh on A/UX it can't be used to create - 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 shouldn't cause you into problems and is recommended - even if you don't use ngIRCd. - --- -$Id: README-AUX.txt,v 1.10 2006/07/23 12:19:57 alex Exp $ diff --git a/ngircd/doc/README-BeOS.txt b/ngircd/doc/README-BeOS.txt deleted file mode 100644 index 9e8df38..0000000 --- a/ngircd/doc/README-BeOS.txt +++ /dev/null @@ -1,53 +0,0 @@ - - ngIRCd - Next Generation IRC Server - - (c)2001-2003 by Alexander Barton, - alex@barton.de, http://www.barton.de/ - - ngIRCd is free software and published under the - terms of the GNU General Public License. - - -- README-BeOS.txt -- - - - +-------------------------------------------------------------+ - | This text is only available in german at the moment, sorry! | - | Contributors for this text or the BeOS port are welcome :-) | - +-------------------------------------------------------------+ - - -BeOS gehoert im Moment (noch?) nicht zu den offiziell unterstuetzten Plat- -formen: der ngIRCd enthaelt zwar bereits einige Anpassungen an BeOS und -compiliert auch, jedoch bricht er bei jedem Connect-Versuch eines Clients -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 asynchron -gestartet wird, also Pipe-Handles im select() vorhanden sind, fuehrt das zu -obiger Meldung. - -Theoretische "Loesung"/Workaround: -Den Resolver unter BeOS nicht verwenden, sondern mit IP-Adressen arbeiten. -Nachteil: der ngIRCd koennte sich nicht zu Servern verbinden, die dynamische -Adressen benutzen -- dazu muesste er den Namen aufloesen. Ansonsten sollte -es eigentlich zu keinen Beeintraechtigungen kommen ... - -Also: wenn es jemand implementieren will ... ;-)) - -Vielleicht mache ich es auch irgendwann mal selber. Mal sehen. - -2002-05-19: -Ich habe gerade damit ein wenig gespielt und den Source hier so geaendert, -dass unter BeOS keine Resolver-Subprozesse mehr erzeugt werden, sondern mit -den "rohen" IP-Adressen gearbeitet wird. Das funktioniert so weit auch, -allerdings verschluckt sich BeOS nun bei anderen Funktionen, so zum Beispiel -bei close(), wenn ein Socket eines Clients geschlossen werden soll!? -Sehr komisch. -Wer Interesse daran hat, das weiter zu verfolgen, der moege sich bitte mit -mir in Verbindung setzen (alex@barton.de), ich maile gerne meine Patches zu. -Fuer eine Aenderung im CVS ist es aber meiner Meinung nach noch zu frueh ... - --- -$Id: README-BeOS.txt,v 1.7 2003/05/15 21:47:57 alex Exp $ diff --git a/ngircd/doc/README-Interix.txt b/ngircd/doc/README-Interix.txt deleted file mode 100644 index f24f38d..0000000 --- a/ngircd/doc/README-Interix.txt +++ /dev/null @@ -1,44 +0,0 @@ - - ngIRCd - Next Generation IRC Server - http://ngircd.barton.de/ - - (c)2001-2012 Alexander Barton and Contributors. - ngIRCd is free software and published under the - terms of the GNU General Public License. - - -- README-Interix.txt -- - - -ngIRCd release 15 has successfully been tested on Microsoft Windows XP -Professional using the Services for UNIX (SFU) version 3.5 and Microsoft -Windows 7 with the bundled Subsystem for UNIX Applications (SUA). - -SFU are supported on Windows 2000, Windows 2000 Server, Windows XP, and -Windows Server 2003. SUA is supported on Windows Server 2003 R2, Windows -Server 2008 & 2008 R2, Windows Vista, and Windows 7 -- so ngIRCd should be -able to run on all of these platforms. - -But please note that two things: - -1. Don't use the poll() IO API - -The poll() API function is not fully implemented by SFU/SUA and therefore -can't be used by ngIRCd -- which normally would be the default. Please see -<http://www.suacommunity.com/faqs.aspx> section 4.25 for details: - - "If you do try to use the poll() API your program will block on the - API call forever. You must direct your program to build using the - select() API." - -So when running the ./configure script, you HAVE TO DISABLE poll() support: - - ./configure --without-poll - -ngIRCd then defaults to using the select() API function which works fine. - -2. Use GNU make(1) - -Starting with ngIRCd 18, our build system doesn't work with the default -make(1) binary of Interix, you should use GNU make instead (tested with -version 3.82 built from source). - diff --git a/ngircd/doc/RFC.txt b/ngircd/doc/RFC.txt deleted file mode 100644 index 1524852..0000000 --- a/ngircd/doc/RFC.txt +++ /dev/null @@ -1,32 +0,0 @@ - - ngIRCd - Next Generation IRC Server - http://ngircd.barton.de/ - - (c)2001-2017 Alexander Barton and Contributors. - ngIRCd is free software and published under the - terms of the GNU General Public License. - - -- RFC.txt -- - - -The Internet Relay Chat (IRC) protocol is documented in these Request for -Comments (RFCs), which you can get via <http://www.faqs.org/rfcs/> or -<https://www.ietf.org/rfc.html> for example. - - 1459 Oikarinen, J. & D. Reed, "Internet Relay Chat Protocol", - May 1993, [IRC]. - - 2810 Kalt, C., "Internet Relay Chat: Architecture", - April 2000, [IRC-ARCH]. - - 2811 Kalt, C., "Internet Relay Chat: Channel Management", - April 2000, [IRC-CHAN]. - - 2812 Kalt, C., "Internet Relay Chat: Client Protocol", - April 2000, [IRC-CLIENT]. - - 2813 Kalt, C., "Internet Relay Chat: Server Protocol", - April 2000, [IRC-SERVER]. - - 7194 Hartmann, R., "Default Port for Internet Relay Chat (IRC) via TLS/SSL", - August 2014. diff --git a/ngircd/doc/SSL.md b/ngircd/doc/SSL.md deleted file mode 100644 index c457e60..0000000 --- a/ngircd/doc/SSL.md +++ /dev/null @@ -1,81 +0,0 @@ -# [ngIRCd](https://ngircd.barton.de) - SSL/TLS Encrypted Connections - -ngIRCd supports SSL/TLS encrypted connections using the *OpenSSL* or *GnuTLS* -libraries. Both encrypted server-server links as well as client-server links -are supported. - -SSL is a compile-time option which is disabled by default. Use one of these -options of the ./configure script to enable it: - -- `--with-openssl`: enable SSL support using OpenSSL. -- `--with-gnutls`: enable SSL support using GnuTLS. - -You can check the output of `ngircd --version` to validate if your executable -includes support for SSL or not: "+SSL" must be listed in the feature flags. - -You also need a SSL key and certificate, for example using Let's Encrypt, which -is out of the scope of this document. - -From a feature point of view, ngIRCds support for both libraries is -comparable. The only major difference (at this time) is that ngIRCd with GnuTLS -does not support password protected private keys. - -## Configuration - -SSL-encrypted connections and plain-text connects can't run on the same network -port (which is a limitation of the IRC protocol); therefore you have to define -separate port(s) in your `[SSL]` block in the configuration file. - -A minimal configuration for *accepting* SSL-encrypted client -connections looks like this: - -``` ini -[SSL] -CertFile = /etc/ssl/certs/my-fullchain.pem -KeyFile = /etc/ssl/certs/my-privkey.pem -Ports = 6697, 6698 -``` - -In this case, the server only deals with unauthenticated incoming -connections and never has to validate SSL certificates itself, and therefore -no "Certificate Authorities" are needed. - -If you want to use *outgoing* SSL-connections to other servers or accept -incoming *server* connections, you need to add: - -``` ini -[SSL] -... -CAFile = /etc/ssl/certs/ca-certificates.crt -DHFile = /etc/ngircd/dhparams.pem - -[SERVER] -... -SSLConnect = yes -``` - -The `CAFile` option configures a file listing all the certificates of the -trusted Certificate Authorities. - -The Diffie-Hellman parameters file `dhparams.pem` can be created like this: - -- OpenSSL: `openssl dhparam -2 -out /etc/ngircd/dhparams.pem 4096` -- GnuTLS: `certtool --generate-dh-params --bits 4096 --outfile /etc/ngircd/dhparams.pem` - -Note that enabling `SSLConnect` not only enforces SSL-encrypted links for -*outgoing* connections to other servers, but for *incoming* connections as well: -If a server configured with `SSLConnect = yes` tries to connect on a plain-text -connection, it won't be accepted to prevent data leakage! Therefore you should -set this for *all* servers you expect to use SSL-encrypted connections! - -## Accepting untrusted Remote Certificates - -If you are using self-signed certificates or otherwise invalid certificates, -which ngIRCd would reject by default, you can force ngIRCd to skip certificate -validation on a per-server basis and continue establishing outgoing connections -to the respective peer by setting `SSLVerify = no` in the `[SERVER]` block of -this remote server in your configuration. - -But please think twice before doing so: the established connection is still -encrypted but the remote site is *not verified at all* and man-in-the-middle -attacks are possible! diff --git a/ngircd/doc/Services.txt b/ngircd/doc/Services.txt deleted file mode 100644 index f945bbf..0000000 --- a/ngircd/doc/Services.txt +++ /dev/null @@ -1,152 +0,0 @@ - - ngIRCd - Next Generation IRC Server - http://ngircd.barton.de/ - - (c)2001-2011 Alexander Barton and Contributors. - ngIRCd is free software and published under the - terms of the GNU General Public License. - - -- Services.txt -- - - -ngIRCd doesn't implement a "special IRC services interface", but services -acting as a "regular servers" ("pseudo servers") are supported, either -using the IRC protocol as defined in RFC 1459 or RFC 2812. - -Support for Services has been tested using - - Anope 1.9.8 or later (<http://www.anope.org/>) - - Atheme 7.0.2 or later (<https://atheme.org/>) - - "IRC Services" 5.1.x by Andrew Church (<http://achurch.org/services/>) - -This document describes setting up ngIRCd and these services. - -Please let us know if you are successfully using other IRC service packages or -which problems you encounter -- thanks! - - -Setting up ngIRCd -~~~~~~~~~~~~~~~~~ - -The "pseudo server" handling the IRC services is configured as a regular -remote server in the ngircd.conf(5). In addition the variable "ServiceMask" -should be set, enabling this ngIRCd to recognize the "pseudo users" as IRC -services instead of regular IRC users. - -Example: - - [GLOBAL] - Name = server.irc.net - Ports = 6667 - - [SERVER] - Name = services.irc.net - MyPassword = 123abc - PeerPassword = 123abc - ServiceMask = *Serv - - -Setting up Anope 1.9.x & 2.x -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Anope 1.9.8 or later (<http://www.anope.org/>) can be used with ngIRCd using -the "ngircd" protocol module. - -At least the following settings have to be tweaked, in addition to all the -settings marked as required by Anope: - -In conf/services.conf: - - define - { - name = "services.host" - value = "services.irc.net" - } - - uplink - { - host = "server.irc.net" - port = 6667 - password = "123abc" - } - - # Load ngIRCd protocol module - module - { - name = "ngircd" - } - - networkinfo - { - # Must be set to the "MaxNickLength" setting of ngIRCd! - nicklen = 9 - - # When not using "strict mode", which is the default: - userlen = 20 - - chanlen = 50 - } - -In conf/nickserv.conf: - - module - { - name = "nickserv" - - # not required if you are running ngIRCd with a higher nickname limit - # ("MaxNickLength") than 11 characters, but REQUIRED by default! - guestnickprefix = "G-" - } - - -Setting up Atheme 7.0.2 or later -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Atheme 7.0.2 or later (<https://atheme.org/>) may be used with ngIRCd using -the "ngircd" protocol module. - -The following settings need to be in atheme.conf: - - loadmodule "modules/protocol/ngircd"; - - serverinfo { - name = "services.irc.net"; - } - - uplink "server.irc.net" { - password = "123abc"; - port = 6667; - }; - -The documentation of Atheme can be found in the doc/ directory of the -Atheme source distribution. - - -Setting up IRC Services 5.1.x -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -IRC Services 5.1.3 and above can be used with ngIRCd using the "rfc1459" -protocol module. - -Please note that versions up to and including 5.1.3 contain a bug that -sometimes causes IRC Services to hang on startup. There are two workarounds: - a) send the services process a HUP signal ("killall -HUP ircservices") - b) apply this patch to the IRC Services source tree: - <http://arthur.barton.de/pub/ngircd/contrib/IRCServices513-FlushBuffer.patch> - -At least the following settings have to be tweaked, in addition to all the -settings marked as required by IRC Services: - -In ircservices.conf: - - Variable Example value - - RemoteServer server.irc.net 6667 "123abc" - ServerName "services.irc.net" - LoadModule protocol/rfc1459 - -In modules.conf: - - Module protocol/rfc1459 - -The documentation of IRC Services can be found here: -<http://www.ircservices.za.net/docs/> diff --git a/ngircd/doc/sample-ngircd.conf.tmpl b/ngircd/doc/sample-ngircd.conf.tmpl deleted file mode 100644 index f02c535..0000000 --- a/ngircd/doc/sample-ngircd.conf.tmpl +++ /dev/null @@ -1,426 +0,0 @@ -# -# This is a sample configuration file for the ngIRCd IRC daemon, which must -# be customized to the local preferences and needs. -# -# Comments are started with "#" or ";". -# -# A lot of configuration options in this file start with a ";". You have -# to remove the ";" in front of each variable to actually set a value! -# The disabled variables are shown with example values for completeness only -# and the daemon is using compiled-in default settings. -# -# Use "ngircd --configtest" (see manual page ngircd(8)) to validate that the -# server interprets the configuration file as expected! -# -# Please see ngircd.conf(5) for a complete list of configuration options -# and their descriptions. -# - -[Global] - # The [Global] section of this file is used to define the main - # configuration of the server, like the server name and the ports - # on which the server should be listening. - # These settings depend on your personal preferences, so you should - # make sure that they correspond to your installation and setup! - - # Server name in the IRC network, must contain at least one dot - # (".") and be unique in the IRC network. When not set, ngIRCd tries - # to deduce a valid IRC server name from the local host name. - ;Name = irc.example.net - - # Information about the server and the administrator, used by the - # ADMIN command. Not required by server but by RFC! - ;AdminInfo1 = Description - ;AdminInfo2 = Location - ;AdminEMail = admin@irc.server - - # Text file which contains the ngIRCd help text. This file is required - # to display help texts when using the "HELP <cmd>" command. Default: a - # built-in standard path (check "ngircd --configtest"). - ;HelpFile = :DOCDIR:/Commands.txt - - # Info text of the server. This will be shown by WHOIS and - # LINKS requests for example. Set to the server software name and - # version by default. - ;Info = Server Info Text - - # 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. - ;Listen = 127.0.0.1,192.168.0.1 - - # Text file with the "message of the day" (MOTD). This message will - # be shown to all users connecting to the server: Default: a built-in - # standard path (check "ngircd --configtest"). - ;MotdFile = :ETCDIR:/ngircd.motd - - # A simple Phrase (<127 chars) if you don't want to use a motd file. - ;MotdPhrase = "Hello world!" - - # The name of the IRC network to which this server belongs. This name - # is optional, should only contain ASCII characters, and can't contain - # spaces. It is only used to inform clients. The default is empty, - # so no network name is announced to clients. - ;Network = aIRCnetwork - - # Global password for all users needed to connect to the server. - # (Default: not set) - ;Password = abc - - # This tells ngIRCd to write its current process ID to a file. - # Note that the pidfile is written AFTER chroot and switching the - # user ID, e.g. the directory the pidfile resides in must be - # writable by the ngIRCd user and exist in the chroot directory. - ;PidFile = /var/run/ngircd/ngircd.pid - - # Ports on which the server should listen. There may be more than - # one port, separated with ",". (Default: 6667) - ;Ports = 6667, 6668, 6669 - - # Group ID under which the ngIRCd should run; you can use the name - # of the group or the numerical ID. ATTENTION: For this to work the - # server must have been started with root privileges! - ;ServerGID = 65534 - - # User ID under which the server should run; you can use the name - # of the user or the numerical ID. ATTENTION: For this to work the - # server must have been started with root privileges! In addition, - # the configuration and MOTD files must be readable by this user, - # otherwise RESTART and REHASH won't work! - ;ServerUID = 65534 - -[Limits] - # Define some limits and timeouts for this ngIRCd instance. Default - # values should be safe, but it is wise to double-check :-) - - # The server tries every <ConnectRetry> seconds to establish a link - # to not yet (or no longer) connected servers. - ;ConnectRetry = 60 - - # Number of seconds after which the whole daemon should shutdown when - # no connections are left active after handling at least one client - # (0: never, which is the default). - # This can be useful for testing or when ngIRCd is started using - # "socket activation" with systemd(8), for example. - ;IdleTimeout = 0 - - # Maximum number of simultaneous in- and outbound connections the - # server is allowed to accept (0: unlimited): - ;MaxConnections = 0 - - # Maximum number of simultaneous connections from a single IP address - # the server will accept (0: unlimited): - ;MaxConnectionsIP = 5 - - # Maximum number of channels a user can be member of (0: no limit): - ;MaxJoins = 10 - - # Maximum length of an user nickname (Default: 9, as in RFC 2812). - # Please note that all servers in an IRC network MUST use the same - # maximum nickname length! - ;MaxNickLength = 9 - - # Maximum penalty time increase in seconds, per penalty event. Set to -1 - # for no limit (the default), 0 to disable penalties altogether. The - # daemon doesn't use penalty increases higher than 2 seconds during - # normal operation, so values greater than 1 rarely make sense. - ;MaxPenaltyTime = -1 - - # Maximum number of channels returned in response to a /list - # command (0: unlimited): - ;MaxListSize = 100 - - # After <PingTimeout> seconds of inactivity the server will send a - # PING to the peer to test whether it is alive or not. - ;PingTimeout = 120 - - # If a client fails to answer a PING with a PONG within <PongTimeout> - # seconds, it will be disconnected by the server. - ;PongTimeout = 20 - -[Options] - # Optional features and configuration options to further tweak the - # behavior of ngIRCd. If you want to get started quickly, you most - # probably don't have to make changes here -- they are all optional. - - # List of allowed channel types (channel prefixes) for newly created - # channels on the local server. By default, all supported channel - # types are allowed. Set this variable to the empty string to disallow - # creation of new channels by local clients at all. - ;AllowedChannelTypes = #&+ - - # Are remote IRC operators allowed to control this server, e.g. - # use commands like CONNECT, SQUIT, DIE, ...? - ;AllowRemoteOper = no - - # A directory to chroot in when everything is initialized. It - # doesn't need to be populated if ngIRCd is compiled as a static - # binary. By default ngIRCd won't use the chroot() feature. - # ATTENTION: For this to work the server must have been started - # with root privileges! - ;ChrootDir = /var/empty - - # Set this hostname for every client instead of the real one. - # Use %x to add the hashed value of the original hostname. - ;CloakHost = cloaked.host - - # Use this hostname for hostname cloaking on clients that have the - # user mode "+x" set, instead of the name of the server. - # Use %x to add the hashed value of the original hostname. - # If this variable is empty, regular users cannot set mode "+x" themselves. - ;CloakHostModeX = cloaked.user - - # The Salt for cloaked hostname hashing. When undefined a random - # hash is generated after each server start. - ;CloakHostSalt = abcdefghijklmnopqrstuvwxyz - - # Set every clients' user name to their nickname - ;CloakUserToNick = yes - - # Try to connect to other IRC servers using IPv4 and IPv6, if possible. - ;ConnectIPv6 = yes - ;ConnectIPv4 = yes - - # Default user mode(s) to set on new local clients. Please note that - # only modes can be set that the client could set using regular MODE - # commands, you can't set "a" (away) for example! Default: none. - ;DefaultUserModes = i - - # Do DNS lookups when a client connects to the server. - ;DNS = yes - - # Do IDENT lookups if ngIRCd has been compiled with support for it. - # Users identified using IDENT are registered without the "~" character - # prepended to their user name. - ;Ident = yes - - # Directory containing configuration snippets (*.conf), that should - # be read in after parsing this configuration file. - # Default: a built-in directory name when no configuration file was - # explicitly given on the command line (check "ngircd --configtest"), - # none (empty) otherwise. - ;IncludeDir = :ETCDIR:/conf.d - - # Enhance user privacy slightly (useful for IRC server on TOR or I2P) - # by censoring some information like idle time, logon time, etc. - ;MorePrivacy = no - - # Normally ngIRCd doesn't send any messages to a client until it is - # registered. Enable this option to let the daemon send "NOTICE *" - # messages to clients while connecting. - ;NoticeBeforeRegistration = no - - # Should IRC Operators be allowed to use the MODE command even if - # they are not(!) channel-operators? - ;OperCanUseMode = no - - # Should IRC Operators get AutoOp (+o) in persistent (+P) channels? - ;OperChanPAutoOp = yes - - # Mask IRC Operator mode requests as if they were coming from the - # server? (This is a compatibility hack for ircd-irc2 servers) - ;OperServerMode = no - - # Use PAM if ngIRCd has been compiled with support for it. - # Users identified using PAM are registered without the "~" character - # prepended to their user name. - ;PAM = yes - - # When PAM is enabled, all clients are required to be authenticated - # using PAM; connecting to the server without successful PAM - # authentication isn't possible. - # If this option is set, clients not sending a password are still - # allowed to connect: they won't become "identified" and keep the "~" - # character prepended to their supplied user name. - # Please note: To make some use of this behavior, it most probably - # isn't useful to enable "Ident", "PAM" and "PAMIsOptional" at the - # same time, because you wouldn't be able to distinguish between - # Ident'ified and PAM-authenticated users: both don't have a "~" - # character prepended to their respective user names! - ;PAMIsOptional = no - - # When PAM is enabled, this value determines the used PAM - # configuration. - # This setting allows to run multiple ngIRCd instances with - # different PAM configurations on each instance. - # If you set it to "ngircd-foo", PAM will use - # /etc/pam.d/ngircd-foo instead of the default - # /etc/pam.d/ngircd. - ;PAMServiceName = ngircd - - # Let ngIRCd send an "authentication PING" when a new client connects, - # and register this client only after receiving the corresponding - # "PONG" reply. - ;RequireAuthPing = no - - # Silently drop all incoming CTCP requests. - ;ScrubCTCP = no - - # Syslog "facility" to which ngIRCd should send log messages. - # Possible values are system dependent, but most probably auth, daemon, - # user and local1 through local7 are possible values; see syslog(3). - # Default is "local5" for historical reasons, you probably want to - # change this to "daemon", for example. - ;SyslogFacility = local1 - - # Password required for using the WEBIRC command used by some - # Web-to-IRC gateways. If not set/empty, the WEBIRC command can't - # be used. (Default: not set) - ;WebircPassword = xyz - -;[SSL] - # SSL-related configuration options. Please note that this section - # is only available when ngIRCd is compiled with support for SSL! - # So don't forget to remove the ";" above if this is the case ... - - # SSL Trusted CA Certificates File for verifying peer certificates. - # (Default: not set; so no certificates are trusted) - ;CAFile = /etc/ssl/CA/cacert.pem - - # Certificate Revocation File (for marking otherwise valid - # certficates as invalid) - ;CRLFile = /etc/ssl/CA/crl.pem - - # SSL Server Key Certificate - ;CertFile = :ETCDIR:/ssl/server-cert.pem - - # Select cipher suites allowed for SSL/TLS connections. This defaults - # to HIGH:!aNULL:@STRENGTH (OpenSSL) or SECURE128 (GnuTLS). - # See 'man 1ssl ciphers' (OpenSSL) or 'man 3 gnutls_priority_init' - # (GnuTLS) for details. - # For OpenSSL: - ;CipherList = HIGH:!aNULL:@STRENGTH:!SSLv3 - # For GnuTLS: - ;CipherList = SECURE128:-VERS-SSL3.0 - - # Diffie-Hellman parameters - ;DHFile = :ETCDIR:/ssl/dhparams.pem - - # SSL Server Key - ;KeyFile = :ETCDIR:/ssl/server-key.pem - - # password to decrypt SSLKeyFile (OpenSSL only) - ;KeyFilePassword = secret - - # Additional Listen Ports that expect SSL/TLS encrypted connections - ;Ports = 6697, 9999 - -[Operator] - # [Operator] sections are used to define IRC Operators. There may be - # more than one [Operator] block, one for each local operator. - - # ID of the operator (may be different of the nickname) - ;Name = TheOper - - # Password of the IRC operator - ;Password = ThePwd - - # Optional Mask from which /OPER will be accepted - ;Mask = *!ident@somewhere.example.com - -[Operator] - # More [Operator] sections, if you like ... - -[Server] - # Other servers are configured in [Server] sections. If you - # configure a port for the connection, then this ngircd tries to - # connect to the other server on the given port; if not it waits - # for the other server to connect. - # There may be more than one server block, one for each server. - # - # Server Groups: - # The ngIRCd allows "server groups": You can assign an "ID" to every - # server with which you want this ngIRCd to link. If a server of a - # group won't answer, the ngIRCd tries to connect to the next server - # in the given group. But the ngircd never tries to connect to two - # servers with the same group ID. - - # IRC name of the remote server, must match the "Name" variable in - # the [Global] section of the other server (when using ngIRCd). - ;Name = irc2.example.net - - # Internet host name or IP address of the peer (only required when - # this server should establish the connection). - ;Host = connect-to-host.example.net - - # IP address to use as _source_ address for the connection. if - # unspecified, ngircd will let the operating system pick an address. - ;Bind = 10.0.0.1 - - # Port of the server to which the ngIRCd should connect. If you - # assign no port the ngIRCd waits for incoming connections. - ;Port = 6667 - - # Own password for the connection. This password has to be configured - # as "PeerPassword" on the other server. - ;MyPassword = MySecret - - # Foreign password for this connection. This password has to be - # configured as "MyPassword" on the other server. - ;PeerPassword = PeerSecret - - # Group of this server (optional) - ;Group = 123 - - # Set the "Passive" option to "yes" if you don't want this ngIRCd to - # connect to the configured peer (same as leaving the "Port" variable - # empty). The advantage of this option is that you can actually - # configure a port an use the IRC command CONNECT more easily to - # manually connect this specific server later. - ;Passive = no - - # Connect to the remote server using TLS/SSL (Default: false) - ;SSLConnect = yes - - # Verify the TLS certificate presented by the remote server - # (Default: yes) - ;SSLVerify = yes - - # Define a (case insensitive) list of masks matching nicknames that - # should be treated as IRC services when introduced via this remote - # server, separated by commas (","). - # 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" and "ChanServ", you should set this parameter to - # something like "*Serv" or "NickServ,ChanServ,XyzServ". - ;ServiceMask = *Serv,Global - -[Server] - # More [Server] sections, if you like ... - -[Channel] - # Pre-defined channels can be configured in [Channel] sections. - # Such channels are created by the server when starting up and even - # persist when there are no more members left. - # Persistent channels are marked with the mode 'P', which can be set - # and unset by IRC operators like other modes on the fly. - # There may be more than one [Channel] block, one for each channel. - - # Name of the channel - ;Name = #TheName - - # Topic for this channel - ;Topic = a great topic - - # Initial channel modes, as used in "MODE" commands. Modifying lists - # (ban list, invite list, exception list) is supported. - # This option can be specified multiple times, evaluated top to bottom. - ;Modes = +tnk mykey +l 5 - ;Modes = +b nick!~user@bad.host.example.com - - # Should ngIRCd automatically join ("autojoin") all users to this - # channel on connect? Note: The users must have permissions to access - # the channel, otherwise joining them will fail! - ;Autojoin = yes - - # Key file, syntax for each line: "<user>:<nick>:<key>". - # Default: none. - ;KeyFile = :ETCDIR:/#chan.key - -[Channel] - # More [Channel] sections, if you like ... - -# -eof- diff --git a/ngircd/doc/src/Doxyfile b/ngircd/doc/src/Doxyfile deleted file mode 100644 index 6d9ccb5..0000000 --- a/ngircd/doc/src/Doxyfile +++ /dev/null @@ -1,93 +0,0 @@ -# -# ngIRCd -- The Next Generation IRC Daemon -# Copyright (c)2001-2010 Alexander Barton (alex@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 -# the Free Software Foundation; either version 2 of the License, or -# (at your option) any later version. -# Please read the file COPYING, README and AUTHORS for more information. -# -# This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for ngIRCd. -# - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- - -DOXYFILE_ENCODING = UTF-8 - -PROJECT_NAME = ngIRCd -PROJECT_BRIEF = "Lightweight Internet Relay Chat server" -PROJECT_LOGO = "../../contrib/ngIRCd-Logo.gif" - -OUTPUT_DIRECTORY = . -STRIP_FROM_PATH = ../.. - -JAVADOC_AUTOBRIEF = YES -OPTIMIZE_OUTPUT_FOR_C = YES -TYPEDEF_HIDES_STRUCT = YES - -TAB_SIZE = 8 - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- - -EXTRACT_ALL = YES -EXTRACT_STATIC = YES - -SHOW_DIRECTORIES = YES - -#--------------------------------------------------------------------------- -# configuration options related to warning and progress messages -#--------------------------------------------------------------------------- - -QUIET = NO -WARNINGS = YES -WARN_IF_UNDOCUMENTED = YES -WARN_IF_DOC_ERROR = YES -WARN_NO_PARAMDOC = YES - -#--------------------------------------------------------------------------- -# configuration options related to the input files -#--------------------------------------------------------------------------- - -INPUT = ../../src -INPUT_ENCODING = UTF-8 -RECURSIVE = YES - -#--------------------------------------------------------------------------- -# configuration options related to source browsing -#--------------------------------------------------------------------------- - -SOURCE_BROWSER = YES -STRIP_CODE_COMMENTS = NO -REFERENCED_BY_RELATION = YES -REFERENCES_RELATION = YES - -#--------------------------------------------------------------------------- -# Output formats -#--------------------------------------------------------------------------- - -GENERATE_HTML = YES -HTML_FOOTER = footer.inc.html -HTML_DYNAMIC_SECTIONS = YES - -GENERATE_DOCSET = NO -GENERATE_HTMLHELP = NO -GENERATE_LATEX = NO -GENERATE_RTF = NO -GENERATE_MAN = NO -GENERATE_XML = NO -GENERATE_AUTOGEN_DEF = NO -GENERATE_PERLMOD = NO - -#--------------------------------------------------------------------------- -# Configuration options related to the preprocessor -#--------------------------------------------------------------------------- - -PREDEFINED = DEBUG ZLIB PAM ZEROCONF CONN_MODULE __client_c__ - -# -eof- diff --git a/ngircd/doc/src/Makefile.am b/ngircd/doc/src/Makefile.am deleted file mode 100644 index 0d27b7e..0000000 --- a/ngircd/doc/src/Makefile.am +++ /dev/null @@ -1,25 +0,0 @@ -# -# ngIRCd -- The Next Generation IRC Daemon -# Copyright (c)2001-2011 Alexander Barton (alex@barton.de) and Contributors. -# -# 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 -# the Free Software Foundation; either version 2 of the License, or -# (at your option) any later version. -# Please read the file COPYING, README and AUTHORS for more information. -# - -EXTRA_DIST = Doxyfile footer.inc.html - -maintainer-clean-local: - rm -f Makefile Makefile.in - -distclean-local: - rm -rf html - -srcdoc: - @doxygen --version >/dev/null 2>&1 \ - || ( echo; echo "Error: \"doxygen\" not found!"; echo; exit 1 ) - doxygen - -# -eof- diff --git a/ngircd/doc/src/footer.inc.html b/ngircd/doc/src/footer.inc.html deleted file mode 100644 index 6189afb..0000000 --- a/ngircd/doc/src/footer.inc.html +++ /dev/null @@ -1,12 +0,0 @@ - -<hr class="footer"> -<p style="text-align: center"> - ngIRCd - <a href="https://ngircd.barton.de/">Homepage</a>. - GitHub: - <a href="https://github.com/ngircd/ngircd">Code Repository</a>, - <a href="https://github.com/ngircd/ngircd/issues">Bug-Tracker</a>. -</p> - -</body> -</html> |