-.TH "OPENOCD" "1" "July 26, 2007" "" ""
+.TH "OPENOCD" "1" "February 29, 2008"
.SH "NAME"
openocd \- A free and open on\-chip debugging, in\-system programming and
-boundary\-scan testing tool for ARM systems (currently ARM7/9, XScale, and Cortex\-M3)
+boundary\-scan testing tool for ARM systems
.SH "SYNOPSIS"
-.B openocd \fR[\fB\-fdlh\fR] [\fB\-\-file\fR <filename>] [\fB\-\-debug\fR <debuglevel>] [\fB\-\-log_output\fR <filename>] [\fB\-\-help]
+.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]
.SH "DESCRIPTION"
.B OpenOCD
is an on\-chip debugging, in\-system programming and boundary\-scan
testing tool for ARM systems.
.PP
The debugger uses an IEEE 1149\-1 compliant JTAG TAP bus master to access
-on\-chip debug functionality available on ARM7/9, XScale, and Cortex-M3 based
+on\-chip debug functionality available on ARM7/9, XScale, Cortex-M3, and
+Marvell Feroceon (as found in the Orion SoC family) based
microcontrollers / system\-on\-chip solutions.
.PP
User interaction is realized through a telnet command line interface and
a gdb (the GNU debugger) remote protocol server.
.PP
-OpenOCD supports various different types of JTAG interfaces/programmers:
- * Parallel port wigglers, e.g.
- * Macraigor Wiggler JTAG cable
- * Gateworks GW16012 JTAG programmer
- * Xilinx DLC5 JTAG parallel cable III
- * Ka-Ro TRITON starterkit II JTAG cable
- * Lattice parallel port JTAG cable
- * ST FlashLINK programming cable
- * Amontec JTAG Accelerator
- * FTDI FT2232 based USB devices
- * USBJTAG
- * OOCD\-Link
- * Amontec JTAGkey
- * Amontec JTAGkey\-Tiny
- * Olimex ARM\-USB\-OCD
- * eVerve Signalyzer
- * American Microsystem M5960
- * Turtelizer 2
- * Hitex STR9-comSTICK
- * Luminary Micro evb_lm3s811
- * ASIX PRESTO
- * usbprog
-.PP
-It also supports a number of different ARM7/9 cores:
- * ARM7TDMI(\-s)
- * ARM720t
- * ARM9TDMI
- * ARM920t
- * ARM922t
- * ARM926ej\-s
- * ARM966e
- * Cortex-M3
-.PP
-Support for Intel XScale CPUs is also included:
- * PXA25x
- * PXA27x
- * IXP42x
+OpenOCD supports various different types of JTAG interfaces/programmers,
+please check the README for the complete list.
.SH "OPTIONS"
.TP
.B "\-f, \-\-file <filename>"
.B openocd.cfg
in the current working directory will be used.
.TP
+.B "\-s, \-\-search <dirname>"
+Search for config files and scripts in the directory
+.BR <dirname> .
+If this option is omitted, openocd searches for config files and scripts
+in the current directory.
+.TP
.B "\-d, \-\-debug <debuglevel>"
Set debug level. Possible values are:
.br
Per default the log output is printed on
.BR stderr .
.TP
+.B "\-c, \-\-command <cmd>"
+Run the command
+.BR <cmd> .
+.TP
.B "\-h, \-\-help"
Show a help text and exit.
-.\".TP
-.\".B "\-v, \-\-version"
-.\"Show version information and exit.
+.TP
+.B "\-v, \-\-version"
+Show version information and exit.
.SH "BUGS"
Please report any bugs at
.B http://developer.berlios.de/bugs/?group_id=4148
.SH "LICENCE"
.B OpenOCD
is covered by the GNU General Public License (GPL), version 2 or later.
-.\"
.SH "SEE ALSO"
.BR jtag (1)
+.PP
+The full documentation for
+.B openocd
+is maintained as a Texinfo manual. If the
+.BR info
+and
+.BR openocd
+programs are properly installed at your site, the command
+.B info flex
+should give you access to the complete manual.
+.PP
+Also, the OpenOCD wiki contains some more information and examples:
+.B http://openfacts.berlios.de/index-en.phtml?title=Open_On-Chip_Debugger
.SH "AUTHORS"
-Dominic Rath <Dominic.Rath@gmx.de>
-.br
-Magnus Lundin <lundin@mlu.mine.nu>
-.br
-Michael Fischer <fischermi@t\-online.de>
-.br
-Spencer Oliver <spen@spen\-soft.co.uk>
-.br
-and others
+Please see the file AUTHORS.
.PP
This manual page was written by Uwe Hermann <uwe@hermann\-uwe.de>.
-It is licensed under the terms of the GNU GPL (v2 or later).
+It is licensed under the terms of the GNU GPL (version 2 or later).
projects / openocd / blobdiff