94 lines
2.8 KiB
Groff
94 lines
2.8 KiB
Groff
.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
|
|
.SH "SYNOPSIS"
|
|
.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, 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,
|
|
please check the README for the complete list.
|
|
.SH "OPTIONS"
|
|
.TP
|
|
.B "\-f, \-\-file <filename>"
|
|
Use configuration file
|
|
.BR <filename> .
|
|
If this option is omitted, the config file
|
|
.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
|
|
.RB " * " 0 " (errors)"
|
|
.br
|
|
.RB " * " 1 " (warnings)"
|
|
.br
|
|
.RB " * " 2 " (informational messages)"
|
|
.br
|
|
.RB " * " 3 " (debug messages)"
|
|
.br
|
|
The default level is
|
|
.BR 2 .
|
|
.TP
|
|
.B "\-l, \-\-log_output <filename>"
|
|
Redirect log output to the file
|
|
.BR <filename> .
|
|
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.
|
|
.SH "BUGS"
|
|
Please report any bugs at
|
|
.B http://developer.berlios.de/bugs/?group_id=4148
|
|
or on the mailing list
|
|
.BR openocd\-development@lists.berlios.de .
|
|
.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"
|
|
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 (version 2 or later).
|