From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Damien Cassou Newsgroups: gmane.emacs.bugs Subject: bug#55569: Improve documentation of mail-user-agent Date: Sun, 22 May 2022 09:18:58 +0200 Message-ID: <87czg62fx9.fsf@cassou.me> References: <871qwmks7a.fsf@cassou.me> <83v8ty6q1o.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="6529"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 55569@debbugs.gnu.org To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun May 22 09:20:39 2022 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 1nsftG-0001Zc-Gp for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 22 May 2022 09:20:38 +0200 Original-Received: from localhost ([::1]:38866 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nsft5-0007J8-Hn for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 22 May 2022 03:20:35 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:54538) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nsfsh-0007J0-3j for bug-gnu-emacs@gnu.org; Sun, 22 May 2022 03:20:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:49688) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nsfsg-0001Fy-Pw for bug-gnu-emacs@gnu.org; Sun, 22 May 2022 03:20:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1nsfsg-0000l4-J2 for bug-gnu-emacs@gnu.org; Sun, 22 May 2022 03:20:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Damien Cassou Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 22 May 2022 07:20:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 55569 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 55569-submit@debbugs.gnu.org id=B55569.16532039432794 (code B ref 55569); Sun, 22 May 2022 07:20:02 +0000 Original-Received: (at 55569) by debbugs.gnu.org; 22 May 2022 07:19:03 +0000 Original-Received: from localhost ([127.0.0.1]:43585 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nsfrj-0000j0-I9 for submit@debbugs.gnu.org; Sun, 22 May 2022 03:19:03 -0400 Original-Received: from mail.choca.pics ([80.67.172.235]:35206) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nsfri-0000iW-03 for 55569@debbugs.gnu.org; Sun, 22 May 2022 03:19:02 -0400 Original-Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id 2271B18197CC7; Sun, 22 May 2022 09:19:00 +0200 (CEST) Original-Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavisd-new, port 10032) with ESMTP id jR_ea25LQCl1; Sun, 22 May 2022 09:18:59 +0200 (CEST) Original-Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id 584A31817C2C5; Sun, 22 May 2022 09:18:59 +0200 (CEST) X-Virus-Scanned: amavisd-new at choca.pics Original-Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavisd-new, port 10026) with ESMTP id zYANFSfsXoa5; Sun, 22 May 2022 09:18:59 +0200 (CEST) Original-Received: from localhost (153.226.95.79.rev.sfr.net [79.95.226.153]) by mail.choca.pics (Postfix) with ESMTPSA id 1426518193F60; Sun, 22 May 2022 09:18:59 +0200 (CEST) In-Reply-To: <83v8ty6q1o.fsf@gnu.org> 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" Xref: news.gmane.io gmane.emacs.bugs:232873 Archived-At: Hi Eli, Eli Zaretskii writes: >> +@code{mh-e-user-agent}. Additional options may be available; check >> +with the author of your mail user agent package for details. You may >> +also define another mail user agent using `define-mail-user-agent'. > > Thanks, but what do you mean by "the author of your mail user agent > package"? I mean that the authors of notmuch and mu4e both define a symbol to be used as value for the `mail-user-agent` variable: `mu4e-user-agent` and `notmuch-user-agent`. These symbols should be documented somewhere in notmuch and mu4e manuals so their users know they should pass them to `mail-user-agent`. There might be other mail user agent packages out there that I don't know about. > This is an Emacs user manual, and I very much doubt that > Emacs users could figure out where and how to check that. > > Can we provide more practical advice here how to check for those > additional options? I could certainly mention the symbols for notmuch and mu4e if you think that is ok to mention external packages inside the Emacs manual but I'm not sure what else I could do. -- Damien Cassou "Success is the ability to go from one failure to another without losing enthusiasm." --Winston Churchill