BSFL  0.1.0
Bash Shell Function Library
 All Files Functions Variables Groups
Functions
Log

Functions

 log (message, status)
 Writes a message in a log file and/or to syslog. More...
 
 log2syslog (message)
 Logs a message using syslog. More...
 
 log_alert (message)
 Logs a message with the 'alert' status. More...
 
 log_critical (message)
 Logs a message with the 'critical' status. More...
 
 log_debug (message)
 Logs a message with the 'debug' status. More...
 
 log_emergency (message)
 Logs a message with the 'emergency' status. More...
 
 log_error (message)
 Logs a message with the 'error' status. More...
 
 log_failed (message)
 Logs a message with the 'failed' status. More...
 
 log_info (message)
 Logs a message with the 'info' status. More...
 
 log_not_ok (message)
 Logs a message with the 'not ok' status. More...
 
 log_notice (message)
 Logs a message with the 'notice' status. More...
 
 log_ok (message)
 Logs a message with the 'ok' status. More...
 
 log_passed (message)
 Logs a message with the 'passed' status. More...
 
 log_status (message, status)
 Logs a message with its status. More...
 
 log_success (message)
 Logs a message with the 'success' status. More...
 
 log_warning (message)
 Logs a message with the 'warning' status. More...
 

Detailed Description

Function Documentation

log ( message  ,
status   
)

Writes a message in a log file and/or to syslog.

Parameters
messageMessage to be logged.
statusMessage status.
log2syslog ( message  )

Logs a message using syslog.

Parameters
messageMessage to be logged.
log_alert ( message  )

Logs a message with the 'alert' status.

Parameters
messageMessage to be logged.
log_critical ( message  )

Logs a message with the 'critical' status.

Parameters
messageMessage to be logged.
log_debug ( message  )

Logs a message with the 'debug' status.

Parameters
messageMessage to be logged.
log_emergency ( message  )

Logs a message with the 'emergency' status.

Parameters
messageMessage to be logged.
log_error ( message  )

Logs a message with the 'error' status.

Parameters
messageMessage to be logged.
log_failed ( message  )

Logs a message with the 'failed' status.

Parameters
messageMessage to be logged.
log_info ( message  )

Logs a message with the 'info' status.

Parameters
messageMessage to be logged.
log_not_ok ( message  )

Logs a message with the 'not ok' status.

Parameters
messageMessage to be logged.
log_notice ( message  )

Logs a message with the 'notice' status.

Parameters
messageMessage to be logged.
log_ok ( message  )

Logs a message with the 'ok' status.

Parameters
messageMessage to be logged.
log_passed ( message  )

Logs a message with the 'passed' status.

Parameters
messageMessage to be logged.
log_status ( message  ,
status   
)

Logs a message with its status.

The log message is formatted with its status preceding its content.

Parameters
messageMessage to be logged.
statusMessage status.
log_success ( message  )

Logs a message with the 'success' status.

Parameters
messageMessage to be logged.
log_warning ( message  )

Logs a message with the 'warning' status.

Parameters
messageMessage to be logged.