FunctionPackage: exclToCDocOverviewCGDocRelNotesFAQIndexPermutedIndex
Allegro CL version 10.0
Minimal update since the initial 10.0 release.
9.0 version

apropos-regexp

Arguments: string &optional package external-only case-insensitive

This function is just like apropos except the first string argument (which must be a string or a symbol) is interpreted as a regular expression. For example (the exact symbols listed may be different for you):

cl-user(2): (apropos-regexp "^def.n-.*")
excl::defun-like    [function] (xp list &rest args)
excl::defun-spec
excl::defun-proto-1
defun-proto         [macro] (name varlist &rest body)
ff::defun-foreign-callable-1 [function] (name arglist body)
ff:defun-c-callable [macro] (&whole form &rest args)
ff:defun-foreign-callable [macro] (name arglist &rest body)
sys::defun-noicheck
cl-user(3): 

The first optional argument, package, is similar to the same optional argument to apropos. It can be nil or a package designator. If it is a package designator, only symbols accessible in that package are considered.

The second and third optional arguments are Allegro CL extensions to apropos, as described in Extensions to cl:make-package, cl:disassemble, cl:open, cl:apropos in implementation.htm. If external-only is specified non-nil, only external symbols are considered. If case-insensitive is specified non-nil, a case-insensitive search is done, rather than a case-sensitive search. All the optional arguments default to nil. See Extensions to cl:make-package, cl:disassemble, cl:open, cl:apropos in implementation.htm for more information on the optional arguments.

apropos-regexp binds *print-alternate-package-name* to true

When printing output, apropos-regexp binds *print-alternate-package-name* to true, so package nicknames are always used when they exist. For example, the alternate name of the foreign-functions package is "ff", and we have:

cg-user(5): *print-alternate-package-name*
nil
cg-user(6): (format t "~S~%" 'ff:defun-foreign-callable)
foreign-functions:defun-foreign-callable
nil
cg-user(7): (apropos-regexp "^def.n-.*")
[...]
ff:defun-foreign-callable [macro] (ff::name arglist &rest ff::body)
cg-user(8): 

Copyright (c) 1998-2019, Franz Inc. Oakland, CA., USA. All rights reserved.
This page was not revised from the 9.0 page.
Created 2015.5.21.

ToCDocOverviewCGDocRelNotesFAQIndexPermutedIndex
Allegro CL version 10.0
Minimal update since the initial 10.0 release.
9.0 version