git.gag.com Git - fw/openocd/blob - doc/openocd.1

   1 .TH "OPENOCD" "1" "February 28, 2008"
   2 .SH "NAME"
   3 openocd \- A free and open on\-chip debugging, in\-system programming and
   4 boundary\-scan testing tool for ARM systems
   5 .SH "SYNOPSIS"
   6 .B openocd \fR[\fB\-fdlh\fR] [\fB\-\-file\fR <filename>] [\fB\-\-debug\fR <debuglevel>] [\fB\-\-log_output\fR <filename>] [\fB\-\-help\fR]
   7 .SH "DESCRIPTION"
   8 .B OpenOCD
   9 is an on\-chip debugging, in\-system programming and boundary\-scan
  10 testing tool for ARM systems.
  11 .PP
  12 The debugger uses an IEEE 1149\-1 compliant JTAG TAP bus master to access
  13 on\-chip debug functionality available on ARM7/9, XScale, Cortex-M3, and
  14 Marvell Feroceon (as found in the Orion SoC family) based
  15 microcontrollers / system\-on\-chip solutions.
  16 .PP
  17 User interaction is realized through a telnet command line interface and
  18 a gdb (the GNU debugger) remote protocol server.
  19 .PP
  20 OpenOCD supports various different types of JTAG interfaces/programmers,
  21 please check the README for the complete list.
  22 .SH "OPTIONS"
  23 .TP
  24 .B "\-f, \-\-file <filename>"
  25 Use configuration file
  26 .BR <filename> .
  27 If this option is omitted, the config file
  28 .B openocd.cfg
  29 in the current working directory will be used.
  30 .TP
  31 .B "\-d, \-\-debug <debuglevel>"
  32 Set debug level. Possible values are:
  33 .br
  34 .RB "  * " 0 " (errors)"
  35 .br
  36 .RB "  * " 1 " (warnings)"
  37 .br
  38 .RB "  * " 2 " (informational messages)"
  39 .br
  40 .RB "  * " 3 " (debug messages)"
  41 .br
  42 The default level is
  43 .BR 2 .
  44 .TP
  45 .B "\-l, \-\-log_output <filename>"
  46 Redirect log output to the file
  47 .BR <filename> .
  48 Per default the log output is printed on
  49 .BR stderr .
  50 .TP
  51 .B "\-h, \-\-help"
  52 Show a help text and exit.
  53 .\".TP
  54 .\".B "\-v, \-\-version"
  55 .\"Show version information and exit.
  56 .SH "BUGS"
  57 Please report any bugs at
  58 .B http://developer.berlios.de/bugs/?group_id=4148
  59 or on the mailing list
  60 .BR openocd\-development@lists.berlios.de .
  61 .SH "LICENCE"
  62 .B OpenOCD
  63 is covered by the GNU General Public License (GPL), version 2 or later.
  64 .SH "SEE ALSO"
  65 .BR jtag (1)
  66 .SH "AUTHORS"
  67 Please see the file AUTHORS.
  68 .PP
  69 This manual page was written by Uwe Hermann <uwe@hermann\-uwe.de>.
  70 It is licensed under the terms of the GNU GPL (version 2 or later).