From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: "Basil L. Contovounesios" Newsgroups: gmane.emacs.bugs Subject: bug#44016: 28.0.50; Add new "gnus-search" search interface to Gnus Date: Sun, 01 Nov 2020 18:10:39 +0000 Message-ID: <87v9ep9cdc.fsf@tcd.ie> References: <877drrigg6.fsf@ericabrahamsen.net> <87k0vqsqol.fsf@gnus.org> <87tuuu5fyf.fsf@ericabrahamsen.net> <874km9d4mc.fsf@ericabrahamsen.net> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="39931"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) Cc: Lars Ingebrigtsen , 44016@debbugs.gnu.org To: Eric Abrahamsen Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun Nov 01 19:11:14 2020 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 1kZHov-000AH3-TQ for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 01 Nov 2020 19:11:14 +0100 Original-Received: from localhost ([::1]:43606 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kZHou-00016P-HD for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 01 Nov 2020 13:11:12 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:57560) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kZHok-00016C-JT for bug-gnu-emacs@gnu.org; Sun, 01 Nov 2020 13:11:02 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:55115) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1kZHok-0000rp-7x for bug-gnu-emacs@gnu.org; Sun, 01 Nov 2020 13:11:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1kZHok-0005vn-2G for bug-gnu-emacs@gnu.org; Sun, 01 Nov 2020 13:11:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: "Basil L. Contovounesios" Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 01 Nov 2020 18:11:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 44016 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 44016-submit@debbugs.gnu.org id=B44016.160425424922778 (code B ref 44016); Sun, 01 Nov 2020 18:11:02 +0000 Original-Received: (at 44016) by debbugs.gnu.org; 1 Nov 2020 18:10:49 +0000 Original-Received: from localhost ([127.0.0.1]:38428 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kZHoW-0005vJ-OL for submit@debbugs.gnu.org; Sun, 01 Nov 2020 13:10:49 -0500 Original-Received: from mail-wr1-f53.google.com ([209.85.221.53]:45853) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kZHoV-0005v5-5C for 44016@debbugs.gnu.org; Sun, 01 Nov 2020 13:10:47 -0500 Original-Received: by mail-wr1-f53.google.com with SMTP id a9so11972051wrg.12 for <44016@debbugs.gnu.org>; Sun, 01 Nov 2020 10:10:47 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=tcd-ie.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:references:date:in-reply-to:message-id :user-agent:mime-version; bh=MEtPQCVSFFA7LSVTKB2jnJza/zF7CC9qqYV/ewCYKEE=; b=IFL9jbVHUsKSfIUy4MQz2PklOX9SLQYbHVFpvW6V7WzAtQRDXvtf64X6++lUqqpEnC 5nv1DLAKuiqR1EItI4woK+/LPxKCBNBzANHdXibSSlq5eLd8uS4nheX4hniDlggaso3i DLluN3GKtaJPgbekiQdt13Od2to/AT4krfgMceAhSd1tdQY8gyGHBGZwxc6U182fDvW2 T1Cr0porRPK2fU7hYjTXT0v/9U4mJRmKKUtxHD4LGk8YQX5mJ2SvU9mLdRAHZD0NNUgH Fb+paUpVH25mlD+/PPuR6nnb/Hc0rs1SJMNCqb067AHww/tv8510dRfOsak02nMUUmsq eP4w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:references:date:in-reply-to :message-id:user-agent:mime-version; bh=MEtPQCVSFFA7LSVTKB2jnJza/zF7CC9qqYV/ewCYKEE=; b=ftmgdXSm1nWiyiVR0cwJ3k6GkDOWN46vw8Knvq4THXmSxpYI0dB8Bwr37ny6jObiDD e4rMxXkA5kps02gOWQMOINRsiVU1PHMO7eP2+VtG22308dlTuN8VHGj5CWG+eEJsqW4x uVA74OHt+JpdEl7436AKG3oSDvXu1s7ur62NwCr59DZDOXUpHKIr/xsCeS3Fp/gu7wAN oNI4MONETN2hJF8JZa2tbCJTCRY5e16hcvnfNW6NY/vJNB6+x7WCtvfpVOEhr2eNhaj2 c3nlXJlyybwTesjn975XNXxGabwwiKXPIDlX3e2Q3rFX8iOvMYBFsSjrBrKcPYOOtIzq pbwg== X-Gm-Message-State: AOAM532uQ7XcVf/4RacQBzZQ6EapBKwsC9+LTbO8tCvFJM8EWM+b1z1f aKiO91PNhiQWyUOXYf1Y3ipc5w== X-Google-Smtp-Source: ABdhPJxPwxV5spMfBVNUoGZZ34w8bNB5XOeJNOQH8Nclue3PHArztj9O5qxxLVfT8+Zcxcxm3pRt+w== X-Received: by 2002:adf:a29e:: with SMTP id s30mr16708017wra.29.1604254241153; Sun, 01 Nov 2020 10:10:41 -0800 (PST) Original-Received: from localhost ([51.37.36.100]) by smtp.gmail.com with ESMTPSA id t1sm18443058wrs.48.2020.11.01.10.10.40 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 01 Nov 2020 10:10:40 -0800 (PST) In-Reply-To: <874km9d4mc.fsf@ericabrahamsen.net> (Eric Abrahamsen's message of "Sat, 31 Oct 2020 22:32:11 -0700") 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:192424 Archived-At: Eric Abrahamsen writes: > Finally done! I think. Most of the final work was writing the docs. Thanks! I only had time to look through the manual, and it looks good, modulo some minor markup nits. > +It's possible to search a backend more thoroughly using an associated > +search engine. Some backends come with their own search engine: IMAP > +servers, for instance, do their own searching. Other backends, for > +example a local @code{nnmaildir} installation, might require the user > +to manually set up some sort of search indexing. Default associations > +between backends and engines can be defined in > +@code{gnus-search-default-engines}, and engines can also be defined on > +a per-backend basis (@xref{Search Engines}). Should this and other parenthesised xrefs be pxref instead? (I haven't tested the difference.) > +Once the search engines are set up, you can search for messages in > +groups from one or more backends, and show the results in a group. > +The groups that hold search results are created on the nnselect > +backend, and can be either ephemeral or persistent (@xref{Creating > +Search Groups}). > + > +@vindex: gnus-search-use-parsed-queries Is the colon necessary? > +Search queries can be specified one of two ways: either using the > +syntax of the engine responsible for the group you're searching, or > +using Gnus' generalized search syntax. Set the option > +@code{gnus-search-use-parsed-queries} to a non-nil value to used the > +generalized syntax. The advantage of this syntax is that, if you have > +multiple backends indexed by different engines, you don't need to > +remember which one you're searching -- it's also possible to issue the I think Texinfo conventionally uses three hyphens for punctuation in sentences (info "(texinfo) Conventions"). (Here and elsewhere.) > +same query against multiple groups, indexed by different engines, at > +the same time. It also provides a few other conveniences including > +relative date parsing and tie-ins into other Emacs packages. For > +details on Gnus' query language, @xref{Search Queries}. I think @xref is used at the start of sentences and @ref at the end. > +@vindex gnus-search-default-engines > +The option @code{gnus-search-default-engines} assigns search engines > +by server type. Its value is an alist mapping symbols indicating a > +server type (e.g. @code{nnmaildir} or @code{nnml}) to symbols My impression is that Emacs uses the (US?) convention of following e.g. with a comma (but I could be wrong). (Here and elsewhere.) > +These engines have a handful of configuration parameters that can > +either be set as a default option for all engines of that type, or set > +per-engine in your server config. These common paramters are: paramters -> parameters > + > +@itemize > +@item > +@code{program}: The name of the executable. Defaults to the plain I think listing definitions, particularly when they need markup, is better done with e.g. '@table @code' rather than @itemize. (Here and elsewhere.) > +program name such as ``notmuch'' or ``namazu''. Should command names be marked as @command? (Here or elsewhere.) > +The customization options are formed on the pattern > +@code{gnus-search--}. For instance, to use a Don't know whether it's preferable here, but there's also the metavariable syntax @code{gnus-search-@var{engine}-@var{parameter}}, with which you can e.g. refer to individual @vars in subsequent prose. > +non-standard notmuch program, you might set > +@code{gnus-search-notmuch-program} to ``/usr/local/bin/notmuch''. @file? > -By default the whole message will be searched. The query can be limited > -to a specific part of a message by using a prefix-arg. After inputting > -the query this will prompt (with completion) for a message part. > -Choices include ``Whole message'', ``Subject'', ``From'', and I think literal text (here and elsewhere) is usually written as @samp. > +(from:john or from:peter) subject: ``lunch tomorrow'' since:3d I think quoting in examples should use "" instead of ``'' (here and elsewhere). > +@item > +mark: Accepts ``flag'', ``seen'', ``read'' or ``replied'', or any of > +Gnus' single-letter representations of those marks, i.e. ``mark:R'' i.e. -> e.g.? > +for ``read''. > -@end table > +@vindex gnus-search-contact-sources > +If an elisp-based contact management packages (e.g. BBDB or EBDB) packages -> package elisp -> Elisp? > -@node Customizations > -@subsubsection Customizations > +@vindex gnus-search-date-keys > +Date-type keys (see @code{gnus-search-date-keys}) will accept a wide > +variety of values. First, anything that @code{parse-time-string} can > +parse is acceptable. Dates with missing values will be interpreted as > +the most recent occurance thereof: for instance ``march 03'' is the occurance -> occurrence (here and elsewhere) -- Basil