GSP
Quick Navigator
Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
SHTK_CLI_USAGE_ERROR(3) FreeBSD Library Functions Manual SHTK_CLI_USAGE_ERROR(3)

shtk_cli_usage_error —
Prints a usage error and exits

shtk_import cli

shtk_cli_usage_error message1 [.. messageN]

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.

shtk(3), shtk_cli(3)

shtk_cli_usage_error first appeared in shtk 1.0.
November 5, 2014 FreeBSD 13.1-RELEASE
Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.