doc/man/emacsclient.1

   1 .\" See section COPYING for conditions for redistribution.
   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 .B emacsclient
  41 program telling it to exit.  The programs that use
  42 EDITOR wait for the "editor" (actually,
  43 .BR emacsclient )
  44 to exit.  "C-x #" also checks for other pending external requests to
  45 edit various
  46 files, and selects the next such file.
  47
  48 If you set the variable "server-window" to a window or a frame, "C-x
  49 #" displays the server buffer in that window or in that frame.
  50
  51 .SH OPTIONS
  52 The programs follow the usual GNU command line syntax, with long
  53 options starting with two dashes ("\-").
  54 .TP
  55 .B \-a, \-\-alternate-editor=EDITOR
  56 if the Emacs server is not running, run the specified editor instead.
  57 This can also be specified via the ALTERNATE_EDITOR environment variable.
  58 If the value of EDITOR is the empty string, run "emacs \-\-daemon" to
  59 start Emacs in daemon mode, and try to connect to it.
  60 .TP
  61 .B -c, \-\-create-frame
  62 create a new frame instead of trying to use the current Emacs frame
  63 .TP
  64 .B \-F, \-\-frame-parameters=ALIST
  65 set the parameters of a newly-created frame.
  66 .TP
  67 .B \-d, \-\-display=DISPLAY
  68 tell the server to display the files on the given display.
  69 .TP
  70 .B \-e, \-\-eval
  71 do not visit files but instead evaluate the arguments as Emacs
  72 Lisp expressions.
  73 .TP
  74 .B \-f, \-\-server-file=FILENAME
  75 use TCP configuration file FILENAME for communication.
  76 This can also be specified via the EMACS_SERVER_FILE environment variable.
  77 .TP
  78 .B \-n, \-\-no-wait
  79 returns
  80 immediately without waiting for you to "finish" the buffer in Emacs.
  81 .TP
  82 .B \-nw, \-t, \-\-tty
  83 open a new Emacs frame on the current terminal
  84 .TP
  85 .B \-s, \-\-socket-name=FILENAME
  86 use socket named FILENAME for communication.
  87 .TP
  88 .B \-V, \-\-version
  89 print version information and exit
  90 .TP
  91 .B \-H, \-\-help
  92 print this usage information message and exit
  93 .SH "EXIT STATUS"
  94 Normally, the exit status is 0.  If emacsclient shuts down due to
  95 Emacs signaling an error, the exit status is 1.
  96 .SH "SEE ALSO"
  97 The program is documented fully in
  98 .IR "Using Emacs as a Server"
  99 available via the Info system.
 100 .SH AUTHOR
 101 This manual page was written by Stephane Bortzmeyer <bortzmeyer@debian.org>,
 102 for the Debian GNU/Linux system (but may be used by others).
 103 .SH COPYING
 104 This manual page is in the public domain.