flash: add padded_value cmd
[openocd.git] / doc / openocd.1
index f4ba7d96bf5618ce00be0b1c8757678217aef508..4278486e5da42a17847a537f1aee1af00af72f1c 100644 (file)
@@ -1,73 +1,84 @@
-.TH "OPENOCD" "1" "February 29, 2008"
+.TH "OPENOCD" "1" "November 24, 2009"
 openocd \- A free and open on\-chip debugging, in\-system programming and
-boundary\-scan testing tool for ARM systems
+boundary\-scan testing tool for ARM and MIPS systems
-.B openocd \fR[\fB\-fsdlch\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]
+.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]
 .B OpenOCD
 is an on\-chip debugging, in\-system programming and boundary\-scan
-testing tool for ARM systems.
+testing tool for various ARM and MIPS systems.
 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.
-User interaction is realized through a telnet command line interface and
-a gdb (the GNU debugger) remote protocol server.
+on\-chip debug functionality available on ARM based microcontrollers or
+system-on-chip solutions. For MIPS systems the EJTAG interface is supported.
+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.
 OpenOCD supports various different types of JTAG interfaces/programmers,
-please check the README for the complete list.
+please check the \fIopenocd\fR info page for the complete list.
 .B "\-f, \-\-file <filename>"
-Use configuration file
-.BR <filename> .
-If this option is omitted, the config file
+This is a shortcut for a \fB\-c "[script \fI<filename>\fB]"\fR
+command, using a search path to load the configuration file
+.IR <filename> .
+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.
+in the search path will be used.
 .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.
+.I <dirname>
+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.
 .B "\-d, \-\-debug <debuglevel>"
 Set debug level. Possible values are:
 .RB "  * " 0 " (errors)"
 .RB "  * " 1 " (warnings)"
 .RB "  * " 2 " (informational messages)"
 .RB "  * " 3 " (debug messages)"
 The default level is
 .BR 2 .
 .B "\-l, \-\-log_output <filename>"
 Redirect log output to the file
-.BR <filename> .
+.IR <filename> .
 Per default the log output is printed on
 .BR stderr .
 .B "\-c, \-\-command <cmd>"
-Run the command
-.BR <cmd> .
+Add the command
+.I <cmd>
+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.
+.B "\-p, \-\-pipe"
+Use pipes when talking to gdb.
 .B "\-h, \-\-help"
 Show a help text and exit.
-.\".B "\-v, \-\-version"
-.\"Show version information and exit.
+.B "\-v, \-\-version"
+Show version information and exit.
-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 .
 .B OpenOCD
 is covered by the GNU General Public License (GPL), version 2 or later.
@@ -78,16 +89,15 @@ The full documentation for
 .B openocd
 is maintained as a Texinfo manual. If the
 .BR info
+.BR pinfo )
 .BR openocd
 programs are properly installed at your site, the command
-.B info flex
+.B info openocd
 should give you access to the complete manual.
-Also, the OpenOCD wiki contains some more information and examples:
-.B http://openfacts.berlios.de/index-en.phtml?title=Open_On-Chip_Debugger
 Please see the file AUTHORS.
 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).

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)