Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
SHTK_CLI_USAGE_ERROR(3)	 BSD Library Functions Manual  SHTK_CLI_USAGE_ERROR(3)

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 sin-
     gle line.

     The printed message has the following form, where `progname' is deter-
     mined 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	di-
     rectly 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.

BSD			       November	5, 2014				   BSD

NAME | LIBRARY | SYNOPSIS | DESCRIPTION | SEE ALSO | HISTORY

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=shtk_cli_usage_error&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help