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 - `Dockerfile`: Container definition file, for Docker or Podman for example.
  13   More information can be found in the `doc/Container.md` file.
  14
  15 - `ngindent.sh`: Script to indent the code of ngIRCd in the "standard way".
  16
  17 - `ngircd-bsd.sh`: Start/stop script for FreeBSD.
  18
  19 - `ngircd-redhat.init`: Start/stop script for old(er) RedHat-based
  20   distributions (like CentOS and Fedora), which did _not_ use systemd(8).
  21
  22 - `ngIRCd-Logo.gif`: The ngIRCd logo as GIF file.
  23
  24 - `ngircd.logcheck`: Sample rules for logcheck(8) to ignore "normal" log
  25   messages of ngIRCd.
  26
  27 - `ngircd.service`: systemd(8) service unit configuration file.
  28
  29 - `ngircd.socket`: systemd(8) socket unit configuration file for "socket
  30   activation".
  31
  32 - `ngircd.spec`: RPM "spec" file.
  33
  34 - `nglog.sh`: Script for colorizing the log messages of ngircd(8) according to
  35   their log level. Example: `./src/ngircd/ngircd -n | ./contrib/nglog.sh`.
  36
  37 - `platformtest.sh`: Build ngIRCd and output a "result line" suitable for
  38   the `doc/Platforms.txt` file.