X-Git-Url: https://review.openocd.org/gitweb?a=blobdiff_plain;f=doc%2Fopenocd.1;h=d9f8a7c0570a8eef1cc992044aa89d72e9f189fa;hb=07c06ec5e23ae90a3a1f8faba60828b453ff6be7;hp=b352521956fa4799282d8384e4e78b040b321f24;hpb=ebd5afbb0e879aeb124f62fdf0bdb6ff5889834b;p=openocd.git diff --git a/doc/openocd.1 b/doc/openocd.1 index b352521956..d9f8a7c057 100644 --- a/doc/openocd.1 +++ b/doc/openocd.1 @@ -1,4 +1,4 @@ -.TH "OPENOCD" "1" "January 08, 2009" +.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 and MIPS systems @@ -8,19 +8,19 @@ boundary\-scan testing tool for ARM and MIPS systems .B OpenOCD is an on\-chip debugging, in\-system programming and boundary\-scan testing tool for various ARM and MIPS systems. -.PP +.PP The debugger uses an IEEE 1149\-1 compliant JTAG TAP bus master to access on\-chip debug functionality available on ARM based microcontrollers or system-on-chip solutions. For MIPS systems the EJTAG interface is supported. -.PP +.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 +.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 . @@ -29,49 +29,47 @@ In order to specify multiple config files, you can use multiple arguments. If this option is omitted, the config file .B openocd.cfg in the current working directory will be used. -.TP +.TP .B "\-s, \-\-search " Search for config files and scripts in the directory .BR . If this option is omitted, OpenOCD searches for config files and scripts in the current directory. -.TP +.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 . Per default the log output is printed on .BR stderr . -.TP +.TP .B "\-c, \-\-command " Run the command .BR . -.TP +.TP .B "\-p, \-\-pipe" Use pipes when talking to gdb. -.TP +.TP .B "\-h, \-\-help" Show a help text and exit. -.TP +.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 +Please report any bugs on the mailing list at .BR openocd\-development@lists.berlios.de . .SH "LICENCE" .B OpenOCD @@ -95,6 +93,6 @@ 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 . It is licensed under the terms of the GNU GPL (version 2 or later).