2. Installing

vzDoc comes as a tarball with a filename of the form vzdoc-<version>-<platform>.tar.gz. It will unpack into a directory named vzdoc-<version>-<platform>.

Pick a directory in which to keep your vzDoc bits; reasonable choices might be /tools/verilab or (for personal use) ~/vzdoc.

Unpack the tarball; the commands will be something like...

% mkdir /tools/verilab # if it doesn't exist
% cd /tools/verilab
% tar xfz vzdoc-<version>-<platform>.tar.gz
# (that's assuming GNU tar, which will do the gunzip'ping as well)

Now simply cause vzDoc to be in your PATH. Assuming that /usr/local/bin is a common directory in your users' PATH, something like this would work fine:

% cd /usr/local/bin
% ln -s /tools/verilab/vzdoc-<version>-<platform>/bin/vzdoc vzdoc

Test it:

% cd <ANYWHERE>
% vzdoc myfile.vr

For further customisation of vzDoc's behaviour, users may with to consult Section 2, “Invoking vzDoc.