lib/cmd/help.sh


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
34
35
36
37

# pro-archman
# lib/cmd/help.sh
# "help" command
#
# Copyright (C) 2013  Patrick "P. J." McDermott
#
# 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, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

cmd_summary 'print this help message'
cmd_usage '[<command>]'

cmd_help_main()
{
	local cmd

	if [ ${#} -eq 1 ]; then
		cmd="${1}"
		if is_cmd "${cmd}"; then
			print_cmd_usage "${cmd}"
			return 0
		fi
	fi

	printf 'Usage: %s <command>\n\nWhere <command> is one of:\n' "${0}"
	print_cmd_summaries
}