summaryrefslogtreecommitdiff
path: root/functions/usage.sh
blob: 38876389500cbe7dca24a63407a3a05ad528765c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
#!/bin/sh

## live-build(7) - System Build Scripts
## Copyright (C) 2016-2020 The Debian Live team
## Copyright (C) 2006-2015 Daniel Baumann <mail@daniel-baumann.ch>
##
## This program comes with ABSOLUTELY NO WARRANTY; for details see COPYING.
## This is free software, and you are welcome to redistribute it
## under certain conditions; see COPYING for details.


Usage ()
{
	if [ -z "${1}" ]; then
		Echo_error "Usage() requires an exit code"
	fi

	echo "${PROGRAM_NAME} - ${DESCRIPTION}"
	printf "\nUsage:\n\n"

	if [ -n "${USAGE}" ]; then
		# printf without placeholder required here for correct \t and \n formatting of `lb config` usage string
		printf "  ${USAGE}\n"
	fi

	echo "  ${PROGRAM} [-h|--help]"
	echo "  ${PROGRAM} [-u|--usage]"
	echo "  ${PROGRAM} [-v|--version]"
	echo
	echo "Try \"${PROGRAM} --help\" for more information."

	exit $1
}