Mercurial > hg > xemacs-beta

comparison man/lispref/intro.texi @ 5791:9fae6227ede5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Silence texinfo 5.2 warnings, primarily by adding next, prev, and up pointers to all nodes. See xemacs-patches message with ID <5315f7bf.sHpFD7lXYR05GH6E%james@xemacs.org>.
author Jerry James <james@xemacs.org>
date Thu, 27 Mar 2014 08:59:03 -0600
parents 62b9ef1ed4ac
children
comparison
equal deleted inserted replaced
5790:dcf9067f26bb 5791:9fae6227ede5
431 * Lisp History:: XEmacs Lisp is descended from Maclisp. 431 * Lisp History:: XEmacs Lisp is descended from Maclisp.
432 * Conventions:: How the manual is formatted. 432 * Conventions:: How the manual is formatted.
433 * Acknowledgements:: The authors, editors, and sponsors of this manual. 433 * Acknowledgements:: The authors, editors, and sponsors of this manual.
434 @end menu 434 @end menu
435 435
436 @node Caveats 436 @node Caveats, Lisp History, Introduction, Introduction
437 @section Caveats 437 @section Caveats
438 438
439 This manual has gone through numerous drafts. It is nearly complete 439 This manual has gone through numerous drafts. It is nearly complete
440 but not flawless. There are a few topics that are not covered, either 440 but not flawless. There are a few topics that are not covered, either
441 because we consider them secondary (such as most of the individual 441 because we consider them secondary (such as most of the individual
487 @noindent 487 @noindent
488 @display 488 @display
489 --Ben Wing 489 --Ben Wing
490 @end display 490 @end display
491 491
492 @node Lisp History 492 @node Lisp History, Conventions, Caveats, Introduction
493 @section Lisp History 493 @section Lisp History
494 @cindex Lisp history 494 @cindex Lisp history
495 495
496 Lisp (LISt Processing language) was first developed in the late 1950's 496 Lisp (LISt Processing language) was first developed in the late 1950's
497 at the Massachusetts Institute of Technology for research in artificial 497 at the Massachusetts Institute of Technology for research in artificial
513 Sometimes the simplifications are so drastic that a Common Lisp user 513 Sometimes the simplifications are so drastic that a Common Lisp user
514 might be very confused. We will occasionally point out how XEmacs 514 might be very confused. We will occasionally point out how XEmacs
515 Lisp differs from Common Lisp. If you don't know Common Lisp, don't 515 Lisp differs from Common Lisp. If you don't know Common Lisp, don't
516 worry about it; this manual is self-contained. 516 worry about it; this manual is self-contained.
517 517
518 @node Conventions 518 @node Conventions, Acknowledgements, Lisp History, Introduction
519 @section Conventions 519 @section Conventions
520 520
521 This section explains the notational conventions that are used in this 521 This section explains the notational conventions that are used in this
522 manual. You may want to skip this section and refer back to it later. 522 manual. You may want to skip this section and refer back to it later.
523 523
529 * Error Messages:: The format we use for examples of errors. 529 * Error Messages:: The format we use for examples of errors.
530 * Buffer Text Notation:: The format we use for buffer contents in examples. 530 * Buffer Text Notation:: The format we use for buffer contents in examples.
531 * Format of Descriptions:: Notation for describing functions, variables, etc. 531 * Format of Descriptions:: Notation for describing functions, variables, etc.
532 @end menu 532 @end menu
533 533
534 @node Some Terms 534 @node Some Terms, nil and t, Conventions, Conventions
535 @subsection Some Terms 535 @subsection Some Terms
536 536
537 Throughout this manual, the phrases ``the Lisp reader'' and ``the Lisp 537 Throughout this manual, the phrases ``the Lisp reader'' and ``the Lisp
538 printer'' are used to refer to those routines in Lisp that convert 538 printer'' are used to refer to those routines in Lisp that convert
539 textual representations of Lisp objects into actual Lisp objects, and vice 539 textual representations of Lisp objects into actual Lisp objects, and vice
545 @cindex fonts 545 @cindex fonts
546 Examples of Lisp code appear in this font or form: @code{(list 1 2 546 Examples of Lisp code appear in this font or form: @code{(list 1 2
547 3)}. Names that represent arguments or metasyntactic variables appear 547 3)}. Names that represent arguments or metasyntactic variables appear
548 in this font or form: @var{first-number}. 548 in this font or form: @var{first-number}.
549 549
550 @node nil and t 550 @node nil and t, Evaluation Notation, Some Terms, Conventions
551 @subsection @code{nil} and @code{t} 551 @subsection @code{nil} and @code{t}
552 @cindex @code{nil}, uses of 552 @cindex @code{nil}, uses of
553 @cindex truth value 553 @cindex truth value
554 @cindex boolean 554 @cindex boolean
555 @cindex false 555 @cindex false
588 evaluate to themselves. This is so that you do not need to quote them 588 evaluate to themselves. This is so that you do not need to quote them
589 to use them as constants in a program. An attempt to change their 589 to use them as constants in a program. An attempt to change their
590 values results in a @code{setting-constant} error. @xref{Accessing 590 values results in a @code{setting-constant} error. @xref{Accessing
591 Variables}. 591 Variables}.
592 592
593 @node Evaluation Notation 593 @node Evaluation Notation, Printing Notation, nil and t, Conventions
594 @subsection Evaluation Notation 594 @subsection Evaluation Notation
595 @cindex evaluation notation 595 @cindex evaluation notation
596 @cindex documentation notation 596 @cindex documentation notation
597 597
598 A Lisp expression that you can evaluate is called a @dfn{form}. 598 A Lisp expression that you can evaluate is called a @dfn{form}.
624 624
625 @example 625 @example
626 (cons 'a nil) @equiv{} (list 'a) 626 (cons 'a nil) @equiv{} (list 'a)
627 @end example 627 @end example
628 628
629 @node Printing Notation 629 @node Printing Notation, Error Messages, Evaluation Notation, Conventions
630 @subsection Printing Notation 630 @subsection Printing Notation
631 @cindex printing notation 631 @cindex printing notation
632 632
633 Many of the examples in this manual print text when they are 633 Many of the examples in this manual print text when they are
634 evaluated. If you execute example code in a Lisp Interaction buffer 634 evaluated. If you execute example code in a Lisp Interaction buffer
649 @print{} bar 649 @print{} bar
650 @result{} bar 650 @result{} bar
651 @end group 651 @end group
652 @end example 652 @end example
653 653
654 @node Error Messages 654 @node Error Messages, Buffer Text Notation, Printing Notation, Conventions
655 @subsection Error Messages 655 @subsection Error Messages
656 @cindex error message notation 656 @cindex error message notation
657 657
658 Some examples signal errors. This normally displays an error message 658 Some examples signal errors. This normally displays an error message
659 in the echo area. We show the error message on a line starting with 659 in the echo area. We show the error message on a line starting with
663 @example 663 @example
664 (+ 23 'x) 664 (+ 23 'x)
665 @error{} Wrong type argument: integer-or-marker-p, x 665 @error{} Wrong type argument: integer-or-marker-p, x
666 @end example 666 @end example
667 667
668 @node Buffer Text Notation 668 @node Buffer Text Notation, Format of Descriptions, Error Messages, Conventions
669 @subsection Buffer Text Notation 669 @subsection Buffer Text Notation
670 @cindex buffer text notation 670 @cindex buffer text notation
671 671
672 Some examples show modifications to text in a buffer, with ``before'' 672 Some examples show modifications to text in a buffer, with ``before''
673 and ``after'' versions of the text. These examples show the contents of 673 and ``after'' versions of the text. These examples show the contents of
687 ---------- Buffer: foo ---------- 687 ---------- Buffer: foo ----------
688 This is the changed @point{}contents of foo. 688 This is the changed @point{}contents of foo.
689 ---------- Buffer: foo ---------- 689 ---------- Buffer: foo ----------
690 @end example 690 @end example
691 691
692 @node Format of Descriptions 692 @node Format of Descriptions, , Buffer Text Notation, Conventions
693 @subsection Format of Descriptions 693 @subsection Format of Descriptions
694 @cindex description format 694 @cindex description format
695 695
696 Functions, variables, macros, commands, user options, and special 696 Functions, variables, macros, commands, user options, and special
697 forms are described in this manual in a uniform format. The first 697 forms are described in this manual in a uniform format. The first
713 * A Sample Variable Description:: A description of an imaginary 713 * A Sample Variable Description:: A description of an imaginary
714 variable, 714 variable,
715 @code{electric-future-map}. 715 @code{electric-future-map}.
716 @end menu 716 @end menu
717 717
718 @node A Sample Function Description 718 @node A Sample Function Description, A Sample Variable Description, Format of Descriptions, Format of Descriptions
719 @subsubsection A Sample Function Description 719 @subsubsection A Sample Function Description
720 @cindex function descriptions 720 @cindex function descriptions
721 @cindex command descriptions 721 @cindex command descriptions
722 @cindex macro descriptions 722 @cindex macro descriptions
723 @cindex special operator descriptions 723 @cindex special operator descriptions
817 @var{inc} may optionally be specified as well. These arguments are 817 @var{inc} may optionally be specified as well. These arguments are
818 grouped with the argument @var{var} into a list, to distinguish them 818 grouped with the argument @var{var} into a list, to distinguish them
819 from @var{body}, which includes all remaining elements of the form. 819 from @var{body}, which includes all remaining elements of the form.
820 @end deffn 820 @end deffn
821 821
822 @node A Sample Variable Description 822 @node A Sample Variable Description, , A Sample Function Description, Format of Descriptions
823 @subsubsection A Sample Variable Description 823 @subsubsection A Sample Variable Description
824 @cindex variable descriptions 824 @cindex variable descriptions
825 @cindex option descriptions 825 @cindex option descriptions
826 826
827 A @dfn{variable} is a name that can hold a value. Although any 827 A @dfn{variable} is a name that can hold a value. Although any
840 @end defvar 840 @end defvar
841 841
842 User option descriptions have the same format, but `Variable' is 842 User option descriptions have the same format, but `Variable' is
843 replaced by `User Option'. 843 replaced by `User Option'.
844 844
845 @node Acknowledgements 845 @node Acknowledgements, , Conventions, Introduction
846 @section Acknowledgements 846 @section Acknowledgements
847 847
848 This manual was based on the GNU Emacs Lisp Reference Manual, version 848 This manual was based on the GNU Emacs Lisp Reference Manual, version
849 2.4, written by Robert Krawitz, Bil Lewis, Dan LaLiberte, Richard 849 2.4, written by Robert Krawitz, Bil Lewis, Dan LaLiberte, Richard
850 M. Stallman and Chris Welty, the volunteers of the GNU manual group, in 850 M. Stallman and Chris Welty, the volunteers of the GNU manual group, in