Mercurial > hg > xemacs-beta

comparison man/lispref/help.texi @ 78:c7528f8e288d r20-0b34

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