normalize help messages

9 files changed, 28 insertions, 19 deletions

diff --git a/pbs-convert-absgit b/pbs-convert-absgit
index 9e82330..9db6190 100755
--- a/pbs-convert-absgit
+++ b/pbs-convert-absgit
@@ -184,7 +184,7 @@ convert-arches() {
 
 usage() {
 	echo "Usage: ${0##*/} SOURCE"
-	echo "Convert the absgit format SOURCE to pbs format"
+	echo "Convert SOURCE from the absgit format to the pbs format."
 	echo
 	echo "SOURCE must be configured in /etc/libretools.d/pbs-convert.conf"
 }
diff --git a/pbs-help b/pbs-help
index c2a753f..b60fad9 100755
--- a/pbs-help
+++ b/pbs-help
@@ -11,6 +11,9 @@ list_commands() {
 
 master_usage() {
 	echo "Usage: ${stem} COMMAND [OPTIONS]"
+	echo "Parabola Build System"
+	echo
+	echo "plumb-* commands are for internal use."
 	echo
 	echo "Commands:"
 	list_commands | while read -r cmd; do
@@ -21,7 +24,7 @@ master_usage() {
 
 help_usage() {
 	echo "Usage: ${stem} help [OPTIONS] COMMAND"
-	echo "Shows the manual page for a command"
+	echo "Shows the manual page for a command."
 	echo ''
 	echo 'Options:'
 	echo '  -h            Show this message'
diff --git a/pbs-init b/pbs-init
index b3b6ba4..1a18911 100755
--- a/pbs-init
+++ b/pbs-init
@@ -5,7 +5,7 @@
 cmd=${0##*/}
 usage() {
 	echo "Usage: $cmd [OPTIONS] [DIRECTORY]"
-	echo 'Creates a new pbs repository'
+	echo 'Creates a new pbs repository.'
 	echo ''
 	echo 'Options:'
 	echo '  -h            Show this message'
diff --git a/pbs-package-commit b/pbs-package-commit
index 3b3dfe5..779d1e8 100755
--- a/pbs-package-commit
+++ b/pbs-package-commit
@@ -5,19 +5,19 @@
 cmd=${0##*/}
 usage() {
 	echo "Usage: $cmd [git-commit OPTIONS]"
-	echo 'Commits to a package (run from the package directory).'
-	echo ''
+	echo 'Commits changes to a package. (from pkg dir)'
+	echo
 	echo 'This is like `git commit`, but cascades up out of the submodule.'
 	echo 'It is simply:'
 	echo
 	echo '    git commit "$@"'
 	echo '    pbs-package-postcommit'
-	echo ''
+	echo
 	echo 'Options:'
 	echo '  -h            Show this message'
-	echo ''
+	echo
 	echo ' ====================== `git commit` usage ======================'
-	echo ''
+	echo
 	git commit -h 2>&1 || true
 }
 
diff --git a/pbs-package-merge b/pbs-package-merge
index eca9d1b..1291f68 100755
--- a/pbs-package-merge
+++ b/pbs-package-merge
@@ -5,11 +5,11 @@
 cmd=${0##*/}
 usage() {
 	echo "Usage: $cmd [OPTIONS]"
-	echo 'Fetches and merges changes from an upstream package'
-	echo ''
+	echo 'Merges changes from an upstream package. (from pkg dir)'
+	echo
 	echo 'The repository and refspec that are merged are controlled by the'
 	echo 'file `pbstrack`.'
-	echo ''
+	echo
 	echo 'Options:'
 	echo '  -h            Show this message'
 }
diff --git a/pbs-package-new b/pbs-package-new
index 42a62cb..2a15ea9 100755
--- a/pbs-package-new
+++ b/pbs-package-new
@@ -5,8 +5,8 @@
 cmd=${0##*/}
 usage() {
 	echo "Usage: $cmd [OPTIONS] REPO/PACKAGE"
-	echo 'Creates a new package'
-	echo ''
+	echo 'Creates a new package.'
+	echo
 	echo 'Options:'
 	echo '  -h            Show this message'
 }
diff --git a/pbs-package-postcommit b/pbs-package-postcommit
index e8ff196..0a02af7 100755
--- a/pbs-package-postcommit
+++ b/pbs-package-postcommit
@@ -5,10 +5,10 @@
 cmd=${0##*/}
 usage() {
 	echo "Usage: $cmd [git-commit OPTIONS]"
-	echo 'Call this after doing a `git commit` manually.'
-	echo ''
+	echo 'Call after doing a `git commit` manually. (from pkg dir)'
+	echo
 	echo 'This cascades the commit up out of the submodule.'
-	echo ''
+	echo
 	echo 'Options:'
 	echo '  -h            Show this message'
 }
diff --git a/pbs-plumb-config b/pbs-plumb-config
index d885256..1a1f859 100755
--- a/pbs-plumb-config
+++ b/pbs-plumb-config
@@ -24,12 +24,15 @@ get() {
 }
 
 usage() {
-	echo "Usage: ${0##*/} COMMAND [COMMAND-ARGUMENTS]"
-	echo "Work with /etc/libretools.d/pbs-convert.conf"
+	echo "Usage: ${0##*/} COMMAND [-h] [COMMAND-ARGUMENTS]"
+	echo 'Work with `/etc/libretools.d/pbs-convert.conf`.'
 	echo
 	echo "Commands:"
 	echo "  list          List the variables set in the file"
 	echo "  get VARNAME   Get the value of VARNAME"
+	echo
+	echo 'Options:'
+	echo '  -h            Show this message'
 }
 
 main() {
diff --git a/pbs-plumb-download b/pbs-plumb-download
index 1ba4e68..a03d0fc 100755
--- a/pbs-plumb-download
+++ b/pbs-plumb-download
@@ -20,7 +20,10 @@
 
 usage() {
 	echo "Usage: ${0##*/} SOURCE"
-	echo "Downloads a source as configured in pbs-convert.conf"
+	echo 'Downloads a source as configured in `pbs-convert.conf`.'
+	echo
+	echo 'Options:'
+	echo '  -h            Show this message'
 }
 
 main() {