SHTK_CLI_ERROR(3)

💖 NAME 💖

okay bestie, welcome to the SHTK_CLI_ERROR(3) page — it’s serving Library Functions Manual energy, and it’s all about shtk_cli_error, the function that prints a runtime error message and exits. Very “we are ending this script with receipts” of it. 💅

🎀 LIBRARY 🎀

You get this one by importing the CLI library: shtk_import cli.

✨ SYNOPSIS ✨

shtk_cli_error message1 [.. messageN]

🦋 DESCRIPTION 🦋

The function shtk_cli_error prints the given runtime error message to stderr and then terminates execution of the script with a return value of 1. It is literally the bail-out button. 😭

The message can be handed over as one or more arguments — that’s the message1 to messageN situation — and all arguments are concatenated together into a single line. So yes bestie, you can pass multiple pieces and they get smushed into one line. 🫶

The printed message has this exact form, where progname is determined by shtk_cli_progname(3):

progname: E: message1 .. messageN

Use shtk_cli_error when you need to bail out on erroneous conditions that are not directly caused by an invalid invocation of the script. For errors caused directly by the user — like specifying an incorrect flag to the program — report them with shtk_cli_usage_error(3). That’s the vibe check: wrong user flag goes to usage error, other runtime oops goes here. 💀

🌈 SEE ALSO 🌈

• shtk(3)
• shtk_cli(3)

👑 HISTORY 👑

shtk_cli_error first appeared in shtk 1.0. Iconic. ⭐

okay that’s the whole page, bestie — the footer says Debian and November 5, 2014, so that’s the source/version + date tea. mwah 💋