ouch/inspircd
2
0
Fork 0
mirror of https://github.com/inspircd/inspircd.git synced 2025-03-09 10:39:02 -04:00
Code Issues Packages Projects Releases Wiki Activity

Add man pages.

Browse Source
This commit is contained in:
Peter Powell 2014-06-04 16:40:18 +01:00 committed by Attila Molnar
parent 644e445ba4
commit f78c1c277a
4 changed files with 154 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored
View File

@ -9,6 +9,8 @@
/GNUmakefile
/build
/inspircd
/inspircd.1
/inspircd-genssl.1
/inspircd.service
/org.inspircd.plist
/run

46
make/template/inspircd-genssl.1 Normal file
View File

@ -0,0 +1,46 @@
.\"
.\" InspIRCd -- Internet Relay Chat Daemon
.\"
.\" Copyright (C) 2014 Peter Powell <petpow@saberuk.com>
.\"
.\" This file is part of InspIRCd. InspIRCd is free software: you can
.\" redistribute it and/or modify it under the terms of the GNU General Public
.\" License as published by the Free Software Foundation, version 2.
.\"
.\" This program is distributed in the hope that it will be useful, but WITHOUT
.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
.\" FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
.\" details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see <http://www.gnu.org/licenses/>.
.\"
.TH "InspIRCd" "1" "June 2014" "InspIRCd @VERSION_MAJOR@.@VERSION_MINOR@.@VERSION_PATCH@+@VERSION_LABEL@" "InspIRCd Manual"
.SH "NAME"
\t\fBInspIRCd\fR - \fIthe\fR stable, high-performance and modular Internet Relay Chat Daemon
.BR
.SH "SYNOPSIS"
\t\fBinspircd-genssl\fR [ auto | gnutls | openssl ]
.SH "OPTIONS"
.TP
.B "auto"
.br
Looks for both GnuTLS and OpenSSL and uses the first one which is available for certificate generation.
.TP
.B "gnutls"
.br
Generates certificates using GnuTLS.
.TP
.br
.B "openssl"
Generates certificates using OpenSSL.
.SH "SUPPORT"
IRC support for InspIRCd can be found at irc://irc.inspircd.org/inspircd.
Bug reports and feature requests can be filed at https://github.com/inspircd/inspircd/issues.

104
make/template/inspircd.1 Normal file
View File

@ -0,0 +1,104 @@
.\"
.\" InspIRCd -- Internet Relay Chat Daemon
.\"
.\" Copyright (C) 2014 Peter Powell <petpow@saberuk.com>
.\"
.\" This file is part of InspIRCd. InspIRCd is free software: you can
.\" redistribute it and/or modify it under the terms of the GNU General Public
.\" License as published by the Free Software Foundation, version 2.
.\"
.\" This program is distributed in the hope that it will be useful, but WITHOUT
.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
.\" FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
.\" details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see <http://www.gnu.org/licenses/>.
.\"
.TH "InspIRCd" "1" "June 2014" "InspIRCd @VERSION_MAJOR@.@VERSION_MINOR@.@VERSION_PATCH@+@VERSION_LABEL@" "InspIRCd Manual"
.SH "NAME"
\t\fBInspIRCd\fR - \fIthe\fR stable, high-performance and modular Internet Relay Chat Daemon
.BR
.SH "SYNOPSIS"
\t\fBinspircd\fR [--config <file>] [--debug] [--nofork] [--nolog] [--runasroot] [--version]
.SH "OPTIONS"
.TP
.B "--config <file>"
.br
Sets the path to the main configuration file. Defaults to \fI@CONFIG_DIR@/inspircd.conf\fR.
.TP
.B "--debug"
.br
Log verbosely to the standard output stream.
.TP
.B "--nofork"
.br
Don't fork into the background after starting up.
.TP
.B "--nolog"
.br
Don't write to log files.
.TP
.B "--runasroot"
.br
Allow the server to start as root (not recommended).
.TP
.B "--version"
.br
Displays the InspIRCd version and exits.
.SH "EXIT STATUS"
.TP
.B "0 (EXIT_STATUS_NOERROR)"
.br
The server exited cleanly.
.TP
.B "1 (EXIT_STATUS_DIE)"
.br
The server exited because the DIE command was executed.
.TP
.B "2 (EXIT_STATUS_CONFIG)"
.br
The server exited because of a configuration file error.
.TP
.B "3 (EXIT_STATUS_LOG)"
.br
The server exited because of a log file error.
.TP
.B "4 (EXIT_STATUS_FORK)"
.br
The server exited because it was unable to fork into the background.
.TP
.B "5 (EXIT_STATUS_ARGV)"
.br
The server exited because an invalid argument was passed to it on the command line.
.TP
.B "6 (EXIT_STATUS_PID)"
.br
The server exited because it was unable to write to the PID file.
.TP
.B "7 (EXIT_STATUS_SOCKETENGINE)"
.br
The server exited because it was unable to initialize the @SOCKETENGINE@ socket engine.
.TP
.B "8 (EXIT_STATUS_ROOT)"
.br
The server exited because the user tried to start as root without \fI--runasroot\fR.
.TP
.B "9 (EXIT_STATUS_MODULE)"
.br
The server exited because it was unable to load a module on first run.
.TP
.B "10 (EXIT_STATUS_SIGTERM)"
.br
The server exited because it received SIGTERM.
.SH "SUPPORT"
IRC support for InspIRCd can be found at irc://irc.inspircd.org/inspircd.
Bug reports and feature requests can be filed at https://github.com/inspircd/inspircd/issues.

2
make/template/main.mk
View File

@ -238,6 +238,8 @@ install: target
@IFEQ $(SYSTEM) linux
-$(INSTALL) -m $(INSTMODE_LIB) inspircd.service $(BASE) 2>/dev/null
@ENDIF
-$(INSTALL) -m $(INSTMODE_LIB) inspircd.1 $(BASE) 2>/dev/null
-$(INSTALL) -m $(INSTMODE_LIB) inspircd-genssl.1 $(BASE) 2>/dev/null
-$(INSTALL) -m $(INSTMODE_BIN) tools/genssl $(BINPATH)/inspircd-genssl 2>/dev/null
-$(INSTALL) -m $(INSTMODE_LIB) docs/conf/*.example $(CONPATH)/examples
-$(INSTALL) -m $(INSTMODE_LIB) docs/conf/aliases/*.example $(CONPATH)/examples/aliases