X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=doc%2Fopenocd.1;h=b352521956fa4799282d8384e4e78b040b321f24;hp=d3135300ddf940f1f80c5710769f8d2139299cf6;hb=96ff1d278b58dcdc61bb2923d60851da295f7537;hpb=53d1f9b2ca5718e4996e9cf3406f857d0ed26df2

diff --git a/doc/openocd.1 b/doc/openocd.1
index d3135300dd..b352521956 100644
--- a/doc/openocd.1
+++ b/doc/openocd.1
@@ -1,57 +1,41 @@
-.TH "OPENOCD" "1" "May 03, 2007" "" ""
+.TH "OPENOCD" "1" "January 08, 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 and XScale, Cortex\-M3 support to be merged)
+boundary\-scan testing tool for ARM and MIPS 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\-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.
+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 and XScale based
-microcontrollers / system\-on\-chip solutions.
+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 and
-a gdb (the GNU debugger) remote protocol server.
+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:
-  * Parallel port wigglers
-  * Amontec JTAG Accelerator
-  * FTDI FT2232 based USB devices
-  * USBJTAG
-  * OOCD\-Link
-  * Amontec JTAGkey
-  * Amontec JTAGkey\-Tiny
-  * Olimex ARM\-USB\-OCD
-  * eVerve Signalyzer
-  * ... other FT2232 based dongles
-.PP 
-It also supports a number of different ARM7/9 cores:
-  * ARM7TDMI(\-s)
-  * ARM720t
-  * ARM9TDMI
-  * ARM920t
-  * ARM922t
-  * ARM926ej\-s
-  * ARM966e
-.PP 
-Support for Intel XScale CPUs is also included:
-  * PXA25x
-  * IXP42x
-
-PXA27x debugging should be similar to the PXA25x but fails in the current
-version of OpenOCD.
+OpenOCD supports various different types of JTAG interfaces/programmers,
+please check the \fIopenocd\fR info page for the complete list.
 .SH "OPTIONS"
 .TP 
 .B "\-f, \-\-file <filename>"
 Use configuration file
 .BR <filename> .
-If this option is omitted, the config file
+In order to specify multiple config files, you can use multiple
+.B \-\-file
+arguments. 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 
@@ -72,11 +56,18 @@ Redirect log output to the file
 Per default the log output is printed on
 .BR stderr .
 .TP 
+.B "\-c, \-\-command <cmd>"
+Run the command
+.BR <cmd> .
+.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
@@ -85,19 +76,25 @@ or on the mailing list
 .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.
+.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).