Subject: bug#66598: closed (Re: bug#66598: Missing options from emacsclient man page)

From: [email-masked] (GNU bug Tracking System)
Date: Sat, 23 Dec 2023 09:52:01 +0000

Your bug report

#66598: Missing options from emacsclient man page

which was filed against the emacs package, has been closed.

The explanation is attached below, along with your original report.
If you require more details, please reply to [email-masked].

-- 
66598: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=66598
GNU Bug Tracking System
Contact [email-masked] with problems

Subject: Re: bug#66598: Missing options from emacsclient man page
From: Eli Zaretskii <[email-masked]>
To: Peter Oliver <[email-masked]>
Cc: [email-masked], [email-masked]
Date: Sat, 23 Dec 2023 11:51:03 +0200
List-Id: <debbugs-submit.debbugs.gnu.org>

> Date: Sun, 17 Dec 2023 12:58:47 +0000 (GMT)
> From: Peter Oliver <[email-masked]>
> cc: Michael Albinus <[email-masked]>, [email-masked]
> 
> On Sun, 29 Oct 2023, Eli Zaretskii wrote:
> 
> >> Reading emacsclient.c, there are also further environment variables:
> >>
> >> XDG_CONFIG_HOME
> >> XDG_RUNTIME_DIR
> >>
> >> I'm undecided whether we shall mention them. Eli?
> >
> > I don't see how it could cause any harm to mention them as well.
> 
> Here is an updated patch that does that.

Thanks, installed on the emacs-29 branch, and closing the bug.

Btw, I don't see your copyright assignment on file; did you sign one?
If not, would you like to start your legal paperwork at this time, so
that we could accept your contributions in the future without
limitations?

Subject: Missing options from emacsclient man page
From: Peter Oliver <[email-masked]>
To: [email-masked]
Date: Tue, 17 Oct 2023 19:24:33 +0100 (BST)
List-Id: <debbugs-submit.debbugs.gnu.org>

On Tue, 17 Oct 2023, Michael Albinus wrote:

> Since Emacs 26, emacsclient is prepared for this. If you call
> "emacsclient --tramp=<PREFIX>", all file names on the server side,
> emacsclient sends as "/path/to/file", are "<PREFIX>/path/to/file".

Attached is a patch to mention this (and other) options in the emacsclient man page.

-- 
Peter Oliver

From c96e974073556d24da93332b4edb30da88a3ea8a Mon Sep 17 00:00:00 2001
From: Peter Oliver <[email-masked]>
Date: Tue, 17 Oct 2023 19:11:33 +0100
Subject: [PATCH] Document all emacsclient options in its man page

* doc/man/emacsclient.1: Document omitted options.
---
 doc/man/emacsclient.1 | 27 +++++++++++++++++++++++++--
 1 file changed, 25 insertions(+), 2 deletions(-)

diff --git a/doc/man/emacsclient.1 b/doc/man/emacsclient.1
index 83c8a366f8b..a72e75129f9 100644
--- a/doc/man/emacsclient.1
+++ b/doc/man/emacsclient.1
@@ -94,13 +94,36 @@ Emacs.  If combined with --eval, this option is ignored.
 How long to wait, in seconds, for Emacs to respond before giving up.
 The default is 0, which means to wait forever.
 .TP
-.B \-nw, \-t, \-\-tty
-Open a new Emacs frame on the current terminal.
+.B \-\-parent-id=ID
+Open an
+.B emacsclient
+frame as a client frame in the parent X window with id ID, via the
+XEmbed protocol.
+.TP
+.B \-q, \-\-quiet
+Do not display messages about waiting for Emacs or connecting to
+remote server sockets.
+.TP
+.B \-u, \-\-suppress-output
+Do not display results returned from the server.
 .TP
 .B \-s, \-\-socket-name=FILENAME
 Use socket named FILENAME for communication.
 This can also be specified via the EMACS_SOCKET_NAME environment variable.
 .TP
+.B \-t, \-\-tty, \-nw
+Open a new Emacs frame on the current terminal.
+.TP
+.B \-T, \-\-tramp-prefix=TRAMP-PREFIX’
+Set the prefix to add to filenames for Emacs to locate files on
+remote machines using TRAMP.  This is mostly useful in combination with
+using the Emacs server over a forwarded port or socket.
+
+Setting the environment variable
+.B EMACSCLIENT_TRAMP
+has the same effect as using this option.  If both are specified, the
+command-line option takes precedence.
+.TP
 .B \-V, \-\-version
 Print version information and exit.
 .TP
-- 
2.41.0