GNU bug report logs - #17310
24.3; clarify emacsclient(1) manpage link to "(emacs)Emacs Server"

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 17310 in the body.
You can then email your comments to 17310 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Samuel Bronson <naesten <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 24.3; clarify emacsclient(1) manpage link to "(emacs)Emacs Server"
Date: Mon, 21 Apr 2014 14:01:27 -0400

[Message part 1 (text/plain, inline)]

Tags: patch

It would be helpful if the manpage for emacsclient had a more prominent
(i.e. bold) and more explicit link to (info "(emacs)Emacs Server"),
perhaps using something like the included patch.

In GNU Emacs 24.3.1 (i486-pc-linux-gnu, X toolkit, Xaw3d scroll bars)
 of 2013-12-22 on binet, modified by Debian
Windowing system distributor `Colin Harrison', version 11.0.60900031
System Description:	Debian GNU/Linux testing (jessie)

Important settings:
  value of $LC_COLLATE: C
  value of $LANG: en_US.UTF-8
  locale-coding-system: utf-8-unix

[emacsclient.1.patch (text/x-patch, inline)]

diff -u /home/naesten/hacking/emacsclient.orig.1 /home/naesten/hacking/emacsclient.1
*** /home/naesten/hacking/emacsclient.orig.1	2014-04-21 13:04:31.000000000 -0400
--- /home/naesten/hacking/emacsclient.1	2014-04-21 13:37:07.000000000 -0400
***************
*** 93,99 ****
  .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 <at> debian.org>,
  for the Debian GNU/Linux system (but may be used by others).
--- 93,108 ----
  .SH "SEE ALSO"
  The program is documented fully in
  .IR "Using Emacs as a Server"
! available via the Info system.  You should be able to reach it using the
! shell command
! .IP
! .B info emacs \(aqEmacs Server\(aq
! .PP
! or by evaluating
! .IP
! .B (info \(dq(emacs)Emacs Server\(dq)
! .PP
! in Emacs.
  .SH AUTHOR
  This manual page was written by Stephane Bortzmeyer <bortzmeyer <at> debian.org>,
  for the Debian GNU/Linux system (but may be used by others).

Diff finished.  Mon Apr 21 13:37:21 2014

Message #8 received at 17310 <at> debbugs.gnu.org (full text, mbox):

From: Glenn Morris <rgm <at> gnu.org>
To: Samuel Bronson <naesten <at> gmail.com>
Cc: 17310 <at> debbugs.gnu.org
Subject: Re: bug#17310: 24.3;
 clarify emacsclient(1) manpage link to "(emacs)Emacs Server"
Date: Tue, 29 Apr 2014 10:15:53 -0400

Samuel Bronson wrote:

> It would be helpful if the manpage for emacsclient had a more prominent
> (i.e. bold) and more explicit link to (info "(emacs)Emacs Server"),
> perhaps using something like the included patch.

Thanks for the patch, but IMO it's not worth applying.
It's not the job of every man page to explain how to use info.

> *** /home/naesten/hacking/emacsclient.orig.1	2014-04-21 13:04:31.000000000 -0400
> --- /home/naesten/hacking/emacsclient.1	2014-04-21 13:37:07.000000000 -0400
> ***************
> *** 93,99 ****
>   .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 <at> debian.org>,
>   for the Debian GNU/Linux system (but may be used by others).
> --- 93,108 ----
>   .SH "SEE ALSO"
>   The program is documented fully in
>   .IR "Using Emacs as a Server"
> ! available via the Info system.  You should be able to reach it using the
> ! shell command
> ! .IP
> ! .B info emacs \(aqEmacs Server\(aq
> ! .PP
> ! or by evaluating
> ! .IP
> ! .B (info \(dq(emacs)Emacs Server\(dq)
> ! .PP
> ! in Emacs.
>   .SH AUTHOR

Message #11 received at 17310 <at> debbugs.gnu.org (full text, mbox):

From: Josh <josh <at> foxtail.org>
To: Glenn Morris <rgm <at> gnu.org>
Cc: Samuel Bronson <naesten <at> gmail.com>, 17310 <at> debbugs.gnu.org
Subject: Re: bug#17310: 24.3; clarify emacsclient(1) manpage link to
 "(emacs)Emacs Server"
Date: Tue, 29 Apr 2014 08:29:25 -0700

[Message part 1 (text/plain, inline)]

On Tue, Apr 29, 2014 at 7:15 AM, Glenn Morris <rgm <at> gnu.org> wrote:

> Samuel Bronson wrote:
>
> > It would be helpful if the manpage for emacsclient had a more prominent
> > (i.e. bold) and more explicit link to (info "(emacs)Emacs Server"),
> > perhaps using something like the included patch.
>
> Thanks for the patch, but IMO it's not worth applying.
> It's not the job of every man page to explain how to use info.
>

Agreed, but the current text ("The program is documented fully in
Using Emacs as a Server available via the Info system.") isn't very
helpful to users who are unfamiliar with GNU Info.  Such users would
be more likely to find their way to the complete documentation if we
appended something like ", which can be invoked on most systems
by issuing the `info' shell command." to the language above.

[Message part 2 (text/html, inline)]

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.