configure.ac: Fix misspelled variable
[openocd.git] / doc / openocd.1
1 .TH "OPENOCD" "1" "November 24, 2009"
2 .SH "NAME"
3 openocd \- A free and open on\-chip debugging, in\-system programming and
4 boundary\-scan testing tool for ARM and MIPS systems
5 .SH "SYNOPSIS"
6 .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]
7 .SH "DESCRIPTION"
8 .B OpenOCD
9 is an on\-chip debugging, in\-system programming and boundary\-scan
10 testing tool for various ARM and MIPS systems.
11 .PP
12 The debugger uses an IEEE 1149\-1 compliant JTAG TAP bus master to access
13 on\-chip debug functionality available on ARM based microcontrollers or
14 system-on-chip solutions. For MIPS systems the EJTAG interface is supported.
15 .PP
16 User interaction is realized through a telnet command line interface,
17 a gdb (the GNU debugger) remote protocol server, and a simplified RPC
18 connection that can be used to interface with OpenOCD's Jim Tcl engine.
19 .PP
20 OpenOCD supports various different types of JTAG interfaces/programmers,
21 please check the \fIopenocd\fR info page for the complete list.
22 .SH "OPTIONS"
23 .TP
24 .B "\-f, \-\-file <filename>"
25 This is a shortcut for a \fB\-c "[script \fI<filename>\fB]"\fR
26 command, using a search path to load the configuration file
27 .IR <filename> .
28 In order to specify multiple config files, you can use multiple
29 .B \-\-file
30 arguments. If no such \fB\-c\fR
31 options are included, the first config file
32 .B openocd.cfg
33 in the search path will be used.
34 .TP
35 .B "\-s, \-\-search <dirname>"
36 Add
37 .I <dirname>
38 to the search path used for config files and scripts.
39 The search path begins with the current directory,
40 then includes these additional directories before other
41 components such as the standard OpenOCD script libraries.
42 .TP
43 .B "\-d, \-\-debug <debuglevel>"
44 Set debug level. Possible values are:
45 .br
46 .RB "  * " 0 " (errors)"
47 .br
48 .RB "  * " 1 " (warnings)"
49 .br
50 .RB "  * " 2 " (informational messages)"
51 .br
52 .RB "  * " 3 " (debug messages)"
53 .br
54 The default level is
55 .BR 2 .
56 .TP
57 .B "\-l, \-\-log_output <filename>"
58 Redirect log output to the file
59 .IR <filename> .
60 Per default the log output is printed on
61 .BR stderr .
62 .TP
63 .B "\-c, \-\-command <cmd>"
64 Add the command
65 .I <cmd>
66 to a list of commands executed on server startup.
67 Note that you will need to explicitly invoke
68 .I init
69 if the command requires access to a target or flash.
70 .TP
71 .B "\-p, \-\-pipe"
72 Use pipes when talking to gdb.
73 .TP
74 .B "\-h, \-\-help"
75 Show a help text and exit.
76 .TP
77 .B "\-v, \-\-version"
78 Show version information and exit.
79 .SH "BUGS"
80 Please report any bugs on the mailing list at
81 .BR openocd\-development@lists.berlios.de .
82 .SH "LICENCE"
83 .B OpenOCD
84 is covered by the GNU General Public License (GPL), version 2 or later.
85 .SH "SEE ALSO"
86 .BR jtag (1)
87 .PP
88 The full documentation for
89 .B openocd
90 is maintained as a Texinfo manual. If the
91 .BR info
92 (or
93 .BR pinfo )
94 and
95 .BR openocd
96 programs are properly installed at your site, the command
97 .B info openocd
98 should give you access to the complete manual.
99 .SH "AUTHORS"
100 Please see the file AUTHORS.
101 .PP
102 This manual page was written by Uwe Hermann <uwe@hermann\-uwe.de>.
103 It is licensed under the terms of the GNU GPL (version 2 or later).