X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=doc%2Fopenocd.1;h=4278486e5da42a17847a537f1aee1af00af72f1c;hp=b747c6d0a05c2d17caa228fa69f48292e5b3aa6f;hb=1f3ca0b5b81d9f9e4565cf177797a17ad37ef2c3;hpb=df4b030df770e905aae573b4825d62b3efc96515 diff --git a/doc/openocd.1 b/doc/openocd.1 index b747c6d0a0..4278486e5d 100644 --- a/doc/openocd.1 +++ b/doc/openocd.1 @@ -1,113 +1,103 @@ -.TH "OPENOCD" "1" "July 26, 2007" "" "" +.TH "OPENOCD" "1" "November 24, 2009" .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 and MIPS systems .SH "SYNOPSIS" -.B openocd \fR[\fB\-fdlh\fR] [\fB\-\-file\fR ] [\fB\-\-debug\fR ] [\fB\-\-log_output\fR ] [\fB\-\-help] +.B openocd \fR[\fB\-fsdlcphv\fR] [\fB\-\-file\fR ] [\fB\-\-search\fR ] [\fB\-\-debug\fR ] [\fB\-\-log_output\fR ] [\fB\-\-command\fR ] [\fB\-\-pipe\fR] [\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 +testing tool for various ARM and MIPS 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 -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 +on\-chip debug functionality available on ARM based microcontrollers or +system-on-chip solutions. For MIPS systems the EJTAG interface is supported. +.PP +User interaction is realized through a telnet command line interface, +a gdb (the GNU debugger) remote protocol server, and a simplified RPC +connection that can be used to interface with OpenOCD's Jim Tcl engine. +.PP +OpenOCD supports various different types of JTAG interfaces/programmers, +please check the \fIopenocd\fR info page for the complete list. .SH "OPTIONS" -.TP +.TP .B "\-f, \-\-file " -Use configuration file -.BR . -If this option is omitted, the config file +This is a shortcut for a \fB\-c "[script \fI\fB]"\fR +command, using a search path to load the configuration file +.IR . +In order to specify multiple config files, you can use multiple +.B \-\-file +arguments. If no such \fB\-c\fR +options are included, the first config file .B openocd.cfg -in the current working directory will be used. -.TP +in the search path will be used. +.TP +.B "\-s, \-\-search " +Add +.I +to the search path used for config files and scripts. +The search path begins with the current directory, +then includes these additional directories before other +components such as the standard OpenOCD script libraries. +.TP .B "\-d, \-\-debug " Set debug level. Possible values are: -.br +.br .RB " * " 0 " (errors)" -.br +.br .RB " * " 1 " (warnings)" -.br +.br .RB " * " 2 " (informational messages)" -.br +.br .RB " * " 3 " (debug messages)" -.br +.br The default level is .BR 2 . -.TP +.TP .B "\-l, \-\-log_output " Redirect log output to the file -.BR . +.IR . Per default the log output is printed on .BR stderr . -.TP +.TP +.B "\-c, \-\-command " +Add the command +.I +to a list of commands executed on server startup. +Note that you will need to explicitly invoke +.I init +if the command requires access to a target or flash. +.TP +.B "\-p, \-\-pipe" +Use pipes when talking to gdb. +.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 -or on the mailing list -.BR openocd\-development@lists.berlios.de . +Please report any bugs on the mailing list at +.BR openocd\-devel@lists.sourceforge.net . .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 +(or +.BR pinfo ) +and +.BR openocd +programs are properly installed at your site, the command +.B info openocd +should give you access to the complete manual. .SH "AUTHORS" -Dominic Rath -.br -Magnus Lundin -.br -Michael Fischer -.br -Spencer Oliver -.br -and others -.PP +Please see the file AUTHORS. +.PP This manual page was written by Uwe Hermann . -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).