doc/openocd.1

   1 .TH "OPENOCD" "1" "November 24, 2009"
   2 .SH "NAME"
   3 openocd \- A free and open on\-chip debugging, in\-system programming and
   4 boundary\-scan testing tool for ARM and MIPS systems
   5 .SH "SYNOPSIS"
   6 .B openocd \fR[\fB\-fsdlcphv\fR] [\fB\-\-file\fR <filename>] [\fB\-\-search\fR <dirname>] [\fB\-\-debug\fR <debuglevel>] [\fB\-\-log_output\fR <filename>] [\fB\-\-command\fR <cmd>] [\fB\-\-pipe\fR] [\fB\-\-help\fR] [\fB\-\-version\fR]
   7 .SH "DESCRIPTION"
   8 .B OpenOCD
   9 is an on\-chip debugging, in\-system programming and boundary\-scan
  10 testing tool for various ARM and MIPS 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 ARM based microcontrollers or
  14 system-on-chip solutions. For MIPS systems the EJTAG interface is supported.
  15 .PP
  16 User interaction is realized through a telnet command line interface,
  17 a gdb (the GNU debugger) remote protocol server, and a simplified RPC
  18 connection that can be used to interface with OpenOCD's Jim Tcl engine.
  19 .PP
  20 OpenOCD supports various different types of JTAG interfaces/programmers,
  21 please check the \fIopenocd\fR info page for the complete list.
  22 .SH "OPTIONS"
  23 .TP
  24 .B "\-f, \-\-file <filename>"
  25 Use configuration file
  26 .BR <filename> .
  27 In order to specify multiple config files, you can use multiple
  28 .B \-\-file
  29 arguments. If this option is omitted, the config file
  30 .B openocd.cfg
  31 in the current working directory will be used.
  32 .TP
  33 .B "\-s, \-\-search <dirname>"
  34 Search for config files and scripts in the directory
  35 .BR <dirname> .
  36 If this option is omitted, OpenOCD searches for config files and scripts
  37 in the current directory.
  38 .TP
  39 .B "\-d, \-\-debug <debuglevel>"
  40 Set debug level. Possible values are:
  41 .br
  42 .RB "  * " 0 " (errors)"
  43 .br
  44 .RB "  * " 1 " (warnings)"
  45 .br
  46 .RB "  * " 2 " (informational messages)"
  47 .br
  48 .RB "  * " 3 " (debug messages)"
  49 .br
  50 The default level is
  51 .BR 2 .
  52 .TP
  53 .B "\-l, \-\-log_output <filename>"
  54 Redirect log output to the file
  55 .BR <filename> .
  56 Per default the log output is printed on
  57 .BR stderr .
  58 .TP
  59 .B "\-c, \-\-command <cmd>"
  60 Run the command
  61 .BR <cmd> .
  62 .TP
  63 .B "\-p, \-\-pipe"
  64 Use pipes when talking to gdb.
  65 .TP
  66 .B "\-h, \-\-help"
  67 Show a help text and exit.
  68 .TP
  69 .B "\-v, \-\-version"
  70 Show version information and exit.
  71 .SH "BUGS"
  72 Please report any bugs on the mailing list at
  73 .BR openocd\-development@lists.berlios.de .
  74 .SH "LICENCE"
  75 .B OpenOCD
  76 is covered by the GNU General Public License (GPL), version 2 or later.
  77 .SH "SEE ALSO"
  78 .BR jtag (1)
  79 .PP
  80 The full documentation for
  81 .B openocd
  82 is maintained as a Texinfo manual. If the
  83 .BR info
  84 (or
  85 .BR pinfo )
  86 and
  87 .BR openocd
  88 programs are properly installed at your site, the command
  89 .B info openocd
  90 should give you access to the complete manual.
  91 .PP
  92 Also, the OpenOCD wiki contains some more information and examples:
  93 .B http://openfacts.berlios.de/index-en.phtml?title=Open_On-Chip_Debugger
  94 .SH "AUTHORS"
  95 Please see the file AUTHORS.
  96 .PP
  97 This manual page was written by Uwe Hermann <uwe@hermann\-uwe.de>.
  98 It is licensed under the terms of the GNU GPL (version 2 or later).