util/pb-console: Packaging updates

In preparation for packaging add a man page, a help option, and some
comments to the script.

Signed-off-by: Geoff Levand <geoff@infradead.org>

1 files changed, 19 insertions, 2 deletions

diff --git a/utils/pb-console b/utils/pb-console
index 636c5ad..c96ac98 100644
--- a/utils/pb-console
+++ b/utils/pb-console
@@ -1,16 +1,33 @@
 #!/bin/sh
+#
+# Petitboot utility script for running a petitboot UI program
+# on a console tty.
+#
 
 ui=petitboot-nc
 shell=sh
 
 detach=0
 
+usage() {
+	echo "pb-console [OPTIONS] console_dev" >&2
+	echo "OPTIONS" >&2
+	echo "     -d, --detach" >&2
+	echo "             Start in a detached (background) state." >&2
+	echo "     -h, --help" >&2
+	echo "             Print a help message." >&2
+	exit 1
+}
+
 while [ -n "$1" ]
 do
 	case "$1" in
-	-d)
+	--detach | -d)
 		detach=1
 		;;
+	--help | -h)
+		usage
+		;;
 	--)
 		;;
 	*)
@@ -29,7 +46,7 @@ pb_loop() {
 	while :
 	do
 		$ui
-		echo "Exiting petitboot. Type 'exit' to return"
+		echo "Exiting petitboot. Type 'exit' to return."
 		$shell
 	done
 }