.\" Automatically generated by Pandoc 2.9.2.1
.\"
.TH "VALINOR" "1" "May 2019" "1.1.4" "User Commands"
.hy
.SH NAME
.PP
\f[B]valinor\f[R] - generate debugger project files, and launch a
debugger, to debug an ELF file
.SH SYNOPSIS
.PP
\f[B]valinor\f[R] [\f[B]--tool\f[R] \f[I]TOOL\f[R]]
[\f[B]--project-dir\f[R] \f[I]PROJECT_DIR\f[R]] [\f[B]--no-open\f[R]]
\f[B]-\[en]target\f[R] \f[I]TARGET\f[R] \f[B]executable\f[R]
.PP
\f[B]valinor\f[R] \f[B]\[en]-version\f[R]
.SH DESCRIPTION
.PP
\f[B]valinor\f[R] is designed to be used as a proxy debug command for
\f[B]yotta\f[R] targets to provide as their scripts.debug command.
.SH OPTIONS
.TP
-t, --tool \f[I]TOOL\f[R]
debug tool (IDE) to generate for (if omitted, a debug project will be
generated for an IDE detected on your system, defaulting to opening a
GDB debug session, if no known IDEs are detected)
.TP
-d, --project-dir \f[I]PROJECT_DIR\f[R]
directory in which to generate any necessary project files (default:
directory of the executable argument)
.TP
-n, --no-open
do not open debug session (generate the necessary files to enable
debugging and print command to proceed)
.TP
-\[en]target \f[I]TARGET\f[R]
target board to generate project file for (e.g.\ K64F) (this name is
passed to project_generator - any name it accepts will work)
.TP
--version
print version and exit
.SH YOTTA TARGET DEFINITIONS
.PP
To use valinor to add debug support to a yotta target description, add
the following to your target.json file (replacing K64F with the
project_generator target ID for the chip/board on your target):
.IP
.nf
\f[C]
\[dq]scripts\[dq]:{
    \[dq]debug\[dq]: [\[dq]valinor\[dq], \[dq]--target\[dq], \[dq]frdm-k64f\[dq], \[dq]$program\[dq]]
}
\f[R]
.fi
.SH REPORTING BUGS
.PP
Upstream bug tracker: https://github.com/ARMmbed/valinor/issues
.SH COPYRIGHT
.PP
Copyright (c) 2014-2015 ARM Limited
.SH AUTHOR
.PP
This manual page is based on the valinor documentation.
It was created by Nick Morrott <nickm@debian.org> for the Debian
GNU/Linux system, but may be used by others
.SH SEE ALSO
.PP
\f[B]yotta\f[R](1), \f[B]progen\f[R](1), \f[B]progendef\f[R](1)