• Top
  • Documentation
  • Books
  • Boolean-reasoning
  • Projects
  • Debugging
  • Std
  • Proof-automation
  • Macro-libraries
  • ACL2
  • Interfacing-tools
  • Hardware-verification
    • Gl
    • Esim
    • Vl2014
      • Warnings
      • Primitives
      • Use-set
      • Syntax
      • Getting-started
      • Utilities
      • Loader
      • Transforms
      • Lint
      • Mlib
      • Server
      • Kit
        • Vl-model
        • Vl-json
        • Vl-gather
        • Vl-server
        • Vl-pp
        • Vl-lint
        • Vl-main
        • Vl-toolkit-other-command
        • Vl-help
          • Vl-toolkit-help-message
      • Printer
      • Esim-vl
      • Well-formedness
    • Sv
    • Vwsim
    • Fgl
    • Vl
    • X86isa
    • Svl
    • Rtl
  • Software-verification
  • Math
  • Testing-utilities

• Kit

Vl-help

The vl help command.

Signature

(vl-help args &key (state 'state)) → state

Arguments

args — Guard (string-listp args).

Definitions and Theorems

Function: vl-help-fn

(defun vl-help-fn (args state)
  (declare (xargs :stobjs (state)))
  (declare (xargs :guard (string-listp args)))
  (let ((__function__ 'vl-help))
    (declare (ignorable __function__))
    (b* (((unless (or (atom args) (atom (cdr args))))
          (die "Usage: vl help <command>~%")
          state)
         (command (if (atom args) "help" (car args)))
         (help (vl-toolkit-help-message command))
         ((unless help)
          (die "Unknown command ~s0." command)
          state))
      (vl-cw-ps-seq (vl-print help))
      state)))

Subtopics

Vl-toolkit-help-message

Look up the help message for a VL kit program.