flash/nor/str9xpec: fix help and usage for command "part_id"

[openocd.git] / doc / openocd.1

diff --git a/doc/openocd.1 b/doc/openocd.1
index f4ba7d96bf5618ce00be0b1c8757678217aef508..4278486e5da42a17847a537f1aee1af00af72f1c 100644 (file)
--- a/doc/openocd.1
+++ b/doc/openocd.1
@@ -1,73 +1,84 @@
-.TH "OPENOCD" "1" "February 29, 2008"
+.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
+boundary\-scan testing tool for ARM and MIPS systems
 .SH "SYNOPSIS"
-.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]
 .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, 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 
+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 README for the complete list.
+please check the \fIopenocd\fR info page for the complete list.
 .SH "OPTIONS"
-.TP 
+.TP
 .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.
-.TP 
+in the search path 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 
+Add
+.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.
+.TP
 .B "\-d, \-\-debug <debuglevel>"
 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 <filename>"
 Redirect log output to the file
-.BR <filename> .
+.IR <filename> .
 Per default the log output is printed on
 .BR stderr .
-.TP 
+.TP
 .B "\-c, \-\-command <cmd>"
-Run the command
-.BR <cmd> .
-.TP 
+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.
+.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.
@@ -78,16 +89,15 @@ 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 flex
+.B info openocd
 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 
+.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).