1 This file is help.def, from which is created help.c.
2 It implements the builtin "help" in Bash.
4 Copyright (C) 1987, 1989, 1991 Free Software Foundation, Inc.
6 This file is part of GNU Bash, the Bourne Again SHell.
8 Bash is free software; you can redistribute it and/or modify it under
9 the terms of the GNU General Public License as published by the Free
10 Software Foundation; either version 2, or (at your option) any later
13 Bash is distributed in the hope that it will be useful, but WITHOUT ANY
14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 You should have received a copy of the GNU General Public License along
19 with Bash; see the file COPYING. If not, write to the Free Software
20 Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA.
25 $FUNCTION help_builtin
26 $DEPENDS_ON HELP_BUILTIN
27 $SHORT_DOC help [-s] [pattern ...]
28 Display helpful information about builtin commands. If PATTERN is
29 specified, gives detailed help on all commands matching PATTERN,
30 otherwise a list of the builtins is printed. The -s option
31 restricts the output for each builtin command matching PATTERN to
32 a short usage synopsis.
37 #if defined (HELP_BUILTIN)
40 #if defined (HAVE_UNISTD_H)
42 # include <sys/types.h>
48 #include "../builtins.h"
49 #include "../pathexp.h"
50 #include "bashgetopt.h"
52 #include <glob/fnmatch.h>
53 #include <glob/glob.h>
55 extern void builtin_error ();
56 extern void builtin_usage ();
58 static void show_builtin_command_help ();
60 /* Print out a list of the known functions in the shell, and what they do.
61 If LIST is supplied, print out the list which matches for each pattern
69 int plen, match_found, sflag;
72 reset_internal_getopt ();
73 while ((i = internal_getopt (list, "s")) != -1)
89 show_shell_version (0);
90 show_builtin_command_help ();
91 return (EXECUTION_SUCCESS);
94 /* We should consider making `help bash' do something. */
96 if (glob_pattern_p (list->word->word))
98 printf ("Shell commands matching keyword%s `", list->next ? "s" : "");
99 print_word_list (list, ", ");
103 for (match_found = 0, pattern = ""; list; list = list->next)
105 pattern = list->word->word;
106 plen = strlen (pattern);
108 for (i = 0; name = shell_builtins[i].name; i++)
111 if ((strncmp (pattern, name, plen) == 0) ||
112 (fnmatch (pattern, name, FNMATCH_EXTFLAG) != FNM_NOMATCH))
114 printf ("%s: %s\n", name, shell_builtins[i].short_doc);
117 for (j = 0; shell_builtins[i].long_doc[j]; j++)
118 printf (" %s\n", shell_builtins[i].long_doc[j]);
125 if (match_found == 0)
127 builtin_error ("no help topics match `%s'. Try `help help'.", pattern);
128 return (EXECUTION_FAILURE);
132 return (EXECUTION_SUCCESS);
136 show_builtin_command_help ()
142 "These shell commands are defined internally. Type `help' to see this list.\n\
143 Type `help name' to find out more about the function `name'.\n\
144 Use `info bash' to find out more about the shell in general.\n\
146 A star (*) next to a name means that the command is disabled.\n\
149 for (i = 0; i < num_shell_builtins; i++)
152 blurb[0] = (shell_builtins[i].flags & BUILTIN_ENABLED) ? ' ' : '*';
153 strncpy (blurb + 1, shell_builtins[i].short_doc, 34);
155 printf ("%s", blurb);
160 for (j = strlen (blurb); j < 35; j++)
166 #endif /* HELP_BUILTIN */