Next: , Previous: , Up: Debugger Command Reference   [Contents][Index]

4.2 Getting help (‘help’)

Once inside the debugger, you can always ask it for information on its commands, using the command help.

help
h

You can use help (abbreviated h) with no arguments to display a short list of named classes of commands: 

remake<0> help
  Command                  Short Name  Aliases
  ----------------------   ----------  ---------
  break [TARGET|LINENUM] [all|run|prereq|end]* (b)  L
  cd DIR                          (C)
  comment TEXT                    (#)
  continue [TARGET [all|run|prereq|end]*] (c)
  delete breakpoint numbers..     (d)
  down [AMOUNT]                   (D)
  edit                            (e)
  eval STRING                     (E)
  expand STRING                   (x)
  finish [AMOUNT]                 (F)
  frame N                         (f)
  help [COMMAND]                  (h)  ?, ??
  info [SUBCOMMAND]               (i)
  list [TARGET|LINE-NUMBER]       (l)
  next [AMOUNT]                   (n)
  print {VARIABLE [attrs...]}     (p)
  pwd                             (P)
  quit [exit-status]              (q)  exit, return
  run [ARGS]                      (R)  restart
  set OPTION {on|off|toggle}
  set variable VARIABLE VALUE     (=)
  setq VARIABLE VALUE             (")
  shell STRING                    (!)  !!
  show [SUBCOMMAND]               (S)
  source FILENAME                 (<)
  skip                            (k)
  step [AMOUNT]                   (s)
  target [TARGET-NAME] [info1 [info2...]] (t)
  up [AMOUNT]                     (u)
  where                           (T)  backtrace, bt
  write [TARGET [FILENAME]]       (w)

Readline command line editing (emacs/vi mode) is available.
For more detailed help, type h <cmd> or consult online-documentation.
help command

With a command name as help argument, GNU Remake displays short information on how to use that command. 

remake<3> help where
  where:
	Show target stack.

In addition to help, you can use the debugger command info to inquire about the state of your script, or the state of the GNU Make debugger itself. The listings under info in the Index point to all the sub-commands. See Command Index.

info

This command (abbreviated i) is for describing the state of your program. You can get a complete list of the info sub-commands with help info.

Subcommands can be abbreviated with the minimum number of letters to make that subcommand distinct from another. For example info lo is the same as info locals and info li is the same as info line. 

remake<0> help info
  info [thing]:
	Show the state of thing.
	If no 'thing' is specified, show everything there is to show.

	Available info subcommands are:
	 line locals makefiles targets variables warranty

Next: , Previous: , Up: Debugger Command Reference   [Contents][Index]