annotate etc/emacsclient.1 @ 70820:d0c27da52401

Add entry for ewoc change.
author Thien-Thi Nguyen <ttn@gnuvola.org>
date Sun, 21 May 2006 21:51:17 +0000
parents 19477c8eacc2
children 1611531c83d1 a3716f7538f2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
25853
Dave Love <fx@gnu.org>
parents:
diff changeset
1 .TH EMACSCLIENT 1
Dave Love <fx@gnu.org>
parents:
diff changeset
2 .\" NAME should be all caps, SECTION should be 1-8, maybe w/ subsection
Dave Love <fx@gnu.org>
parents:
diff changeset
3 .\" other parms are allowed: see man(7), man(1)
Dave Love <fx@gnu.org>
parents:
diff changeset
4 .SH NAME
Dave Love <fx@gnu.org>
parents:
diff changeset
5 emacsclient \- tells a running Emacs to visit a file
Dave Love <fx@gnu.org>
parents:
diff changeset
6 .SH SYNOPSIS
Dave Love <fx@gnu.org>
parents:
diff changeset
7 .B emacsclient
Dave Love <fx@gnu.org>
parents:
diff changeset
8 .I "[options] files ..."
Dave Love <fx@gnu.org>
parents:
diff changeset
9 .SH "DESCRIPTION"
Dave Love <fx@gnu.org>
parents:
diff changeset
10 This manual page documents briefly the
Dave Love <fx@gnu.org>
parents:
diff changeset
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
Dave Love <fx@gnu.org>
parents:
diff changeset
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
Dave Love <fx@gnu.org>
parents:
diff changeset
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
Dave Love <fx@gnu.org>
parents:
diff changeset
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
Dave Love <fx@gnu.org>
parents:
diff changeset
29
Dave Love <fx@gnu.org>
parents:
diff changeset
30 For
65178
19477c8eacc2 (DESCRIPTION): Reflect inclusion in the Emacs distribution.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 52401
diff changeset
31 .B emacsclient
19477c8eacc2 (DESCRIPTION): Reflect inclusion in the Emacs distribution.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 52401
diff changeset
32 to work, you need an already running Emacs with a server. Within Emacs, call
25853
Dave Love <fx@gnu.org>
parents:
diff changeset
33 the function
Dave Love <fx@gnu.org>
parents:
diff changeset
34 `server-start'. (Your `.emacs' file can do this automatically if you
65178
19477c8eacc2 (DESCRIPTION): Reflect inclusion in the Emacs distribution.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 52401
diff changeset
35 add the expression `(server-start)' to it.)
25853
Dave Love <fx@gnu.org>
parents:
diff changeset
36
Dave Love <fx@gnu.org>
parents:
diff changeset
37 When you've finished editing the buffer, type `C-x #'
Dave Love <fx@gnu.org>
parents:
diff changeset
38 (`server-edit'). This saves the file and sends a message back to the
Dave Love <fx@gnu.org>
parents:
diff changeset
39 `emacsclient' program telling it to exit. The programs that use
Dave Love <fx@gnu.org>
parents:
diff changeset
40 `EDITOR' wait for the "editor" (actually, `emacsclient') to exit. `C-x
Dave Love <fx@gnu.org>
parents:
diff changeset
41 #' also checks for other pending external requests to edit various
Dave Love <fx@gnu.org>
parents:
diff changeset
42 files, and selects the next such file.
Dave Love <fx@gnu.org>
parents:
diff changeset
43
Dave Love <fx@gnu.org>
parents:
diff changeset
44 If you set the variable `server-window' to a window or a frame, `C-x
Dave Love <fx@gnu.org>
parents:
diff changeset
45 #' displays the server buffer in that window or in that frame.
Dave Love <fx@gnu.org>
parents:
diff changeset
46
Dave Love <fx@gnu.org>
parents:
diff changeset
47 .SH OPTIONS
Dave Love <fx@gnu.org>
parents:
diff changeset
48 The programs follow the usual GNU command line syntax, with long
Dave Love <fx@gnu.org>
parents:
diff changeset
49 options starting with two dashes (`-').
Dave Love <fx@gnu.org>
parents:
diff changeset
50 .TP
Dave Love <fx@gnu.org>
parents:
diff changeset
51 .B \-n, \-\-no-wait
Dave Love <fx@gnu.org>
parents:
diff changeset
52 returns
Dave Love <fx@gnu.org>
parents:
diff changeset
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
19477c8eacc2 (DESCRIPTION): Reflect inclusion in the Emacs distribution.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 52401
diff changeset
60 Use socket named FILENAME for communication.
19477c8eacc2 (DESCRIPTION): Reflect inclusion in the Emacs distribution.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 52401
diff changeset
61 .TP
47649
3b27be508d4e Add info about --eval, --display, and --alternate-editor.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 37560
diff changeset
62 .B \-a, \-\-alternate-editor=EDITOR
3b27be508d4e Add info about --eval, --display, and --alternate-editor.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 37560
diff changeset
63 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
64 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
65 .TP
3b27be508d4e Add info about --eval, --display, and --alternate-editor.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 37560
diff changeset
66 .B \-d, \-\-display=DISPLAY
3b27be508d4e Add info about --eval, --display, and --alternate-editor.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 37560
diff changeset
67 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
68 .TP
19477c8eacc2 (DESCRIPTION): Reflect inclusion in the Emacs distribution.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 52401
diff changeset
69 .B \-V, \-\-version
19477c8eacc2 (DESCRIPTION): Reflect inclusion in the Emacs distribution.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 52401
diff changeset
70 print version information and exit
19477c8eacc2 (DESCRIPTION): Reflect inclusion in the Emacs distribution.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 52401
diff changeset
71 .TP
19477c8eacc2 (DESCRIPTION): Reflect inclusion in the Emacs distribution.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 52401
diff changeset
72 .B \-h, \-\-help
19477c8eacc2 (DESCRIPTION): Reflect inclusion in the Emacs distribution.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 52401
diff changeset
73 print this usage information message and exit
25853
Dave Love <fx@gnu.org>
parents:
diff changeset
74 .SH "SEE ALSO"
Dave Love <fx@gnu.org>
parents:
diff changeset
75 The program is documented fully in
Dave Love <fx@gnu.org>
parents:
diff changeset
76 .IR "Using Emacs as a Server"
Dave Love <fx@gnu.org>
parents:
diff changeset
77 available via the Info system.
Dave Love <fx@gnu.org>
parents:
diff changeset
78 .SH AUTHOR
Dave Love <fx@gnu.org>
parents:
diff changeset
79 This manual page was written by Stephane Bortzmeyer <bortzmeyer@debian.org>,
Dave Love <fx@gnu.org>
parents:
diff changeset
80 for the Debian GNU/Linux system (but may be used by others).
37560
1cf7aceaccd0 Place in the public domain.
Eli Zaretskii <eliz@gnu.org>
parents: 25853
diff changeset
81 .SH COPYING
1cf7aceaccd0 Place in the public domain.
Eli Zaretskii <eliz@gnu.org>
parents: 25853
diff changeset
82 This manual page is in the public domain.
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 47649
diff changeset
83
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 47649
diff changeset
84 .\" arch-tag: 2b35e723-b197-4073-8752-231bc8b3d3f3