From: Gunnar Beutner Date: Thu, 15 Aug 2013 09:47:12 +0000 (+0200) Subject: Update documentation. X-Git-Url: https://jfr.im/git/irc/quakenet/newserv.git/commitdiff_plain/4af4ef24bee8b73c237e905c52442fd85f3c6ee2 Update documentation. --- diff --git a/INSTALL b/INSTALL index d67b7cf4..36893a98 100644 --- a/INSTALL +++ b/INSTALL @@ -10,20 +10,19 @@ a certain library or header file was not found you can run the configure script with the -v option or check the .configure.log file after your first configure run. -Please refer to the "Local Settings" section in this file if you're -using non-standard library/header search paths. Once you've resolved all -dependency issues you can build newserv: +Please refer to the "Local Settings" section in this file if you're using +non-standard library/header search paths. Once you've resolved all dependency +issues you can build newserv: $ make -This might take a while. After all modules are built you can install -newserv: +This might take a while. After all modules are built you can install newserv: $ make install -By default the newserv binary and the modules are installed into your -source tree. The recommended setup is to now create a separate directory -and symlink the "newserv" binary and the "modules" directory into it: +By default the newserv binary and the modules are installed into your source +tree. The recommended setup is to now create a separate directory and symlink +the "newserv" binary and the "modules" directory into it: $ cd $ mkdir newserv-install && cd newserv-install @@ -31,8 +30,8 @@ $ ln -s ../newserv-src/newserv $ ln -s ../newserv-src/modules You will also need to copy the newserv.conf.example configuration file to your -installation directory and rename it to newserv.conf. The MODULES file -has a list of available modules. +installation directory and rename it to newserv.conf. The MODULES file has a +list of available modules and their configuration settings. After you have updated your newserv.conf file you can start newserv: @@ -41,18 +40,33 @@ $ ./newserv newserv does not detach from the console. Consider running it in a screen(1) session. +User Accounts +~~~~~~~~~~~~ + +You can create a user on your control instance using /msg N hello (where N is +the nick of your control user). You need to be opered and authed in order to +use this command. + +If your network does not have an authentication service that supports account +IDs you can load the "auth" module. Note that this module lets opers set +arbitrary account names and IDs and therefore should probably not be loaded on +production networks. + +Once you have an account you should have a look at /msg N showcommands for a +list of available commands. + Local Settings ~~~~~~~~~~~~~ If you are using non-standard library/include paths you can create a file -called configure.ini.local (using configure.ini.local.example as a template) -to override some of the settings. +called configure.ini.local (using configure.ini.local.example as a template) to +override some of the settings. Workspaces ~~~~~~~~~ If you're planning to write your own modules you might consider using -workspace. +workspaces. For this to work you will need to create a directory for your modules: @@ -68,5 +82,5 @@ And finally add your workspace to the workspaces.ini file: [workspaces] custom= -You will need to re-run configure for it to pick up your new -workspace and whatever modules you have in it. +You will need to re-run configure for it to pick up your new workspace and +whatever modules you have in it. diff --git a/MODULES b/MODULES index 80b701a8..7a5b369b 100644 --- a/MODULES +++ b/MODULES @@ -31,13 +31,6 @@ and modify user accounts. Other modules can register their own commands. -You can create a user on your control instance using /msg N hello (where N is -the nick of your control instance). You need to be opered in order to use this -command. - -Once you have an account you should have a look at /msg N showcommands for a -list of available commands. - Configuration: [control] diff --git a/README b/README index cfb1984b..a721abe8 100644 --- a/README +++ b/README @@ -5,7 +5,8 @@ \_/ \_/ \_/ \_/ \_/ \_/ \_/ -newserv is a P10 protocol services daemon developed for the QuakeNet IRC Network since April 2002. It is modular, fast and easily customizable. +newserv is a P10 protocol services daemon developed for the QuakeNet IRC +Network since April 2002. It is modular, fast and easily customizable. newserv is available for download and use under the GPLv2 open source license. @@ -14,7 +15,10 @@ The official website for newserv is http://dev.quakenet.org/ Requirements ~~~~~~~~~~~ -* IRC Server running the P10 Protocol. Full support for all modules may require use of QuakeNet's snircd IRC server [available from https://www.quakenet.org/development], which is based upon Undernet's IRCU server [http://coder-com.undernet.org/]. +* IRC Server running the P10 Protocol. Full support for all modules may require + use of QuakeNet's snircd IRC server [available from + https://www.quakenet.org/development], which is based upon Undernet's IRCU + server [http://coder-com.undernet.org/]. * Please read the INSTALL file for build and installation instructions. @@ -50,9 +54,11 @@ Features Support & Development ~~~~~~~~~~~~~~~~~~~~ -Please read the documentation provided before you ask us for support. You may find some assistance in #dev on QuakeNet for specific questions. +Please read the documentation provided before you ask us for support. You may +find some assistance in #dev on QuakeNet for specific questions. -If you've found any bugs or you're working on any cool new features please give us a shout. +If you've found any bugs or you're working on any cool new features please give +us a shout. License ~~~~~~