emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

update of emacsclient.1


From: Emilio Lopes
Subject: update of emacsclient.1
Date: Wed, 17 Aug 2005 12:32:03 +0200
User-agent: Emacs Gnus

enclosed is a patch updating the man page of Emacsclient.  I hope the
changes are appropriate.

I have one question though.  Under "DESCRIPTION" it says:

   You  typically  do not call emacsclient directly.  Instead, you set the
   environment variable EDITOR to emacsclient and let programs like 'vipw'
   or  'bug'  or anything run it for you, which will use an existing Emacs
   to visit the file.

I myself call `emacsclient' often from the shell.  And should these
`vipw' and `bug' programs be really mentioned?  I use Debian GNU/Linux,
the system for which the man page was originally written, but I don't
have this `bug' program.

What people think of changing the above paragraph to

   You can either call emacsclient directly or set the environment
   variable EDITOR to 'emacsclient' and let other programs run it for
   you, thus using an existing Emacs to edit the file.

?

Here is the patch:

2005-08-17  Emilio C. Lopes  <address@hidden>

        * emacsclient.1 (DESCRIPTION): reflect inclusion in the Emacs
        distribution.
        (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 12:27:14 2005
--- new-emacs-darcs.eclig/etc/emacsclient.1     Wed Aug 17 12:18:48 2005
***************
*** 9,21 ****
  .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
--- 9,21 ----
  .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 typically do not call 
  .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 <address@hidden>,
! for the Debian GNU/Linux system (but may be used by others).
  .SH COPYING
  This manual page is in the public domain.
  
--- 54,81 ----
  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 <address@hidden>,
! for the Debian GNU/Linux system.
  .SH COPYING
  This manual page is in the public domain.
  






reply via email to

[Prev in Thread] Current Thread [Next in Thread]