Răsfoiți Sursa

Documentation updates.

Morten Brix Pedersen 25 ani în urmă
părinte
comite
9d4355f2ae
3 a modificat fișierele cu 34 adăugiri și 28 ștergeri
  1. 22 20
      CONFIG-README
  2. 9 7
      CREDITS
  3. 3 1
      README

+ 22 - 20
CONFIG-README

@@ -2,6 +2,7 @@ README for pisg.cfg - the configuration file for pisg
 ------------------
 ------------------
 This file is used for two things:
 This file is used for two things:
  - Setting user options (for user aliases, pics, ignores and links)
  - Setting user options (for user aliases, pics, ignores and links)
+ - Setting up channel(s) to be parsed.
  - Setting pisg config options (for general things with pisg)
  - Setting pisg config options (for general things with pisg)
  - Word options (for adding words that are meant to be 'foul(bad) language')
  - Word options (for adding words that are meant to be 'foul(bad) language')
  
  
@@ -35,22 +36,36 @@ You don't have to do all this in many lines, you could just as easily do:
 (Here the aliases is a space seperated list of nicks, that also works! But *
 (Here the aliases is a space seperated list of nicks, that also works! But *
 as a wildcard is smarter, but also slower).
 as a wildcard is smarter, but also slower).
 
 
+CHANNELS SETUP
+------------------
+
+For each of your channels which you want to parse through, you make
+something like this:
+
+<channel="#channel" logfile="channel.log">
+ format = "mIRC"
+ maintainer = "NameOfMaintainer"
+</channel>
+
+Any options in the <channel *> section will be forced, even over commandline
+options... any options before </channel> can be overridden from command line
+
+There is a lot of variables which you can set between the <channel> and
+</channel> tags, these are listed in the next section.
 
 
 PISG OPTIONS
 PISG OPTIONS
 ------------------
 ------------------
-This is a tougher part, a lot of things can be set here, simply the syntax
-is like this:
+If you have multiple channels, then you can set some defaults for them, for
+example you can do.
 
 
-<set variable="value">
+<set format="mIRC">
 
 
-For example:
-<set channel="#channel">
+And you won't have to worry about setting the format for every channel.
 
 
 You can also combine settings into one line such as:
 You can also combine settings into one line such as:
 <set channel="#channel" logfile="/var/log/channel.log">
 <set channel="#channel" logfile="/var/log/channel.log">
 
 
-A normal complete line for a channel would be:
-<set channel="#channel" logfile="channel2.log" format="mIRC" network="SomeIRCNet" outputfile="index.html">
+All the differents variables are listed below.
 
 
 Other examples:
 Other examples:
 <set lang='EN' langfile='lang.txt'>
 <set lang='EN' langfile='lang.txt'>
@@ -137,17 +152,4 @@ Or in German:
 <words foul="scheisse scheiße kacke">
 <words foul="scheisse scheiße kacke">
 
 
 
 
-
 Have fun configuring pisg! :)
 Have fun configuring pisg! :)
-
-
-MULTIPLE CHANNELS
-------------------
-***MUST begin with <channel="#channel"
-<channel="#channel" logfile="channel.log" format="mIRC" outputfile="channel.html">
-    network="EFNet"
-    maintainer="fubar"
-</channel>
-
-
-any options in the <channel *> section will be forced, even over commandline options... any options before </channel> can be overridden from command line

+ 9 - 7
CREDITS

@@ -1,6 +1,15 @@
 CREDITS goes to...
 CREDITS goes to...
 --
 --
 
 
+The developers:
+--
+Winfried Nessen <doomy@doomshammer.yi.org>
+Jamie Cheetham <jamie@softham.co.uk>
+Morten Brix Pedersen <morten@wtf.dk>
+Sam Bingner <sam@dhs.org>
+
+And all the other contributors:
+
  * Stefan aka Flyghost <flyghost@ghosthouse.cx>
  * Stefan aka Flyghost <flyghost@ghosthouse.cx>
    | Code contribution and fixes
    | Code contribution and fixes
  * P. Gnodde aka Shogun <peter@pcswebdesign.nl>
  * P. Gnodde aka Shogun <peter@pcswebdesign.nl>
@@ -23,22 +32,15 @@ CREDITS goes to...
    | Reported a very small, but stupid bug with the xchat fileformat :)
    | Reported a very small, but stupid bug with the xchat fileformat :)
  * kiss dess <duvet@mail.com>
  * kiss dess <duvet@mail.com>
    | Found a few minor bugs. And added replace_links()
    | Found a few minor bugs. And added replace_links()
- * Sam Bingner <sam@dhs.org>
-   | Added mIRC color stripping, eggdrop log format and nick/alias tracking.
-   | Bunch of other patches
  * S. William Schulz <sws@astrum.com>
  * S. William Schulz <sws@astrum.com>
    | Better commandline arguments, --help and fixed indenting problems with
    | Better commandline arguments, --help and fixed indenting problems with
      xchat logs, also fixed a critical thing with --format
      xchat logs, also fixed a critical thing with --format
  * Tim Hunter <tim@quic.net>
  * Tim Hunter <tim@quic.net>
    | 'shortest lines', 'most fouls', 'pageheader' and more. 
    | 'shortest lines', 'most fouls', 'pageheader' and more. 
- * Winfried (Doomshammer) <doomy@doomshammer.yi.org>
-   | grufti log format help, German translation and a ton of other things.
  * Kim Ingemann (Tuxi) <tuxi@tuxi.dk>
  * Kim Ingemann (Tuxi) <tuxi@tuxi.dk>
    | Danish translation
    | Danish translation
  * Molator <molator@ifrance.com>
  * Molator <molator@ifrance.com>
    | French translation
    | French translation
- * Jamie Cheetham <jamie@softham.co.uk>
-   | Eggdrop 'last messaged repeated x times' fix, and tons of bug reports
  * Sheuron Azxe <xeron@cfutura.com>
  * Sheuron Azxe <xeron@cfutura.com>
    | Spanish translation
    | Spanish translation
  * Gandalf the Grey <gandalf@irc.pl>
  * Gandalf the Grey <gandalf@irc.pl>

+ 3 - 1
README

@@ -17,7 +17,7 @@ SETTING UP PISG
 It's quite simple to set up pisg. You have 2 choices:
 It's quite simple to set up pisg. You have 2 choices:
 
 
  * Set settings from commandline (try pisg.pl --help)
  * Set settings from commandline (try pisg.pl --help)
- * Set settings from the pisg.cfg config file (more flexible)
+ * Configure pisg from the pisg.cfg file (more flexible and configurable)
 
 
 The most important here is the name of the logfile, the maintainers name,
 The most important here is the name of the logfile, the maintainers name,
 and then the format of your logfile.
 and then the format of your logfile.
@@ -45,6 +45,8 @@ it. If you're on a Linux/Unix system, these steps should do the work:
     $ chmod +x pisg.pl
     $ chmod +x pisg.pl
     $ ./pisg.pl
     $ ./pisg.pl
 
 
+Running pisg like this will just use the settings in pisg.cfg.
+
 If you have more than one channel, then you can also tell it to pisg on the
 If you have more than one channel, then you can also tell it to pisg on the
 commandline, the syntax is explained when doing:
 commandline, the syntax is explained when doing: