opensde-nopast/lib/sde-help.in

# --- SDE-COPYRIGHT-NOTE-BEGIN ---
# This copyright note is auto-generated by ./scripts/Create-CopyPatch.
# 
# Filename: lib/sde-help.in
# Copyright (C) 2006 - 2007 The OpenSDE Project
# 
# More information can be found in the files COPYING and README.
# 
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; version 2 of the License. A copy of the
# GNU General Public License can be found in the file COPYING.
# --- SDE-COPYRIGHT-NOTE-END ---

#Description: Help about the usage of `sde` and the modules
#Alias: --help

help_command() {
	if [ -r "$SDEROOT/lib/sde-$1.hlp" ]; then
		grep -v '^#' "$SDEROOT/lib/sde-$1.hlp"
	else
		echo_warning "'$COLOR_MESSAGE${1}$COLOR_NORMAL' doesn't provide help."
	fi
}

help_list() {
	local command=
	local name= desc= alias=

	echo "Available Commands:"
	for command in $SDEROOT/bin/sde-*; do
		# detect command name
		id=$( echo "$command" | sed -e 's,.*/sde-,,' )
		# optional description
		desc=$( sed -n -e 's,^#Description: \(.*\)$,\1,p' "$command" )
		# and valid aliases
		alias=$( sed -n -e 's,^#Alias: \([^ ]*\)$,\1,p' "$command" | tr '\n' ' ' )

		echo -e "\t* $id${alias:+\t(${alias%% })}"
		if [ -n "$desc" ]; then
			echo -e "\t\t$desc"
		fi
	done
}