w11 - /man/cat1/xtwv.0

XTWV(1)                      Retro Project Manual                      XTWV(1)


NAME
       xtwv - Xilinx Tool Wrapper script for Vivado

SYNOPSIS
       xtwv [COMMAND]

DESCRIPTION
       The Xilinx Vivado setup script redefines PATH and LD_LIBRARY_PATH.  The
       Vivado tools run fine in this environment, but other installed programs
       on  the  system  might  fail. xtwv helps to keep the Vivado environment
       separate from the normal working environment.

       The environment variable XTWV_PATH must be set up to the  install  path
       of the Vivado version to be used.

       xtwv  uses XTWV_PATH to locate the Vivado setup script, sources it, and
       execs the COMMAND. This way COMMAND is executed in the Vivado  environ-
       ment, while the login shell stays clean.

       xtwi can also set up a clean environment when BARE_PATH and BARE_LD_LI-
       BRARY_PATH are defined.


ENVIRONMENT
       BXTWV_PATH
           Install path of Vivado

       BARE_PATH
           Optional. If defined xtwi will set
              export PATH=$BARE_PATH:$RETROBASE/tools/bin
           LD_LIBRARY_PATH will be unset unless  BARE_LD_LIBRARY_PATH  is  de-
           fined too.

       BARE_LD_LIBRARY_PATH
           Optional. If defined xtwi will set
              export LD_LIBRARY_PATH=$BARE_LD_LIBRARY_PATH
           Used only when BARE_PATH is defined.

FILES
       $XTWV_PATH/settings32.sh
       $XTWV_PATH/settings64.sh
           Vivado setup script located and sourced on 32 or 64 bit systems

NOTES
       Vivado  is a lot less intrusive than ISE, but it's still a good precau-
       tion to wrap calls of Vivado tools with xtwv.
       If both Vivado and ISE are used xtwv and xtwi(1) offer a convenient way
       to have both tools available in one session without interference.

EXAMPLES
       xtwv vivado -mode batch -source test.tcl
           Starts Vivado in batch mode and executes the script test.tcl.

SEE ALSO
       xtwi(1)

AUTHOR
       Walter F.J. Mueller <W.F.J.Mueller@gsi.de>


Retro Project                     2016-03-19                           XTWV(1)