doc/openocd.1

   1 .TH "OPENOCD" "1" "June 18, 2024"
   2 .SH "NAME"
   3 openocd \- A free and open on\-chip debugging, in\-system programming and
   4 boundary\-scan testing tool for microcontrollers and other embedded devices
   5 .SH "SYNOPSIS"
   6 .B openocd \fR[\fB\-fsdlchv\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] [\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 microcontrollers and other embedded devices.
  11 .PP
  12 Various different types of debug adapters as well as transport protocols like
  13 JTAG and SWD are supported by OpenOCD, please check the \fIopenocd\fR info page
  14 for the complete list.
  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 .SH "OPTIONS"
  20 .TP
  21 .B "\-f, \-\-file <filename>"
  22 This is a shortcut for a \fB\-c "[script \fI<filename>\fB]"\fR
  23 command, using a search path to load the configuration file
  24 .IR <filename> .
  25 In order to specify multiple config files, you can use multiple
  26 .B \-\-file
  27 arguments. If no such \fB\-c\fR
  28 options are included, the first config file
  29 .B openocd.cfg
  30 in the search path will be used.
  31 .TP
  32 .B "\-s, \-\-search <dirname>"
  33 Add
  34 .I <dirname>
  35 to the search path used for config files and scripts.
  36 The search path begins with the current directory,
  37 then includes these additional directories before other
  38 components such as the standard OpenOCD script libraries.
  39 .TP
  40 .B "\-d, \-\-debug <debuglevel>"
  41 Set debug level. Possible values are:
  42 .br
  43 .RB "  * " 0 " (errors)"
  44 .br
  45 .RB "  * " 1 " (warnings)"
  46 .br
  47 .RB "  * " 2 " (informational messages)"
  48 .br
  49 .RB "  * " 3 " (debug messages)"
  50 .br
  51 The default level is
  52 .BR 2 .
  53 .TP
  54 .B "\-l, \-\-log_output <filename>"
  55 Redirect log output to the file
  56 .IR <filename> .
  57 Per default the log output is printed on
  58 .BR stderr .
  59 .TP
  60 .B "\-c, \-\-command <cmd>"
  61 Add the command
  62 .I <cmd>
  63 to a list of commands executed on server startup.
  64 Note that you will need to explicitly invoke
  65 .I init
  66 if the command requires access to a target or flash.
  67 .TP
  68 .TP
  69 .B "\-h, \-\-help"
  70 Show a help text and exit.
  71 .TP
  72 .B "\-v, \-\-version"
  73 Show version information and exit.
  74 .SH "BUGS"
  75 Please report any bugs on the mailing list at
  76 .BR openocd\-devel@lists.sourceforge.net .
  77 .SH "LICENCE"
  78 .B OpenOCD
  79 is covered by the GNU General Public License (GPL), version 2 or later.
  80 .PP
  81 The full documentation for
  82 .B openocd
  83 is maintained as a Texinfo manual. If the
  84 .BR info
  85 (or
  86 .BR pinfo )
  87 and
  88 .BR openocd
  89 programs are properly installed at your site, the command
  90 .B info openocd
  91 should give you access to the complete manual.
  92 .SH "AUTHORS"
  93 Please see the file AUTHORS.
  94 .PP
  95 This manual page was written by Uwe Hermann <uwe@hermann\-uwe.de>.
  96 It is licensed under the terms of the GNU GPL (version 2 or later).