Mercurial > hg > xemacs-beta

comparison man/lispref/help.texi @ 444:576fb035e263 r21-2-37

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import from CVS: tag r21-2-37
author cvs
date Mon, 13 Aug 2007 11:36:19 +0200
parents 3ecd8885ac67
children 1ccc32a20af4
comparison
equal deleted inserted replaced
443:a8296e22da4e 444:576fb035e263
224 @end group 224 @end group
225 @c DO NOT put a blank line here! That is factually inaccurate! 225 @c DO NOT put a blank line here! That is factually inaccurate!
226 @group 226 @group
227 Those commands will move to this position in the line moved to 227 Those commands will move to this position in the line moved to
228 rather than trying to keep the same horizontal position. 228 rather than trying to keep the same horizontal position.
229 With a non-nil argument, clears out the goal column 229 With a non-@code{nil} argument, clears out the goal column
230 so that C-n and C-p resume vertical motion. 230 so that C-n and C-p resume vertical motion.
231 The goal column is stored in the variable `goal-column'. 231 The goal column is stored in the variable `goal-column'.
232 @end group 232 @end group
233 233
234 @group 234 @group
357 @end group 357 @end group
358 358
359 @group 359 @group
360 (substitute-command-keys 360 (substitute-command-keys
361 "Substrings of the form \\=\\@{MAPVAR@} are replaced by summaries 361 "Substrings of the form \\=\\@{MAPVAR@} are replaced by summaries
362 \(made by describe-bindings) of the value of MAPVAR, taken as a keymap. 362 \(made by `describe-bindings') of the value of MAPVAR, taken as a keymap.
363 Substrings of the form \\=\\<MAPVAR> specify to use the value of MAPVAR 363 Substrings of the form \\=\\<MAPVAR> specify to use the value of MAPVAR
364 as the keymap for future \\=\\[COMMAND] substrings. 364 as the keymap for future \\=\\[COMMAND] substrings.
365 \\=\\= quotes the following character and is discarded; 365 \\=\\= quotes the following character and is discarded;
366 thus, \\=\\=\\=\\= puts \\=\\= into the output, 366 thus, \\=\\=\\=\\= puts \\=\\= into the output,
367 and \\=\\=\\=\\[ puts \\=\\[ into the output.") 367 and \\=\\=\\=\\[ puts \\=\\[ into the output.")
368 @result{} "Substrings of the form \@{MAPVAR@} are replaced by summaries 368 @result{} "Substrings of the form \@{MAPVAR@} are replaced by summaries
369 (made by describe-bindings) of the value of MAPVAR, taken as a keymap. 369 (made by `describe-bindings') of the value of MAPVAR, taken as a keymap.
370 Substrings of the form \<MAPVAR> specify to use the value of MAPVAR 370 Substrings of the form \<MAPVAR> specify to use the value of MAPVAR
371 as the keymap for future \[COMMAND] substrings. 371 as the keymap for future \[COMMAND] substrings.
372 \= quotes the following character and is discarded; 372 \= quotes the following character and is discarded;
373 thus, \=\= puts \= into the output, 373 thus, \=\= puts \= into the output,
374 and \=\[ puts \[ into the output." 374 and \=\[ puts \[ into the output."
604 The function is called when the user types a prefix key followed by the 604 The function is called when the user types a prefix key followed by the
605 help character, and the help character has no binding after that prefix. 605 help character, and the help character has no binding after that prefix.
606 The variable's default value is @code{describe-prefix-bindings}. 606 The variable's default value is @code{describe-prefix-bindings}.
607 @end defvar 607 @end defvar
608 608
609 @defun describe-prefix-bindings 609 @deffn Command describe-prefix-bindings
610 This function calls @code{describe-bindings} to display a list of all 610 This function calls @code{describe-bindings} to display a list of all
611 the subcommands of the prefix key of the most recent key sequence. The 611 the subcommands of the prefix key of the most recent key sequence. The
612 prefix described consists of all but the last event of that key 612 prefix described consists of all but the last event of that key
613 sequence. (The last event is, presumably, the help character.) 613 sequence. (The last event is, presumably, the help character.)
614 @end defun 614 @end deffn
615 615
616 The following two functions are found in the library @file{helper}. 616 The following two functions are found in the library @file{helper}.
617 They are for modes that want to provide help without relinquishing 617 They are for modes that want to provide help without relinquishing
618 control, such as the ``electric'' modes. You must load that library 618 control, such as the ``electric'' modes. You must load that library
619 with @code{(require 'helper)} in order to use them. Their names begin 619 with @code{(require 'helper)} in order to use them. Their names begin
674 with existing code, the older function needs to still exist; but 674 with existing code, the older function needs to still exist; but
675 users of that function should be told to use the newer one instead. 675 users of that function should be told to use the newer one instead.
676 XEmacs Lisp lets you mark a function or variable as @dfn{obsolete}, 676 XEmacs Lisp lets you mark a function or variable as @dfn{obsolete},
677 and indicate what should be used instead. 677 and indicate what should be used instead.
678 678
679 @defun make-obsolete function new 679 @deffn Command make-obsolete function new
680 This function indicates that @var{function} is an obsolete function, 680 This function indicates that @var{function} is an obsolete function,
681 and the function @var{new} should be used instead. The byte compiler 681 and the function @var{new} should be used instead. The byte compiler
682 will issue a warning to this effect when it encounters a usage of the 682 will issue a warning to this effect when it encounters a usage of the
683 older function, and the help system will also note this in the function's 683 older function, and the help system will also note this in the function's
684 documentation. @var{new} can also be a string (if there is not a single 684 documentation. @var{new} can also be a string (if there is not a single
685 function with the same functionality any more), and should be a descriptive 685 function with the same functionality any more), and should be a descriptive
686 statement, such as "use @var{foo} or @var{bar} instead" or "this function is 686 statement, such as "use @var{foo} or @var{bar} instead" or "this function is
687 unnecessary". 687 unnecessary".
688 @end defun 688 @end deffn
689 689
690 @defun make-obsolete-variable variable new 690 @deffn Command make-obsolete-variable variable new
691 This is like @code{make-obsolete} but is for variables instead of functions. 691 This is like @code{make-obsolete} but is for variables instead of functions.
692 @end defun 692 @end deffn
693 693
694 @defun define-obsolete-function-alias oldfun newfun 694 @defun define-obsolete-function-alias oldfun newfun
695 This function combines @code{make-obsolete} and @code{define-function}, 695 This function combines @code{make-obsolete} and @code{define-function},
696 declaring @var{oldfun} to be an obsolete variant of @var{newfun} and 696 declaring @var{oldfun} to be an obsolete variant of @var{newfun} and
697 defining @var{oldfun} as an alias for @var{newfun}. 697 defining @var{oldfun} as an alias for @var{newfun}.