aboutsummaryrefslogtreecommitdiffstats
path: root/becommands/help.py
blob: 1c99af57737faf3366528fb4b4127abd132c7373 (plain) (blame)
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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# Copyright (C) 2006 Thomas Gerigk
# <tgerigk@gmx.de>
#
#    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 2 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, write to the Free Software
#    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
"""Print help for given subcommand"""
from libbe import cmdutil, utility
__desc__ = __doc__

def execute(args):
    """
    Print help of specified command.
    >>> execute(["help"])
    Usage: be help [COMMAND]
    <BLANKLINE>
    Options:
      -h, --help  Print a help message
    <BLANKLINE>
    Print help for specified command or list of all commands.
    <BLANKLINE>
    """
    options, args = get_parser().parse_args(args)
    if len(args) > 1:
        raise cmdutil.UsageError("Too many arguments.")
    if len(args) == 0:
        print cmdutil.help()
    else:
        try:
            print cmdutil.help(args[0])
        except AttributeError:
            print "No help available"    

def get_parser():
    parser = cmdutil.CmdOptionParser("be help [COMMAND]")
    return parser

longhelp="""
Print help for specified command or list of all commands.
"""

def help():
    return get_parser().help_str() + longhelp