]> arthur.barton.de Git - ngircd.git/blob - contrib/README.md
4f04dce6e0931cb126cfea1d3d0d36812e075aa6
[ngircd.git] / contrib / README.md
1 # [ngIRCd](https://ngircd.barton.de) - Supplemental Files
2
3 This `contrib/` directory contains the following sub-folders and files:
4
5 - `Debian/` folder: This subfolder contains the _rules_ file and additional
6   assets for building Debian packages.
7
8 - `de.barton.ngircd.metainfo.xml`: AppStream metadata file.
9
10 - `de.barton.ngircd.plist[.tmpl]`: launchd(8) property list file.
11
12 - `ngindent.sh`: Script to indent the code of ngIRCd in the "standard way".
13
14 - `ngircd-bsd.sh`: Start/stop script for FreeBSD.
15
16 - `ngircd-redhat.init`: Start/stop script for old(er) RedHat-based
17   distributions (like CentOS and Fedora), which did _not_ use systemd(8).
18
19 - `ngIRCd-Logo.gif`: The ngIRCd logo as GIF file.
20
21 - `ngircd.logcheck`: Sample rules for logcheck(8) to ignore "normal" log
22   messages of ngIRCd.
23
24 - `ngircd.service`: systemd(8) service unit configuration file.
25
26 - `ngircd.socket`: systemd(8) socket unit configuration file for "socket
27   activation".
28
29 - `ngircd.spec`: RPM "spec" file.
30
31 - `nglog.sh`: Script for colorizing the log messages of ngircd(8) according to
32   their log level. Example: `./src/ngircd/ngircd -n | ./contrib/nglog.sh`.
33
34 - `platformtest.sh`: Build ngIRCd and output a "result line" suitable for
35   the `doc/Platforms.txt` file.