autogen.sh: Prefere automake 1.11 over other releases

[ngircd-alex.git] / INSTALL.md

diff --git a/INSTALL.md b/INSTALL.md
index 788c2349bee817cb212f7617c3af7558b1613264..28b1da337bbe5f13e2e5c008a0b7a65dfbf83b9f 100644 (file)
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -1,7 +1,7 @@
 # [ngIRCd](https://ngircd.barton.de) - Internet Relay Chat Server
 
-This document explains how to install ngIRCd, the lightweight Internet Relay
-Chat (IRC) server.
+This document explains how to install and configure ngIRCd, the lightweight
+Internet Relay Chat (IRC) server.
 
 The first section lists noteworthy changes to earlier releases; you definitely
 should read this when upgrading your setup! But you can skip over this section
@@ -10,8 +10,30 @@ when you do a fresh installation.
 All the subsequent sections describe the steps required to install and
 configure ngIRCd.
 
+Please see the file `doc/QuickStart.md` in the `doc/` directory and
+[online](https://ngircd.barton.de/doc/QuickStart.md) on the homepage for some
+configuration examples.
+
 ## Upgrade Information
 
+Differences to version 25
+
+- **Attention**:
+  All already deprecated legacy options (besides the newly deprecated *Key* and
+  *MaxUsers* settings, see below) were removed in ngIRCd 26, so make sure to
+  update your configuration before upgrading, if you haven't done so already
+  (you got a warning on daemon startup when using deprecated options): you can
+  check your configuration using `ngircd --configtest` -- which is a good idea
+  anyway ;-)
+
+- Setting modes for predefined channels in *[Channel]* sections has been
+  enhanced: now you can set *all* modes, like in IRC "MODE" commands, and have
+  this setting multiple times per *[Channel]* block. Modifying lists (ban list,
+  invite list, exception list) is supported, too.
+
+  Both the *Key* and *MaxUsers* settings are now deprecated and should be
+  replaced by `Modes = +l <limit>` and `Modes = +k <key>` respectively.
+
 Differences to version 22.x
 
 - The *NoticeAuth* `ngircd.conf` configuration variable has been renamed to
@@ -188,6 +210,14 @@ build the sources including all optional features and to run the test suite:
     libident-dev libpam-dev pkg-config libwrap0-dev libz-dev telnet
 ```
 
+#### ArchLinux based distributions
+
+``` shell
+  pacman -S --needed \
+    autoconf automake expect gcc gnutls inetutils libident libwrap \
+    make pam pkg-config zlib
+```
+
 ### `./autogen.sh`
 
 The first step, to run `./autogen.sh`, is *only* necessary if the `configure`
@@ -323,11 +353,12 @@ standard locations.
   Enable support for SSL/TLS using OpenSSL or GnuTLS libraries.
   See `doc/SSL.txt` for details.
 
-- IPv6:
+- IPv6 (autodetected by default):
 
-  `--enable-ipv6`
+  `--enable-ipv6` / `--disable-ipv6`
 
-  Adds support for version 6 of the Internet Protocol.
+  Enable (disable) support for version 6 of the Internet Protocol, which should
+  be available on most modern UNIX-like operating systems by default.
 
 ## Configuration
 
@@ -335,6 +366,10 @@ Please have a look at the `ngircd(8)` and `ngircd.conf(5)` manual pages for
 details and all possible command line and configuration options -- **and don't
 forget to run `ngircd --configtest` to validate your configuration file!**
 
+The file `doc/QuickStart.md` in the `doc/` directory and
+[online](https://ngircd.barton.de/doc/QuickStart.md) on the homepage has some
+configuration examples, you should take a look :-)
+
 After installing ngIRCd, a sample configuration file will be set up (if it
 does not exist already). By default, when installing from sources, the file is
 named `/usr/local/etc/ngircd.conf` (other common names, especially for