doc/openocd.1

   1 .TH "OPENOCD" "1" "February 29, 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\-fsdlchv\fR] [\fB\-\-file\fR <filename>] [\fB\-\-search\fR <dirname>] [\fB\-\-debug\fR <debuglevel>] [\fB\-\-log_output\fR <filename>] [\fB\-\-command\fR <cmd>] [\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 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 "\-s, \-\-search <dirname>"
  32 Search for config files and scripts in the directory
  33 .BR <dirname> .
  34 If this option is omitted, openocd searches for config files and scripts
  35 in the current directory.
  36 .TP
  37 .B "\-d, \-\-debug <debuglevel>"
  38 Set debug level. Possible values are:
  39 .br
  40 .RB "  * " 0 " (errors)"
  41 .br
  42 .RB "  * " 1 " (warnings)"
  43 .br
  44 .RB "  * " 2 " (informational messages)"
  45 .br
  46 .RB "  * " 3 " (debug messages)"
  47 .br
  48 The default level is
  49 .BR 2 .
  50 .TP
  51 .B "\-l, \-\-log_output <filename>"
  52 Redirect log output to the file
  53 .BR <filename> .
  54 Per default the log output is printed on
  55 .BR stderr .
  56 .TP
  57 .B "\-c, \-\-command <cmd>"
  58 Run the command
  59 .BR <cmd> .
  60 .TP
  61 .B "\-h, \-\-help"
  62 Show a help text and exit.
  63 .TP
  64 .B "\-v, \-\-version"
  65 Show version information and exit.
  66 .SH "BUGS"
  67 Please report any bugs at
  68 .B http://developer.berlios.de/bugs/?group_id=4148
  69 or on the mailing list
  70 .BR openocd\-development@lists.berlios.de .
  71 .SH "LICENCE"
  72 .B OpenOCD
  73 is covered by the GNU General Public License (GPL), version 2 or later.
  74 .SH "SEE ALSO"
  75 .BR jtag (1)
  76 .PP
  77 The full documentation for
  78 .B openocd
  79 is maintained as a Texinfo manual. If the
  80 .BR info
  81 and
  82 .BR openocd
  83 programs are properly installed at your site, the command
  84 .B info flex
  85 should give you access to the complete manual.
  86 .PP
  87 Also, the OpenOCD wiki contains some more information and examples:
  88 .B http://openfacts.berlios.de/index-en.phtml?title=Open_On-Chip_Debugger
  89 .SH "AUTHORS"
  90 Please see the file AUTHORS.
  91 .PP
  92 This manual page was written by Uwe Hermann <uwe@hermann\-uwe.de>.
  93 It is licensed under the terms of the GNU GPL (version 2 or later).