FreeBSD Manual Pages
SHTK_BOOL_CHECK(3) Library Functions Manual SHTK_BOOL_CHECK(3) NAME shtk_bool_check -- Converts a string to a boolean value LIBRARY shtk_import bool SYNOPSIS shtk_bool_check value [error_message] DESCRIPTION The shtk_bool_check function takes the string value and returns the corre- sponding boolean value according to shell conventions. RETURN VALUES shtk_bool_check returns 0 for any value representing truth. These include the strings `yes' and `true', including any variations in their capitaliza- tion, and the integer number `1'. shtk_bool_check returns 1 for any value representing falsehood. These in- clude the strings `no' and `false', including any variations in their capi- talization, and the integer number `0'. EXAMPLES local verbose=no # Parse flags to see if verbose mode is enabled and set verbose=yes. if shtk_bool_check "${verbose}"; then # Print messages. fi ERRORS shtk_bool_check prints the error given in error_message and exits the shell with non-zero if the value does not represent a valid boolean value. If error_message is not provided, a default message is printed. SEE ALSO shtk(3), shtk_bool(3) HISTORY shtk_bool_check first appeared in shtk 1.4. FreeBSD ports 15.quarterly November 5, 2014 SHTK_BOOL_CHECK(3)
NAME | LIBRARY | SYNOPSIS | DESCRIPTION | RETURN VALUES | EXAMPLES | ERRORS | SEE ALSO | HISTORY
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=shtk_bool_check&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>