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

Functions

 __raw_status (status, color)
 Internal use. More...
 
 display_status (status)
 Displays the specified message status on the right side of the screen. More...
 
 msg (message, color)
 Similar to the 'echo' function but with extra features. More...
 
 msg_alert (message)
 Displays a message with the 'alert' status. More...
 
 msg_critical (message)
 Displays a message with the 'critical' status. More...
 
 msg_debug (message)
 Displays a message with the 'debug' status. More...
 
 msg_emergency (message)
 Displays a message with the 'emergency' status. More...
 
 msg_error (message)
 Displays a message with the 'error' status. More...
 
 msg_failed (message)
 Displays a message with the 'failed' status. More...
 
 msg_info (message)
 Displays a message with the 'info' status. More...
 
 msg_not_ok (message)
 Displays a message with the 'not ok' status. More...
 
 msg_notice (message)
 Displays a message with the 'notice' status. More...
 
 msg_ok (message)
 Displays a message with the 'ok' status. More...
 
 msg_passed (message)
 Displays a message with the 'passed' status. More...
 
 msg_status (message, status)
 Displays a message with its status at the end of the line. More...
 
 msg_success (message)
 Displays a message with the 'success' status. More...
 
 msg_warning (message)
 Displays a message with the 'warning' status. More...
 

Detailed Description

Function Documentation

__raw_status ( status  ,
color   
)

Internal use.

This function just positions the cursor one row up and to the right. It then prints the message to display with the specified color. It is used for displaying colored status messages on the right side of the screen.

Parameters
statusMessage status.
colorMessage color.
display_status ( status  )

Displays the specified message status on the right side of the screen.

Parameters
statusMessage status to display.
msg ( message  ,
color   
)

Similar to the 'echo' function but with extra features.

This function basically replaces the 'echo' function in bash scripts. The added functionalities over 'echo' are logging and using colors.

Parameters
messageMessage to display.
colorText color.
msg_alert ( message  )

Displays a message with the 'alert' status.

Parameters
messageMessage to display.
msg_critical ( message  )

Displays a message with the 'critical' status.

Parameters
messageMessage to display.
msg_debug ( message  )

Displays a message with the 'debug' status.

Parameters
messageMessage to display.
msg_emergency ( message  )

Displays a message with the 'emergency' status.

Parameters
messageMessage to display.
msg_error ( message  )

Displays a message with the 'error' status.

Parameters
messageMessage to display.
msg_failed ( message  )

Displays a message with the 'failed' status.

Parameters
messageMessage to display.
msg_info ( message  )

Displays a message with the 'info' status.

Parameters
messageMessage to display.
msg_not_ok ( message  )

Displays a message with the 'not ok' status.

Parameters
messageMessage to display.
msg_notice ( message  )

Displays a message with the 'notice' status.

Parameters
messageMessage to display.
msg_ok ( message  )

Displays a message with the 'ok' status.

Parameters
messageMessage to display.
msg_passed ( message  )

Displays a message with the 'passed' status.

Parameters
messageMessage to display.
msg_status ( message  ,
status   
)

Displays a message with its status at the end of the line.

Parameters
messageMessage to display.
statusMessage status.
msg_success ( message  )

Displays a message with the 'success' status.

Parameters
messageMessage to display.
msg_warning ( message  )

Displays a message with the 'warning' status.

Parameters
messageMessage to display.