unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Emilio Lopes <eclig@gmx.net>
Subject: update of emacsclient.1
Date: Wed, 17 Aug 2005 12:32:03 +0200	[thread overview]
Message-ID: <8t64u4vopo.fsf@tiscali.de> (raw)

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  <eclig@gmx.net>

	* 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 <bortzmeyer@debian.org>,
! 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 <bortzmeyer@debian.org>,
! for the Debian GNU/Linux system.
  .SH COPYING
  This manual page is in the public domain.

             reply	other threads:[~2005-08-17 10:32 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2005-08-17 10:32 Emilio Lopes [this message]
2005-08-17 11:10 ` update of emacsclient.1 Lennart Borgman
2005-08-17 13:30 ` Drew Adams
2005-08-17 16:58 ` Emilio Lopes
2005-08-17 17:35   ` Lennart Borgman
2005-08-19 16:15   ` Richard M. Stallman
2005-08-19 16:33     ` Emilio Lopes
2005-08-20 17:22       ` Richard M. Stallman
2005-08-27 18:21         ` Emilio Lopes
2005-08-27 22:02           ` Thien-Thi Nguyen
2005-08-19 16:42     ` Jose E. Marchesi
2005-08-19 18:45       ` Ken Raeburn
2005-08-18 14:47 ` Richard M. Stallman
2005-08-18 15:24   ` Lennart Borgman

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=8t64u4vopo.fsf@tiscali.de \
    --to=eclig@gmx.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).