annotate man/xemacs/frame.texi @ 428:3ecd8885ac67 r21-2-22

Import from CVS: tag r21-2-22
author cvs
date Mon, 13 Aug 2007 11:28:15 +0200
parents
children abe6d1db359e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
1 @node Frame, Keystrokes, Concept Index, Top
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
2 @comment node-name, next, previous, up
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
3 @chapter The XEmacs Frame
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
4 @cindex frame
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
5 @cindex window
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
6 @cindex buffer
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
7
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
8 @table @asis
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
9 @item Frame
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
10 In many environments, such as a tty terminal, an XEmacs frame
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
11 literally takes up the whole screen. If you are
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
12 running XEmacs in a multi-window system like the X Window System, the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
13 XEmacs frame takes up one X window. @xref{XEmacs under X}, for more
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
14 information.@refill
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
15
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
16 @item Window
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
17 No matter what environment you are running in, XEmacs allows you to look
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
18 at several buffers at the same time by having several windows be part of
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
19 the frame. Often, the whole frame is taken up by just one window, but
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
20 you can split the frame into two or more subwindows. If you are
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
21 running XEmacs under the X window system, that means you can have several
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
22 @dfn{XEmacs windows} inside the X window that contains the XEmacs frame.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
23 You can even have multiple frames in different X windows, each with
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
24 their own set of subwindows.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
25 @refill
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
26 @end table
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
27
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
28 Each XEmacs frame displays a variety of information:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
29 @itemize @bullet
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
30 @item
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
31 The biggest area usually displays the text you are editing. It may
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
32 consist of one window or of two or more windows if you need to look at two
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
33 buffers a the same time.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
34 @item
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
35 Below each text window's last line is a @dfn{mode line} (@pxref{Mode
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
36 Line}), which describes what is going on in that window. The mode line
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
37 is in inverse video if the terminal supports that. If there are several
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
38 XEmacs windows in one frame, each window has its own mode line.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
39 @item
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
40 At the bottom of each XEmacs frame is the @dfn{echo area} or @dfn{minibuffer
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
41 window}(@pxref{Echo Area}). It is used by XEmacs to exchange information
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
42 with the user. There is only one echo area per XEmacs frame.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
43 @item
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
44 If you are running XEmacs under the X Window System, a
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
45 menu bar at the top of the frame makes shortcuts to several of the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
46 commands available (@pxref{Pull-down Menus}).
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
47 @end itemize
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
48
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
49 You can subdivide the XEmacs frame into multiple text windows, and use
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
50 each window for a different file (@pxref{Windows}). Multiple XEmacs
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
51 windows are tiled vertically on the XEmacs frame. The upper XEmacs window
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
52 is separated from the lower window by its mode line.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
53
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
54 When there are multiple, tiled XEmacs windows on a single XEmacs frame,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
55 the XEmacs window receiving input from the keyboard has the @dfn{keyboard
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
56 focus} and is called the @dfn{selected window}. The selected window
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
57 contains the cursor, which indicates the insertion point. If you are
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
58 working in an environment that permits multiple XEmacs frames, and you
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
59 move the focus from one XEmacs frame into another, the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
60 selected window is the one that was last selected in that frame.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
61
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
62 The same text can be displayed simultaneously in several XEmacs
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
63 windows, which can be in different XEmacs frames. If you alter the text
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
64 in an XEmacs buffer by editing it in one XEmacs window, the changes are
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
65 visible in all XEmacs windows containing that buffer.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
66
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
67
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
68 @menu
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
69 * Point:: The place in the text where editing commands operate.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
70 * Echo Area:: Short messages appear at the bottom of the frame.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
71 * Mode Line:: Interpreting the mode line.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
72 * XEmacs under X:: Some information on using XEmacs under the X
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
73 Window System.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
74 @end menu
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
75
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
76 @node Point, Echo Area, Frame, Frame
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
77 @comment node-name, next, previous, up
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
78 @section Point
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
79 @cindex point
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
80 @cindex cursor
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
81
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
82 When XEmacs is running, the cursor shows the location at which editing
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
83 commands will take effect. This location is called @dfn{point}. You
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
84 can use keystrokes or the mouse cursor to move point through the text
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
85 and edit the text at different places.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
86
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
87 While the cursor appears to point @var{at} a character, you should
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
88 think of point as @var{between} two characters: it points @var{before}
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
89 the character on which the cursor appears. The exception is at the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
90 end of the line, where the cursor appears after the last character of
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
91 the line. Where the display is capable, the cursor at the end of the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
92 line will appear differently from a cursor over whitespace at the end
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
93 of the line. (In an X Windows frame, the end-of-line cursor is half
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
94 the width of a within-line cursor.) Sometimes people speak of ``the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
95 cursor'' when they mean ``point,'' or speak of commands that move
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
96 point as ``cursor motion'' commands.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
97
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
98 Each XEmacs frame has only one cursor. When output is in progress, the cursor
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
99 must appear where the typing is being done. This does not mean that
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
100 point is moving. It is only that XEmacs has no way to show you the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
101 location of point except when the terminal is idle.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
102
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
103 If you are editing several files in XEmacs, each file has its own point
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
104 location. A file that is not being displayed remembers where point is.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
105 Point becomes visible at the correct location when you look at the file again.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
106
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
107 When there are multiple text windows, each window has its own point
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
108 location. The cursor shows the location of point in the selected
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
109 window. The visible cursor also shows you which window is selected. If
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
110 the same buffer appears in more than one window, point can be moved in
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
111 each window independently.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
112
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
113 The term `point' comes from the character @samp{.}, which was the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
114 command in TECO (the language in which the original Emacs was written)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
115 for accessing the value now called `point'.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
116
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
117 @node Echo Area, Mode Line, Point, Frame
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
118 @section The Echo Area
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
119 @cindex echo area
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
120
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
121 The line at the bottom of the frame (below the mode line) is the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
122 @dfn{echo area}. XEmacs uses this area to communicate with the user:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
123
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
124 @itemize @bullet
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
125 @item
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
126 @dfn{Echoing} means printing out the characters that the user types. XEmacs
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
127 never echoes single-character commands. Multi-character commands are
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
128 echoed only if you pause while typing them: As soon as you pause for more
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
129 than one second in the middle of a command, all the characters of the command
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
130 so far are echoed. This is intended to @dfn{prompt} you for the rest of
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
131 the command. Once echoing has started, the rest of the command is echoed
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
132 immediately as you type it. This behavior is designed to give confident
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
133 users fast response, while giving hesitant users maximum feedback. You
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
134 can change this behavior by setting a variable (@pxref{Display Vars}).
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
135 @item
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
136 If you issue a command that cannot be executed, XEmacs may print an
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
137 @dfn{error message} in the echo area. Error messages are accompanied by
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
138 a beep or by flashing the frame. Any input you have typed ahead is
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
139 thrown away when an error happens.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
140 @item
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
141 Some commands print informative messages in the echo area. These
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
142 messages look similar to error messages, but are not announced with a
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
143 beep and do not throw away input. Sometimes a message tells you what the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
144 command has done, when this is not obvious from looking at the text being
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
145 edited. Sometimes the sole purpose of a command is to print a message
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
146 giving you specific information. For example, the command @kbd{C-x =} is
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
147 used to print a message describing the character position of point in the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
148 text and its current column in the window. Commands that take a long time
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
149 often display messages ending in @samp{...} while they are working, and
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
150 add @samp{done} at the end when they are finished.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
151 @item
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
152 The echo area is also used to display the @dfn{minibuffer}, a window
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
153 that is used for reading arguments to commands, such as the name of a
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
154 file to be edited. When the minibuffer is in use, the echo area displays
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
155 with a prompt string that usually ends with a colon. The cursor
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
156 appears after the prompt. You can always get out of the minibuffer by
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
157 typing @kbd{C-g}. @xref{Minibuffer}.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
158 @end itemize
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
159
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
160 @node Mode Line, XEmacs under X, Echo Area, Frame
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
161 @comment node-name, next, previous, up
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
162 @section The Mode Line
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
163 @cindex mode line
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
164 @cindex top level
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
165
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
166 Each text window's last line is a @dfn{mode line} which describes what is
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
167 going on in that window. When there is only one text window, the mode line
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
168 appears right above the echo area. The mode line is in inverse video if
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
169 the terminal supports that, starts and ends with dashes, and contains text
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
170 like @samp{XEmacs:@: @var{something}}.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
171
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
172 If a mode line has something else in place of @samp{XEmacs:@:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
173 @var{something}}, the window above it is in a special subsystem
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
174 such as Dired. The mode line then indicates the status of the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
175 subsystem.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
176
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
177 Normally, the mode line has the following appearance:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
178
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
179 @example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
180 --@var{ch}-XEmacs: @var{buf} (@var{major} @var{minor})----@var{pos}------
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
181 @end example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
182
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
183 @noindent
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
184 This gives information about the buffer being displayed in the window: the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
185 buffer's name, what major and minor modes are in use, whether the buffer's
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
186 text has been changed, and how far down the buffer you are currently
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
187 looking.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
188
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
189 @var{ch} contains two stars (@samp{**}) if the text in the buffer has been
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
190 edited (the buffer is ``modified''), or two dashes (@samp{--}) if the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
191 buffer has not been edited. Exception: for a read-only buffer, it is
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
192 @samp{%%}.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
193
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
194 @var{buf} is the name of the window's chosen @dfn{buffer}. The chosen
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
195 buffer in the selected window (the window that the cursor is in) is also
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
196 XEmacs's selected buffer, the buffer in which editing takes place. When
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
197 we speak of what some command does to ``the buffer'', we mean the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
198 currently selected buffer. @xref{Buffers}.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
199
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
200 @var{pos} tells you whether there is additional text above the top of
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
201 the screen or below the bottom. If your file is small and it is
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
202 completely visible on the screen, @var{pos} is @samp{All}. Otherwise,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
203 @var{pos} is @samp{Top} if you are looking at the beginning of the file,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
204 @samp{Bot} if you are looking at the end of the file, or
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
205 @samp{@var{nn}%}, where @var{nn} is the percentage of the file above the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
206 top of the screen.@refill
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
207
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
208 @var{major} is the name of the @dfn{major mode} in effect in the buffer. At
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
209 any time, each buffer is in one and only one major mode.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
210 The available major modes include Fundamental mode (the least specialized),
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
211 Text mode, Lisp mode, and C mode. @xref{Major Modes}, for details
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
212 on how the modes differ and how you select one.@refill
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
213
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
214 @var{minor} is a list of some of the @dfn{minor modes} that are turned on
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
215 in the window's chosen buffer. For example, @samp{Fill} means that Auto
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
216 Fill mode is on. @code{Abbrev} means that Word Abbrev mode is on.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
217 @code{Ovwrt} means that Overwrite mode is on. @xref{Minor Modes}, for more
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
218 information. @samp{Narrow} means that the buffer being displayed has
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
219 editing restricted to only a portion of its text. This is not really a
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
220 minor mode, but is like one. @xref{Narrowing}. @code{Def} means that a
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
221 keyboard macro is being defined. @xref{Keyboard Macros}.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
222
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
223 Some buffers display additional information after the minor modes. For
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
224 example, Rmail buffers display the current message number and the total
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
225 number of messages. Compilation buffers and Shell mode display the status
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
226 of the subprocess.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
227
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
228 If XEmacs is currently inside a recursive editing level, square
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
229 brackets (@samp{[@dots{}]}) appear around the parentheses that surround
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
230 the modes. If XEmacs is in one recursive editing level within another,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
231 double square brackets appear, and so on. Since information on
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
232 recursive editing applies to XEmacs in general and not to any one buffer,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
233 the square brackets appear in every mode line on the screen or not in
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
234 any of them. @xref{Recursive Edit}.@refill
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
235
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
236 @findex display-time
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
237 XEmacs can optionally display the time and system load in all mode lines.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
238 To enable this feature, type @kbd{M-x display-time}. The information added
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
239 to the mode line usually appears after the file name, before the mode names
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
240 and their parentheses. It looks like this:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
241
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
242 @example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
243 @var{hh}:@var{mm}pm @var{l.ll} [@var{d}]
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
244 @end example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
245
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
246 @noindent
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
247 (Some fields may be missing if your operating system cannot support them.)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
248 @var{hh} and @var{mm} are the hour and minute, followed always by @samp{am}
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
249 or @samp{pm}. @var{l.ll} is the average number of running processes in the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
250 whole system recently. @var{d} is an approximate index of the ratio of
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
251 disk activity to CPU activity for all users.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
252
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
253 The word @samp{Mail} appears after the load level if there is mail for
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
254 you that you have not read yet.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
255
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
256 @vindex mode-line-inverse-video
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
257 Customization note: the variable @code{mode-line-inverse-video}
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
258 controls whether the mode line is displayed in inverse video (assuming
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
259 the terminal supports it); @code{nil} means no inverse video. The
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
260 default is @code{t}. For X frames, simply set the foreground and
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
261 background colors appropriately.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
262
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
263 @node XEmacs under X, , Mode Line, Frame
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
264 @section Using XEmacs Under the X Window System
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
265 @comment node-name, next, previous, up
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
266
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
267 XEmacs can be used with the X Window System and a window manager like
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
268 MWM or TWM. In that case, the X window manager opens, closes, and
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
269 resizes XEmacs frames. You use the window manager's mouse gestures to
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
270 perform the operations. Consult your window manager guide or reference
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
271 manual for information on manipulating X windows.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
272
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
273 When you are working under X, each X window (that is, each XEmacs frame)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
274 has a menu bar for mouse-controlled operations (@pxref{Pull-down Menus}).
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
275
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
276 @cindex multi-frame XEmacs
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
277 @findex make-frame
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
278 XEmacs under X is also a multi-frame XEmacs. You can use the @b{New
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
279 Frame} menu item from the @b{File} menu to create a new XEmacs frame in a
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
280 new X window from the same process. The different frames will share the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
281 same buffer list, but you can look at different buffers in the different
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
282 frames.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
283
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
284 @findex find-file-other-frame
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
285 The function @code{find-file-other-frame} is just like @code{find-file},
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
286 but creates a new frame to display the buffer in first. This is
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
287 normally bound to @kbd{C-x 5 C-f}, and is what the @b{Open File, New
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
288 Frame} menu item does.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
289
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
290 @findex switch-to-buffer-other-frame
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
291 The function @code{switch-to-buffer-other-frame} is just like
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
292 @code{switch-to-buffer}, but creates a new frame to display the buffer
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
293 in first. This is normally bound to @kbd{C-x 5 b}.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
294
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
295 @vindex default-frame-alist
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
296 You can specify a different default frame size other than the one provided.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
297 Use the variable @code{default-frame-alist}, which is an alist of default
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
298 values for frame creation other than the first one. These may be set in
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
299 your init file, like this:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
300
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
301 @example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
302 (setq default-frame-alist '((width . 80) (height . 55)))
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
303 @end example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
304
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
305 @vindex x-frame-defaults
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
306 For values specific to the first XEmacs frame, you must use X resources.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
307 The variable @code{x-frame-defaults} takes an alist of default frame
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
308 creation parameters for X window frames. These override what is
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
309 specified in @file{~/.Xdefaults} but are overridden by the arguments to
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
310 the particular call to @code{x-create-frame}.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
311
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
312 @vindex create-frame-hook
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
313 When you create a new frame, the variable @code{create-frame-hook}
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
314 is called with one argument, the frame just created.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
315
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
316 If you want to close one or more of the X windows you created using
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
317 @b{New Frame}, use the @b{Delete Frame} menu item from the @b{File} menu.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
318
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
319 @vindex frame-title-format
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
320 @vindex frame-icon-title-format
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
321 If you are working with multiple frames, some special information
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
322 applies:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
323 @itemize @bullet
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
324 @item
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
325 Two variables, @code{frame-title-format} and
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
326 @code{frame-icon-title-format} determine the title of the frame and
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
327 the title of the icon that results if you shrink the frame.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
328
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
329 @vindex auto-lower-frame
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
330 @vindex auto-raise-frame
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
331 @item
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
332 The variables @code{auto-lower-frame} and @code{auto-raise-frame}
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
333 position a frame. If true, @code{auto-lower-frame} lowers a frame to
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
334 the bottom when it is no longer selected. If true,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
335 @code{auto-raise-frame} raises a frame to the top when it is
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
336 selected. Under X, most ICCCM-compliant window managers will have
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
337 options to do this for you, but these variables are provided in case you
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
338 are using a broken window manager.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
339
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
340 @item
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
341 There is a new frame/modeline format directive, %S, which expands to
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
342 the name of the current frame (a frame's name is distinct from its
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
343 title; the name is used for resource lookup, among other things, and the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
344 title is simply what appears above the window.)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
345 @end itemize