Kit
A command-line program for using vl in basic ways.
The VL Toolkit (``kit'') is a standalone program that lets
you use various parts of VL from the command-line. It currently includes:
- A Verilog/SystemVerilog linter, vl-lint
- A server that powers a web-based module browser, vl-server
- A shell for launching ACL2 with VL pre-loaded, vl-shell
- Some miscellaneous commands.
Note that the kit is intended to be a convenient, but not complete
way to use VL. We generally intend VL to be a useful ACL2 library, not a
standalone program. Most VL functions don't have any command-line
wrappers.
Installation
To build the kit, just run make vl in the acl2/books directory.
This should produce an executable at acl2/books/centaur/vl/bin/vl.
Usage
The top-level vl program is really just a wrapper for several
sub-commands:
VL Verilog Toolkit
Copyright (C) 2008-2016 Centaur Technology
Usage: vl <command> [arguments]
Commands:
help Print this message, or get help on a particular VL command
lint Find potential bugs in a Verilog design
gather Collect Verilog files into a single file
server Start a VL web server for web-based module browsing
shell Interactive VL shell (for experts)
zip Save a .vlzip file for the VL web server
Use 'vl help <command>' for help on a specific command.
Extending the Kit
If you develop your own VL functionality, you can create an extended kit
that knows how to run your additional commands. See in particular vl-toolkit-other-command.
Subtopics
- Vl-lint
- A linting tool for Verilog and SystemVerilog.
- Vl-server
- The VL server powers the Module Browser, a web-based interface for
viewing Verilog designs.
- Vl-gather
- Collect SystemVerilog files from across your design into a single
file.
- Vl-zip
- Parse a SystemVerilog design and save it as a .vlzip file,
typically for use with the vl-server.
- Vl-main
- Top level entry point into the kit. This just handles the
command-line parsing and invokes the right sub-command for the vl
executable.
- Split-plusargs
- Split command line arguments into plusargs and non-plusargs.
- Vl-shell
- An interactive VL command loop. Allows you to use the VL kit
as a normal copy of ACL2 with VL preloaded.
- Vl-json
- Parse a SystemVerilog design and save it as a .json file.
