Mercurial > emacs
annotate etc/emacsclient.1 @ 83716:a73440d2f146 merge-multi-tty-to-trunk
Merge multi-tty branch
Revision: emacs@sv.gnu.org/emacs--devo--0--patch-866
author | Miles Bader <miles@gnu.org> |
---|---|
date | Wed, 29 Aug 2007 05:28:10 +0000 |
parents | 1611531c83d1 |
children | f1d13e615070 |
rev | line source |
---|---|
25853 | 1 .TH EMACSCLIENT 1 |
2 .\" NAME should be all caps, SECTION should be 1-8, maybe w/ subsection | |
3 .\" other parms are allowed: see man(7), man(1) | |
4 .SH NAME | |
5 emacsclient \- tells a running Emacs to visit a file | |
6 .SH SYNOPSIS | |
7 .B emacsclient | |
8 .I "[options] files ..." | |
9 .SH "DESCRIPTION" | |
10 This manual page documents briefly the | |
11 .BR emacsclient | |
65178
19477c8eacc2
(DESCRIPTION): Reflect inclusion in the Emacs distribution.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
52401
diff
changeset
|
12 command. Full documentation is available in the GNU Info format; see |
19477c8eacc2
(DESCRIPTION): Reflect inclusion in the Emacs distribution.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
52401
diff
changeset
|
13 below. |
19477c8eacc2
(DESCRIPTION): Reflect inclusion in the Emacs distribution.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
52401
diff
changeset
|
14 This manual page was originally written for the Debian GNU/Linux |
19477c8eacc2
(DESCRIPTION): Reflect inclusion in the Emacs distribution.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
52401
diff
changeset
|
15 distribution, but is not specific to that system. |
25853 | 16 .PP |
65178
19477c8eacc2
(DESCRIPTION): Reflect inclusion in the Emacs distribution.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
52401
diff
changeset
|
17 .B emacsclient |
19477c8eacc2
(DESCRIPTION): Reflect inclusion in the Emacs distribution.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
52401
diff
changeset
|
18 works in conjunction with the built-in Emacs server. |
25853 | 19 .PP |
65178
19477c8eacc2
(DESCRIPTION): Reflect inclusion in the Emacs distribution.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
52401
diff
changeset
|
20 You can either call |
25853 | 21 .B emacsclient |
65178
19477c8eacc2
(DESCRIPTION): Reflect inclusion in the Emacs distribution.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
52401
diff
changeset
|
22 directly or let other programs run it for you when necessary. On |
19477c8eacc2
(DESCRIPTION): Reflect inclusion in the Emacs distribution.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
52401
diff
changeset
|
23 GNU and Unix systems many programs consult the environment |
19477c8eacc2
(DESCRIPTION): Reflect inclusion in the Emacs distribution.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
52401
diff
changeset
|
24 variable EDITOR (sometimes also VISUAL) to obtain the command used for |
19477c8eacc2
(DESCRIPTION): Reflect inclusion in the Emacs distribution.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
52401
diff
changeset
|
25 editing. Thus, setting this environment variable to 'emacsclient' |
19477c8eacc2
(DESCRIPTION): Reflect inclusion in the Emacs distribution.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
52401
diff
changeset
|
26 will allow these programs to use an already running Emacs for editing. |
19477c8eacc2
(DESCRIPTION): Reflect inclusion in the Emacs distribution.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
52401
diff
changeset
|
27 Other operating systems might have their own methods for defining the |
19477c8eacc2
(DESCRIPTION): Reflect inclusion in the Emacs distribution.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
52401
diff
changeset
|
28 default editor. |
25853 | 29 |
30 For | |
65178
19477c8eacc2
(DESCRIPTION): Reflect inclusion in the Emacs distribution.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
52401
diff
changeset
|
31 .B emacsclient |
74124
1611531c83d1
(DESCRIPTION): Suggest also `server-mode'.
Juanma Barranquero <lekktu@gmail.com>
parents:
65178
diff
changeset
|
32 to work, you need an already running Emacs with a server. Within Emacs, |
1611531c83d1
(DESCRIPTION): Suggest also `server-mode'.
Juanma Barranquero <lekktu@gmail.com>
parents:
65178
diff
changeset
|
33 call the functions `server-start' or `server-mode'. (Your `.emacs' file |
1611531c83d1
(DESCRIPTION): Suggest also `server-mode'.
Juanma Barranquero <lekktu@gmail.com>
parents:
65178
diff
changeset
|
34 can do this automatically if you add either `(server-start)' or |
1611531c83d1
(DESCRIPTION): Suggest also `server-mode'.
Juanma Barranquero <lekktu@gmail.com>
parents:
65178
diff
changeset
|
35 `(server-mode 1)' to it.) |
25853 | 36 |
37 When you've finished editing the buffer, type `C-x #' | |
38 (`server-edit'). This saves the file and sends a message back to the | |
39 `emacsclient' program telling it to exit. The programs that use | |
40 `EDITOR' wait for the "editor" (actually, `emacsclient') to exit. `C-x | |
41 #' also checks for other pending external requests to edit various | |
42 files, and selects the next such file. | |
43 | |
44 If you set the variable `server-window' to a window or a frame, `C-x | |
45 #' displays the server buffer in that window or in that frame. | |
46 | |
47 .SH OPTIONS | |
48 The programs follow the usual GNU command line syntax, with long | |
49 options starting with two dashes (`-'). | |
50 .TP | |
51 .B \-n, \-\-no-wait | |
52 returns | |
53 immediately without waiting for you to "finish" the buffer in Emacs. | |
47649
3b27be508d4e
Add info about --eval, --display, and --alternate-editor.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
37560
diff
changeset
|
54 .TP |
3b27be508d4e
Add info about --eval, --display, and --alternate-editor.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
37560
diff
changeset
|
55 .B \-e, \-\-eval |
3b27be508d4e
Add info about --eval, --display, and --alternate-editor.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
37560
diff
changeset
|
56 do not visit files but instead evaluate the arguments as Emacs |
3b27be508d4e
Add info about --eval, --display, and --alternate-editor.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
37560
diff
changeset
|
57 Lisp expressions. |
3b27be508d4e
Add info about --eval, --display, and --alternate-editor.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
37560
diff
changeset
|
58 .TP |
65178
19477c8eacc2
(DESCRIPTION): Reflect inclusion in the Emacs distribution.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
52401
diff
changeset
|
59 .B \-s, \-\-socket-name=FILENAME |
74124
1611531c83d1
(DESCRIPTION): Suggest also `server-mode'.
Juanma Barranquero <lekktu@gmail.com>
parents:
65178
diff
changeset
|
60 use socket named FILENAME for communication. |
1611531c83d1
(DESCRIPTION): Suggest also `server-mode'.
Juanma Barranquero <lekktu@gmail.com>
parents:
65178
diff
changeset
|
61 .TP |
1611531c83d1
(DESCRIPTION): Suggest also `server-mode'.
Juanma Barranquero <lekktu@gmail.com>
parents:
65178
diff
changeset
|
62 .B \-f, \-\-server-file=FILENAME |
1611531c83d1
(DESCRIPTION): Suggest also `server-mode'.
Juanma Barranquero <lekktu@gmail.com>
parents:
65178
diff
changeset
|
63 use TCP configuration file FILENAME for communication. |
1611531c83d1
(DESCRIPTION): Suggest also `server-mode'.
Juanma Barranquero <lekktu@gmail.com>
parents:
65178
diff
changeset
|
64 This can also be specified via the `EMACS_SERVER_FILE' environment variable. |
65178
19477c8eacc2
(DESCRIPTION): Reflect inclusion in the Emacs distribution.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
52401
diff
changeset
|
65 .TP |
47649
3b27be508d4e
Add info about --eval, --display, and --alternate-editor.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
37560
diff
changeset
|
66 .B \-a, \-\-alternate-editor=EDITOR |
3b27be508d4e
Add info about --eval, --display, and --alternate-editor.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
37560
diff
changeset
|
67 if the Emacs server is not running, run the specified editor instead. |
3b27be508d4e
Add info about --eval, --display, and --alternate-editor.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
37560
diff
changeset
|
68 This can also be specified via the `ALTERNATE_EDITOR' environment variable. |
3b27be508d4e
Add info about --eval, --display, and --alternate-editor.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
37560
diff
changeset
|
69 .TP |
3b27be508d4e
Add info about --eval, --display, and --alternate-editor.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
37560
diff
changeset
|
70 .B \-d, \-\-display=DISPLAY |
3b27be508d4e
Add info about --eval, --display, and --alternate-editor.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
37560
diff
changeset
|
71 tell the server to display the files on the given display. |
65178
19477c8eacc2
(DESCRIPTION): Reflect inclusion in the Emacs distribution.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
52401
diff
changeset
|
72 .TP |
19477c8eacc2
(DESCRIPTION): Reflect inclusion in the Emacs distribution.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
52401
diff
changeset
|
73 .B \-V, \-\-version |
19477c8eacc2
(DESCRIPTION): Reflect inclusion in the Emacs distribution.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
52401
diff
changeset
|
74 print version information and exit |
19477c8eacc2
(DESCRIPTION): Reflect inclusion in the Emacs distribution.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
52401
diff
changeset
|
75 .TP |
19477c8eacc2
(DESCRIPTION): Reflect inclusion in the Emacs distribution.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
52401
diff
changeset
|
76 .B \-h, \-\-help |
19477c8eacc2
(DESCRIPTION): Reflect inclusion in the Emacs distribution.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
52401
diff
changeset
|
77 print this usage information message and exit |
25853 | 78 .SH "SEE ALSO" |
79 The program is documented fully in | |
80 .IR "Using Emacs as a Server" | |
81 available via the Info system. | |
82 .SH AUTHOR | |
83 This manual page was written by Stephane Bortzmeyer <bortzmeyer@debian.org>, | |
84 for the Debian GNU/Linux system (but may be used by others). | |
37560 | 85 .SH COPYING |
86 This manual page is in the public domain. | |
52401 | 87 |
88 .\" arch-tag: 2b35e723-b197-4073-8752-231bc8b3d3f3 |