CFETOOLUPDATE(8)					User Contributed Perl Documentation					  CFETOOLUPDATE(8)

NAME

       cfetoolupdate - Update the database with a new value

SYNOPSIS

       cfetool update name --value|-V value [--path|-p directory name] [--time|-t seconds] [--daily|-d] [--weekly|-w] [--yearly|-y] [--cfenvd|-c]
       [--histograms|-H] [--verbose|-v] [--help|-h]

DESCRIPTION

       Takes a new value and uses it to update the database specified by name, located at the path specified by the -p argument, or the current
       working directory if the -p argument is omitted. The value will be associated with the current time, unless the -t option is given. In
       order for cfetool to function properly, this command should be issued at least once during each interval specified by the --step option of
       "cfetool create".

       The -d, -w and -y options specify the databases to update. If all three options are omitted, only the weekly database will be updated.

OPTIONS

       --value|-v value
	   Specifies a new value to update the database with.

       --path|-p directory name
	   The directory in which the database specified by name can be found.

       --time|-t
	   The time the value was collected, in seconds since epoch (January 1st, 1970).  If this argument is omitted, the current time will be
	   used.

       --daily|-d
	   Update the daily averages database.

       --weekly|-w
	   Update the weekly averages database.

       --yearly|-y
	   Update the yearly averages database.

       --cfenvd|-c
	   Communicate with cfengine. If this option is specified, cfetool will define classes understandable by cfagent. For more information,
	   refer to the documentation for cfenvd.

       --histograms|-H
	   Collect histogram information about the probability distribiution of fluctuations about the mean value over all times of day. Cfetool
	   won't write anything to this file for the first four weeks, as it has to have reliable mean values in order to accurately calculate it.

       --verbose|-v
	   Print details of the command's execution to the standard output stream.

       --help|-h
	   Print a short help message and then exit.

OUTPUT

       Before exiting, "cfetool update" will print one line to the standard output stream in the following format:

       yrly=ynum,wkly=wnum,dly=dnum

       ynum, wnum and dnum will be either the number 0 if the corresponding database was not updated, or a code indicating the state of the given
       statistic, as compared to an average of equivalent earlier times, as specified below:

	code	high|low|normal   meaning
	-------------------------------------------------------------
	 -2	-		  no sigma variation
	-------------------------------------------------------------
	 -4	low		  within noise threshold, and within
	 -5	normal		    2 standard deviations from
	 -6	high		    expected value
	-------------------------------------------------------------
	-14	low		  microanomaly: within noise
	-15	normal		    threshold, but 2 or more standard
	-16	high		    deviations from expected value
	-------------------------------------------------------------
	-24	low		  normal; within 1 standard deviation
	-25	normal		    from the expected value
	-26	high
	-------------------------------------------------------------
	-34	low		  dev1; more than 1 standard
	-35	normal		    deviation from the expected
	-36	high		    value
	------------------------------------------------------------
	-44	low		  dev2; more than 2 standard
	-45	normal		    deviations from the expected
	-46	high		    value
	-------------------------------------------------------------
	-54	low		  anomaly; more than 3 standard
	-55	normal		    deviations from the expected
	-56	high		    value

       Where "low" indicates that the current value is below both the expected value for the current time position, and the global average value.
       "high" indicates that the current value is above those values. "normal" indicates that the current value is within the range of expected
       values.

       "cfetool update" also exits with a code corresponding to the above table. If more than one database is being updated, the most negative
       result from the updates is returned, and the individual results must be obtained from the standard output stream, as described above.

EXAMPLE

	 % cfetool update temperature --path /my/path --value 14.5 --histograms
	 yrly=0,wkly=-6,dly=0

       Updates the weekly temperature database and histogram files located in /my/path/ with the value 14.5 using the current time as the update
       time. The output indicates that only a weekly database was updated, and the new value given was within cfetool's noise threshold, and also
       within 2 standard deviations of the previous average stored in the database.

AUTHORS

       The code and documentation were contributed by Stanford Linear Accelerator Center, a department of Stanford University.	This documentation
       was written by

       Elizabeth Cassell <e_a_c@mailsnare.net> and
       Alf Wachsmann <alfw@slac.stanford.edu>

COPYRIGHT AND DISCLAIMER

	Copyright 2004 Alf Wachsmann <alfw@slac.stanford.edu> and
		       Elizabeth Cassell <e_a_c@mailsnare.net>
	All rights reserved.

perl v5.8.4							    2004-09-21							  CFETOOLUPDATE(8)