DragonFly On-Line Manual Pages

SHTK_CLI_USAGE_ERROR(3)                     DragonFly Library Functions Manual

NAME
     shtk_cli_usage_error - Prints a usage error and exits

LIBRARY
     shtk_import cli

SYNOPSIS
     shtk_cli_usage_error message1 [.. messageN]

DESCRIPTION
     The shtk_cli_usage_error function prints the given usage error message to
     stderr and terminates execution of the script with a return value of 1.
     The message can be provided as one or more arguments as depicted by
     message1 to messageN; all arguments are concatenated together into a
     single line.

     The printed message has the following form, where `progname' is
     determined by shtk_cli_progname(3):

           progname: E: message1 .. messageN
           Type 'man progname' for help.

     shtk_cli_usage_error should be used to inform the user of problems
     directly caused by his invocation of the script (e.g. the use of an
     invalid flag).  Note that the printed error message refers to a manual
     page for the script, so you should make sure to provide one.

SEE ALSO
     shtk(3), shtk_cli(3)

HISTORY
     shtk_cli_usage_error first appeared in shtk 1.0.

DragonFly 6.5-DEVELOPMENT      November 5, 2014      DragonFly 6.5-DEVELOPMENT