view etc/emacsclient.1 @ 54754:fe0b01c2265f

(Info-history): Doc fix. (Info-history-list): New var. (info-xref): Change magenta4 to blue, remove bold for dark and light backgrounds, change bold to underline for non-color classes. (info-xref-visited): New face. (Info-fontify-visited-nodes): New custom. (Info-hide-note-references): Add new value `hide'. Doc fix. (Info-reference-name): New var. (Info-selection-hook): New custom. (Info-edit-mode-hook): New var. (Info-find-file): New fun. (Info-find-node): Move part of code to Info-find-file. (Info-find-node-2): Add anchors to Info-history-list. Move point to the place with the reference name if name is defined. (Info-select-node): Add current node to Info-history-list. (Info-goto-node): Switch to *info* from *info-history* *info-toc*. (Info-search-whitespace-regexp): New custom. (Info-search-case-fold): New var. (Info-search): Add "case-sensitively" to the prompt. Use Info-search-whitespace-regexp. Set Info-search-case-fold. (Info-search-case-sensitively, Info-search-next): New fun. (Info-up): Move point to the menu item of the current node. (Info-history): New fun. Add *info-history* to same-window-buffer-names. (Info-toc): New fun. Add *info-toc* to same-window-buffer-names. (Info-insert-toc): New fun. (Info-build-toc): New fun. (Info-follow-reference): Add new arg `fork'. Doc fix. Replace [ \n\t]* by [ \n\t]+ in the *Note regexp. For references with the same name prefer the reference closest to point. (Info-next-reference): Replace * by + in the *Note regexp. Add regexp for http:// and ftp://. Skip the *Note prefix. (Info-prev-reference): Replace * by + in the *Note regexp. Add regexp for http:// and ftp://. Skip the *Note prefix. (Info-follow-nearest-node): Add new arg `fork'. (Info-try-follow-nearest-node): Add new arg `fork'. Call browse-url for http:// and ftp:// references. Set Info-reference-name for index entries. (Info-mode-menu): Add menu items for Info-search-case-sensitively, Info-search-next, Info-history, Info-toc, clone-buffer. (Info-menu-update): Replace * by + in the *Note regexp. (Info-mode): Add documentation for Info-history, Info-toc, Info-search-case-sensitively, Info-search-next, clone-buffer. (Info-fontify-menu-headers): Remove fun. Move code to Info-fontify-node. (Info-fontify-node): Add docstring. Add local vars fontify-visited-p and not-fontified-p. If not-fontified-p is t then fontify header line, titles, menu headers, http and ftp references, refill paragraphs. If not-fontified-p is t or fontify-visited-p is t then fontify cross references, menu items. Fontify menu headers. Fontify http and ftp references. Change regexp for cross references to require whitespace after *Note, add matching groups for file and node names. Remove hack for quote. Use display property for Info-hide-note-references=t. Use fifth or fourth match for help-echo. Display visited nodes in a different face. Unhide file names of external references. Unhide newlines. Display visited menu items in a different face.

.TH EMACSCLIENT 1
.\" NAME should be all caps, SECTION should be 1-8, maybe w/ subsection
.\" other parms are allowed: see man(7), man(1)
.SH NAME
emacsclient \- tells a running Emacs to visit a file
.SH SYNOPSIS
.B emacsclient
.I "[options] files ..."
.SH "DESCRIPTION"
This manual page documents briefly the
.BR emacsclient
command.
This manual page was written for the Debian GNU/Linux distribution
because the original program does not have a manual page.
Instead, it has documentation in the GNU Info format; see below.
.PP
.B emacsclient 
works in conjunction with the built-in server of Emacs.
.PP
You typically do not call 
.B emacsclient
directly.  Instead, you set the environment variable EDITOR
to 
.B emacsclient
and let programs like 'vipw' or 'bug' or anything run
it for you, which will use an existing Emacs to visit the file.

For
.B emacsclient 
to work, you need an already running Emacs with a server.  Within Emacs, call 
the function
`server-start'.  (Your `.emacs' file can do this automatically if you
add the expression `(server-start)' to it.)  

When you've finished editing the buffer, type `C-x #'
(`server-edit').  This saves the file and sends a message back to the
`emacsclient' program telling it to exit.  The programs that use
`EDITOR' wait for the "editor" (actually, `emacsclient') to exit.  `C-x
#' also checks for other pending external requests to edit various
files, and selects the next such file.

If you set the variable `server-window' to a window or a frame, `C-x
#' displays the server buffer in that window or in that frame.

.SH OPTIONS
The programs follow the usual GNU command line syntax, with long
options starting with two dashes (`-').
.TP
.B \-n, \-\-no-wait
returns
immediately without waiting for you to "finish" the buffer in Emacs.
.TP
.B \-e, \-\-eval
do not visit files but instead evaluate the arguments as Emacs
Lisp expressions.
.TP
.B \-a, \-\-alternate-editor=EDITOR
if the Emacs server is not running, run the specified editor instead.
This can also be specified via the `ALTERNATE_EDITOR' environment variable.
.TP
.B \-d, \-\-display=DISPLAY
tell the server to display the files on the given display.
.SH "SEE ALSO"
The program is documented fully in
.IR "Using Emacs as a Server"
available via the Info system.
.SH BUGS
If there is no running Emacs server, 
.B emacsclient 
cannot launch one. I use a small Perl script instead of raw 
.B emacsclient
to do it (it works only with systems which have BSD sockets, which is fine
for Debian GNU/Linux).
.SH AUTHOR
This manual page was written by Stephane Bortzmeyer <[e-mail]>,
for the Debian GNU/Linux system (but may be used by others).
.SH COPYING
This manual page is in the public domain.

.\" arch-tag: 2b35e723-b197-4073-8752-231bc8b3d3f3