Mercurial > hg > xemacs-beta

comparison man/lispref/help.texi @ 70:131b0175ea99 r20-0b30

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import from CVS: tag r20-0b30
author cvs
date Mon, 13 Aug 2007 09:02:59 +0200
parents 05472e90ae02
children c7528f8e288d
comparison
equal deleted inserted replaced
69:804d1389bcd6 70:131b0175ea99
75 list under the property name @code{variable-documentation}. The 75 list under the property name @code{variable-documentation}. The
76 function @code{documentation-property} knows how to extract it. 76 function @code{documentation-property} knows how to extract it.
77 @end itemize 77 @end itemize
78 78
79 @cindex @file{DOC} (documentation) file 79 @cindex @file{DOC} (documentation) file
80 @cindex @file{emacs/etc/DOC-@var{version}}
81 @cindex @file{etc/DOC-@var{version}}
80 To save space, the documentation for preloaded functions and variables 82 To save space, the documentation for preloaded functions and variables
81 (including primitive functions and autoloaded functions) is stored in 83 (including primitive functions and autoloaded functions) is stored in
82 the @dfn{internal doc file} @file{DOC}. The documentation for functions 84 the @dfn{internal doc file} @file{emacs/etc/DOC-@var{version}}. The
83 and variables loaded during the XEmacs session from byte-compiled files 85 documentation for functions and variables loaded during the XEmacs
84 is stored in those very same byte-compiled files (@pxref{Docs and 86 session from byte-compiled files is stored in those very same
85 Compilation}). 87 byte-compiled files (@pxref{Docs and Compilation}).
86 88
87 XEmacs does not keep documentation strings in memory unless necessary. 89 XEmacs does not keep documentation strings in memory unless necessary.
88 Instead, XEmacs maintains, for preloaded symbols, an integer offset into 90 Instead, XEmacs maintains, for preloaded symbols, an integer offset into
89 the internal doc file, and for symbols loaded from byte-compiled files, 91 the internal doc file, and for symbols loaded from byte-compiled files,
90 a list containing the filename of the byte-compiled file and an integer 92 a list containing the filename of the byte-compiled file and an integer
246 the runnable XEmacs is dumped. It finds the file offsets of the 248 the runnable XEmacs is dumped. It finds the file offsets of the
247 documentation strings stored in the file @var{filename}, and records 249 documentation strings stored in the file @var{filename}, and records
248 them in the in-core function definitions and variable property lists in 250 them in the in-core function definitions and variable property lists in
249 place of the actual strings. @xref{Building XEmacs}. 251 place of the actual strings. @xref{Building XEmacs}.
250 252
251 XEmacs finds the file @var{filename} in the @file{lib-src} directory. 253 XEmacs finds the file @var{filename} in the @file{xemacs/lib-src}
252 When the dumped XEmacs is later executed, the same file is found in the 254 directory. When the dumped XEmacs is later executed, the same file is
253 directory @code{doc-directory}. The usual value for @var{filename} is 255 found in the directory @code{doc-directory}. Usually @var{filename} is
254 @file{DOC}, but this can be changed by modifying the variable 256 @file{"DOC-@var{version}"}, but this can be changed by modifying the
255 @code{internal-doc-file-name}. 257 variable @code{internal-doc-file-name}.
256 @end defun 258 @end defun
257 259
258 @defvar internal-doc-file-name 260 @defvar internal-doc-file-name
259 This variable holds the name of the file containing documentation 261 This variable holds the name of the file containing documentation
260 strings of built-in symbols, usually @file{DOC}. The full pathname of 262 strings of built-in symbols, usually @file{"DOC-@var{version}"}. The
261 the internal doc file is @samp{(concat doc-directory internal-doc-file-name)}. 263 full pathname of the internal doc file is @samp{(concat doc-directory
264 internal-doc-file-name)}.
262 @end defvar 265 @end defvar
263 266
264 @defvar doc-directory 267 @defvar doc-directory
265 This variable holds the name of the directory which contains the 268 This variable holds the name of the directory which contains the
266 @dfn{internal doc file} that contains documentation strings for built-in 269 @dfn{internal doc file} that contains documentation strings for built-in