[Orca-checkins] rev 237 - in trunk/orca: . data_gatherers/orca_services data_gatherers/orcallator data_gatherers/procallator orca

Thu Jun 5 21:50:28 PDT 2003

Author: blair
Date: Thu Jun  5 21:50:25 2003
New Revision: 237

Modified:
   trunk/orca/INSTALL
   trunk/orca/data_gatherers/orca_services/orca_services.cfg.in
   trunk/orca/data_gatherers/orcallator/orcallator.cfg.in
   trunk/orca/data_gatherers/procallator/procallator.cfg
   trunk/orca/orca/orca.pl.in
Log:
* INSTALL
  (Doing an upgrade from Orca 0.23 or older?):
    The upgrade_installation program was misspelled and listed in the
    wrong directory.
  ([Solaris Only and Optional] Install orcallator):
    Update the section on configuring orcallator.cfg to the particular
    site.

* orca/orca.pl.in
  (POD): Correct the description of html_top_title, which is only used
  in the main index.html file.

* data_gatherers/orca_services/orca_services.cfg.in,
* data_gatherers/orcallator/orcallator.cfg.in,
* data_gatherers/procallator/procallator.cfg:
  Add/or correct the description of the html_page_header,
  html_top_title and html_page_footer configuration parameters.


Modified: trunk/orca/INSTALL
==============================================================================

--- trunk/orca/INSTALL	(original)
+++ trunk/orca/INSTALL	Thu Jun  5 21:50:25 2003
@@ -342,8 +342,8 @@
 
     If you have some new directories that are not included in the
     above list directories that make upgrade will cover, you can run
-    the src/upgrage_installation program with a list of directories to
-    parse and rename.  If you want to see what upgrage_installation
+    the orca/upgrade_installation program with a list of directories
+    to parse and rename.  If you want to see what upgrade_installation
     will rename without actually doing the rename, give it the -n
     option before any directory names.
 
@@ -459,12 +459,19 @@
 
     f) Edit orcallator.cfg.
 
-       You need to edit the installed orcallator.cfg file and remove
-       all unneeded references.  In particular, you'll want to change
-       warn_email, which is the email address that receives emails
-       when orcallator generated files are out of date, which may
-       signify a orcallator program that has died and is no longer
-       gathering data.
+       You will probably want to edit orcallator.cfg to customize
+       various parameters for your site.
+
+       To change the HTML header and footer's on each web page, modify
+       the html_page_header and html_page_footer configuration values.
+       You may also want to edit the html_top_title, which is the
+       title of the top level HTML page.
+
+       You may want to change warn_email, which is the email address
+       that is sent mail when Orca sends out warning messages, such as
+       when the input data files (say generated by orcallator) are out
+       of date, which may signify a orcallator program that has died
+       and is no longer gathering data.
 
 11) Run Orca.
 

Modified: trunk/orca/data_gatherers/orca_services/orca_services.cfg.in
==============================================================================
--- trunk/orca/data_gatherers/orca_services/orca_services.cfg.in	(original)
+++ trunk/orca/data_gatherers/orca_services/orca_services.cfg.in	Thu Jun  5 21:50:25 2003
@@ -72,14 +72,14 @@
 			}
 }
 
-#
-# ATTENTION: change this to your values
-#
+# This sets the text, that should not be HTML markup, that is used
+# only in the main index.html file.  It is used in the <title></title>
+# element and also placed in the HTML body after the html_page_header
+# in a <h1></h1> element index.html file.
 html_top_title		Services Status
 
-#
-# ATTENTION: change this to your values
-#
+# This sets the HTML markup that is placed at the very top of every
+# web page and is primarily used to display the site's logo.
 html_page_header
   <a href="http://www.kpnQwest.pt/">
     <img border=0 alt="kpnQwest Portugal"
@@ -87,6 +87,8 @@
      width=101 height=61></a>
   <spacer type=vertical size=4>
 
+# This sets the HTML markup that is placed at the bottom of every web
+# page.
 html_page_footer
   <spacer type=vertical size=20>
   <font face="Arial,Helvetica">

Modified: trunk/orca/data_gatherers/orcallator/orcallator.cfg.in
==============================================================================
--- trunk/orca/data_gatherers/orcallator/orcallator.cfg.in	(original)
+++ trunk/orca/data_gatherers/orcallator/orcallator.cfg.in	Thu Jun  5 21:50:25 2003
@@ -50,13 +50,13 @@
 generate_yearly_plot	1
 
 # This sets the HTML markup that is placed at the very top of every
-# web page and is primarly used to display the site's logo.
+# web page and is primarily used to display the site's logo.
 html_page_header	<h3>Put your site's logo here.</h3>
 
-# This sets the text, that should not be HTML markup, that is placed
-# in each web page's <title></title> element.  This text is also added
-# to each HTML page in a <h1></h1> element after the html_page_header
-# HTML markup.
+# This sets the text, that should not be HTML markup, that is used
+# only in the main index.html file.  It is used in the <title></title>
+# element and also placed in the HTML body after the html_page_header
+# in a <h1></h1> element index.html file.
 html_top_title		Orca Host Status
 
 # This sets the HTML markup that is placed at the bottom of every web

Modified: trunk/orca/data_gatherers/procallator/procallator.cfg
==============================================================================
--- trunk/orca/data_gatherers/procallator/procallator.cfg	(original)
+++ trunk/orca/data_gatherers/procallator/procallator.cfg	Thu Jun  5 21:50:25 2003
@@ -67,12 +67,20 @@
 			}
 }
 
-html_top_title		Estado dos servidores TCO/NBT 
-
+# This sets the HTML markup that is placed at the very top of every
+# web page and is primarily used to display the site's logo.
 html_page_header
   <spacer type=vertical size=4>
   <body bgcolor="#808080">
 
+# This sets the text, that should not be HTML markup, that is used
+# only in the main index.html file.  It is used in the <title></title>
+# element and also placed in the HTML body after the html_page_header
+# in a <h1></h1> element index.html file.
+html_top_title		Estado dos servidores TCO/NBT 
+
+# This sets the HTML markup that is placed at the bottom of every web
+# page.
 html_page_footer
   <spacer type=vertical size=20>
   <font face="Arial,Helvetica">

Modified: trunk/orca/orca/orca.pl.in
==============================================================================
--- trunk/orca/orca/orca.pl.in	(original)
+++ trunk/orca/orca/orca.pl.in	Thu Jun  5 21:50:25 2003
@@ -1551,18 +1551,20 @@
 
 =item B<html_top_title> I<text> ...
 
-The I<text> is placed at the top of the main index.html that Orca
-creates.  By default, no additional text is placed at the top of the
-main index.html.
+This sets the text, that should not be HTML markup, that is used only
+in the main index.html file.  It is used in the <title></title>
+element and also placed in the HTML body after the html_page_header in
+a <h1></h1> element index.html file.  By default, no additional text
+is placed at the top of the main index.html.
 
-=item B<html_page_header> I<text> ...
+=item B<html_page_header> I<html> ...
 
-The I<text> is placed at the top of each HTML file that Orca creates.
+The I<html> is placed at the top of each HTML file that Orca creates.
 By default, no additional text is placed at the top of each HTML file.
 
-=item B<html_page_footer> I<text> ...
+=item B<html_page_footer> I<html> ...
 
-The I<text> is placed at the bottom of each HTML file that Orca
+The I<html> is placed at the bottom of each HTML file that Orca
 creates.  By default, no additional text is placed at the bottom of
 each HTML file.
 

