xemacs-beta: man/lispref/help.texi comparison

comparison man/lispref/help.texi @ 272:c5d627a313b1 r21-0b34

Import from CVS: tag r21-0b34

author	cvs
date	Mon, 13 Aug 2007 10:28:48 +0200
parents	c7528f8e288d
children	a4f53d9b3154

comparison

equal deleted inserted replaced

-:c7b7086b0a39
+:c5d627a313b1
 @c -*-texinfo-*-
 @c This is part of the XEmacs Lisp Reference Manual.
 @c Copyright (C) 1990, 1991, 1992, 1993, 1994 Free Software Foundation, Inc.
 @c See the file lispref.texi for copying conditions.
 @setfilename ../../info/help.info
 @node Documentation, Files, Modes, Top
 @chapter Documentation
 @cindex documentation strings
 "Describe the XEmacs Lisp symbols matching PATTERN.
 All symbols that have PATTERN in their name are described
 in the `*Help*' buffer."
 (interactive "sDescribe symbols matching: ")
 (let ((describe-func
 (function
 (lambda (s)
 @end group
 @group
 ;; @r{Print description of symbol.}
 (if (fboundp s)             ; @r{It is a function.}
 (princ
 (format "%s\t%s\n%s\n\n" s
 (if (commandp s)
 (let ((keys (where-is-internal s)))
 (if keys
 (concat
 "Keys: "
 (mapconcat 'key-description
 keys " "))
 "Keys: none"))
 "Function")
 @end group
 @group
 (or (documentation s)
 "not documented"))))
 (if (boundp s)              ; @r{It is a variable.}
 @end group
 @group
 (princ
 (format "%s\t%s\n%s\n\n" s
 (if (user-variable-p s)
 "Option " "Variable")
 @end group
 @group
 (or (documentation-property
 s 'variable-documentation)
 "not documented")))))))
 sym-list)
 @end group
 @group
 ;; @r{Build a list of symbols that match pattern.}
 (mapatoms (function
 (lambda (sym)
 (if (string-match pattern (symbol-name sym))
 (setq sym-list (cons sym sym-list))))))
 @end group
 @smallexample
 @group
 (describe-symbols "goal")
 ---------- Buffer: *Help* ----------
 goal-column     Option
 *Semipermanent goal column for vertical motion, as set by C-x C-n, or nil.
 @end group
 @c Do not blithely break or fill these lines.
 @c That makes them incorrect.
 @table @code
 @item \[@var{command}]
 stands for a key sequence that will invoke @var{command}, or @samp{M-x
 @var{command}} if @var{command} has no key bindings.
 @item \@{@var{mapvar}@}
 stands for a summary of the value of @var{mapvar}, which should be a
 keymap.  The summary is made by @code{describe-bindings}.
 @item \<@var{mapvar}>
 stands for no text itself.  It is used for a side effect: it specifies
 @var{mapvar} as the keymap for any following @samp{\[@var{command}]}
 sequences in this documentation string.
 @item \=
 Here are examples of the special sequences:
 @smallexample
 @group
 (substitute-command-keys
 "To abort recursive edit, type: \\[abort-recursive-edit]")
 @result{} "To abort recursive edit, type: C-]"
 @end group
 @group
 (substitute-command-keys
 "The keys that are defined for the minibuffer here are:
 \\@{minibuffer-local-must-match-map@}")
 @result{} "The keys that are defined for the minibuffer here are:
 @end group
 "Substrings of the form \\=\\@{MAPVAR@} are replaced by summaries
 \(made by describe-bindings) of the value of MAPVAR, taken as a keymap.
 Substrings of the form \\=\\<MAPVAR> specify to use the value of MAPVAR
 as the keymap for future \\=\\[COMMAND] substrings.
 \\=\\= quotes the following character and is discarded;
 thus, \\=\\=\\=\\= puts \\=\\= into the output,
 and \\=\\=\\=\\[ puts \\=\\[ into the output.")
 @result{} "Substrings of the form \@{MAPVAR@} are replaced by summaries
 (made by describe-bindings) of the value of MAPVAR, taken as a keymap.
 Substrings of the form \<MAPVAR> specify to use the value of MAPVAR
 as the keymap for future \[COMMAND] substrings.
 ---------- Buffer: *Help* ----------
 Buffer-menu-execute
 Function: Save and/or delete buffers marked with
 M-x Buffer-menu-save or M-x Buffer-menu-delete commands.
 execute-extended-command      ESC x
 Function: Read function name, then read its
 arguments and call it.
 ---------- Buffer: *Help* ----------
 @end group
 @end ignore
 @end smallexample
 @end deffn
 @ignore @c Not in XEmacs currently
 @c Emacs 19 feature
 @defmac make-help-screen fname help-line help-text help-map
 This macro defines a help command named @var{fname} that acts like a
 prefix key that shows a list of the subcommands it offers.
 When invoked, @var{fname} displays @var{help-text} in a window, then
 reads and executes a key sequence according to @var{help-map}.  The
 string @var{help-text} should describe the bindings available in

Mercurial > hg > xemacs-beta

comparison man/lispref/help.texi @ 272:c5d627a313b1 r21-0b34