Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
OPENOCD(1)		    General Commands Manual		    OPENOCD(1)

NAME
       openocd	- A free and open on-chip debugging, in-system programming and
       boundary-scan testing tool for microcontrollers and other embedded  de-
       vices

SYNOPSIS
       openocd	[-fsdlchv]  [--file  <filename>] [--search <dirname>] [--debug
       <debuglevel>]  [--log_output  <filename>]  [--command  <cmd>]  [--help]
       [--version]

DESCRIPTION
       OpenOCD	is  an	on-chip	 debugging,  in-system	programming and	bound-
       ary-scan	testing	tool for various microcontrollers and  other  embedded
       devices.

       Various	different  types of debug adapters as well as transport	proto-
       cols like JTAG and SWD are  supported  by  OpenOCD,  please  check  the
       openocd info page for the complete list.

       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.

OPTIONS
       -f, --file <filename>
	      This is a	shortcut for a -c "[script <filename>]"	command, using
	      a	search path to load the	configuration file <filename>.	In or-
	      der to specify multiple  config  files,  you  can	 use  multiple
	      --file  arguments. If no such -c options are included, the first
	      config file openocd.cfg in the search path will be used.

       -s, --search <dirname>
	      Add <dirname> to the search  path	 used  for  config  files  and
	      scripts.	 The  search  path  begins with	the current directory,
	      then includes these additional directories before	 other	compo-
	      nents such as the	standard OpenOCD script	libraries.

       -d, --debug <debuglevel>
	      Set debug	level. Possible	values are:
		* 0 (errors)
		* 1 (warnings)
		* 2 (informational messages)
		* 3 (debug messages)
	      The default level	is 2.

       -l, --log_output	<filename>
	      Redirect log output to the file <filename>.  Per default the log
	      output is	printed	on stderr.

       -c, --command <cmd>
	      Add  the	command	<cmd> to a list	of commands executed on	server
	      startup.	Note that you will need	to explicitly invoke  init  if
	      the command requires access to a target or flash.

       -h, --help
	      Show a help text and exit.

       -v, --version
	      Show version information and exit.

BUGS
       Please	report	 any   bugs   on   the	mailing	 list  at  openocd-de-
       vel@lists.sourceforge.net.

LICENCE
       OpenOCD is covered by the GNU General Public License (GPL),  version  2
       or later.

       The  full  documentation	for openocd is maintained as a Texinfo manual.
       If the info (or pinfo) and openocd programs are properly	 installed  at
       your  site, the command info openocd should give	you access to the com-
       plete manual.

AUTHORS
       Please see the file AUTHORS.

       This manual page	was written by Uwe Hermann  <uwe@hermann-uwe.de>.   It
       is licensed under the terms of the GNU GPL (version 2 or	later).

				 June 18, 2024			    OPENOCD(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=openocd&sektion=1&manpath=FreeBSD+Ports+15.0>

home | help