comparison doc/lispref/vol1.texi @ 103795:510b33da5f7b

Use a DATE variable with the publication date, and update it. Fix antinews menu description. Update VERSION to match elisp.texi. Update the detailed node listing to match elisp.texi.
author Glenn Morris <rgm@gnu.org>
date Thu, 09 Jul 2009 03:03:14 +0000
parents ed6152fc596c
children a110c11135b8
comparison
equal deleted inserted replaced
103794:ce767480885f 103795:510b33da5f7b
23 \global\chapno=0 23 \global\chapno=0
24 @end tex 24 @end tex
25 25
26 @c Version of the manual and of Emacs. 26 @c Version of the manual and of Emacs.
27 @c Please remember to update the edition number in README as well. 27 @c Please remember to update the edition number in README as well.
28 @set VERSION 2.9 28 @set VERSION 3.0
29 @set EMACSVER 23.1.50 29 @set EMACSVER 23.1.50
30 @set DATE July 2009
30 31
31 @dircategory Emacs 32 @dircategory Emacs
32 @direntry 33 @direntry
33 * Elisp: (elisp). The Emacs Lisp Reference Manual. 34 * Elisp: (elisp). The Emacs Lisp Reference Manual.
34 @end direntry 35 @end direntry
87 88
88 @titlepage 89 @titlepage
89 @title GNU Emacs Lisp Reference Manual 90 @title GNU Emacs Lisp Reference Manual
90 @subtitle Volume 1 91 @subtitle Volume 1
91 @subtitle For Emacs Version @value{EMACSVER} 92 @subtitle For Emacs Version @value{EMACSVER}
92 @subtitle Revision @value{VERSION}, June 2007 93 @subtitle Revision @value{VERSION}, @value{DATE}
93 94
94 @author by Bil Lewis, Dan LaLiberte, Richard Stallman 95 @author by Bil Lewis, Dan LaLiberte, Richard Stallman
95 @author and the GNU Manual Group 96 @author and the GNU Manual Group
96 @page 97 @page
97 @vskip 0pt plus 1filll 98 @vskip 0pt plus 1filll
178 * System Interface:: Getting the user id, system type, environment 179 * System Interface:: Getting the user id, system type, environment
179 variables, and other such things. 180 variables, and other such things.
180 181
181 Appendices 182 Appendices
182 183
183 * Antinews:: Info for users downgrading to Emacs 21. 184 * Antinews:: Info for users downgrading to Emacs 22.
184 * GNU Free Documentation License:: The license for this documentation 185 * GNU Free Documentation License:: The license for this documentation
185 * GPL:: Conditions for copying and changing GNU Emacs. 186 * GPL:: Conditions for copying and changing GNU Emacs.
186 * Tips:: Advice and coding conventions for Emacs Lisp. 187 * Tips:: Advice and coding conventions for Emacs Lisp.
187 * GNU Emacs Internals:: Building and dumping Emacs; 188 * GNU Emacs Internals:: Building and dumping Emacs;
188 internal data structures. 189 internal data structures.
294 Editing Types 295 Editing Types
295 296
296 * Buffer Type:: The basic object of editing. 297 * Buffer Type:: The basic object of editing.
297 * Marker Type:: A position in a buffer. 298 * Marker Type:: A position in a buffer.
298 * Window Type:: What makes buffers visible. 299 * Window Type:: What makes buffers visible.
299 * Frame Type:: Windows subdivide frames. 300 * Frame Type:: Windows subdivide frames.
301 * Terminal Type:: A terminal device displays frames.
300 * Window Configuration Type:: Recording the way a frame is subdivided. 302 * Window Configuration Type:: Recording the way a frame is subdivided.
301 * Frame Configuration Type:: Recording the status of all frames. 303 * Frame Configuration Type:: Recording the status of all frames.
302 * Process Type:: A process running on the underlying OS. 304 * Process Type:: A subprocess of Emacs running on the underlying OS.
303 * Stream Type:: Receive or send characters. 305 * Stream Type:: Receive or send characters.
304 * Keymap Type:: What function a keystroke invokes. 306 * Keymap Type:: What function a keystroke invokes.
305 * Overlay Type:: How an overlay is represented. 307 * Overlay Type:: How an overlay is represented.
308 * Font Type:: Fonts for displaying text.
306 309
307 Numbers 310 Numbers
308 311
309 * Integer Basics:: Representation and range of integers. 312 * Integer Basics:: Representation and range of integers.
310 * Float Basics:: Representation and range of floating point. 313 * Float Basics:: Representation and range of floating point.
439 * Accessing Variables:: Examining values of variables whose names 442 * Accessing Variables:: Examining values of variables whose names
440 are known only at run time. 443 are known only at run time.
441 * Setting Variables:: Storing new values in variables. 444 * Setting Variables:: Storing new values in variables.
442 * Variable Scoping:: How Lisp chooses among local and global values. 445 * Variable Scoping:: How Lisp chooses among local and global values.
443 * Buffer-Local Variables:: Variable values in effect only in one buffer. 446 * Buffer-Local Variables:: Variable values in effect only in one buffer.
444 * Future Local Variables:: New kinds of local values we might add some day.
445 * File Local Variables:: Handling local variable lists in files. 447 * File Local Variables:: Handling local variable lists in files.
448 * Directory Local Variables:: Local variables common to all files in a directory.
449 * Frame-Local Variables:: Frame-local bindings for variables.
446 * Variable Aliases:: Variables that are aliases for other variables. 450 * Variable Aliases:: Variables that are aliases for other variables.
447 * Variables with Restricted Values:: Non-constant variables whose value can 451 * Variables with Restricted Values:: Non-constant variables whose value can
448 @emph{not} be an arbitrary Lisp object. 452 @emph{not} be an arbitrary Lisp object.
449 * Standard Buffer-Local Variables:: 453 * Standard Buffer-Local Variables::
450 List of variables buffer-local in all buffers. 454 List of variables buffer-local in all buffers.
648 (These are too low level to use the minibuffer.) 652 (These are too low level to use the minibuffer.)
649 * Minibuffer Completion:: Invoking the minibuffer with completion. 653 * Minibuffer Completion:: Invoking the minibuffer with completion.
650 * Completion Commands:: Minibuffer commands that do completion. 654 * Completion Commands:: Minibuffer commands that do completion.
651 * High-Level Completion:: Convenient special cases of completion 655 * High-Level Completion:: Convenient special cases of completion
652 (reading buffer name, file name, etc.) 656 (reading buffer name, file name, etc.)
653 * Reading File Names:: Using completion to read file names. 657 * Reading File Names:: Using completion to read file names and
658 shell commands.
659 * Completion Styles:: Specifying rules for performing completion.
654 * Programmed Completion:: Finding the completions for a given file name. 660 * Programmed Completion:: Finding the completions for a given file name.
655 661
656 Command Loop 662 Command Loop
657 663
658 * Command Overview:: How the command loop reads commands. 664 * Command Overview:: How the command loop reads commands.
659 * Defining Commands:: Specifying how a function should read arguments. 665 * Defining Commands:: Specifying how a function should read arguments.
660 * Interactive Call:: Calling a command, so that it will read arguments. 666 * Interactive Call:: Calling a command, so that it will read arguments.
667 * Distinguish Interactive:: Making a command distinguish interactive calls.
661 * Command Loop Info:: Variables set by the command loop for you to examine. 668 * Command Loop Info:: Variables set by the command loop for you to examine.
662 * Adjusting Point:: Adjustment of point after a command. 669 * Adjusting Point:: Adjustment of point after a command.
663 * Input Events:: What input looks like when you read it. 670 * Input Events:: What input looks like when you read it.
664 * Reading Input:: How to read input events from the keyboard or mouse. 671 * Reading Input:: How to read input events from the keyboard or mouse.
665 * Special Events:: Events processed immediately and individually. 672 * Special Events:: Events processed immediately and individually.
691 * Motion Events:: Just moving the mouse, not pushing a button. 698 * Motion Events:: Just moving the mouse, not pushing a button.
692 * Focus Events:: Moving the mouse between frames. 699 * Focus Events:: Moving the mouse between frames.
693 * Misc Events:: Other events the system can generate. 700 * Misc Events:: Other events the system can generate.
694 * Event Examples:: Examples of the lists for mouse events. 701 * Event Examples:: Examples of the lists for mouse events.
695 * Classifying Events:: Finding the modifier keys in an event symbol. 702 * Classifying Events:: Finding the modifier keys in an event symbol.
696 * Accessing Events:: Functions to extract info from events. 703 * Accessing Mouse:: Functions to extract info from mouse events.
704 * Accessing Scroll:: Functions to get info from scroll bar events.
697 * Strings of Events:: Special considerations for putting 705 * Strings of Events:: Special considerations for putting
698 keyboard character events in a string. 706 keyboard character events in a string.
699 707
700 Reading Input 708 Reading Input
701 709
915 * The Buffer List:: How to look at all the existing buffers. 923 * The Buffer List:: How to look at all the existing buffers.
916 * Creating Buffers:: Functions that create buffers. 924 * Creating Buffers:: Functions that create buffers.
917 * Killing Buffers:: Buffers exist until explicitly killed. 925 * Killing Buffers:: Buffers exist until explicitly killed.
918 * Indirect Buffers:: An indirect buffer shares text with some 926 * Indirect Buffers:: An indirect buffer shares text with some
919 other buffer. 927 other buffer.
928 * Swapping Text:: Swapping text between two buffers.
920 * Buffer Gap:: The gap in the buffer. 929 * Buffer Gap:: The gap in the buffer.
921 930
922 Windows 931 Windows
923 932
924 * Basic Windows:: Basic information on using windows. 933 * Basic Windows:: Basic information on using windows.
928 * Cyclic Window Ordering:: Moving around the existing windows. 937 * Cyclic Window Ordering:: Moving around the existing windows.
929 * Buffers and Windows:: Each window displays the contents of a buffer. 938 * Buffers and Windows:: Each window displays the contents of a buffer.
930 * Displaying Buffers:: Higher-level functions for displaying a buffer 939 * Displaying Buffers:: Higher-level functions for displaying a buffer
931 and choosing a window for it. 940 and choosing a window for it.
932 * Choosing Window:: How to choose a window for displaying a buffer. 941 * Choosing Window:: How to choose a window for displaying a buffer.
942 * Dedicated Windows:: How to avoid displaying another buffer in
943 a specific window.
933 * Window Point:: Each window has its own location of point. 944 * Window Point:: Each window has its own location of point.
934 * Window Start:: The display-start position controls which text 945 * Window Start and End:: Buffer positions indicating which text is
935 is on-screen in the window. 946 on-screen in a window.
936 * Textual Scrolling:: Moving text up and down through the window. 947 * Textual Scrolling:: Moving text up and down through the window.
937 * Vertical Scrolling:: Moving the contents up and down on the window. 948 * Vertical Scrolling:: Moving the contents up and down on the window.
938 * Horizontal Scrolling:: Moving the contents sideways on the window. 949 * Horizontal Scrolling:: Moving the contents sideways on the window.
939 * Size of Window:: Accessing the size of a window. 950 * Size of Window:: Accessing the size of a window.
940 * Resizing Windows:: Changing the size of a window. 951 * Resizing Windows:: Changing the size of a window.
941 * Coordinates and Windows:: Converting coordinates to windows. 952 * Coordinates and Windows:: Converting coordinates to windows.
942 * Window Tree:: The layout and sizes of all windows in a frame. 953 * Window Tree:: The layout and sizes of all windows in a frame.
943 * Window Configurations:: Saving and restoring the state of the screen. 954 * Window Configurations:: Saving and restoring the state of the screen.
955 * Window Parameters:: Associating additional information with windows.
944 * Window Hooks:: Hooks for scrolling, window size changes, 956 * Window Hooks:: Hooks for scrolling, window size changes,
945 redisplay going past a certain point, 957 redisplay going past a certain point,
946 or window configuration changes. 958 or window configuration changes.
947 959
948 Frames 960 Frames
949 961
950 * Creating Frames:: Creating additional frames. 962 * Creating Frames:: Creating additional frames.
951 * Multiple Terminals:: Creating frames on other displays. 963 * Multiple Terminals:: Displaying on several different devices.
952 * Frame Parameters:: Controlling frame size, position, font, etc. 964 * Frame Parameters:: Controlling frame size, position, font, etc.
965 * Terminal Parameters:: Parameters common for all frames on terminal.
953 * Frame Titles:: Automatic updating of frame titles. 966 * Frame Titles:: Automatic updating of frame titles.
954 * Deleting Frames:: Frames last until explicitly deleted. 967 * Deleting Frames:: Frames last until explicitly deleted.
955 * Finding All Frames:: How to examine all existing frames. 968 * Finding All Frames:: How to examine all existing frames.
956 * Frames and Windows:: A frame contains windows; 969 * Frames and Windows:: A frame contains windows;
957 display of text always works through windows. 970 display of text always works through windows.
1081 * Property Search:: Searching for where a property changes value. 1094 * Property Search:: Searching for where a property changes value.
1082 * Special Properties:: Particular properties with special meanings. 1095 * Special Properties:: Particular properties with special meanings.
1083 * Format Properties:: Properties for representing formatting of text. 1096 * Format Properties:: Properties for representing formatting of text.
1084 * Sticky Properties:: How inserted text gets properties from 1097 * Sticky Properties:: How inserted text gets properties from
1085 neighboring text. 1098 neighboring text.
1086 * Saving Properties:: Saving text properties in files, and reading
1087 them back.
1088 * Lazy Properties:: Computing text properties in a lazy fashion 1099 * Lazy Properties:: Computing text properties in a lazy fashion
1089 only when text is examined. 1100 only when text is examined.
1090 * Clickable Text:: Using text properties to make regions of text 1101 * Clickable Text:: Using text properties to make regions of text
1091 do something when you click on them. 1102 do something when you click on them.
1092 * Links and Mouse-1:: How to make @key{Mouse-1} follow a link.
1093 * Fields:: The @code{field} property defines 1103 * Fields:: The @code{field} property defines
1094 fields within the buffer. 1104 fields within the buffer.
1095 * Not Intervals:: Why text properties do not use 1105 * Not Intervals:: Why text properties do not use
1096 Lisp-visible text intervals. 1106 Lisp-visible text intervals.
1097 1107
1100 * Text Representations:: Unibyte and multibyte representations 1110 * Text Representations:: Unibyte and multibyte representations
1101 * Converting Representations:: Converting unibyte to multibyte and vice versa. 1111 * Converting Representations:: Converting unibyte to multibyte and vice versa.
1102 * Selecting a Representation:: Treating a byte sequence as unibyte or multi. 1112 * Selecting a Representation:: Treating a byte sequence as unibyte or multi.
1103 * Character Codes:: How unibyte and multibyte relate to 1113 * Character Codes:: How unibyte and multibyte relate to
1104 codes of individual characters. 1114 codes of individual characters.
1115 * Character Properties:: Character attributes that define their
1116 behavior and handling.
1105 * Character Sets:: The space of possible character codes 1117 * Character Sets:: The space of possible character codes
1106 is divided into various character sets. 1118 is divided into various character sets.
1107 * Chars and Bytes:: More information about multibyte encodings.
1108 * Splitting Characters:: Converting a character to its byte sequence.
1109 * Scanning Charsets:: Which character sets are used in a buffer? 1119 * Scanning Charsets:: Which character sets are used in a buffer?
1110 * Translation of Characters:: Translation tables are used for conversion. 1120 * Translation of Characters:: Translation tables are used for conversion.
1111 * Coding Systems:: Coding systems are conversions for saving files. 1121 * Coding Systems:: Coding systems are conversions for saving files.
1112 * Input Methods:: Input methods allow users to enter various 1122 * Input Methods:: Input methods allow users to enter various
1113 non-ASCII characters without special keyboards. 1123 non-ASCII characters without special keyboards.
1206 * Signals to Processes:: Stopping, continuing or interrupting 1216 * Signals to Processes:: Stopping, continuing or interrupting
1207 an asynchronous subprocess. 1217 an asynchronous subprocess.
1208 * Output from Processes:: Collecting output from an asynchronous subprocess. 1218 * Output from Processes:: Collecting output from an asynchronous subprocess.
1209 * Sentinels:: Sentinels run when process run-status changes. 1219 * Sentinels:: Sentinels run when process run-status changes.
1210 * Query Before Exit:: Whether to query if exiting will kill a process. 1220 * Query Before Exit:: Whether to query if exiting will kill a process.
1221 * System Processes:: Accessing other processes running on your system.
1211 * Transaction Queues:: Transaction-based communication with subprocesses. 1222 * Transaction Queues:: Transaction-based communication with subprocesses.
1212 * Network:: Opening network connections. 1223 * Network:: Opening network connections.
1213 * Network Servers:: Network servers let Emacs accept net connections. 1224 * Network Servers:: Network servers let Emacs accept net connections.
1214 * Datagrams:: UDP network connections. 1225 * Datagrams:: UDP network connections.
1215 * Low-Level Network:: Lower-level but more general function 1226 * Low-Level Network:: Lower-level but more general function
1216 to create connections and servers. 1227 to create connections and servers.
1217 * Misc Network:: Additional relevant functions for network connections. 1228 * Misc Network:: Additional relevant functions for network connections.
1229 * Serial Ports:: Communicating with serial ports.
1218 * Byte Packing:: Using bindat to pack and unpack binary data. 1230 * Byte Packing:: Using bindat to pack and unpack binary data.
1219 1231
1220 Receiving Output from Processes 1232 Receiving Output from Processes
1221 1233
1222 * Process Buffers:: If no filter, output is put in a buffer. 1234 * Process Buffers:: If no filter, output is put in a buffer.
1290 * Defining Faces:: How to define a face with @code{defface}. 1302 * Defining Faces:: How to define a face with @code{defface}.
1291 * Face Attributes:: What is in a face? 1303 * Face Attributes:: What is in a face?
1292 * Attribute Functions:: Functions to examine and set face attributes. 1304 * Attribute Functions:: Functions to examine and set face attributes.
1293 * Displaying Faces:: How Emacs combines the faces specified for 1305 * Displaying Faces:: How Emacs combines the faces specified for
1294 a character. 1306 a character.
1295 * Font Selection:: Finding the best available font for a face. 1307 * Face Remapping:: Remapping faces to alternative definitions.
1296 * Face Functions:: How to define and examine faces. 1308 * Face Functions:: How to define and examine faces.
1297 * Auto Faces:: Hook for automatic face assignment. 1309 * Auto Faces:: Hook for automatic face assignment.
1310 * Font Selection:: Finding the best available font for a face.
1298 * Font Lookup:: Looking up the names of available fonts 1311 * Font Lookup:: Looking up the names of available fonts
1299 and information about them. 1312 and information about them.
1300 * Fontsets:: A fontset is a collection of fonts 1313 * Fontsets:: A fontset is a collection of fonts
1301 that handle a range of character sets. 1314 that handle a range of character sets.
1315 * Low-Level Font:: Lisp representation of character display fonts.
1302 1316
1303 Fringes 1317 Fringes
1304 1318
1305 * Fringe Size/Pos:: Specifying where to put the window fringes. 1319 * Fringe Size/Pos:: Specifying where to put the window fringes.
1306 * Fringe Indicators:: Displaying indicator icons in the window fringes. 1320 * Fringe Indicators:: Displaying indicator icons in the window fringes.