make/template/inspircd.1

   1 .\"
   2 .\" InspIRCd -- Internet Relay Chat Daemon
   3 .\"
   4 .\"   Copyright (C) 2014, 2016, 2018 Sadie Powell <sadie@witchery.services>
   5 .\"
   6 .\" This file is part of InspIRCd.  InspIRCd is free software: you can
   7 .\" redistribute it and/or modify it under the terms of the GNU General Public
   8 .\" License as published by the Free Software Foundation, version 2.
   9 .\"
  10 .\" This program is distributed in the hope that it will be useful, but WITHOUT
  11 .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  12 .\" FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  13 .\" details.
  14 .\"
  15 .\" You should have received a copy of the GNU General Public License
  16 .\" along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17 .\"
  18
  19
  20 .TH "InspIRCd" "1" "June 2014" "InspIRCd @VERSION_FULL@" "InspIRCd Manual"
  21
  22 .SH "NAME"
  23 \t\fBInspIRCd\fR - \fIthe\fR stable, high-performance and modular Internet Relay Chat Daemon
  24 .BR
  25
  26 .SH "SYNOPSIS"
  27 \t\fBinspircd\fR [--config <file>] [--debug] [--nofork] [--nolog] [--nopid] [--runasroot] [--version]
  28
  29 .SH "OPTIONS"
  30 .TP
  31 .B "--config <file>"
  32 .br
  33 Sets the path to the main configuration file. Defaults to \fI@CONFIG_DIR@/inspircd.conf\fR.
  34 .TP
  35 .B "--debug"
  36 .br
  37 Log verbosely to the standard output stream.
  38 .TP
  39 .B "--nofork"
  40 .br
  41 Don't fork into the background after starting up.
  42 .TP
  43 .B "--nolog"
  44 .br
  45 Don't write to log files.
  46 .TP
  47 .B "--nopid"
  48 .br
  49 Don't write to the PID file.
  50 .TP
  51 .B "--runasroot"
  52 .br
  53 Allow the server to start as root (not recommended).
  54 .TP
  55 .B "--version"
  56 .br
  57 Displays the InspIRCd version and exits.
  58
  59 .SH "EXIT STATUS"
  60 .TP
  61 .B "0 (EXIT_STATUS_NOERROR)"
  62 .br
  63 The server exited cleanly.
  64 .TP
  65 .B "1 (EXIT_STATUS_DIE)"
  66 .br
  67 The server exited because the DIE command was executed.
  68 .TP
  69 .B "2 (EXIT_STATUS_CONFIG)"
  70 .br
  71 The server exited because of a configuration file error.
  72 .TP
  73 .B "3 (EXIT_STATUS_LOG)"
  74 .br
  75 The server exited because of a log file error.
  76 .TP
  77 .B "4 (EXIT_STATUS_FORK)"
  78 .br
  79 The server exited because it was unable to fork into the background.
  80 .TP
  81 .B "5 (EXIT_STATUS_ARGV)"
  82 .br
  83 The server exited because an invalid argument was passed to it on the command line.
  84 .TP
  85 .B "6 (EXIT_STATUS_PID)"
  86 .br
  87 The server exited because it was unable to write to the PID file.
  88 .TP
  89 .B "7 (EXIT_STATUS_SOCKETENGINE)"
  90 .br
  91 The server exited because it was unable to initialize the @SOCKETENGINE@ socket engine.
  92 .TP
  93 .B "8 (EXIT_STATUS_ROOT)"
  94 .br
  95 The server exited because the user tried to start as root without \fI--runasroot\fR.
  96 .TP
  97 .B "9 (EXIT_STATUS_MODULE)"
  98 .br
  99 The server exited because it was unable to load a module on first run.
 100 .TP
 101 .B "10 (EXIT_STATUS_SIGTERM)"
 102 .br
 103 The server exited because it received SIGTERM.
 104
 105 .SH "SUPPORT"
 106 IRC support for InspIRCd can be found at ircs://irc.inspircd.org/inspircd.
 107
 108 Bug reports and feature requests can be filed at https://github.com/inspircd/inspircd/issues.