• Top
    • Documentation
    • Books
    • Boolean-reasoning
    • Projects
    • Debugging
    • Std
    • Proof-automation
    • Macro-libraries
    • ACL2
      • Theories
      • Rule-classes
      • Proof-builder
      • Recursion-and-induction
      • Hons-and-memoization
      • Events
        • Defun
        • Verify-guards
        • Table
        • Mutual-recursion
        • Memoize
        • Make-event
        • Include-book
          • Fast-cert
          • Show-books
          • Encapsulate
          • Defun-sk
          • Defttag
          • Defstobj
          • Defpkg
          • Defattach
          • Defabsstobj
          • Defchoose
          • Progn
          • Verify-termination
          • Redundant-events
          • Defmacro
          • Defconst
          • Skip-proofs
          • In-theory
          • Embedded-event-form
          • Value-triple
          • Comp
          • Local
          • Defthm
          • Progn!
          • Defevaluator
          • Theory-invariant
          • Assert-event
          • Defun-inline
          • Project-dir-alist
          • Partial-encapsulate
          • Define-trusted-clause-processor
          • Defproxy
          • Defexec
          • Defun-nx
          • Defthmg
          • Defpun
          • Defabbrev
          • Set-table-guard
          • Name
          • Defrec
          • Add-custom-keyword-hint
          • Regenerate-tau-database
          • Defcong
          • Deftheory
          • Defaxiom
          • Deftheory-static
          • Defund
          • Evisc-table
          • Verify-guards+
          • Logical-name
          • Profile
          • Defequiv
          • Defmacro-untouchable
          • Add-global-stobj
          • Defthmr
          • Defstub
          • Defrefinement
          • Deflabel
          • In-arithmetic-theory
          • Unmemoize
          • Defabsstobj-missing-events
          • Defthmd
          • Fake-event
          • Set-body
          • Defun-notinline
          • Functions-after
          • Macros-after
          • Dump-events
          • Defund-nx
          • Defun$
          • Remove-global-stobj
          • Remove-custom-keyword-hint
          • Dft
          • Defthy
          • Defund-notinline
          • Defnd
          • Defn
          • Defund-inline
          • Defmacro-last
        • Parallelism
        • History
        • Programming
        • Operational-semantics
        • Real
        • Start-here
        • Debugging
        • Miscellaneous
        • Output-controls
        • Macros
        • Interfacing-tools
      • Interfacing-tools
      • Hardware-verification
      • Software-verification
      • Math
      • Testing-utilities
    • Kestrel-utilities
    • Books
    • Include-book

    Show-books

    Return a tree representing the included books.

    General Forms:
    (show-books) ; Return a tree representing the included books,
                 ; in a format described below
    (show-books :sysfile :default) ; Same as above
    (show-books :sysfile t)   ; Same as above but using sysfiles when possible
    (show-books :sysfile nil) ; Same as above but using strings only

    The form (show-books) evaluates to a tree whose leaves consist of exactly one entry per book included in the current ACL2 session using include-book (either explicitly or by way of include-book forms within included books). The result thus has the following structure, which actually will probably be pretty obvious when you run show-books.

    result     ::= entry-list
    entry-list ::= nil | (entry . entry-list)
    entry      ::= (book-representation . entry-list)

    The :sysfile keyword controls the book-representation values in the result. When :sysfile is omitted or has value :default, the books will be represented using their full pathnames except as follows. When a book is in the community-books, it is represented as "[books]/pathname" where "pathname" is the book's pathname relative to the community-books directory. The only other exception can occur when you have set the project-dir-alist, in which case sysfile notation will be used for books residing under project directories; see sysfile.

    The other legal values of :sysfile are t and nil. With value t, sysfile notation will be used for all books residing in project directories, including the community books. With value nil, the full (absolute) pathname will be used for all books.

    Note that each book will be listed only once. If it was included by way of an include-book form within an included book, then it will be a child of the book that included it non-redundantly.