builtins/help.def

   1 This file is help.def, from which is created help.c.
   2 It implements the builtin "help" in Bash.
   3
   4 Copyright (C) 1987-2002 Free Software Foundation, Inc.
   5
   6 This file is part of GNU Bash, the Bourne Again SHell.
   7
   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
  11 version.
  12
  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
  16 for more details.
  17
  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.
  21
  22 $PRODUCES help.c
  23
  24 $BUILTIN help
  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.
  33 $END
  34
  35 #include <config.h>
  36
  37 #if defined (HELP_BUILTIN)
  38 #include <stdio.h>
  39
  40 #if defined (HAVE_UNISTD_H)
  41 #  ifdef _MINIX
  42 #    include <sys/types.h>
  43 #  endif
  44 #  include <unistd.h>
  45 #endif
  46
  47 #include <errno.h>
  48
  49 #include <filecntl.h>
  50
  51 #include "../shell.h"
  52 #include "../builtins.h"
  53 #include "../pathexp.h"
  54 #include "common.h"
  55 #include "bashgetopt.h"
  56
  57 #include <glob/strmatch.h>
  58 #include <glob/glob.h>
  59
  60 #ifndef errno
  61 extern int errno;
  62 #endif
  63
  64 static void show_builtin_command_help __P((void));
  65 static void show_longdoc __P((int));
  66
  67 /* Print out a list of the known functions in the shell, and what they do.
  68    If LIST is supplied, print out the list which matches for each pattern
  69    specified. */
  70 int
  71 help_builtin (list)
  72      WORD_LIST *list;
  73 {
  74   register int i;
  75   char *pattern, *name;
  76   int plen, match_found, sflag;
  77
  78   sflag = 0;
  79   reset_internal_getopt ();
  80   while ((i = internal_getopt (list, "s")) != -1)
  81     {
  82       switch (i)
  83         {
  84         case 's':
  85           sflag = 1;
  86           break;
  87         default:
  88           builtin_usage ();
  89           return (EX_USAGE);
  90         }
  91     }
  92   list = loptend;
  93
  94   if (list == 0)
  95     {
  96       show_shell_version (0);
  97       show_builtin_command_help ();
  98       return (EXECUTION_SUCCESS);
  99     }
 100
 101   /* We should consider making `help bash' do something. */
 102
 103   if (glob_pattern_p (list->word->word))
 104     {
 105       printf ("Shell commands matching keyword%s `", list->next ? "s" : "");
 106       print_word_list (list, ", ");
 107       printf ("'\n\n");
 108     }
 109
 110   for (match_found = 0, pattern = ""; list; list = list->next)
 111     {
 112       pattern = list->word->word;
 113       plen = strlen (pattern);
 114
 115       for (i = 0; name = shell_builtins[i].name; i++)
 116         {
 117           QUIT;
 118           if ((strncmp (pattern, name, plen) == 0) ||
 119               (strmatch (pattern, name, FNMATCH_EXTFLAG) != FNM_NOMATCH))
 120             {
 121               printf ("%s: %s\n", name, shell_builtins[i].short_doc);
 122
 123               if (sflag == 0)
 124                 show_longdoc (i);
 125
 126               match_found++;
 127             }
 128         }
 129     }
 130
 131   if (match_found == 0)
 132     {
 133       builtin_error ("no help topics match `%s'.  Try `help help' or `man -k %s' or `info %s'.", pattern, pattern, pattern);
 134       return (EXECUTION_FAILURE);
 135     }
 136
 137   fflush (stdout);
 138   return (EXECUTION_SUCCESS);
 139 }
 140
 141 /* By convention, enforced by mkbuiltins.c, if separate help files are being
 142    used, the long_doc array contains one string -- the full pathname of the
 143    help file for this builtin.  */
 144 static void
 145 show_longdoc (i)
 146      int i;
 147 {
 148   register int j;
 149   char * const *doc;
 150   int fd;
 151
 152   doc = shell_builtins[i].long_doc;
 153
 154   if (doc && doc[0] && *doc[0] == '/' && doc[1] == (char *)NULL)
 155     {
 156       fd = open (doc[0], O_RDONLY);
 157       if (fd == -1)
 158         {
 159           builtin_error ("%s: cannot open: %s", doc[0], strerror (errno));
 160           return;
 161         }
 162       zcatfd (fd, 1, doc[0]);
 163       close (fd);
 164     }
 165   else
 166     for (j = 0; doc[j]; j++)
 167       printf ("    %s\n", doc[j]);
 168 }
 169
 170 static void
 171 show_builtin_command_help ()
 172 {
 173   int i, j;
 174   char blurb[36];
 175
 176   printf (
 177 "These shell commands are defined internally.  Type `help' to see this list.\n\
 178 Type `help name' to find out more about the function `name'.\n\
 179 Use `info bash' to find out more about the shell in general.\n\
 180 Use `man -k' or `info' to find out more about commands not in this list.\n\
 181 \n\
 182 A star (*) next to a name means that the command is disabled.\n\
 183 \n");
 184
 185   for (i = 0; i < num_shell_builtins; i++)
 186     {
 187       QUIT;
 188       blurb[0] = (shell_builtins[i].flags & BUILTIN_ENABLED) ? ' ' : '*';
 189       strncpy (blurb + 1, shell_builtins[i].short_doc, 34);
 190       blurb[35] = '\0';
 191       printf ("%s", blurb);
 192
 193       if (i % 2)
 194         printf ("\n");
 195       else
 196         for (j = strlen (blurb); j < 35; j++)
 197           putc (' ', stdout);
 198     }
 199   if (i % 2)
 200     printf ("\n");
 201 }
 202 #endif /* HELP_BUILTIN */