← Back to branch summary

~ubuntu-branches/ubuntu/quantal/gclcvs/quantal

« back to all changes in this revision

Viewing changes to info/doc.texi

  • Committer: Bazaar Package Importer
  • Author(s): Camm Maguire
  • Date: 2004-06-24 15:13:46 UTC
  • Revision ID: james.westby@ubuntu.com-20040624151346-xh0xaaktyyp7aorc
Tags: 2.7.0-26
C_GC_OFFSET is 2 on m68k-linux

Show diffs side-by-side

added added

removed removed

Lines of Context:
info/doc.texi
 
1
@node Doc, Type, User Interface, Top
 
2
@chapter Doc
 
3
 
 
4
@defun APROPOS (string &optional (package nil))
 
5
Package:LISP
 
6
 
 
7
Prints those symbols whose print-names contain STRING as substring.
 
8
If PACKAGE is non-NIL, then only the specified package is searched.
 
9
 
 
10
 
 
11
@end defun
 
12
 
 
13
@defun INFO (string &optional (list-of-info-files *default-info-files*))
 
14
PACKAGE:SI
 
15
 
 
16
Find all documentation about STRING in LIST-OF-INFO-FILES.  The search
 
17
is done for STRING as a substring of a node name, or for STRING in the
 
18
indexed entries in the first index for each info file.  Typically that
 
19
should be a variable and function definition index, if the info file is
 
20
about a programming language.  If the windowing system is connected,
 
21
then a choice box is offered and double clicking on an item brings up
 
22
its documentation.
 
23
 
 
24
Otherwise a list of choices is offered and the user may select some of
 
25
these choices.
 
26
 
 
27
list-of-info-files is of the form
 
28
@example
 
29
 ("gcl-si.info" "gcl-tk.info" "gcl.info")
 
30
@end example
 
31
The above list is the default value of *default-info-files*,
 
32
a variable in the SI package.   To find these files in the file
 
33
system, the search path *info-paths* is consulted as is the master
 
34
info directory @file{dir}.
 
35
 
 
36
see *Index *default-info-files*:: and *Index *info-paths*::.
 
37
For example
 
38
@example
 
39
(info "defun")
 
40
 
 
41
 0: DEFUN :(gcl-si.info)Special Forms and Functions.
 
42
 1: (gcl.info)defun.
 
43
Enter n, all, none, or multiple choices eg 1 3 : 1
 
44
 
 
45
Info from file /home/wfs/gcl-doc/gcl.info:
 
46
defun                                                               [Macro]
 
47
---------------------------------------------------------------------------
 
48
`Defun'  function-name lambda-list [[@{declaration@}* | documentation]]
 
49
...
 
50
 
 
51
@end example
 
52
would list the node @code{(gcl.info)defun}.
 
53
That is the node entitled @code{defun} from the info file gcl.info.   That
 
54
documentation is based on the ANSI common lisp standard.   The choice
 
55
@example
 
56
DEFUN :(gcl-si.info)Special Forms and Functions.
 
57
@end example
 
58
 
 
59
refers to the documentation on DEFUN from the info file gcl-si.info in
 
60
the node @i{Special Forms And Functions}.  This is an index reference
 
61
and only the part of the node which refers to @code{defun} will be
 
62
printed.
 
63
 
 
64
@example
 
65
(info "factor" '("maxima.info"))
 
66
@end example
 
67
would search the maxima info files index and nodes for @code{factor}.
 
68
 
 
69
@end defun
 
70
 
 
71
 
 
72
 
 
73
 
 
74
 
 
75
@defvar *info-paths*
 
76
Package SI:
 
77
 
 
78
A list of strings such as
 
79
@example
 
80
  '("" "/usr/info/" "/usr/local/lib/info/" "/usr/local/info/"
 
81
    "/usr/local/gnu/info/" )
 
82
@end example
 
83
saying where to look for the info files.   It is used implicitly
 
84
by @code{info}, see *Index info::.
 
85
 
 
86
Looking for maxima.info would look for the file
 
87
maxima.info in all the directories listed in *info-paths*.  If nto found
 
88
then it would look for @file{dir} in the *info-paths* directories,
 
89
and if it were found it would look in the @file{dir} for a menu item
 
90
such as
 
91
 
 
92
@example
 
93
* maxima: (/home/wfs/maxima-5.0/info/maxima.info).
 
94
@end example
 
95
 
 
96
@noindent
 
97
If such an entry exists then the directory there would be used for the
 
98
purpose of finding @code{maxima.info}
 
99
 
 
100
@end defvar