NAME

LCFG::Utils - LCFG Utility Functions

SYNOPSIS

  # Select fd for message output
  SetOutput( $fd )

  # Send Debug Message
  Debug( $component, $msg )

  # Send Info message (log file and terminal)
  Info( $component, $msg )

  # Send Log Message (logfile only)
  Log( $component, $msg )

  # Send Log Message with sepcial prefix
  LogPrefix( $component, $pfx, $msg )

  # Send OK Message (terminal only)
  OK( $component, $msg )

  # Send Warning Message
  Warn( $component, $msg )

  # Send Error Message (non fatal)
  Error( $component, $msg )

  # Send Fail Message (fatal error)
  Fail( $component, $msg )

  # Send Monitoring Message
  Notify( $component, $tag, $msg )

  # Send Message to named event log
  Event( $component, $event, $msg )

  # Clear event log
  ClearEvent( $component, $event )

  # Start a Progress Bar
  StartProgress( $component, $msg )

  # Advance Progress Bar
  Progress()

  # End Progress Bar
  EndProgress()

  # Signal client component to acknowledge server
  Ack()
 
  # Detect if shift key pressed
  ShiftPressed()

DESCRIPTION

These routines are Perl bindings for the LCFG utility routines in lcfgutils.

ENVIRONMENT VARIABLES

LCFG_MONITOR

If this is set to the name of a pipe, erorrs, warnings and monitoring information will be written to the named pipe.

LCFG_SYSLOG

If this is set to the name of a syslog facility, errors and warnings will be copied to syslog.

SEE ALSO

LCFG::Utils, lcfgmsg, lcfg-ngeneric, LCFG::Component

PLATFORMS

Solaris9, Fedora3, Fedora5, Darwin, Fedora6, Scientific5

AUTHOR

Paul Anderson <dcspaul@inf.ed.ac.uk>