From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#66598: Missing options from emacsclient man page Date: Sat, 21 Oct 2023 16:31:33 +0300 Message-ID: <83lebwqeyy.fsf@gnu.org> References: <85msy98sni.fsf@elpa.gnu.org> <87r0nidkmt.fsf@bernoul.li> <83bkelc1p1.fsf@gnu.org> <87fs3xwzxm.fsf@bernoul.li> <837cp9bur7.fsf@gnu.org> <87a5u5wskw.fsf@bernoul.li> <87r0ltzgwe.fsf@gmx.de> <1efecd26-43ea-96d3-de27-8b75bd9a3a0f@mavit.org.uk> <87il74tsr8.fsf@gmx.de> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="31026"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 66598@debbugs.gnu.org, michael.albinus@gmx.de To: Peter Oliver Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat Oct 21 15:32:55 2023 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1quC63-0007on-37 for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 21 Oct 2023 15:32:55 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1quC5j-000079-3T; Sat, 21 Oct 2023 09:32:35 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1quC5i-00006c-31 for bug-gnu-emacs@gnu.org; Sat, 21 Oct 2023 09:32:34 -0400 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1quC5h-0003QQ-RD for bug-gnu-emacs@gnu.org; Sat, 21 Oct 2023 09:32:33 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1quC69-0000SQ-KA for bug-gnu-emacs@gnu.org; Sat, 21 Oct 2023 09:33:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 21 Oct 2023 13:33:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 66598 X-GNU-PR-Package: emacs Original-Received: via spool by 66598-submit@debbugs.gnu.org id=B66598.16978951361696 (code B ref 66598); Sat, 21 Oct 2023 13:33:01 +0000 Original-Received: (at 66598) by debbugs.gnu.org; 21 Oct 2023 13:32:16 +0000 Original-Received: from localhost ([127.0.0.1]:42578 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1quC5P-0000RH-Av for submit@debbugs.gnu.org; Sat, 21 Oct 2023 09:32:16 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:49774) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1quC5K-0000R0-J3 for 66598@debbugs.gnu.org; Sat, 21 Oct 2023 09:32:13 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1quC4m-0003Ko-Ta; Sat, 21 Oct 2023 09:31:36 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=4Fl9puMxlePH/lqyIe5Ppfzo9CzzSlzA1DD3/kP+HRs=; b=YaO7FjuUWEvG i0i0yDP30Jc6BO17hGveyldyTvy8jhfcCAgdsG09ndwhps1KqF6kSfbIJjEnBc1g74SDioweKhrXq bJ1Tr5HM8re+31fM4TehQUUQEFIWYM3W2pF113gr3PRt0vaRNV5Zze2zx84ZauZV24JD/PV4uJjjo a2CwutWqjL6e+/ZJ39Qqz5hzMXn+RN4klRo/EhL01BQrAfahyaPUxWTrqJGCmMkqnQy7Y9FXtiLmH 7N9QO9sOe/fpyo3cutW2k+buDpoKhXAVHNn9HG9+47GwSLxeT/AJ73TIZ1WE8NN3ovmUYScgJZINl dcbltUj4NcLaUu15f2kyAw==; In-Reply-To: (message from Peter Oliver on Sat, 21 Oct 2023 14:05:40 +0100 (BST)) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:272899 Archived-At: > Cc: 66598@debbugs.gnu.org > Date: Sat, 21 Oct 2023 14:05:40 +0100 (BST) > From: Peter Oliver > > On Wed, 18 Oct 2023, Michael Albinus wrote: > > > Since I'm not that fluent with the nroff format, you might cross-check > > whether everything is right. > > Looks good to me. > > > And perhaps we could also add an ENVIRONMENT section. > > Attached is a patch to do that. Thanks, a couple of comments below. > @@ -62,8 +62,8 @@ This option applies only to the next file specified. > .TP > .B \-a, \-\-alternate-editor=COMMAND > If the Emacs server is not running, run the specified shell command instead. > -This can also be specified via the ALTERNATE_EDITOR environment variable. > -If the value of ALTERNATE_EDITOR is the empty string, run "emacs \-\-daemon" to > +This takes precedence over the ALTERNATE_EDITOR environment variable. > +If the empty string is specified, run "emacs \-\-daemon" to > start Emacs in daemon mode, and try to connect to it. This talks about precedence between the variable and the command-line option without first introducing the environment variable. The precedence part should be not _instead_ of the description of the variable, but _in_addition_ to it. It's okay that there's now the ENVIRONMENT section, but it's too far away, so at least something like "see ENVIRONMENT below" should be here. > @@ -84,7 +84,9 @@ Lisp expressions. > .TP > .B \-f, \-\-server-file=FILENAME > Use TCP configuration file FILENAME for communication. > -This can also be specified via the EMACS_SERVER_FILE environment variable. > +This takes precedence over the EMACS_SERVER_FILE environment variable. > +Relative filenames are relative to "~/.emacs.d/server/", and the > +default is "server". Same here. > @@ -114,7 +116,7 @@ side-effect rather than result. > .TP > .B \-s, \-\-socket-name=FILENAME > Use socket named FILENAME for communication. > -This can also be specified via the EMACS_SOCKET_NAME environment variable. > +This takes precedence over the EMACS_SOCKET_NAME environment variable. And here. > @@ -122,8 +124,9 @@ Open a new Emacs frame on the current terminal. > .B \-T, \-\-tramp-prefix=PREFIX > Set 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 TCP with --server-file. This can also be > -specified via the EMACSCLIENT_TRAMP environment variable. > +the Emacs server on a remote host (either using TCP with > +--server-file, or a socket forwarded over SSH). This takes precedence > +over the EMACSCLIENT_TRAMP environment variable. And here. > @@ -133,6 +136,25 @@ Print this usage information message and exit. > .SH "EXIT STATUS" > Normally, the exit status is 0. If emacsclient shuts down due to > Emacs signaling an error, the exit status is 1. > +.SH ENVIRONMENT > +.TP > +.B ALTERNATE_EDITOR > +If the Emacs server is not running, run the shell command in this > +environment variable instead. If set to the empty string, run > +"emacs \-\-daemon" to start Emacs in daemon mode, and try to connect > +to it. > +.TP > +.B EMACSCLIENT_TRAMP > +A prefix to add to filenames, intended to allow Emacs to locate files > +on remote machines using TRAMP. > +.TP > +.B EMACS_SERVER_FILE > +Look in this file to discover where to find a TCP Emacs server. > +Relative filenames are relative to "~/.emacs.d/server/", and the > +default is "server". > +.TP > +.B EMACS_SOCKET_NAME > +The filename of the socket to use for communication with the Emacs server. And this section should say that the corresponding command-line arguments override the environment variables.