imi415/openocd
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Uwe Hermann: mproves the manpage text a bit and adds the

Browse Source 
missing -s and -c options.

git-svn-id: svn://svn.berlios.de/openocd/trunk@394 b42882b7-edfa-0310-969c-e2dbd0fdcd60
This commit is contained in:
oharboe 2008-02-29 12:30:21 +00:00
parent fb2c709166
commit 315cbed1fb
1 changed files with 25 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
doc/openocd.1
View File

@ -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 <filename>] [\fB\-\-debug\fR <debuglevel>] [\fB\-\-log_output\fR <filename>] [\fB\-\-help\fR]
.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]
.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 <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
@ -48,6 +54,10 @@ 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 "\-h, \-\-help"
Show a help text and exit.
.\".TP
@ -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