3 Copyright 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
5 This file is part of GDB.
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.
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.
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. */
23 #include <readline/tilde.h>
24 #include "completer.h"
25 #include "target.h" /* For baud_rate, remote_debug and remote_timeout */
26 #include "gdb_wait.h" /* For shell escape implementation */
27 #include "gdb_regex.h" /* Used by apropos_command */
28 #include "gdb_string.h"
29 #include "gdb_vfork.h"
31 #include "expression.h"
35 #include "filenames.h" /* for DOSish file names */
43 #include "cli/cli-decode.h"
44 #include "cli/cli-script.h"
45 #include "cli/cli-setshow.h"
46 #include "cli/cli-cmds.h"
48 #ifndef GDBINIT_FILENAME
49 #define GDBINIT_FILENAME ".gdbinit"
52 /* Prototypes for local command functions */
54 static void complete_command (char *, int);
56 static void echo_command (char *, int);
58 static void pwd_command (char *, int);
60 static void show_version (char *, int);
62 static void validate_comname (char *);
64 static void help_command (char *, int);
66 static void show_command (char *, int);
68 static void info_command (char *, int);
70 static void show_debug (char *, int);
72 static void set_debug (char *, int);
74 static void show_user (char *, int);
76 static void make_command (char *, int);
78 static void shell_escape (char *, int);
80 static void edit_command (char *, int);
82 static void list_command (char *, int);
84 void apropos_command (char *, int);
86 /* Prototypes for local utility functions */
88 static void ambiguous_line_spec (struct symtabs_and_lines *);
90 /* Limit the call depth of user-defined commands */
91 int max_user_call_depth;
93 /* Define all cmd_list_elements. */
95 /* Chain containing all defined commands. */
97 struct cmd_list_element *cmdlist;
99 /* Chain containing all defined info subcommands. */
101 struct cmd_list_element *infolist;
103 /* Chain containing all defined enable subcommands. */
105 struct cmd_list_element *enablelist;
107 /* Chain containing all defined disable subcommands. */
109 struct cmd_list_element *disablelist;
111 /* Chain containing all defined toggle subcommands. */
113 struct cmd_list_element *togglelist;
115 /* Chain containing all defined stop subcommands. */
117 struct cmd_list_element *stoplist;
119 /* Chain containing all defined delete subcommands. */
121 struct cmd_list_element *deletelist;
123 /* Chain containing all defined "enable breakpoint" subcommands. */
125 struct cmd_list_element *enablebreaklist;
127 /* Chain containing all defined set subcommands */
129 struct cmd_list_element *setlist;
131 /* Chain containing all defined unset subcommands */
133 struct cmd_list_element *unsetlist;
135 /* Chain containing all defined show subcommands. */
137 struct cmd_list_element *showlist;
139 /* Chain containing all defined \"set history\". */
141 struct cmd_list_element *sethistlist;
143 /* Chain containing all defined \"show history\". */
145 struct cmd_list_element *showhistlist;
147 /* Chain containing all defined \"unset history\". */
149 struct cmd_list_element *unsethistlist;
151 /* Chain containing all defined maintenance subcommands. */
153 struct cmd_list_element *maintenancelist;
155 /* Chain containing all defined "maintenance info" subcommands. */
157 struct cmd_list_element *maintenanceinfolist;
159 /* Chain containing all defined "maintenance print" subcommands. */
161 struct cmd_list_element *maintenanceprintlist;
163 struct cmd_list_element *setprintlist;
165 struct cmd_list_element *showprintlist;
167 struct cmd_list_element *setdebuglist;
169 struct cmd_list_element *showdebuglist;
171 struct cmd_list_element *setchecklist;
173 struct cmd_list_element *showchecklist;
175 /* Utility used everywhere when at least one argument is needed and
179 error_no_arg (char *why)
181 error ("Argument required (%s).", why);
184 /* The "info" command is defined as a prefix, with allow_unknown = 0.
185 Therefore, its own definition is called only for "info" with no args. */
189 info_command (char *arg, int from_tty)
191 printf_unfiltered ("\"info\" must be followed by the name of an info command.\n");
192 help_list (infolist, "info ", -1, gdb_stdout);
195 /* The "show" command with no arguments shows all the settings. */
199 show_command (char *arg, int from_tty)
201 cmd_show_list (showlist, from_tty, "");
204 /* Provide documentation on command or list given by COMMAND. FROM_TTY
209 help_command (char *command, int from_tty)
211 help_cmd (command, gdb_stdout);
214 /* String compare function for qsort. */
216 compare_strings (const void *arg1, const void *arg2)
218 const char **s1 = (const char **) arg1;
219 const char **s2 = (const char **) arg2;
220 return strcmp (*s1, *s2);
223 /* The "complete" command is used by Emacs to implement completion. */
227 complete_command (char *arg, int from_tty)
237 argpoint = strlen (arg);
239 completions = complete_line (arg, arg, argpoint);
245 for (size = 0; completions[size]; ++size)
247 qsort (completions, size, sizeof (char *), compare_strings);
249 /* We do extra processing here since we only want to print each
255 printf_unfiltered ("%s\n", completions[item]);
256 next_item = item + 1;
257 while (next_item < size
258 && ! strcmp (completions[item], completions[next_item]))
260 xfree (completions[next_item]);
264 xfree (completions[item]);
273 is_complete_command (struct cmd_list_element *c)
275 return cmd_cfunc_eq (c, complete_command);
280 show_version (char *args, int from_tty)
283 print_gdb_version (gdb_stdout);
284 printf_filtered ("\n");
288 /* Handle the quit command. */
291 quit_command (char *args, int from_tty)
293 if (!quit_confirm ())
294 error ("Not confirmed.");
295 quit_force (args, from_tty);
300 pwd_command (char *args, int from_tty)
303 error ("The \"pwd\" command does not take an argument: %s", args);
304 getcwd (gdb_dirbuf, sizeof (gdb_dirbuf));
306 if (!STREQ (gdb_dirbuf, current_directory))
307 printf_unfiltered ("Working directory %s\n (canonically %s).\n",
308 current_directory, gdb_dirbuf);
310 printf_unfiltered ("Working directory %s.\n", current_directory);
314 cd_command (char *dir, int from_tty)
317 /* Found something other than leading repetitions of "/..". */
321 /* If the new directory is absolute, repeat is a no-op; if relative,
322 repeat might be useful but is more likely to be a mistake. */
326 error_no_arg ("new working directory");
328 dir = tilde_expand (dir);
329 make_cleanup (xfree, dir);
332 perror_with_name (dir);
334 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
335 /* There's too much mess with DOSish names like "d:", "d:.",
336 "d:./foo" etc. Instead of having lots of special #ifdef'ed code,
337 simply get the canonicalized name of the current directory. */
338 dir = getcwd (gdb_dirbuf, sizeof (gdb_dirbuf));
342 if (IS_DIR_SEPARATOR (dir[len - 1]))
344 /* Remove the trailing slash unless this is a root directory
345 (including a drive letter on non-Unix systems). */
346 if (!(len == 1) /* "/" */
347 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
348 && !(len == 3 && dir[1] == ':') /* "d:/" */
354 dir = savestring (dir, len);
355 if (IS_ABSOLUTE_PATH (dir))
356 current_directory = dir;
359 if (IS_DIR_SEPARATOR (current_directory[strlen (current_directory) - 1]))
360 current_directory = concat (current_directory, dir, NULL);
362 current_directory = concat (current_directory, SLASH_STRING, dir, NULL);
366 /* Now simplify any occurrences of `.' and `..' in the pathname. */
369 for (p = current_directory; *p;)
371 if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.'
372 && (p[2] == 0 || IS_DIR_SEPARATOR (p[2])))
374 else if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.' && p[2] == '.'
375 && (p[3] == 0 || IS_DIR_SEPARATOR (p[3])))
379 /* Search backwards for the directory just before the "/.."
380 and obliterate it and the "/..". */
382 while (q != current_directory && !IS_DIR_SEPARATOR (q[-1]))
385 if (q == current_directory)
386 /* current_directory is
387 a relative pathname ("can't happen"--leave it alone). */
391 strcpy (q - 1, p + 3);
396 /* We are dealing with leading repetitions of "/..", for example
397 "/../..", which is the Mach super-root. */
407 forget_cached_source_info ();
410 pwd_command ((char *) 0, 1);
414 source_command (char *args, int from_tty)
417 struct cleanup *old_cleanups;
422 error ("source command requires pathname of file to source.");
425 file = tilde_expand (file);
426 old_cleanups = make_cleanup (xfree, file);
428 stream = fopen (file, FOPEN_RT);
432 perror_with_name (file);
437 script_from_file (stream, file);
439 do_cleanups (old_cleanups);
444 echo_command (char *text, int from_tty)
450 while ((c = *p++) != '\0')
454 /* \ at end of argument is used after spaces
455 so they won't be lost. */
459 c = parse_escape (&p);
461 printf_filtered ("%c", c);
464 printf_filtered ("%c", c);
467 /* Force this output to appear now. */
469 gdb_flush (gdb_stdout);
474 shell_escape (char *arg, int from_tty)
477 /* If ARG is NULL, they want an inferior shell, but `system' just
478 reports if the shell is available when passed a NULL arg. */
479 int rc = system (arg ? arg : "");
482 arg = "inferior shell";
486 fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", arg,
487 safe_strerror (errno));
488 gdb_flush (gdb_stderr);
492 fprintf_unfiltered (gdb_stderr, "%s exited with status %d\n", arg, rc);
493 gdb_flush (gdb_stderr);
496 /* Make sure to return to the directory GDB thinks it is, in case the
497 shell command we just ran changed it. */
498 chdir (current_directory);
500 #else /* Can fork. */
502 char *p, *user_shell;
504 if ((user_shell = (char *) getenv ("SHELL")) == NULL)
505 user_shell = "/bin/sh";
507 /* Get the name of the shell for arg0 */
508 if ((p = strrchr (user_shell, '/')) == NULL)
511 p++; /* Get past '/' */
513 if ((pid = vfork ()) == 0)
516 execl (user_shell, p, 0);
518 execl (user_shell, p, "-c", arg, 0);
520 fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", user_shell,
521 safe_strerror (errno));
522 gdb_flush (gdb_stderr);
527 while ((rc = wait (&status)) != pid && rc != -1)
530 error ("Fork failed");
531 #endif /* Can fork. */
535 edit_command (char *arg, int from_tty)
537 struct symtabs_and_lines sals;
538 struct symtab_and_line sal;
546 /* Pull in the current default source line if necessary */
549 set_default_source_symtab_and_line ();
550 sal = get_current_source_symtab_and_line ();
553 /* bare "edit" edits file with present line. */
558 error ("No default source file yet.");
559 sal.line += get_lines_to_list () / 2;
564 /* Now should only be one argument -- decode it in SAL */
567 sals = decode_line_1 (&arg1, 0, 0, 0, 0);
569 if (! sals.nelts) return; /* C++ */
570 if (sals.nelts > 1) {
571 ambiguous_line_spec (&sals);
580 error ("Junk at end of line specification.");
582 /* if line was specified by address,
583 first print exactly which line, and which file.
584 In this case, sal.symtab == 0 means address is outside
585 of all known source files, not that user failed to give a filename. */
589 /* FIXME-32x64--assumes sal.pc fits in long. */
590 error ("No source file for address %s.",
591 local_hex_string((unsigned long) sal.pc));
592 sym = find_pc_function (sal.pc);
595 print_address_numeric (sal.pc, 1, gdb_stdout);
596 printf_filtered (" is in ");
597 fputs_filtered (SYMBOL_PRINT_NAME (sym), gdb_stdout);
598 printf_filtered (" (%s:%d).\n", sal.symtab->filename, sal.line);
602 print_address_numeric (sal.pc, 1, gdb_stdout);
603 printf_filtered (" is at %s:%d.\n",
604 sal.symtab->filename, sal.line);
608 /* If what was given does not imply a symtab, it must be an undebuggable
609 symbol which means no source code. */
612 error ("No line number known for %s.", arg);
615 if ((editor = (char *) getenv ("EDITOR")) == NULL)
618 /* Approximate base-10 log of line to 1 unit for digit count */
619 for(log10=32, m=0x80000000; !(sal.line & m) && log10>0; log10--, m=m>>1);
620 log10 = 1 + (int)((log10 + (0 == ((m-1) & sal.line)))/3.32192809);
622 cmdlen = strlen(editor) + 1
623 + (NULL == sal.symtab->dirname ? 0 : strlen(sal.symtab->dirname) + 1)
624 + (NULL == sal.symtab->filename? 0 : strlen(sal.symtab->filename)+ 1)
628 sprintf(p,"%s +%d %s%s",editor,sal.line,
629 (NULL == sal.symtab->dirname ? "./" :
630 (NULL != sal.symtab->filename && *(sal.symtab->filename) != '/') ?
631 sal.symtab->dirname : ""),
632 (NULL == sal.symtab->filename ? "unknown" : sal.symtab->filename)
634 shell_escape(p, from_tty);
640 list_command (char *arg, int from_tty)
642 struct symtabs_and_lines sals, sals_end;
643 struct symtab_and_line sal, sal_end, cursal;
652 /* Pull in the current default source line if necessary */
653 if (arg == 0 || arg[0] == '+' || arg[0] == '-')
655 set_default_source_symtab_and_line ();
656 cursal = get_current_source_symtab_and_line ();
659 /* "l" or "l +" lists next ten lines. */
661 if (arg == 0 || STREQ (arg, "+"))
663 print_source_lines (cursal.symtab, cursal.line,
664 cursal.line + get_lines_to_list (), 0);
668 /* "l -" lists previous ten lines, the ones before the ten just listed. */
669 if (STREQ (arg, "-"))
671 print_source_lines (cursal.symtab,
672 max (get_first_line_listed () - get_lines_to_list (), 1),
673 get_first_line_listed (), 0);
677 /* Now if there is only one argument, decode it in SAL
679 If there are two arguments, decode them in SAL and SAL_END
680 and clear NO_END; however, if one of the arguments is blank,
681 set DUMMY_BEG or DUMMY_END to record that fact. */
683 if (!have_full_symbols () && !have_partial_symbols ())
684 error ("No symbol table is loaded. Use the \"file\" command.");
691 sals = decode_line_1 (&arg1, 0, 0, 0, 0);
697 ambiguous_line_spec (&sals);
706 /* Record whether the BEG arg is all digits. */
708 for (p = arg; p != arg1 && *p >= '0' && *p <= '9'; p++);
709 linenum_beg = (p == arg1);
711 while (*arg1 == ' ' || *arg1 == '\t')
717 while (*arg1 == ' ' || *arg1 == '\t')
724 sals_end = decode_line_1 (&arg1, 0, 0, 0, 0);
726 sals_end = decode_line_1 (&arg1, 0, sal.symtab, sal.line, 0);
727 if (sals_end.nelts == 0)
729 if (sals_end.nelts > 1)
731 ambiguous_line_spec (&sals_end);
732 xfree (sals_end.sals);
735 sal_end = sals_end.sals[0];
736 xfree (sals_end.sals);
741 error ("Junk at end of line specification.");
743 if (!no_end && !dummy_beg && !dummy_end
744 && sal.symtab != sal_end.symtab)
745 error ("Specified start and end are in different files.");
746 if (dummy_beg && dummy_end)
747 error ("Two empty args do not say what lines to list.");
749 /* if line was specified by address,
750 first print exactly which line, and which file.
751 In this case, sal.symtab == 0 means address is outside
752 of all known source files, not that user failed to give a filename. */
756 /* FIXME-32x64--assumes sal.pc fits in long. */
757 error ("No source file for address %s.",
758 local_hex_string ((unsigned long) sal.pc));
759 sym = find_pc_function (sal.pc);
762 print_address_numeric (sal.pc, 1, gdb_stdout);
763 printf_filtered (" is in ");
764 fputs_filtered (SYMBOL_PRINT_NAME (sym), gdb_stdout);
765 printf_filtered (" (%s:%d).\n", sal.symtab->filename, sal.line);
769 print_address_numeric (sal.pc, 1, gdb_stdout);
770 printf_filtered (" is at %s:%d.\n",
771 sal.symtab->filename, sal.line);
775 /* If line was not specified by just a line number,
776 and it does not imply a symtab, it must be an undebuggable symbol
777 which means no source code. */
779 if (!linenum_beg && sal.symtab == 0)
780 error ("No line number known for %s.", arg);
782 /* If this command is repeated with RET,
783 turn it into the no-arg variant. */
788 if (dummy_beg && sal_end.symtab == 0)
789 error ("No default source file yet. Do \"help list\".");
791 print_source_lines (sal_end.symtab,
792 max (sal_end.line - (get_lines_to_list () - 1), 1),
793 sal_end.line + 1, 0);
794 else if (sal.symtab == 0)
795 error ("No default source file yet. Do \"help list\".");
798 int first_line = sal.line - get_lines_to_list () / 2;
800 if (first_line < 1) first_line = 1;
802 print_source_lines (sal.symtab,
804 first_line + get_lines_to_list (),
808 print_source_lines (sal.symtab, sal.line,
810 ? sal.line + get_lines_to_list ()
815 /* Dump a specified section of assembly code. With no command line
816 arguments, this command will dump the assembly code for the
817 function surrounding the pc value in the selected frame. With one
818 argument, it will dump the assembly code surrounding that pc value.
819 Two arguments are interpeted as bounds within which to dump
824 disassemble_command (char *arg, int from_tty)
828 CORE_ADDR pc, pc_masked;
837 if (!deprecated_selected_frame)
838 error ("No frame selected.\n");
840 pc = get_frame_pc (deprecated_selected_frame);
841 if (find_pc_partial_function (pc, &name, &low, &high) == 0)
842 error ("No function contains program counter for selected frame.\n");
844 /* NOTE: cagney/2003-02-13 The `tui_active' was previously
847 low = tuiGetLowDisassemblyAddress (low, pc);
849 low += FUNCTION_START_OFFSET;
851 else if (!(space_index = (char *) strchr (arg, ' ')))
854 pc = parse_and_eval_address (arg);
855 if (find_pc_partial_function (pc, &name, &low, &high) == 0)
856 error ("No function contains specified address.\n");
858 /* NOTE: cagney/2003-02-13 The `tui_active' was previously
861 low = tuiGetLowDisassemblyAddress (low, pc);
863 low += FUNCTION_START_OFFSET;
869 low = parse_and_eval_address (arg);
870 high = parse_and_eval_address (space_index + 1);
874 if (!tui_is_window_visible (DISASSEM_WIN))
877 printf_filtered ("Dump of assembler code ");
880 printf_filtered ("for function %s:\n", name);
884 printf_filtered ("from ");
885 print_address_numeric (low, 1, gdb_stdout);
886 printf_filtered (" to ");
887 print_address_numeric (high, 1, gdb_stdout);
888 printf_filtered (":\n");
891 /* Dump the specified range. */
892 gdb_disassembly (uiout, 0, 0, 0, -1, low, high);
894 printf_filtered ("End of assembler dump.\n");
895 gdb_flush (gdb_stdout);
900 tui_show_assembly (low);
906 make_command (char *arg, int from_tty)
914 p = xmalloc (sizeof ("make ") + strlen (arg));
916 strcpy (p + sizeof ("make ") - 1, arg);
919 shell_escape (p, from_tty);
924 show_user (char *args, int from_tty)
926 struct cmd_list_element *c;
927 extern struct cmd_list_element *cmdlist;
931 c = lookup_cmd (&args, cmdlist, "", 0, 1);
932 if (c->class != class_user)
933 error ("Not a user command.");
934 show_user_1 (c, gdb_stdout);
938 for (c = cmdlist; c; c = c->next)
940 if (c->class == class_user)
941 show_user_1 (c, gdb_stdout);
946 /* Search through names of commands and documentations for a certain
950 apropos_command (char *searchstr, int from_tty)
952 extern struct cmd_list_element *cmdlist; /*This is the main command list*/
954 char *pattern_fastmap;
955 char errorbuffer[512];
956 pattern_fastmap = xcalloc (256, sizeof (char));
957 if (searchstr == NULL)
958 error("REGEXP string is empty");
960 if (regcomp(&pattern,searchstr,REG_ICASE) == 0)
962 pattern.fastmap=pattern_fastmap;
963 re_compile_fastmap(&pattern);
964 apropos_cmd (gdb_stdout,cmdlist,&pattern,"");
968 regerror(regcomp(&pattern,searchstr,REG_ICASE),NULL,errorbuffer,512);
969 error("Error in regular expression:%s",errorbuffer);
971 xfree (pattern_fastmap);
974 /* Print a list of files and line numbers which a user may choose from
975 in order to list a function which was specified ambiguously (as with
976 `list classname::overloadedfuncname', for example). The vector in
977 SALS provides the filenames and line numbers. */
980 ambiguous_line_spec (struct symtabs_and_lines *sals)
984 for (i = 0; i < sals->nelts; ++i)
985 printf_filtered ("file: \"%s\", line number: %d\n",
986 sals->sals[i].symtab->filename, sals->sals[i].line);
990 set_debug (char *arg, int from_tty)
992 printf_unfiltered ("\"set debug\" must be followed by the name of a print subcommand.\n");
993 help_list (setdebuglist, "set debug ", -1, gdb_stdout);
997 show_debug (char *args, int from_tty)
999 cmd_show_list (showdebuglist, from_tty, "");
1003 init_cmd_lists (void)
1005 max_user_call_depth = 1024;
1014 enablebreaklist = NULL;
1019 showhistlist = NULL;
1020 unsethistlist = NULL;
1021 maintenancelist = NULL;
1022 maintenanceinfolist = NULL;
1023 maintenanceprintlist = NULL;
1024 setprintlist = NULL;
1025 showprintlist = NULL;
1026 setchecklist = NULL;
1027 showchecklist = NULL;
1032 init_cli_cmds (void)
1034 struct cmd_list_element *c;
1036 /* Define the classes of commands.
1037 They will appear in the help list in the reverse of this order. */
1039 add_cmd ("internals", class_maintenance, NULL,
1040 "Maintenance commands.\n\
1041 Some gdb commands are provided just for use by gdb maintainers.\n\
1042 These commands are subject to frequent change, and may not be as\n\
1043 well documented as user commands.",
1045 add_cmd ("obscure", class_obscure, NULL, "Obscure features.", &cmdlist);
1046 add_cmd ("aliases", class_alias, NULL, "Aliases of other commands.", &cmdlist);
1047 add_cmd ("user-defined", class_user, NULL, "User-defined commands.\n\
1048 The commands in this class are those defined by the user.\n\
1049 Use the \"define\" command to define a command.", &cmdlist);
1050 add_cmd ("support", class_support, NULL, "Support facilities.", &cmdlist);
1052 add_cmd ("status", class_info, NULL, "Status inquiries.", &cmdlist);
1053 add_cmd ("files", class_files, NULL, "Specifying and examining files.", &cmdlist);
1054 add_cmd ("breakpoints", class_breakpoint, NULL, "Making program stop at certain points.", &cmdlist);
1055 add_cmd ("data", class_vars, NULL, "Examining data.", &cmdlist);
1056 add_cmd ("stack", class_stack, NULL, "Examining the stack.\n\
1057 The stack is made up of stack frames. Gdb assigns numbers to stack frames\n\
1058 counting from zero for the innermost (currently executing) frame.\n\n\
1059 At any time gdb identifies one frame as the \"selected\" frame.\n\
1060 Variable lookups are done with respect to the selected frame.\n\
1061 When the program being debugged stops, gdb selects the innermost frame.\n\
1062 The commands below can be used to select other frames by number or address.",
1064 add_cmd ("running", class_run, NULL, "Running the program.", &cmdlist);
1066 /* Define general commands. */
1068 add_com ("pwd", class_files, pwd_command,
1069 "Print working directory. This is used for your program as well.");
1070 c = add_cmd ("cd", class_files, cd_command,
1071 "Set working directory to DIR for debugger and program being debugged.\n\
1072 The change does not take effect for the program being debugged\n\
1073 until the next time it is started.", &cmdlist);
1074 set_cmd_completer (c, filename_completer);
1076 add_com ("echo", class_support, echo_command,
1077 "Print a constant string. Give string as argument.\n\
1078 C escape sequences may be used in the argument.\n\
1079 No newline is added at the end of the argument;\n\
1080 use \"\\n\" if you want a newline to be printed.\n\
1081 Since leading and trailing whitespace are ignored in command arguments,\n\
1082 if you want to print some you must use \"\\\" before leading whitespace\n\
1083 to be printed or after trailing whitespace.");
1084 add_com ("document", class_support, document_command,
1085 "Document a user-defined command.\n\
1086 Give command name as argument. Give documentation on following lines.\n\
1087 End with a line of just \"end\".");
1088 add_com ("define", class_support, define_command,
1089 "Define a new command name. Command name is argument.\n\
1090 Definition appears on following lines, one command per line.\n\
1091 End with a line of just \"end\".\n\
1092 Use the \"document\" command to give documentation for the new command.\n\
1093 Commands defined in this way may have up to ten arguments.");
1095 c = add_cmd ("source", class_support, source_command,
1096 "Read commands from a file named FILE.\n\
1097 Note that the file \"" GDBINIT_FILENAME "\" is read automatically in this way\n\
1098 when gdb is started.", &cmdlist);
1099 set_cmd_completer (c, filename_completer);
1101 add_com ("quit", class_support, quit_command, "Exit gdb.");
1102 c = add_com ("help", class_support, help_command, "Print list of commands.");
1103 set_cmd_completer (c, command_completer);
1104 add_com_alias ("q", "quit", class_support, 1);
1105 add_com_alias ("h", "help", class_support, 1);
1107 c = add_set_cmd ("verbose", class_support, var_boolean, (char *) &info_verbose,
1110 add_show_from_set (c, &showlist);
1111 set_cmd_sfunc (c, set_verbose);
1112 set_verbose (NULL, 0, c);
1114 add_prefix_cmd ("history", class_support, set_history,
1115 "Generic command for setting command history parameters.",
1116 &sethistlist, "set history ", 0, &setlist);
1117 add_prefix_cmd ("history", class_support, show_history,
1118 "Generic command for showing command history parameters.",
1119 &showhistlist, "show history ", 0, &showlist);
1122 (add_set_cmd ("expansion", no_class, var_boolean, (char *) &history_expansion_p,
1123 "Set history expansion on command input.\n\
1124 Without an argument, history expansion is enabled.", &sethistlist),
1127 add_prefix_cmd ("info", class_info, info_command,
1128 "Generic command for showing things about the program being debugged.",
1129 &infolist, "info ", 0, &cmdlist);
1130 add_com_alias ("i", "info", class_info, 1);
1132 add_com ("complete", class_obscure, complete_command,
1133 "List the completions for the rest of the line as a command.");
1135 add_prefix_cmd ("show", class_info, show_command,
1136 "Generic command for showing things about the debugger.",
1137 &showlist, "show ", 0, &cmdlist);
1138 /* Another way to get at the same thing. */
1139 add_info ("set", show_command, "Show all GDB settings.");
1141 add_cmd ("commands", no_class, show_commands,
1142 "Show the history of commands you typed.\n\
1143 You can supply a command number to start with, or a `+' to start after\n\
1144 the previous command number shown.",
1147 add_cmd ("version", no_class, show_version,
1148 "Show what version of GDB this is.", &showlist);
1150 add_com ("while", class_support, while_command,
1151 "Execute nested commands WHILE the conditional expression is non zero.\n\
1152 The conditional expression must follow the word `while' and must in turn be\n\
1153 followed by a new line. The nested commands must be entered one per line,\n\
1154 and should be terminated by the word `end'.");
1156 add_com ("if", class_support, if_command,
1157 "Execute nested commands once IF the conditional expression is non zero.\n\
1158 The conditional expression must follow the word `if' and must in turn be\n\
1159 followed by a new line. The nested commands must be entered one per line,\n\
1160 and should be terminated by the word 'else' or `end'. If an else clause\n\
1161 is used, the same rules apply to its nested commands as to the first ones.");
1163 /* If target is open when baud changes, it doesn't take effect until the
1164 next open (I think, not sure). */
1165 add_show_from_set (add_set_cmd ("remotebaud", no_class,
1166 var_zinteger, (char *) &baud_rate,
1167 "Set baud rate for remote serial I/O.\n\
1168 This value is used to set the speed of the serial port when debugging\n\
1169 using remote targets.", &setlist),
1172 c = add_set_cmd ("remotedebug", no_class, var_zinteger,
1173 (char *) &remote_debug,
1174 "Set debugging of remote protocol.\n\
1175 When enabled, each packet sent or received with the remote target\n\
1176 is displayed.", &setlist);
1177 deprecate_cmd (c, "set debug remote");
1178 deprecate_cmd (add_show_from_set (c, &showlist), "show debug remote");
1180 add_show_from_set (add_set_cmd ("remote", no_class, var_zinteger,
1181 (char *) &remote_debug,
1182 "Set debugging of remote protocol.\n\
1183 When enabled, each packet sent or received with the remote target\n\
1184 is displayed.", &setdebuglist),
1188 add_set_cmd ("remotetimeout", no_class, var_integer, (char *) &remote_timeout,
1189 "Set timeout limit to wait for target to respond.\n\
1190 This value is used to set the time limit for gdb to wait for a response\n\
1191 from the target.", &setlist),
1194 add_prefix_cmd ("debug", no_class, set_debug,
1195 "Generic command for setting gdb debugging flags",
1196 &setdebuglist, "set debug ", 0, &setlist);
1198 add_prefix_cmd ("debug", no_class, show_debug,
1199 "Generic command for showing gdb debugging flags",
1200 &showdebuglist, "show debug ", 0, &showlist);
1202 c = add_com ("shell", class_support, shell_escape,
1203 "Execute the rest of the line as a shell command.\n\
1204 With no arguments, run an inferior shell.");
1205 set_cmd_completer (c, filename_completer);
1207 c = add_com ("edit", class_files, edit_command,
1208 concat ("Edit specified file or function.\n\
1209 With no argument, edits file containing most recent line listed.\n\
1211 Editing targets can be specified in these ways:\n\
1212 FILE:LINENUM, to edit at that line in that file,\n\
1213 FUNCTION, to edit at the beginning of that function,\n\
1214 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1215 *ADDRESS, to edit at the line containing that address.\n\
1216 Uses EDITOR environment variable contents as editor (or ex as default).",NULL));
1218 c->completer = location_completer;
1220 add_com ("list", class_files, list_command,
1221 concat ("List specified function or line.\n\
1222 With no argument, lists ten more lines after or around previous listing.\n\
1223 \"list -\" lists the ten lines before a previous ten-line listing.\n\
1224 One argument specifies a line, and ten lines are listed around that line.\n\
1225 Two arguments with comma between specify starting and ending lines to list.\n\
1227 Lines can be specified in these ways:\n\
1228 LINENUM, to list around that line in current file,\n\
1229 FILE:LINENUM, to list around that line in that file,\n\
1230 FUNCTION, to list around beginning of that function,\n\
1231 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1232 *ADDRESS, to list around the line containing that address.\n\
1233 With two args if one is empty it stands for ten lines away from the other arg.", NULL));
1236 add_com_alias ("l", "list", class_files, 1);
1238 add_com_alias ("v", "list", class_files, 1);
1241 add_com_alias ("file", "list", class_files, 1);
1243 c = add_com ("disassemble", class_vars, disassemble_command,
1244 "Disassemble a specified section of memory.\n\
1245 Default is the function surrounding the pc of the selected frame.\n\
1246 With a single argument, the function surrounding that address is dumped.\n\
1247 Two arguments are taken as a range of memory to dump.");
1248 set_cmd_completer (c, location_completer);
1250 add_com_alias ("va", "disassemble", class_xdb, 0);
1252 /* NOTE: cagney/2000-03-20: Being able to enter ``(gdb) !ls'' would
1253 be a really useful feature. Unfortunately, the below wont do
1254 this. Instead it adds support for the form ``(gdb) ! ls''
1255 (i.e. the space is required). If the ``!'' command below is
1256 added the complains about no ``!'' command would be replaced by
1257 complains about how the ``!'' command is broken :-) */
1259 add_com_alias ("!", "shell", class_support, 0);
1261 c = add_com ("make", class_support, make_command,
1262 "Run the ``make'' program using the rest of the line as arguments.");
1263 set_cmd_completer (c, filename_completer);
1264 add_cmd ("user", no_class, show_user,
1265 "Show definitions of user defined commands.\n\
1266 Argument is the name of the user defined command.\n\
1267 With no argument, show definitions of all user defined commands.", &showlist);
1268 add_com ("apropos", class_support, apropos_command, "Search for commands matching a REGEXP");
1271 add_set_cmd ("max-user-call-depth", no_class, var_integer,
1272 (char *) &max_user_call_depth,
1273 "Set the max call depth for user-defined commands.\n",