unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Peter Oliver <p.d.oliver@mavit.org.uk>
To: 66598@debbugs.gnu.org
Subject: bug#66598: Missing options from emacsclient man page
Date: Tue, 17 Oct 2023 19:24:33 +0100 (BST)	[thread overview]
Message-ID: <1efecd26-43ea-96d3-de27-8b75bd9a3a0f@mavit.org.uk> (raw)
In-Reply-To: <87r0ltzgwe.fsf@gmx.de>

[-- Attachment #1: Type: text/plain, Size: 350 bytes --]

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

[-- Attachment #2: Type: text/plain, Size: 1915 bytes --]

From c96e974073556d24da93332b4edb30da88a3ea8a Mon Sep 17 00:00:00 2001
From: Peter Oliver <git@mavit.org.uk>
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


       reply	other threads:[~2023-10-17 18:24 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <85msy98sni.fsf@elpa.gnu.org>
     [not found] ` <E1qbslO-0006oK-RA@fencepost.gnu.org>
     [not found]   ` <87r0nidkmt.fsf@bernoul.li>
     [not found]     ` <83bkelc1p1.fsf@gnu.org>
     [not found]       ` <87fs3xwzxm.fsf@bernoul.li>
     [not found]         ` <837cp9bur7.fsf@gnu.org>
     [not found]           ` <87a5u5wskw.fsf@bernoul.li>
     [not found]             ` <87r0ltzgwe.fsf@gmx.de>
2023-10-17 18:24               ` Peter Oliver [this message]
2023-10-18  5:16                 ` bug#66598: Missing options from emacsclient man page Michael Albinus
2023-10-21 13:05                   ` Peter Oliver
2023-10-21 13:31                     ` Eli Zaretskii
2023-10-21 14:35                     ` Michael Albinus
2023-10-29 11:27                       ` Eli Zaretskii
2023-12-17 12:58                         ` Peter Oliver
2023-12-23  9:51                           ` Eli Zaretskii

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=1efecd26-43ea-96d3-de27-8b75bd9a3a0f@mavit.org.uk \
    --to=p.d.oliver@mavit.org.uk \
    --cc=66598@debbugs.gnu.org \
    /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).