mirror of
https://github.com/wfjm/w11.git
synced 2026-03-05 03:05:52 +00:00
88 lines
2.8 KiB
Groff
88 lines
2.8 KiB
Groff
.\" -*- nroff -*-
|
|
.\" $Id: xtwv.1 1235 2022-05-07 12:47:28Z mueller $
|
|
.\" SPDX-License-Identifier: GPL-3.0-or-later
|
|
.\" Copyright 2014-2022 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
|
|
.\"
|
|
.\" ------------------------------------------------------------------
|
|
.
|
|
.TH XTWV 1 2016-03-19 "Retro Project" "Retro Project Manual"
|
|
.\" ------------------------------------------------------------------
|
|
.SH NAME
|
|
xtwv \- Xilinx Tool Wrapper script for Vivado
|
|
.\" ------------------------------------------------------------------
|
|
.SH SYNOPSIS
|
|
.
|
|
.SY xtwv
|
|
.RI [ COMMAND ]
|
|
.YS
|
|
.
|
|
.\" ------------------------------------------------------------------
|
|
.SH DESCRIPTION
|
|
The Xilinx Vivado setup script redefines \fBPATH\fP and \fBLD_LIBRARY_PATH\fP.
|
|
The Vivado tools run fine in this environment, but other installed programs
|
|
on the system might fail. \fBxtwv\fP helps to keep the Vivado environment
|
|
separate from the normal working environment.
|
|
|
|
The environment variable \fBXTWV_PATH\fP must be set up to the install path
|
|
of the Vivado version to be used.
|
|
|
|
\fBxtwv\fP uses \fBXTWV_PATH\fP to locate the Vivado setup script, sources it,
|
|
and execs the \fICOMMAND\fP. This way \fICOMMAND\fP is executed in the
|
|
Vivado environment, while the login shell stays clean.
|
|
|
|
\fBxtwi\fP can also set up a clean environment when \fBBARE_PATH\fP and
|
|
\fBBARE_LD_LIBRARY_PATH\fP are defined.
|
|
|
|
.
|
|
.\" ------------------------------------------------------------------
|
|
.SH ENVIRONMENT
|
|
.TP 4
|
|
.B BXTWV_PATH
|
|
Install path of Vivado
|
|
.
|
|
.TP
|
|
.B BARE_PATH
|
|
Optional. If defined \fBxtwi\fP will set
|
|
.EX
|
|
export PATH=$BARE_PATH:$RETROBASE/tools/bin
|
|
.EE
|
|
LD_LIBRARY_PATH will be unset unless BARE_LD_LIBRARY_PATH is
|
|
defined too.
|
|
.
|
|
.TP
|
|
.B BARE_LD_LIBRARY_PATH
|
|
Optional. If defined \fBxtwi\fP will set
|
|
.EX
|
|
export LD_LIBRARY_PATH=$BARE_LD_LIBRARY_PATH
|
|
.EE
|
|
Used only when BARE_PATH is defined.
|
|
.
|
|
.\" ------------------------------------------------------------------
|
|
.SH FILES
|
|
.TP 4
|
|
$XTWV_PATH/settings32.sh
|
|
.TQ
|
|
$XTWV_PATH/settings64.sh
|
|
Vivado setup script located and sourced on 32 or 64 bit systems
|
|
.
|
|
.\" ------------------------------------------------------------------
|
|
.SH "NOTES"
|
|
Vivado is a lot less intrusive than ISE, but it's still a good precaution to
|
|
wrap calls of Vivado tools with \fBxtwv\fP.
|
|
.br
|
|
If both Vivado and ISE are used \fBxtwv\fP and \fBxtwi\fP(1) offer a convenient
|
|
way to have both tools available in one session without interference.
|
|
.
|
|
.\" ------------------------------------------------------------------
|
|
.SH EXAMPLES
|
|
.IP "\fBxtwv vivado -mode batch -source test.tcl" 4
|
|
Starts Vivado in batch mode and executes the script \fItest.tcl\fP.
|
|
.
|
|
.\" ------------------------------------------------------------------
|
|
.SH "SEE ALSO"
|
|
.BR xtwi (1)
|
|
.
|
|
.\" ------------------------------------------------------------------
|
|
.SH AUTHOR
|
|
Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
|