Major Section: DOCUMENTATION
:docs command only makes sense at the terminal.
:docs command is given a
stringp argument it searches the
text produced by
more-doc and lists all the
documented topics whose text contains the given string. For purposes of this
string matching we ignore distinctions of case and the amount and kind (but
not presence) of white space. We also treat hyphen as whitespace.
However, the following examples show how
:docs can be used on other than
Examples: ACL2 !>:docs * ; lists documentation sections ACL2 !>:docs ** ; lists all documented topics within all sections ACL2 !>:docs events ; lists all topics in section EVENTS ACL2 !>:docs "compil" ; lists topics ``apropos''
The database of formatted documentation strings is structured into
sections. Within a section are topics. Each topic has a one-liner,
some notes, and some detailed discussions. The
provides a view of the entire database.
:docs takes one argument, as described below:
arg effect * list all section headings in the database ** list all section headings and all topics within each section name list all topics in the section named name (where name is some symbol other than * and **). This is always the same as :doc name. pattern list all topics whose :doc or :more-doc text mentions the string pattern. For purposes of this string matching we ignore distinctions of case and the amount and kind (but not presence) of white space. We also treat hyphen as whitespace.