annotate man/entering.texi @ 47467:c5035e184eba

(comment-with-narrowing): Use the `declare' thingy.
author Stefan Monnier <monnier@iro.umontreal.ca>
date Fri, 13 Sep 2002 18:22:37 +0000
parents 861d4dd87bd7
children 23a1cea22d13
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1 @c This is part of the Emacs manual.
Dave Love <fx@gnu.org>
parents:
diff changeset
2 @c Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995 Free Software Foundation, Inc.
Dave Love <fx@gnu.org>
parents:
diff changeset
3 @c See file emacs.texi for copying conditions.
Dave Love <fx@gnu.org>
parents:
diff changeset
4 @node Entering Emacs, Exiting, Text Characters, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
5 @chapter Entering and Exiting Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
6 @cindex entering Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
7 @cindex starting Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
8
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 25829
diff changeset
9 The usual way to invoke Emacs is with the shell command @command{emacs}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
10 Emacs clears the screen and then displays an initial help message and
Dave Love <fx@gnu.org>
parents:
diff changeset
11 copyright notice. Some operating systems discard all type-ahead when
Dave Love <fx@gnu.org>
parents:
diff changeset
12 Emacs starts up; they give Emacs no way to prevent this. Therefore, it
Dave Love <fx@gnu.org>
parents:
diff changeset
13 is advisable to wait until Emacs clears the screen before typing your
Dave Love <fx@gnu.org>
parents:
diff changeset
14 first editing command.
Dave Love <fx@gnu.org>
parents:
diff changeset
15
Dave Love <fx@gnu.org>
parents:
diff changeset
16 If you run Emacs from a shell window under the X Window System, run it
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 25829
diff changeset
17 in the background with @command{emacs&}. This way, Emacs does not tie up
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
18 the shell window, so you can use that to run other shell commands while
Dave Love <fx@gnu.org>
parents:
diff changeset
19 Emacs operates its own X windows. You can begin typing Emacs commands
Dave Love <fx@gnu.org>
parents:
diff changeset
20 as soon as you direct your keyboard input to the Emacs frame.
Dave Love <fx@gnu.org>
parents:
diff changeset
21
Dave Love <fx@gnu.org>
parents:
diff changeset
22 @vindex initial-major-mode
38954
5c282c7df1cf Minor clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38920
diff changeset
23 When Emacs starts up, it creates a buffer named @samp{*scratch*}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
24 That's the buffer you start out in. The @samp{*scratch*} buffer uses Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
25 Interaction mode; you can use it to type Lisp expressions and evaluate
Dave Love <fx@gnu.org>
parents:
diff changeset
26 them, or you can ignore that capability and simply doodle. (You can
Dave Love <fx@gnu.org>
parents:
diff changeset
27 specify a different major mode for this buffer by setting the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
28 @code{initial-major-mode} in your init file. @xref{Init File}.)
Dave Love <fx@gnu.org>
parents:
diff changeset
29
Dave Love <fx@gnu.org>
parents:
diff changeset
30 It is possible to specify files to be visited, Lisp files to be
Dave Love <fx@gnu.org>
parents:
diff changeset
31 loaded, and functions to be called, by giving Emacs arguments in the
Dave Love <fx@gnu.org>
parents:
diff changeset
32 shell command line. @xref{Command Arguments}. But we don't recommend
Dave Love <fx@gnu.org>
parents:
diff changeset
33 doing this. The feature exists mainly for compatibility with other
Dave Love <fx@gnu.org>
parents:
diff changeset
34 editors.
Dave Love <fx@gnu.org>
parents:
diff changeset
35
Dave Love <fx@gnu.org>
parents:
diff changeset
36 Many other editors are designed to be started afresh each time you
Dave Love <fx@gnu.org>
parents:
diff changeset
37 want to edit. You edit one file and then exit the editor. The next
Dave Love <fx@gnu.org>
parents:
diff changeset
38 time you want to edit either another file or the same one, you must run
Dave Love <fx@gnu.org>
parents:
diff changeset
39 the editor again. With these editors, it makes sense to use a
Dave Love <fx@gnu.org>
parents:
diff changeset
40 command-line argument to say which file to edit.
Dave Love <fx@gnu.org>
parents:
diff changeset
41
Dave Love <fx@gnu.org>
parents:
diff changeset
42 But starting a new Emacs each time you want to edit a different file
37348
84cb4bee4df1 Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 29107
diff changeset
43 does not make sense. For one thing, this would be annoyingly slow.
84cb4bee4df1 Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 29107
diff changeset
44 For another, this would fail to take advantage of Emacs's ability to
84cb4bee4df1 Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 29107
diff changeset
45 visit more than one file in a single editing session. And it would
84cb4bee4df1 Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 29107
diff changeset
46 lose the other accumulated context, such as the kill ring, registers,
84cb4bee4df1 Minor clarification.
Richard M. Stallman <rms@gnu.org>
parents: 29107
diff changeset
47 undo history, and mark ring.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
48
Dave Love <fx@gnu.org>
parents:
diff changeset
49 The recommended way to use GNU Emacs is to start it only once, just
Dave Love <fx@gnu.org>
parents:
diff changeset
50 after you log in, and do all your editing in the same Emacs session.
Dave Love <fx@gnu.org>
parents:
diff changeset
51 Each time you want to edit a different file, you visit it with the
Dave Love <fx@gnu.org>
parents:
diff changeset
52 existing Emacs, which eventually comes to have many files in it ready
Dave Love <fx@gnu.org>
parents:
diff changeset
53 for editing. Usually you do not kill the Emacs until you are about to
Dave Love <fx@gnu.org>
parents:
diff changeset
54 log out. @xref{Files}, for more information on visiting more than one
Dave Love <fx@gnu.org>
parents:
diff changeset
55 file.
Dave Love <fx@gnu.org>
parents:
diff changeset
56
46913
861d4dd87bd7 Mention emacsclient, with xref.
Richard M. Stallman <rms@gnu.org>
parents: 38954
diff changeset
57 If you want to edit a file from another program and already have
861d4dd87bd7 Mention emacsclient, with xref.
Richard M. Stallman <rms@gnu.org>
parents: 38954
diff changeset
58 Emacs running, you can use the @command{emacsclient} program to open a
861d4dd87bd7 Mention emacsclient, with xref.
Richard M. Stallman <rms@gnu.org>
parents: 38954
diff changeset
59 file in the already running Emacs. @xref{Emacs Server}, for more
861d4dd87bd7 Mention emacsclient, with xref.
Richard M. Stallman <rms@gnu.org>
parents: 38954
diff changeset
60 information on editing files with Emacs from other programs.
861d4dd87bd7 Mention emacsclient, with xref.
Richard M. Stallman <rms@gnu.org>
parents: 38954
diff changeset
61
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
62 @node Exiting, Basic, Entering Emacs, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
63 @section Exiting Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
64 @cindex exiting
Dave Love <fx@gnu.org>
parents:
diff changeset
65 @cindex killing Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
66 @cindex suspending
Dave Love <fx@gnu.org>
parents:
diff changeset
67 @cindex leaving Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
68 @cindex quitting Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
69
Dave Love <fx@gnu.org>
parents:
diff changeset
70 There are two commands for exiting Emacs because there are two kinds
Dave Love <fx@gnu.org>
parents:
diff changeset
71 of exiting: @dfn{suspending} Emacs and @dfn{killing} Emacs.
Dave Love <fx@gnu.org>
parents:
diff changeset
72
Dave Love <fx@gnu.org>
parents:
diff changeset
73 @dfn{Suspending} means stopping Emacs temporarily and returning
Dave Love <fx@gnu.org>
parents:
diff changeset
74 control to its parent process (usually a shell), allowing you to resume
Dave Love <fx@gnu.org>
parents:
diff changeset
75 editing later in the same Emacs job, with the same buffers, same kill
Dave Love <fx@gnu.org>
parents:
diff changeset
76 ring, same undo history, and so on. This is the usual way to exit.
Dave Love <fx@gnu.org>
parents:
diff changeset
77
Dave Love <fx@gnu.org>
parents:
diff changeset
78 @dfn{Killing} Emacs means destroying the Emacs job. You can run Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
79 again later, but you will get a fresh Emacs; there is no way to resume
Dave Love <fx@gnu.org>
parents:
diff changeset
80 the same editing session after it has been killed.
Dave Love <fx@gnu.org>
parents:
diff changeset
81
Dave Love <fx@gnu.org>
parents:
diff changeset
82 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
83 @item C-z
Dave Love <fx@gnu.org>
parents:
diff changeset
84 Suspend Emacs (@code{suspend-emacs}) or iconify a frame
Dave Love <fx@gnu.org>
parents:
diff changeset
85 (@code{iconify-or-deiconify-frame}).
Dave Love <fx@gnu.org>
parents:
diff changeset
86 @item C-x C-c
Dave Love <fx@gnu.org>
parents:
diff changeset
87 Kill Emacs (@code{save-buffers-kill-emacs}).
Dave Love <fx@gnu.org>
parents:
diff changeset
88 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
89
Dave Love <fx@gnu.org>
parents:
diff changeset
90 @kindex C-z
Dave Love <fx@gnu.org>
parents:
diff changeset
91 @findex suspend-emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
92 To suspend Emacs, type @kbd{C-z} (@code{suspend-emacs}). This takes
Dave Love <fx@gnu.org>
parents:
diff changeset
93 you back to the shell from which you invoked Emacs. You can resume
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 25829
diff changeset
94 Emacs with the shell command @command{%emacs} in most common shells.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
95
Dave Love <fx@gnu.org>
parents:
diff changeset
96 On systems that do not support suspending programs, @kbd{C-z} starts
Dave Love <fx@gnu.org>
parents:
diff changeset
97 an inferior shell that communicates directly with the terminal.
Dave Love <fx@gnu.org>
parents:
diff changeset
98 Emacs waits until you exit the subshell. (The way to do that is
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 25829
diff changeset
99 probably with @kbd{C-d} or @command{exit}, but it depends on which shell
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
100 you use.) The only way on these systems to get back to the shell from
Dave Love <fx@gnu.org>
parents:
diff changeset
101 which Emacs was run (to log out, for example) is to kill Emacs.
Dave Love <fx@gnu.org>
parents:
diff changeset
102
Dave Love <fx@gnu.org>
parents:
diff changeset
103 Suspending also fails if you run Emacs under a shell that doesn't
Dave Love <fx@gnu.org>
parents:
diff changeset
104 support suspending programs, even if the system itself does support it.
Dave Love <fx@gnu.org>
parents:
diff changeset
105 In such a case, you can set the variable @code{cannot-suspend} to a
Dave Love <fx@gnu.org>
parents:
diff changeset
106 non-@code{nil} value to force @kbd{C-z} to start an inferior shell.
Dave Love <fx@gnu.org>
parents:
diff changeset
107 (One might also describe Emacs's parent shell as ``inferior'' for
Dave Love <fx@gnu.org>
parents:
diff changeset
108 failing to support job control properly, but that is a matter of taste.)
Dave Love <fx@gnu.org>
parents:
diff changeset
109
Dave Love <fx@gnu.org>
parents:
diff changeset
110 When Emacs communicates directly with an X server and creates its own
Dave Love <fx@gnu.org>
parents:
diff changeset
111 dedicated X windows, @kbd{C-z} has a different meaning. Suspending an
38172
aad260e72f97 Minor change.
Richard M. Stallman <rms@gnu.org>
parents: 37348
diff changeset
112 application that uses its own X windows is not meaningful or useful.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
113 Instead, @kbd{C-z} runs the command @code{iconify-or-deiconify-frame},
38954
5c282c7df1cf Minor clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38920
diff changeset
114 which temporarily iconifies (or ``minimizes'') the selected Emacs
5c282c7df1cf Minor clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38920
diff changeset
115 frame (@pxref{Frames}). Then you can use the window manager to get
5c282c7df1cf Minor clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38920
diff changeset
116 back to a shell window.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
117
Dave Love <fx@gnu.org>
parents:
diff changeset
118 @kindex C-x C-c
Dave Love <fx@gnu.org>
parents:
diff changeset
119 @findex save-buffers-kill-emacs
38954
5c282c7df1cf Minor clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38920
diff changeset
120 To exit and kill Emacs, type @kbd{C-x C-c}
5c282c7df1cf Minor clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38920
diff changeset
121 (@code{save-buffers-kill-emacs}). A two-character key is used for
5c282c7df1cf Minor clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38920
diff changeset
122 this to make it harder to type by accident. This command first offers
5c282c7df1cf Minor clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38920
diff changeset
123 to save any modified file-visiting buffers. If you do not save them
5c282c7df1cf Minor clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38920
diff changeset
124 all, it asks for reconfirmation with @kbd{yes} before killing Emacs,
5c282c7df1cf Minor clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38920
diff changeset
125 since any changes not saved will be lost forever. Also, if any
5c282c7df1cf Minor clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38920
diff changeset
126 subprocesses are still running, @kbd{C-x C-c} asks for confirmation
5c282c7df1cf Minor clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38920
diff changeset
127 about them, since killing Emacs will also kill the subprocesses.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
128
38920
caf015ed2aea Document confirm-kill-emacs.
Eli Zaretskii <eliz@gnu.org>
parents: 38172
diff changeset
129 @vindex confirm-kill-emacs
caf015ed2aea Document confirm-kill-emacs.
Eli Zaretskii <eliz@gnu.org>
parents: 38172
diff changeset
130 If the value of the variable @code{confirm-kill-emacs} is
caf015ed2aea Document confirm-kill-emacs.
Eli Zaretskii <eliz@gnu.org>
parents: 38172
diff changeset
131 non-@code{nil}, @kbd{C-x C-c} assumes that its value is a predicate
caf015ed2aea Document confirm-kill-emacs.
Eli Zaretskii <eliz@gnu.org>
parents: 38172
diff changeset
132 function, and calls that function. If the result is non-@code{nil}, the
caf015ed2aea Document confirm-kill-emacs.
Eli Zaretskii <eliz@gnu.org>
parents: 38172
diff changeset
133 session is killed, otherwise Emacs continues to run. One convenient
caf015ed2aea Document confirm-kill-emacs.
Eli Zaretskii <eliz@gnu.org>
parents: 38172
diff changeset
134 function to use as the value of @code{confirm-kill-emacs} is the
caf015ed2aea Document confirm-kill-emacs.
Eli Zaretskii <eliz@gnu.org>
parents: 38172
diff changeset
135 function @code{yes-or-no-p}. The default value of
caf015ed2aea Document confirm-kill-emacs.
Eli Zaretskii <eliz@gnu.org>
parents: 38172
diff changeset
136 @code{confirm-kill-emacs} is @code{nil}.
caf015ed2aea Document confirm-kill-emacs.
Eli Zaretskii <eliz@gnu.org>
parents: 38172
diff changeset
137
38954
5c282c7df1cf Minor clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38920
diff changeset
138 There is no way to resume an Emacs session once you have killed it.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
139 You can, however, arrange for Emacs to record certain session
38954
5c282c7df1cf Minor clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38920
diff changeset
140 information when you kill it, such as which files are visited, so that
5c282c7df1cf Minor clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 38920
diff changeset
141 the next time you start Emacs it will try to visit the same files and
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
142 so on. @xref{Saving Emacs Sessions}.
Dave Love <fx@gnu.org>
parents:
diff changeset
143
Dave Love <fx@gnu.org>
parents:
diff changeset
144 The operating system usually listens for certain special characters
Dave Love <fx@gnu.org>
parents:
diff changeset
145 whose meaning is to kill or suspend the program you are running.
Dave Love <fx@gnu.org>
parents:
diff changeset
146 @b{This operating system feature is turned off while you are in Emacs.}
Dave Love <fx@gnu.org>
parents:
diff changeset
147 The meanings of @kbd{C-z} and @kbd{C-x C-c} as keys in Emacs were
Dave Love <fx@gnu.org>
parents:
diff changeset
148 inspired by the use of @kbd{C-z} and @kbd{C-c} on several operating
Dave Love <fx@gnu.org>
parents:
diff changeset
149 systems as the characters for stopping or killing a program, but that is
Dave Love <fx@gnu.org>
parents:
diff changeset
150 their only relationship with the operating system. You can customize
Dave Love <fx@gnu.org>
parents:
diff changeset
151 these keys to run any commands of your choice (@pxref{Keymaps}).