Mercurial > emacs
annotate doc/man/emacsclient.1 @ 112450:16ddab338c43
Remove HAVE_RAW_DECL_CHOWN etc. from config.h
author | Paul Eggert <eggert@cs.ucla.edu> |
---|---|
date | Sun, 23 Jan 2011 20:53:39 -0800 |
parents | ef719132ddfa |
children |
rev | line source |
---|---|
100390 | 1 .\" See section COPYING for conditions for redistribution. |
83912 | 2 .TH EMACSCLIENT 1 |
3 .\" NAME should be all caps, SECTION should be 1-8, maybe w/ subsection | |
4 .\" other parms are allowed: see man(7), man(1) | |
5 .SH NAME | |
6 emacsclient \- tells a running Emacs to visit a file | |
7 .SH SYNOPSIS | |
8 .B emacsclient | |
9 .I "[options] files ..." | |
10 .SH "DESCRIPTION" | |
11 This manual page documents briefly the | |
12 .BR emacsclient | |
13 command. Full documentation is available in the GNU Info format; see | |
14 below. | |
15 This manual page was originally written for the Debian GNU/Linux | |
16 distribution, but is not specific to that system. | |
17 .PP | |
18 .B emacsclient | |
19 works in conjunction with the built-in Emacs server. | |
20 .PP | |
21 You can either call | |
22 .B emacsclient | |
23 directly or let other programs run it for you when necessary. On | |
24 GNU and Unix systems many programs consult the environment | |
25 variable EDITOR (sometimes also VISUAL) to obtain the command used for | |
26 editing. Thus, setting this environment variable to 'emacsclient' | |
27 will allow these programs to use an already running Emacs for editing. | |
28 Other operating systems might have their own methods for defining the | |
29 default editor. | |
30 | |
31 For | |
32 .B emacsclient | |
33 to work, you need an already running Emacs with a server. Within Emacs, | |
34 call the functions `server-start' or `server-mode'. (Your `.emacs' file | |
35 can do this automatically if you add either `(server-start)' or | |
36 `(server-mode 1)' to it.) | |
37 | |
38 When you've finished editing the buffer, type `C-x #' | |
39 (`server-edit'). This saves the file and sends a message back to the | |
40 `emacsclient' program telling it to exit. The programs that use | |
41 `EDITOR' wait for the "editor" (actually, `emacsclient') to exit. `C-x | |
42 #' also checks for other pending external requests to edit various | |
43 files, and selects the next such file. | |
44 | |
45 If you set the variable `server-window' to a window or a frame, `C-x | |
46 #' displays the server buffer in that window or in that frame. | |
47 | |
48 .SH OPTIONS | |
49 The programs follow the usual GNU command line syntax, with long | |
50 options starting with two dashes (`-'). | |
51 .TP | |
52 .B \-a, \-\-alternate-editor=EDITOR | |
53 if the Emacs server is not running, run the specified editor instead. | |
54 This can also be specified via the `ALTERNATE_EDITOR' environment variable. | |
100312
6da82f7dfa67
* misc.texi (emacsclient Options): Describe what an empty string
Dan Nicolaescu <dann@ics.uci.edu>
parents:
99991
diff
changeset
|
55 If the value of EDITOR is the empty string, then Emacs is started in |
6da82f7dfa67
* misc.texi (emacsclient Options): Describe what an empty string
Dan Nicolaescu <dann@ics.uci.edu>
parents:
99991
diff
changeset
|
56 daemon mode and emacsclient will try to connect to it. |
83912 | 57 .TP |
112086
f5d1f4fc8c14
* emacsclient.1: Arrange options alphabetically (Bug#7620).
Chong Yidong <cyd@stupidchicken.com>
parents:
100390
diff
changeset
|
58 .B -c, \-\-create-frame |
f5d1f4fc8c14
* emacsclient.1: Arrange options alphabetically (Bug#7620).
Chong Yidong <cyd@stupidchicken.com>
parents:
100390
diff
changeset
|
59 create a new frame instead of trying to use the current Emacs frame |
f5d1f4fc8c14
* emacsclient.1: Arrange options alphabetically (Bug#7620).
Chong Yidong <cyd@stupidchicken.com>
parents:
100390
diff
changeset
|
60 .TP |
83912 | 61 .B \-d, \-\-display=DISPLAY |
62 tell the server to display the files on the given display. | |
63 .TP | |
112086
f5d1f4fc8c14
* emacsclient.1: Arrange options alphabetically (Bug#7620).
Chong Yidong <cyd@stupidchicken.com>
parents:
100390
diff
changeset
|
64 .B \-e, \-\-eval |
f5d1f4fc8c14
* emacsclient.1: Arrange options alphabetically (Bug#7620).
Chong Yidong <cyd@stupidchicken.com>
parents:
100390
diff
changeset
|
65 do not visit files but instead evaluate the arguments as Emacs |
f5d1f4fc8c14
* emacsclient.1: Arrange options alphabetically (Bug#7620).
Chong Yidong <cyd@stupidchicken.com>
parents:
100390
diff
changeset
|
66 Lisp expressions. |
f5d1f4fc8c14
* emacsclient.1: Arrange options alphabetically (Bug#7620).
Chong Yidong <cyd@stupidchicken.com>
parents:
100390
diff
changeset
|
67 .TP |
f5d1f4fc8c14
* emacsclient.1: Arrange options alphabetically (Bug#7620).
Chong Yidong <cyd@stupidchicken.com>
parents:
100390
diff
changeset
|
68 .B \-f, \-\-server-file=FILENAME |
f5d1f4fc8c14
* emacsclient.1: Arrange options alphabetically (Bug#7620).
Chong Yidong <cyd@stupidchicken.com>
parents:
100390
diff
changeset
|
69 use TCP configuration file FILENAME for communication. |
f5d1f4fc8c14
* emacsclient.1: Arrange options alphabetically (Bug#7620).
Chong Yidong <cyd@stupidchicken.com>
parents:
100390
diff
changeset
|
70 This can also be specified via the `EMACS_SERVER_FILE' environment variable. |
f5d1f4fc8c14
* emacsclient.1: Arrange options alphabetically (Bug#7620).
Chong Yidong <cyd@stupidchicken.com>
parents:
100390
diff
changeset
|
71 .TP |
f5d1f4fc8c14
* emacsclient.1: Arrange options alphabetically (Bug#7620).
Chong Yidong <cyd@stupidchicken.com>
parents:
100390
diff
changeset
|
72 .B \-n, \-\-no-wait |
f5d1f4fc8c14
* emacsclient.1: Arrange options alphabetically (Bug#7620).
Chong Yidong <cyd@stupidchicken.com>
parents:
100390
diff
changeset
|
73 returns |
f5d1f4fc8c14
* emacsclient.1: Arrange options alphabetically (Bug#7620).
Chong Yidong <cyd@stupidchicken.com>
parents:
100390
diff
changeset
|
74 immediately without waiting for you to "finish" the buffer in Emacs. |
f5d1f4fc8c14
* emacsclient.1: Arrange options alphabetically (Bug#7620).
Chong Yidong <cyd@stupidchicken.com>
parents:
100390
diff
changeset
|
75 .TP |
f5d1f4fc8c14
* emacsclient.1: Arrange options alphabetically (Bug#7620).
Chong Yidong <cyd@stupidchicken.com>
parents:
100390
diff
changeset
|
76 .B \-nw, \-t, \-\-tty |
f5d1f4fc8c14
* emacsclient.1: Arrange options alphabetically (Bug#7620).
Chong Yidong <cyd@stupidchicken.com>
parents:
100390
diff
changeset
|
77 open a new Emacs frame on the current terminal |
f5d1f4fc8c14
* emacsclient.1: Arrange options alphabetically (Bug#7620).
Chong Yidong <cyd@stupidchicken.com>
parents:
100390
diff
changeset
|
78 .TP |
f5d1f4fc8c14
* emacsclient.1: Arrange options alphabetically (Bug#7620).
Chong Yidong <cyd@stupidchicken.com>
parents:
100390
diff
changeset
|
79 .B \-s, \-\-socket-name=FILENAME |
f5d1f4fc8c14
* emacsclient.1: Arrange options alphabetically (Bug#7620).
Chong Yidong <cyd@stupidchicken.com>
parents:
100390
diff
changeset
|
80 use socket named FILENAME for communication. |
f5d1f4fc8c14
* emacsclient.1: Arrange options alphabetically (Bug#7620).
Chong Yidong <cyd@stupidchicken.com>
parents:
100390
diff
changeset
|
81 .TP |
83912 | 82 .B \-V, \-\-version |
83 print version information and exit | |
84 .TP | |
99991
ec1ce2561f47
Mention -nw and -c. Fix the character for --help.
Dan Nicolaescu <dann@ics.uci.edu>
parents:
83912
diff
changeset
|
85 .B \-H, \-\-help |
83912 | 86 print this usage information message and exit |
87 .SH "SEE ALSO" | |
88 The program is documented fully in | |
89 .IR "Using Emacs as a Server" | |
90 available via the Info system. | |
91 .SH AUTHOR | |
92 This manual page was written by Stephane Bortzmeyer <bortzmeyer@debian.org>, | |
93 for the Debian GNU/Linux system (but may be used by others). | |
94 .SH COPYING | |
95 This manual page is in the public domain. | |
96 |