Update the "rpm" make target to use rpmbuild(8)

[ngircd-alex.git] / INSTALL.md

diff --git a/INSTALL.md b/INSTALL.md
index 5d521b55cdee07a1439c977eb335374b8b3279fe..ac9eff407bf86070b7b4c0a44223bef7e82459f4 100644 (file)
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -1,14 +1,20 @@
 # [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, 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
 when you do a fresh installation.
 
-All the subsequent sections describe the steps required to install and
-configure ngIRCd.
+All the subsequent sections describe the steps required to build and install
+ngIRCd from sources. The information given here is not relevant when you are
+using packages provided by your operating system vendor or third-party
+repositories.
+
+Please see the file `doc/QuickStart.md` in the `doc/` directory and
+[online](https://ngircd.barton.de/doc/QuickStart.md) on the homepage for
+information about configuring ngIRCd, including some configuration examples.
 
 ## Upgrade Information
 
@@ -198,6 +204,18 @@ build the sources including all optional features and to run the test suite:
     telnet zlib-devel
 ```
 
+*Note:* More recent versions use the DNF package manager; so substitute "yum"
+with "dnf" in the command above. And neither "libident-devel" (IDENT support)
+nor "tcp_wrappers-devel" (TCP Wrappers) are provided any more!
+
+So the resulting command looks like this:
+
+``` shell
+  dnf install \
+    autoconf automake expect gcc glibc-devel gnutls-devel \
+    make pam-devel pkg-config telnet zlib-devel
+```
+
 #### Debian / Ubuntu based distributions
 
 ``` shell
@@ -206,6 +224,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`
@@ -341,42 +367,23 @@ 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
 
-Please have a look at the `ngircd(8)` and `ngircd.conf(5)` manual pages for
+Please see the file `doc/QuickStart.md` in the `doc/` directory and
+[online](https://ngircd.barton.de/doc/QuickStart.md) on the homepage for
+information about configuring ngIRCd, including some configuration examples.
+
+And 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!**
 
-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
-distribution packages, are `/etc/ngircd.conf` or `/etc/ngircd/ngircd.conf`).
-
-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.
-
-In the sample configuration file, there are comments beginning with `#` *or*
-`;` -- this is only for the better understanding of the file, both comment
-styles are equal.
-
-The file is separated in five blocks: *[Global]*, *[Features]*, *[Operator]*,
-*[Server]*, and *[Channel]*.
-
-In the *[Global]* section, there is the main configuration like the server
-name and the ports, on which the server should be listening. Options in
-the *[Features]* section enable or disable functionality in the daemon.
-IRC operators of this server are defined in *[Operator]* blocks, remote
-servers are configured in *[Server]* sections, and *[Channel]* blocks are
-used to configure pre-defined ("persistent") IRC channels.
-
 ### Manual Pages Online
 
 - Daemon: [ngircd.8](https://manpages.debian.org/ngircd.8)