Browse Source

Cosmetic README -- ASR

Gaétan RYCKEBOER 10 years ago
parent
commit
8e16af3de8
1 changed files with 23 additions and 18 deletions
  1. 23 18
      README.md

+ 23 - 18
README.md

@@ -3,16 +3,22 @@ nagios-fifo
 
 IRSSI BOT to handle nagios/irssi communication.
 
+Presentation 
+------------
+
 To ease the use of the bot configuration, I use to link different
 files from the BOT configuration director etc/ bin/ var/ up to
 respective irssi directories :
 
-1/ setup an irssi client, inside a screen.
-2/ symlink ~/.irssi/ as etc/config.directory
-3/ symlink the scripts you want to load to as ~/.irssi/scripts/autorun
-4/ edit the ~/.irssi/config to join the communication channel
-5/ symlink it to etc/config.local
-6/ start "screen irssi"
+1. setup an irssi client, inside a screen.
+2. symlink ~/.irssi/ as etc/config.directory
+3. symlink the scripts you want to load to as ~/.irssi/scripts/autorun
+4. edit the ~/.irssi/config to join the communication channel
+5. symlink it to etc/config.local
+6. start "screen irssi"
+
+How does it works 
+------------
 
 The bot is made of 3 scripts :
 - nagios bot ;
@@ -21,18 +27,18 @@ The bot is made of 3 scripts :
 
 all are designed to work standalone.
 
-Commands allowed by nagios-fifo.pl / Nagios module :
+Using the bots
+---------
+
+Commands allowed by *nagios-fifo.pl* / Nagios module :
 The nagios bot is designed to work with nagios notifications, via commands.cfg configuration file.
 - !nagios list : list of received alerts
 - !nagios help : l'aide");
-- !nagios ack <#ALERT> <message> 
-               : ACK the alert");
-- !nagios check <#ALERT> 
-               : recheck any alert (service/host)
-- !nagios refresh [silent] 
-               : request nagios livestatus and import all unack alerts
-
-Commands allowed by tc-14.pl / Dumb module :
+- !nagios ack <#ALERT> <message> : ACK the alert");
+- !nagios check <#ALERT> : recheck any alert (service/host)
+- !nagios refresh [silent] : request nagios livestatus and import all unack alerts
+
+Commands allowed by *tc-14.pl* / Dumb module :
 - !status      to have a look on inner variables / structures (particularly for the bingo module)
 - !password    to generate a random password
 - !help        totally useless
@@ -43,9 +49,8 @@ Commands allowed by tc-14.pl / Dumb module :
   * some pedant words, used to check a bingo business card
   * his own name
   
-Commands allowed by tweet.pl / admin module :
+Commands allowed by *tweet.pl* / admin module :
 - !tweet        : tweet a tweet, on twitter and identi.ca (twitter module broken, to be redisigned)
 - !tweet last   : what was last tweet ?
 - !changelog    : add/list lasts changelogs
-- !lastlog [pattern] 
-                : display last 20 messages [about pattern]
+- !lastlog [pattern] : display last 20 messages [about pattern]