gdb/main.c

   1 /* Top level stuff for GDB, the GNU debugger.
   2    Copyright 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995,
   3    1996, 1997, 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; if not, write to the Free Software
  19    Foundation, Inc., 59 Temple Place - Suite 330,
  20    Boston, MA 02111-1307, USA.  */
  21
  22 #include "defs.h"
  23 #include "top.h"
  24 #include "target.h"
  25 #include "inferior.h"
  26 #include "symfile.h"
  27 #include "gdbcore.h"
  28
  29 #include "getopt.h"
  30
  31 #include <sys/types.h>
  32 #include "gdb_stat.h"
  33 #include <ctype.h>
  34
  35 #include "gdb_string.h"
  36 #include "event-loop.h"
  37 #include "ui-out.h"
  38
  39 /* If nonzero, display time usage both at startup and for each command.  */
  40
  41 int display_time;
  42
  43 /* If nonzero, display space usage both at startup and for each command.  */
  44
  45 int display_space;
  46
  47 /* Whether this is the async version or not.  The async version is
  48    invoked on the command line with the -nw --async options.  In this
  49    version, the usual command_loop is substituted by and event loop which
  50    processes UI events asynchronously. */
  51 int event_loop_p = 1;
  52
  53 #ifdef UI_OUT
  54 /* Has an interpreter been specified and if so, which. */
  55 char *interpreter_p;
  56 #endif
  57
  58 /* Whether this is the command line version or not */
  59 int tui_version = 0;
  60
  61 /* Whether xdb commands will be handled */
  62 int xdb_commands = 0;
  63
  64 /* Whether dbx commands will be handled */
  65 int dbx_commands = 0;
  66
  67 struct ui_file *gdb_stdout;
  68 struct ui_file *gdb_stderr;
  69 struct ui_file *gdb_stdlog;
  70 struct ui_file *gdb_stdtarg;
  71
  72 /* Used to initialize error() - defined in utils.c */
  73
  74 extern void error_init (void);
  75
  76 /* Whether to enable writing into executable and core files */
  77 extern int write_files;
  78
  79 static void print_gdb_help (struct ui_file *);
  80
  81 /* These two are used to set the external editor commands when gdb is farming
  82    out files to be edited by another program. */
  83
  84 extern char *external_editor_command;
  85
  86 /* Call command_loop.  If it happens to return, pass that through as a
  87    non-zero return status. */
  88
  89 static int
  90 captured_command_loop (void *data)
  91 {
  92   if (command_loop_hook == NULL)
  93     command_loop ();
  94   else
  95     command_loop_hook ();
  96   /* FIXME: cagney/1999-11-05: A correct command_loop() implementaton
  97      would clean things up (restoring the cleanup chain) to the state
  98      they were just prior to the call.  Technically, this means that
  99      the do_cleanups() below is redundant.  Unfortunately, many FUNCs
 100      are not that well behaved.  do_cleanups should either be replaced
 101      with a do_cleanups call (to cover the problem) or an assertion
 102      check to detect bad FUNCs code. */
 103   do_cleanups (ALL_CLEANUPS);
 104   /* If the command_loop returned, normally (rather than threw an
 105      error) we try to quit. If the quit is aborted, catch_errors()
 106      which called this catch the signal and restart the command
 107      loop. */
 108   quit_command (NULL, instream == stdin);
 109   return 1;
 110 }
 111
 112 struct captured_main_args
 113   {
 114     int argc;
 115     char **argv;
 116   };
 117
 118 static int
 119 captured_main (void *data)
 120 {
 121   struct captured_main_args *context = data;
 122   int argc = context->argc;
 123   char **argv = context->argv;
 124   int count;
 125   static int quiet = 0;
 126   static int batch = 0;
 127
 128   /* Pointers to various arguments from command line.  */
 129   char *symarg = NULL;
 130   char *execarg = NULL;
 131   char *corearg = NULL;
 132   char *cdarg = NULL;
 133   char *ttyarg = NULL;
 134
 135   /* These are static so that we can take their address in an initializer.  */
 136   static int print_help;
 137   static int print_version;
 138
 139   /* Pointers to all arguments of --command option.  */
 140   char **cmdarg;
 141   /* Allocated size of cmdarg.  */
 142   int cmdsize;
 143   /* Number of elements of cmdarg used.  */
 144   int ncmd;
 145
 146   /* Indices of all arguments of --directory option.  */
 147   char **dirarg;
 148   /* Allocated size.  */
 149   int dirsize;
 150   /* Number of elements used.  */
 151   int ndir;
 152
 153   struct stat homebuf, cwdbuf;
 154   char *homedir, *homeinit;
 155
 156   register int i;
 157
 158   long time_at_startup = get_run_time ();
 159
 160   START_PROGRESS (argv[0], 0);
 161
 162 #ifdef MPW
 163   /* Do all Mac-specific setup. */
 164   mac_init ();
 165 #endif /* MPW */
 166
 167   /* This needs to happen before the first use of malloc.  */
 168   init_malloc ((PTR) NULL);
 169
 170 #if defined (ALIGN_STACK_ON_STARTUP)
 171   i = (int) &count & 0x3;
 172   if (i != 0)
 173     alloca (4 - i);
 174 #endif
 175
 176   cmdsize = 1;
 177   cmdarg = (char **) xmalloc (cmdsize * sizeof (*cmdarg));
 178   ncmd = 0;
 179   dirsize = 1;
 180   dirarg = (char **) xmalloc (dirsize * sizeof (*dirarg));
 181   ndir = 0;
 182
 183   quit_flag = 0;
 184   line = (char *) xmalloc (linesize);
 185   line[0] = '\0';               /* Terminate saved (now empty) cmd line */
 186   instream = stdin;
 187
 188   getcwd (gdb_dirbuf, sizeof (gdb_dirbuf));
 189   current_directory = gdb_dirbuf;
 190
 191   gdb_stdout = stdio_fileopen (stdout);
 192   gdb_stderr = stdio_fileopen (stderr);
 193   gdb_stdlog = gdb_stderr;      /* for moment */
 194   gdb_stdtarg = gdb_stderr;     /* for moment */
 195
 196   /* initialize error() */
 197   error_init ();
 198
 199   /* Parse arguments and options.  */
 200   {
 201     int c;
 202     /* When var field is 0, use flag field to record the equivalent
 203        short option (or arbitrary numbers starting at 10 for those
 204        with no equivalent).  */
 205     static struct option long_options[] =
 206     {
 207       {"async", no_argument, &event_loop_p, 1},
 208       {"noasync", no_argument, &event_loop_p, 0},
 209 #if defined(TUI)
 210       {"tui", no_argument, &tui_version, 1},
 211 #endif
 212       {"xdb", no_argument, &xdb_commands, 1},
 213       {"dbx", no_argument, &dbx_commands, 1},
 214       {"readnow", no_argument, &readnow_symbol_files, 1},
 215       {"r", no_argument, &readnow_symbol_files, 1},
 216       {"mapped", no_argument, &mapped_symbol_files, 1},
 217       {"m", no_argument, &mapped_symbol_files, 1},
 218       {"quiet", no_argument, &quiet, 1},
 219       {"q", no_argument, &quiet, 1},
 220       {"silent", no_argument, &quiet, 1},
 221       {"nx", no_argument, &inhibit_gdbinit, 1},
 222       {"n", no_argument, &inhibit_gdbinit, 1},
 223       {"batch", no_argument, &batch, 1},
 224       {"epoch", no_argument, &epoch_interface, 1},
 225
 226     /* This is a synonym for "--annotate=1".  --annotate is now preferred,
 227        but keep this here for a long time because people will be running
 228        emacses which use --fullname.  */
 229       {"fullname", no_argument, 0, 'f'},
 230       {"f", no_argument, 0, 'f'},
 231
 232       {"annotate", required_argument, 0, 12},
 233       {"help", no_argument, &print_help, 1},
 234       {"se", required_argument, 0, 10},
 235       {"symbols", required_argument, 0, 's'},
 236       {"s", required_argument, 0, 's'},
 237       {"exec", required_argument, 0, 'e'},
 238       {"e", required_argument, 0, 'e'},
 239       {"core", required_argument, 0, 'c'},
 240       {"c", required_argument, 0, 'c'},
 241       {"command", required_argument, 0, 'x'},
 242       {"version", no_argument, &print_version, 1},
 243       {"x", required_argument, 0, 'x'},
 244 #ifdef GDBTK
 245       {"tclcommand", required_argument, 0, 'z'},
 246       {"enable-external-editor", no_argument, 0, 'y'},
 247       {"editor-command", required_argument, 0, 'w'},
 248 #endif
 249 #ifdef UI_OUT
 250       {"ui", required_argument, 0, 'i'},
 251       {"interpreter", required_argument, 0, 'i'},
 252       {"i", required_argument, 0, 'i'},
 253 #endif
 254       {"directory", required_argument, 0, 'd'},
 255       {"d", required_argument, 0, 'd'},
 256       {"cd", required_argument, 0, 11},
 257       {"tty", required_argument, 0, 't'},
 258       {"baud", required_argument, 0, 'b'},
 259       {"b", required_argument, 0, 'b'},
 260       {"nw", no_argument, &use_windows, 0},
 261       {"nowindows", no_argument, &use_windows, 0},
 262       {"w", no_argument, &use_windows, 1},
 263       {"windows", no_argument, &use_windows, 1},
 264       {"statistics", no_argument, 0, 13},
 265       {"write", no_argument, &write_files, 1},
 266 /* Allow machine descriptions to add more options... */
 267 #ifdef ADDITIONAL_OPTIONS
 268       ADDITIONAL_OPTIONS
 269 #endif
 270       {0, no_argument, 0, 0}
 271     };
 272
 273     while (1)
 274       {
 275         int option_index;
 276
 277         c = getopt_long_only (argc, argv, "",
 278                               long_options, &option_index);
 279         if (c == EOF)
 280           break;
 281
 282         /* Long option that takes an argument.  */
 283         if (c == 0 && long_options[option_index].flag == 0)
 284           c = long_options[option_index].val;
 285
 286         switch (c)
 287           {
 288           case 0:
 289             /* Long option that just sets a flag.  */
 290             break;
 291           case 10:
 292             symarg = optarg;
 293             execarg = optarg;
 294             break;
 295           case 11:
 296             cdarg = optarg;
 297             break;
 298           case 12:
 299             /* FIXME: what if the syntax is wrong (e.g. not digits)?  */
 300             annotation_level = atoi (optarg);
 301             break;
 302           case 13:
 303             /* Enable the display of both time and space usage.  */
 304             display_time = 1;
 305             display_space = 1;
 306             break;
 307           case 'f':
 308             annotation_level = 1;
 309 /* We have probably been invoked from emacs.  Disable window interface.  */
 310             use_windows = 0;
 311             break;
 312           case 's':
 313             symarg = optarg;
 314             break;
 315           case 'e':
 316             execarg = optarg;
 317             break;
 318           case 'c':
 319             corearg = optarg;
 320             break;
 321           case 'x':
 322             cmdarg[ncmd++] = optarg;
 323             if (ncmd >= cmdsize)
 324               {
 325                 cmdsize *= 2;
 326                 cmdarg = (char **) xrealloc ((char *) cmdarg,
 327                                              cmdsize * sizeof (*cmdarg));
 328               }
 329             break;
 330 #ifdef GDBTK
 331           case 'z':
 332             {
 333 extern int gdbtk_test (char *);
 334               if (!gdbtk_test (optarg))
 335                 {
 336                   fprintf_unfiltered (gdb_stderr, "%s: unable to load tclcommand file \"%s\"",
 337                                       argv[0], optarg);
 338                   exit (1);
 339                 }
 340               break;
 341             }
 342           case 'y':
 343             /* Backwards compatibility only.  */
 344             break;
 345           case 'w':
 346             {
 347               external_editor_command = xstrdup (optarg);
 348               break;
 349             }
 350 #endif /* GDBTK */
 351 #ifdef UI_OUT
 352           case 'i':
 353             interpreter_p = optarg;
 354             break;
 355 #endif
 356           case 'd':
 357             dirarg[ndir++] = optarg;
 358             if (ndir >= dirsize)
 359               {
 360                 dirsize *= 2;
 361                 dirarg = (char **) xrealloc ((char *) dirarg,
 362                                              dirsize * sizeof (*dirarg));
 363               }
 364             break;
 365           case 't':
 366             ttyarg = optarg;
 367             break;
 368           case 'q':
 369             quiet = 1;
 370             break;
 371           case 'b':
 372             {
 373               int i;
 374               char *p;
 375
 376               i = strtol (optarg, &p, 0);
 377               if (i == 0 && p == optarg)
 378
 379                 /* Don't use *_filtered or warning() (which relies on
 380                    current_target) until after initialize_all_files(). */
 381
 382                 fprintf_unfiltered
 383                   (gdb_stderr,
 384                    "warning: could not set baud rate to `%s'.\n", optarg);
 385               else
 386                 baud_rate = i;
 387             }
 388           case 'l':
 389             {
 390               int i;
 391               char *p;
 392
 393               i = strtol (optarg, &p, 0);
 394               if (i == 0 && p == optarg)
 395
 396                 /* Don't use *_filtered or warning() (which relies on
 397                    current_target) until after initialize_all_files(). */
 398
 399                 fprintf_unfiltered
 400                   (gdb_stderr,
 401                  "warning: could not set timeout limit to `%s'.\n", optarg);
 402               else
 403                 remote_timeout = i;
 404             }
 405             break;
 406
 407 #ifdef ADDITIONAL_OPTION_CASES
 408             ADDITIONAL_OPTION_CASES
 409 #endif
 410           case '?':
 411             fprintf_unfiltered (gdb_stderr,
 412                         "Use `%s --help' for a complete list of options.\n",
 413                                 argv[0]);
 414             exit (1);
 415           }
 416       }
 417
 418     /* If --help or --version, disable window interface.  */
 419     if (print_help || print_version)
 420       {
 421         use_windows = 0;
 422 #ifdef TUI
 423         /* Disable the TUI as well.  */
 424         tui_version = 0;
 425 #endif
 426       }
 427
 428 #ifdef TUI
 429     /* An explicit --tui flag overrides the default UI, which is the
 430        window system.  */
 431     if (tui_version)
 432       use_windows = 0;
 433 #endif
 434
 435     /* OK, that's all the options.  The other arguments are filenames.  */
 436     count = 0;
 437     for (; optind < argc; optind++)
 438       switch (++count)
 439         {
 440         case 1:
 441           symarg = argv[optind];
 442           execarg = argv[optind];
 443           break;
 444         case 2:
 445           /* FIXME: The documentation says this can be a "ProcID". as well. */
 446           corearg = argv[optind];
 447           break;
 448         case 3:
 449           fprintf_unfiltered (gdb_stderr,
 450                           "Excess command line arguments ignored. (%s%s)\n",
 451                           argv[optind], (optind == argc - 1) ? "" : " ...");
 452           break;
 453         }
 454     if (batch)
 455       quiet = 1;
 456   }
 457
 458   /* Initialize all files.  Give the interpreter a chance to take
 459      control of the console via the init_ui_hook()) */
 460   gdb_init (argv[0]);
 461
 462   /* Do these (and anything which might call wrap_here or *_filtered)
 463      after initialize_all_files.  */
 464   if (print_version)
 465     {
 466       print_gdb_version (gdb_stdout);
 467       wrap_here ("");
 468       printf_filtered ("\n");
 469       exit (0);
 470     }
 471
 472   if (print_help)
 473     {
 474       print_gdb_help (gdb_stdout);
 475       fputs_unfiltered ("\n", gdb_stdout);
 476       exit (0);
 477     }
 478
 479   if (!quiet)
 480     {
 481       /* Print all the junk at the top, with trailing "..." if we are about
 482          to read a symbol file (possibly slowly).  */
 483       print_gdb_version (gdb_stdout);
 484       if (symarg)
 485         printf_filtered ("..");
 486       wrap_here ("");
 487       gdb_flush (gdb_stdout);   /* Force to screen during slow operations */
 488     }
 489
 490   error_pre_print = "\n\n";
 491   quit_pre_print = error_pre_print;
 492
 493   /* We may get more than one warning, don't double space all of them... */
 494   warning_pre_print = "\nwarning: ";
 495
 496   /* Read and execute $HOME/.gdbinit file, if it exists.  This is done
 497      *before* all the command line arguments are processed; it sets
 498      global parameters, which are independent of what file you are
 499      debugging or what directory you are in.  */
 500   homedir = getenv ("HOME");
 501   if (homedir)
 502     {
 503       homeinit = (char *) alloca (strlen (homedir) +
 504                                   strlen (gdbinit) + 10);
 505       strcpy (homeinit, homedir);
 506       strcat (homeinit, "/");
 507       strcat (homeinit, gdbinit);
 508
 509       if (!inhibit_gdbinit)
 510         {
 511           catch_command_errors (source_command, homeinit, 0, RETURN_MASK_ALL);
 512         }
 513
 514       /* Do stats; no need to do them elsewhere since we'll only
 515          need them if homedir is set.  Make sure that they are
 516          zero in case one of them fails (this guarantees that they
 517          won't match if either exists).  */
 518
 519       memset (&homebuf, 0, sizeof (struct stat));
 520       memset (&cwdbuf, 0, sizeof (struct stat));
 521
 522       stat (homeinit, &homebuf);
 523       stat (gdbinit, &cwdbuf);  /* We'll only need this if
 524                                    homedir was set.  */
 525     }
 526
 527   /* Now perform all the actions indicated by the arguments.  */
 528   if (cdarg != NULL)
 529     {
 530       catch_command_errors (cd_command, cdarg, 0, RETURN_MASK_ALL);
 531     }
 532
 533   for (i = 0; i < ndir; i++)
 534     catch_command_errors (directory_command, dirarg[i], 0, RETURN_MASK_ALL);
 535   xfree (dirarg);
 536
 537   if (execarg != NULL
 538       && symarg != NULL
 539       && STREQ (execarg, symarg))
 540     {
 541       /* The exec file and the symbol-file are the same.  If we can't
 542          open it, better only print one error message.
 543          catch_command_errors returns non-zero on success! */
 544       if (catch_command_errors (exec_file_attach, execarg, !batch, RETURN_MASK_ALL))
 545         catch_command_errors (symbol_file_add_main, symarg, 0, RETURN_MASK_ALL);
 546     }
 547   else
 548     {
 549       if (execarg != NULL)
 550         catch_command_errors (exec_file_attach, execarg, !batch, RETURN_MASK_ALL);
 551       if (symarg != NULL)
 552         catch_command_errors (symbol_file_add_main, symarg, 0, RETURN_MASK_ALL);
 553     }
 554
 555   /* After the symbol file has been read, print a newline to get us
 556      beyond the copyright line...  But errors should still set off
 557      the error message with a (single) blank line.  */
 558   if (!quiet)
 559     printf_filtered ("\n");
 560   error_pre_print = "\n";
 561   quit_pre_print = error_pre_print;
 562   warning_pre_print = "\nwarning: ";
 563
 564   if (corearg != NULL)
 565     {
 566       if (catch_command_errors (core_file_command, corearg, !batch, RETURN_MASK_ALL) == 0)
 567         {
 568           /* See if the core file is really a PID. */
 569           if (isdigit (corearg[0]))
 570             catch_command_errors (attach_command, corearg, !batch, RETURN_MASK_ALL);
 571         }
 572     }
 573
 574   if (ttyarg != NULL)
 575     catch_command_errors (tty_command, ttyarg, !batch, RETURN_MASK_ALL);
 576
 577 #ifdef ADDITIONAL_OPTION_HANDLER
 578   ADDITIONAL_OPTION_HANDLER;
 579 #endif
 580
 581   /* Error messages should no longer be distinguished with extra output. */
 582   error_pre_print = NULL;
 583   quit_pre_print = NULL;
 584   warning_pre_print = "warning: ";
 585
 586   /* Read the .gdbinit file in the current directory, *if* it isn't
 587      the same as the $HOME/.gdbinit file (it should exist, also).  */
 588
 589   if (!homedir
 590       || memcmp ((char *) &homebuf, (char *) &cwdbuf, sizeof (struct stat)))
 591     if (!inhibit_gdbinit)
 592       {
 593         catch_command_errors (source_command, gdbinit, 0, RETURN_MASK_ALL);
 594       }
 595
 596   for (i = 0; i < ncmd; i++)
 597     {
 598 #if 0
 599       /* NOTE: cagney/1999-11-03: SET_TOP_LEVEL() was a macro that
 600          expanded into a call to setjmp().  */
 601       if (!SET_TOP_LEVEL ()) /* NB: This is #if 0'd out */
 602         {
 603           /* NOTE: I am commenting this out, because it is not clear
 604              where this feature is used. It is very old and
 605              undocumented. ezannoni: 1999-05-04 */
 606 #if 0
 607           if (cmdarg[i][0] == '-' && cmdarg[i][1] == '\0')
 608             read_command_file (stdin);
 609           else
 610 #endif
 611             source_command (cmdarg[i], !batch);
 612           do_cleanups (ALL_CLEANUPS);
 613         }
 614 #endif
 615       catch_command_errors (source_command, cmdarg[i], !batch, RETURN_MASK_ALL);
 616     }
 617   xfree (cmdarg);
 618
 619   /* Read in the old history after all the command files have been read. */
 620   init_history ();
 621
 622   if (batch)
 623     {
 624       /* We have hit the end of the batch file.  */
 625       exit (0);
 626     }
 627
 628   /* Do any host- or target-specific hacks.  This is used for i960 targets
 629      to force the user to set a nindy target and spec its parameters.  */
 630
 631 #ifdef BEFORE_MAIN_LOOP_HOOK
 632   BEFORE_MAIN_LOOP_HOOK;
 633 #endif
 634
 635   END_PROGRESS (argv[0]);
 636
 637   /* Show time and/or space usage.  */
 638
 639   if (display_time)
 640     {
 641       long init_time = get_run_time () - time_at_startup;
 642
 643       printf_unfiltered ("Startup time: %ld.%06ld\n",
 644                          init_time / 1000000, init_time % 1000000);
 645     }
 646
 647   if (display_space)
 648     {
 649 #ifdef HAVE_SBRK
 650       extern char **environ;
 651       char *lim = (char *) sbrk (0);
 652
 653       printf_unfiltered ("Startup size: data size %ld\n",
 654                          (long) (lim - (char *) &environ));
 655 #endif
 656     }
 657
 658 #if 0
 659   /* FIXME: cagney/1999-11-06: The original main loop was like: */
 660   while (1)
 661     {
 662       if (!SET_TOP_LEVEL ())
 663         {
 664           do_cleanups (ALL_CLEANUPS);   /* Do complete cleanup */
 665           /* GUIs generally have their own command loop, mainloop, or whatever.
 666              This is a good place to gain control because many error
 667              conditions will end up here via longjmp(). */
 668           if (command_loop_hook)
 669             command_loop_hook ();
 670           else
 671             command_loop ();
 672           quit_command ((char *) 0, instream == stdin);
 673         }
 674     }
 675   /* NOTE: If the command_loop() returned normally, the loop would
 676      attempt to exit by calling the function quit_command().  That
 677      function would either call exit() or throw an error returning
 678      control to SET_TOP_LEVEL. */
 679   /* NOTE: The function do_cleanups() was called once each time round
 680      the loop.  The usefulness of the call isn't clear.  If an error
 681      was thrown, everything would have already been cleaned up.  If
 682      command_loop() returned normally and quit_command() was called,
 683      either exit() or error() (again cleaning up) would be called. */
 684 #endif
 685   /* NOTE: cagney/1999-11-07: There is probably no reason for not
 686      moving this loop and the code found in captured_command_loop()
 687      into the command_loop() proper.  The main thing holding back that
 688      change - SET_TOP_LEVEL() - has been eliminated. */
 689   while (1)
 690     {
 691       catch_errors (captured_command_loop, 0, "", RETURN_MASK_ALL);
 692     }
 693   /* No exit -- exit is through quit_command.  */
 694 }
 695
 696 int
 697 main (int argc, char **argv)
 698 {
 699   struct captured_main_args args;
 700   args.argc = argc;
 701   args.argv = argv;
 702   catch_errors (captured_main, &args, "", RETURN_MASK_ALL);
 703   return 0;
 704 }
 705
 706
 707 /* Don't use *_filtered for printing help.  We don't want to prompt
 708    for continue no matter how small the screen or how much we're going
 709    to print.  */
 710
 711 static void
 712 print_gdb_help (struct ui_file *stream)
 713 {
 714   fputs_unfiltered ("\
 715 This is the GNU debugger.  Usage:\n\n\
 716     gdb [options] [executable-file [core-file or process-id]]\n\n\
 717 Options:\n\n\
 718 ", stream);
 719   fputs_unfiltered ("\
 720   --[no]async        Enable (disable) asynchronous version of CLI\n\
 721 ", stream);
 722   fputs_unfiltered ("\
 723   -b BAUDRATE        Set serial port baud rate used for remote debugging.\n\
 724   --batch            Exit after processing options.\n\
 725   --cd=DIR           Change current directory to DIR.\n\
 726   --command=FILE     Execute GDB commands from FILE.\n\
 727   --core=COREFILE    Analyze the core dump COREFILE.\n\
 728 ", stream);
 729   fputs_unfiltered ("\
 730   --dbx              DBX compatibility mode.\n\
 731   --directory=DIR    Search for source files in DIR.\n\
 732   --epoch            Output information used by epoch emacs-GDB interface.\n\
 733   --exec=EXECFILE    Use EXECFILE as the executable.\n\
 734   --fullname         Output information used by emacs-GDB interface.\n\
 735   --help             Print this message.\n\
 736 ", stream);
 737   fputs_unfiltered ("\
 738   --interpreter=INTERP\n\
 739                      Select a specific interpreter / user interface\n\
 740 ", stream);
 741   fputs_unfiltered ("\
 742   --mapped           Use mapped symbol files if supported on this system.\n\
 743   --nw               Do not use a window interface.\n\
 744   --nx               Do not read ", stream);
 745   fputs_unfiltered (gdbinit, stream);
 746   fputs_unfiltered (" file.\n\
 747   --quiet            Do not print version number on startup.\n\
 748   --readnow          Fully read symbol files on first access.\n\
 749 ", stream);
 750   fputs_unfiltered ("\
 751   --se=FILE          Use FILE as symbol file and executable file.\n\
 752   --symbols=SYMFILE  Read symbols from SYMFILE.\n\
 753   --tty=TTY          Use TTY for input/output by the program being debugged.\n\
 754 ", stream);
 755 #if defined(TUI)
 756   fputs_unfiltered ("\
 757   --tui              Use a terminal user interface.\n\
 758 ", stream);
 759 #endif
 760   fputs_unfiltered ("\
 761   --version          Print version information and then exit.\n\
 762   -w                 Use a window interface.\n\
 763   --write            Set writing into executable and core files.\n\
 764   --xdb              XDB compatibility mode.\n\
 765 ", stream);
 766 #ifdef ADDITIONAL_OPTION_HELP
 767   fputs_unfiltered (ADDITIONAL_OPTION_HELP, stream);
 768 #endif
 769   fputs_unfiltered ("\n\
 770 For more information, type \"help\" from within GDB, or consult the\n\
 771 GDB manual (available as on-line info or a printed manual).\n\
 772 Report bugs to \"bug-gdb@gnu.org\".\
 773 ", stream);
 774 }