From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Emilio Lopes Newsgroups: gmane.emacs.devel Subject: Re: update of emacsclient.1 Date: Wed, 17 Aug 2005 18:58:47 +0200 Organization: private Message-ID: References: <8t64u4vopo.fsf@tiscali.de> NNTP-Posting-Host: main.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: sea.gmane.org 1124298586 31906 80.91.229.2 (17 Aug 2005 17:09:46 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Wed, 17 Aug 2005 17:09:46 +0000 (UTC) Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Wed Aug 17 19:09:38 2005 Return-path: Original-Received: from lists.gnu.org ([199.232.76.165]) by ciao.gmane.org with esmtp (Exim 4.43) id 1E5RPd-0005o8-An for ged-emacs-devel@m.gmane.org; Wed, 17 Aug 2005 19:09:13 +0200 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1E5RT6-0004R8-KY for ged-emacs-devel@m.gmane.org; Wed, 17 Aug 2005 13:12:48 -0400 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1E5RSb-0004Q2-Cv for emacs-devel@gnu.org; Wed, 17 Aug 2005 13:12:17 -0400 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1E5RSZ-0004PE-NM for emacs-devel@gnu.org; Wed, 17 Aug 2005 13:12:16 -0400 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1E5RSZ-0004P4-KU for emacs-devel@gnu.org; Wed, 17 Aug 2005 13:12:15 -0400 Original-Received: from [80.91.229.2] (helo=ciao.gmane.org) by monty-python.gnu.org with esmtp (TLS-1.0:RSA_AES_128_CBC_SHA:16) (Exim 4.34) id 1E5ReY-0003Y4-Qe for emacs-devel@gnu.org; Wed, 17 Aug 2005 13:24:39 -0400 Original-Received: from list by ciao.gmane.org with local (Exim 4.43) id 1E5RML-0004tM-NV for emacs-devel@gnu.org; Wed, 17 Aug 2005 19:05:49 +0200 Original-Received: from p62.246.13.241.tisdip.tiscali.de ([62.246.13.241]) by main.gmane.org with esmtp (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Wed, 17 Aug 2005 19:05:49 +0200 Original-Received: from eclig by p62.246.13.241.tisdip.tiscali.de with local (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Wed, 17 Aug 2005 19:05:49 +0200 X-Injected-Via-Gmane: http://gmane.org/ Original-To: emacs-devel@gnu.org Original-Lines: 123 Original-X-Complaints-To: usenet@sea.gmane.org X-Gmane-NNTP-Posting-Host: p62.246.13.241.tisdip.tiscali.de User-Agent: Emacs Gnus Cancel-Lock: sha1:SGBLGViJULaVLvTEsAzQet2IMh0= X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:42192 X-Report-Spam: http://spam.gmane.org/gmane.emacs.devel:42192 I wrote: > enclosed is a patch updating the man page of Emacsclient. I hope > the changes are appropriate. [...] After collecting suggestions from others, I came up with the following changes. They already include the patch I sent before. 2005-08-17 Emilio C. Lopes * emacsclient.1 (DESCRIPTION): reflect inclusion in the Emacs distribution. Made the role of EDITOR clearer. (OPTIONS): documented `-s', `-V' and `-h' as well as their long name counterparts. (BUGS): removed since its contents doesn't apply anymore. diff -rN -c old-emacs-darcs.eclig/etc/emacsclient.1 new-emacs-darcs.eclig/etc/emacsclient.1 *** old-emacs-darcs.eclig/etc/emacsclient.1 Wed Aug 17 18:54:07 2005 --- new-emacs-darcs.eclig/etc/emacsclient.1 Wed Aug 17 18:51:17 2005 *************** *** 9,29 **** .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 --- 9,31 ---- .SH "DESCRIPTION" This manual page documents briefly the .BR emacsclient ! command. Full documentation is available in the GNU Info format; see ! below. ! This manual page was originally written for the Debian GNU/Linux ! distribution, but is not specific to that system. .PP .B emacsclient ! works in conjunction with the built-in Emacs server. .PP ! You can either call .B emacsclient ! directly or let other programs run it for you when necessary. On ! GNU/Linux and Unix systems many programs consult the environment ! variable EDITOR (sometimes also VISUAL) to obtain the command used for ! editing. Thus, setting this environment variable to 'emacsclient' ! will allow these programs to use an already running Emacs for editing. ! Other operating systems might have their own methods for defining the ! default editor. For .B emacsclient *************** *** 54,79 **** 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 , ! for the Debian GNU/Linux system (but may be used by others). .SH COPYING This manual page is in the public domain. --- 56,83 ---- do not visit files but instead evaluate the arguments as Emacs Lisp expressions. .TP + .B \-s, \-\-socket-name=FILENAME + Use socket named FILENAME for communication. + .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. + .TP + .B \-V, \-\-version + print version information and exit + .TP + .B \-h, \-\-help + print this usage information message and exit .SH "SEE ALSO" The program is documented fully in .IR "Using Emacs as a Server" available via the Info system. .SH AUTHOR ! This manual page was written by Stephane Bortzmeyer ! for the Debian GNU/Linux system. .SH COPYING This manual page is in the public domain.