marcuskammer/cl-sites
1
0
Fork 0
Code Activity
cl-sites/novaspec.org/cl/f_apropos.html
Marcus Kammer 00674f4c59
Add novaspec
2025-02-05 18:52:26 +01:00

329 lines
No EOL
6.8 KiB
HTML
Raw Blame History

<!DOCTYPE HTML>
<HTML LANG="en-us"
><HEAD
><TITLE
>apropos, apropos-list | Common Lisp Nova Spec</TITLE
><META CHARSET="US-ASCII"
><LINK REL="canonical" HREF="f_apropos.html"
><LINK REL="next" HREF="f_describe.html" TYPE="text/html" TITLE="describe"
><LINK REL="prev" HREF="f_sleep.html" TYPE="text/html" TITLE="sleep"
><LINK REL="up" HREF="25_2_Environment_Dictionary.html" TYPE="text/html" TITLE="25.2 Environment Dictionary"
><LINK REL="start" HREF="index.html" TYPE="text/html" TITLE="Common Lisp Nova Spec"
><META NAME="VIEWPORT" CONTENT="width=device-width, initial-scale=1.0"
><LINK REL="STYLESHEET" HREF="dpans.css%3F3909942064.css"
><SCRIPT SRC="dpans.js%3F3909942064"
></SCRIPT
><SCRIPT SRC="apropos.js%3F3909942064"
></SCRIPT
></HEAD
><BODY
><DIV
><DIV CLASS="topnav"
><DIV CLASS="breadcrumb"
><SPAN CLASS="breadcrumb-item"
><A HREF="index.html"
>Common Lisp Nova Spec</A
></SPAN
> <SPAN CLASS="breadcrumb-item"
>&#8594; <A HREF="25_Environment.html"
>25. Environment</A
></SPAN
> <SPAN CLASS="breadcrumb-item"
>&#8594; <A HREF="25_2_Environment_Dictionary.html"
>25.2 Environment Dictionary</A
></SPAN
> <SPAN CLASS="breadcrumb-item"
>&#8594; <A HREF="f_apropos.html"
>apropos, apropos-list</A
></SPAN
></DIV
><DIV CLASS="apropos"
><DIV CLASS="apropos-io"
><A HREF="f_sleep.html" CLASS="prev"
>&#8592;</A
><SPAN ID="apropos-label"
>Apropos </SPAN
><INPUT ID="apropos" AUTOFOCUS="AUTOFOCUS" PLACEHOLDER="Type here to search" ONINPUT="aproposInput(this);" ONKEYUP="aproposKeyup(event);" ONCHANGE="aproposChange(this);" ONFOCUS="aproposFocus(this);" ONFOCUSOUT="aproposFocusout(this);"
><A HREF="f_describe.html" CLASS="next"
>&#8594;</A
></DIV
><DIV ID="apropos-res"
></DIV
></DIV
></DIV
><DIV CLASS="matter"
><DIV CLASS="com"
><DIV CLASS="begincom"
><HR
><TABLE WIDTH="100%" CELLSPACING="0" CELLPADDING="0"
><TR
><TD ALIGN="LEFT" VALIGN="BASELINE" WIDTH="100%" CLASS="name"
><SPAN CLASS="idx" DATA-KIND="idxref" DATA-TERM="apropos, apropos-list"
></SPAN
><B
>apropos, apropos-list</B
></TD
><TD ALIGN="RIGHT" VALIGN="BASELINE" WIDTH="0" NOWRAP="NOWRAP" CLASS="ftype"
><I
>Function</I
></TD
></TR
></TABLE
><HR
></DIV
><UL CLASS="subtoc"
></UL
><DL
><DT
><B
>Syntax</B
></DT
><DD
><P CLASS="j"
><B
>apropos</B
> <SPAN CLASS="cmssi"
>string</SPAN
> <SPAN CLASS="cmtt"
>&amp;optional</SPAN
> <SPAN CLASS="cmssi"
>package</SPAN
> <SPAN CLASS="arrow"
>&#8594;</SPAN
> &#10216;<I
>no</I
> <A HREF="26_1_Glossary.html#value"
><EM CLASS="term"
>values</EM
></A
>&#10217;</P
><P CLASS="j"
><B
>apropos-list</B
> <SPAN CLASS="cmssi"
>string</SPAN
> <SPAN CLASS="cmtt"
>&amp;optional</SPAN
> <SPAN CLASS="cmssi"
>package</SPAN
> <SPAN CLASS="arrow"
>&#8594;</SPAN
> <SPAN CLASS="cmssi"
>symbols</SPAN
></P
></DD
><DT
><B
>Arguments and Values</B
></DT
><DD
><P CLASS="j"
><VAR CLASS="param"
>string</VAR
> &#8212; a <A HREF="26_1_Glossary.html#string_designator"
><EM CLASS="term"
>string designator</EM
></A
>. </P
><P CLASS="j"
><VAR CLASS="param"
>package</VAR
> &#8212; a <A HREF="26_1_Glossary.html#package_designator"
><EM CLASS="term"
>package designator</EM
></A
> or <SPAN CLASS="misc"
><B
>nil</B
></SPAN
>. The default is <SPAN CLASS="misc"
><B
>nil</B
></SPAN
>. </P
><P CLASS="j"
><VAR CLASS="param"
>symbols</VAR
> &#8212; a <A HREF="26_1_Glossary.html#list"
><EM CLASS="term"
>list</EM
></A
> of <A HREF="26_1_Glossary.html#symbol"
><EM CLASS="term"
>symbols</EM
></A
>.</P
></DD
><DT
><B
>Description</B
></DT
><DD
><P CLASS="j"
>These functions search for <A HREF="26_1_Glossary.html#interned"
><EM CLASS="term"
>interned</EM
></A
> <A HREF="26_1_Glossary.html#symbol"
><EM CLASS="term"
>symbols</EM
></A
> whose <A HREF="26_1_Glossary.html#name"
><EM CLASS="term"
>names</EM
></A
> contain the substring <VAR CLASS="param"
>string</VAR
>. </P
><P CLASS="j"
>For <A HREF="f_apropos.html" CLASS="funref"
><B
>apropos</B
></A
>, as each such <A HREF="26_1_Glossary.html#symbol"
><EM CLASS="term"
>symbol</EM
></A
> is found, its name is printed on <A HREF="26_1_Glossary.html#standard_output"
><EM CLASS="term"
>standard output</EM
></A
>. In addition, if such a <A HREF="26_1_Glossary.html#symbol"
><EM CLASS="term"
>symbol</EM
></A
> is defined as a <A HREF="26_1_Glossary.html#function"
><EM CLASS="term"
>function</EM
></A
> or <A HREF="26_1_Glossary.html#dynamic_variable"
><EM CLASS="term"
>dynamic variable</EM
></A
>, information about those definitions might also be printed. </P
><P CLASS="j"
>For <A HREF="f_apropos.html" CLASS="funref"
><B
>apropos-list</B
></A
>, no output occurs as the search proceeds; instead a list of the matching <A HREF="26_1_Glossary.html#symbol"
><EM CLASS="term"
>symbols</EM
></A
> is returned when the search is complete. </P
><P CLASS="j"
>If <VAR CLASS="param"
>package</VAR
> is <A HREF="26_1_Glossary.html#non-nil"
><EM CLASS="term"
>non-nil</EM
></A
>, only the <A HREF="26_1_Glossary.html#symbol"
><EM CLASS="term"
>symbols</EM
></A
> <A HREF="26_1_Glossary.html#accessible"
><EM CLASS="term"
>accessible</EM
></A
> in that <VAR CLASS="param"
>package</VAR
> are searched; otherwise all <A HREF="26_1_Glossary.html#symbol"
><EM CLASS="term"
>symbols</EM
></A
> <A HREF="26_1_Glossary.html#accessible"
><EM CLASS="term"
>accessible</EM
></A
> in any <A HREF="26_1_Glossary.html#package"
><EM CLASS="term"
>package</EM
></A
> are searched. </P
><P CLASS="j"
>Because a <A HREF="26_1_Glossary.html#symbol"
><EM CLASS="term"
>symbol</EM
></A
> might be available by way of more than one inheritance path, <A HREF="f_apropos.html" CLASS="funref"
><B
>apropos</B
></A
> might print information about the <A HREF="26_1_Glossary.html#same"
><EM CLASS="term"
>same</EM
></A
> <A HREF="26_1_Glossary.html#symbol"
><EM CLASS="term"
>symbol</EM
></A
> more than once, or <A HREF="f_apropos.html" CLASS="funref"
><B
>apropos-list</B
></A
> might return a <A HREF="26_1_Glossary.html#list"
><EM CLASS="term"
>list</EM
></A
> containing duplicate <A HREF="26_1_Glossary.html#symbol"
><EM CLASS="term"
>symbols</EM
></A
>. </P
><P CLASS="j"
>Whether or not the search is case-sensitive is <A HREF="26_1_Glossary.html#implementation-defined"
><EM CLASS="term"
>implementation-defined</EM
></A
>.</P
></DD
><DT
><B
>Affected By</B
></DT
><DD
><P CLASS="j"
>The set of <A HREF="26_1_Glossary.html#symbol"
><EM CLASS="term"
>symbols</EM
></A
> which are currently <A HREF="26_1_Glossary.html#interned"
><EM CLASS="term"
>interned</EM
></A
> in any <A HREF="26_1_Glossary.html#package"
><EM CLASS="term"
>packages</EM
></A
> being searched. </P
><P CLASS="j"
><A HREF="f_apropos.html" CLASS="funref"
><B
>apropos</B
></A
> is also affected by <A HREF="v_debug-io.html" CLASS="varref"
><B
>*standard-output*</B
></A
>.</P
></DD
></DL
></DIV
></DIV
><DIV CLASS="footer"
><DIV CLASS="btmnav"
><A HREF="f_sleep.html" CLASS="prev"
>&#8592;</A
><A HREF="f_describe.html" CLASS="next"
>&#8594;</A
></DIV
><DIV CLASS="trail"
>Conversion to HTML copyright 2023 by Gilbert Baumann</DIV
></DIV
></DIV
><SCRIPT
>domReady();</SCRIPT
></BODY
></HTML
>
View git blame Copy permalink