X-Git-Url: https://review.openocd.org/gitweb?a=blobdiff_plain;f=doc%2Fopenocd.1;h=cfb99af9c3ba67fa67ccd39607680a73f0bfe3b9;hb=769fa69b9ada68df69b5ca5c1139fda32940bf80;hp=85dac9f782edaa7e3c8ab78859d59896e6231de7;hpb=6d0aa6dc05ce83941d59eb6c3617b35f7595cf2c;p=openocd.git diff --git a/doc/openocd.1 b/doc/openocd.1 index 85dac9f782..cfb99af9c3 100644 --- a/doc/openocd.1 +++ b/doc/openocd.1 @@ -1,9 +1,9 @@ -.TH "OPENOCD" "1" "February 28, 2008" +.TH "OPENOCD" "1" "February 29, 2008" .SH "NAME" openocd \- A free and open on\-chip debugging, in\-system programming and boundary\-scan testing tool for ARM systems .SH "SYNOPSIS" -.B openocd \fR[\fB\-fdlh\fR] [\fB\-\-file\fR ] [\fB\-\-debug\fR ] [\fB\-\-log_output\fR ] [\fB\-\-help\fR] +.B openocd \fR[\fB\-fsdlchv\fR] [\fB\-\-file\fR ] [\fB\-\-search\fR ] [\fB\-\-debug\fR ] [\fB\-\-log_output\fR ] [\fB\-\-command\fR ] [\fB\-\-help\fR] [\fB\-\-version\fR] .SH "DESCRIPTION" .B OpenOCD is an on\-chip debugging, in\-system programming and boundary\-scan @@ -28,6 +28,12 @@ If this option is omitted, the config file .B openocd.cfg in the current working directory will be used. .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 .B "\-d, \-\-debug " Set debug level. Possible values are: .br @@ -48,11 +54,15 @@ Redirect log output to the file Per default the log output is printed on .BR stderr . .TP +.B "\-c, \-\-command " +Run the command +.BR . +.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 @@ -63,6 +73,19 @@ or on the mailing list 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 +and +.BR openocd +programs are properly installed at your site, the command +.B info flex +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