Variable: nnir-engines

nnir-engines is a variable defined in nnir.el.gz.

Value

((imap nnir-run-imap
       ((criteria "Imap Search in"
		  ("whole message" "subject" "to" "from" "body" "imap"
		   "gmail")
		  nil nil nnir-imap-search-argument-history
		  "whole message")))
 (swish++ nnir-run-swish++
	  ((swish++-group . "Swish++ Group spec (regexp): ")))
 (swish-e nnir-run-swish-e
	  ((swish-e-group . "Swish-e Group spec (regexp): ")))
 (namazu nnir-run-namazu nil) (notmuch nnir-run-notmuch nil)
 (hyrex nnir-run-hyrex ((hyrex-group . "Hyrex Group spec (regexp): ")))
 (find-grep nnir-run-find-grep ((grep-options . "Grep options: "))))

Documentation

Alist of supported search engines.

Each element in the alist is a three-element list (ENGINE FUNCTION ARGS). ENGINE is a symbol designating the searching engine. FUNCTION is also a symbol, giving the function that does the search. The third element ARGS is a list of cons pairs (PARAM . PROMPT). When issuing a query, the FUNCTION will issue a query for each of the PARAMs, using PROMPT.

The value of nnir-search-engine must be one of the ENGINE symbols. For example, for searching a server using namazu include
    (nnir-search-engine namazu)
in the server definition. Note that you have to set additional variables for most backends. For example, the namazu backend needs the variables nnir-namazu-program, nnir-namazu-index-directory and nnir-namazu-remove-prefix.

Add an entry here when adding a new search engine.

Source Code

;; Defined in /usr/src/emacs/lisp/obsolete/nnir.el.gz
;;; Developer Extension Variable:

(defvar nnir-engines
  `((imap    nnir-run-imap
             ((criteria
	       "Imap Search in"                   ; Prompt
	       ,(mapcar #'car nnir-imap-search-arguments) ; alist for completing
	       nil                                ; allow any user input
	       nil                                ; initial value
	       nnir-imap-search-argument-history  ; the history to use
	       ,nnir-imap-default-search-key      ; default
	       )))
    (swish++ nnir-run-swish++
             ((swish++-group . "Swish++ Group spec (regexp): ")))
    (swish-e nnir-run-swish-e
             ((swish-e-group . "Swish-e Group spec (regexp): ")))
    (namazu  nnir-run-namazu
             ())
    (notmuch nnir-run-notmuch
             ())
    (hyrex   nnir-run-hyrex
	     ((hyrex-group . "Hyrex Group spec (regexp): ")))
    (find-grep nnir-run-find-grep
	       ((grep-options . "Grep options: "))))
  "Alist of supported search engines.
Each element in the alist is a three-element list (ENGINE FUNCTION ARGS).
ENGINE is a symbol designating the searching engine.  FUNCTION is also
a symbol, giving the function that does the search.  The third element
ARGS is a list of cons pairs (PARAM . PROMPT).  When issuing a query,
the FUNCTION will issue a query for each of the PARAMs, using PROMPT.

The value of `nnir-search-engine' must be one of the ENGINE symbols.
For example, for searching a server using namazu include
    (nnir-search-engine namazu)
in the server definition.  Note that you have to set additional
variables for most backends.  For example, the `namazu' backend
needs the variables `nnir-namazu-program',
`nnir-namazu-index-directory' and `nnir-namazu-remove-prefix'.

Add an entry here when adding a new search engine.")