[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/engine-mode c68054af30 02/71: update package commentary
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/engine-mode c68054af30 02/71: update package commentary |
Date: |
Wed, 21 Dec 2022 09:58:56 -0500 (EST) |
branch: elpa/engine-mode
commit c68054af3026f37177069a6ed7232202b050b74a
Author: Harry Schwartz <hello@harryrschwartz.com>
Commit: Harry Schwartz <hello@harryrschwartz.com>
update package commentary
---
engine.el | 37 +++++++++++++++++++++++++++++++------
1 file changed, 31 insertions(+), 6 deletions(-)
diff --git a/engine.el b/engine.el
index 945850f392..27a64e4e02 100644
--- a/engine.el
+++ b/engine.el
@@ -1,12 +1,37 @@
-;;; engine.el --- Define and query search engines from within Emacs
+;;; engine.el --- Define and query search engines from within Emacs.
-;; Copyright 2014 Harry Schwartz
-
-;; Author: Harry Schwartz <hello@harryrschwartz.com>
+;; Author: Harry R. Schwartz <hello@harryrschwartz.com>
;; Version: 2014.05.06
;; URL: https://github.com/hrs/engine-mode/engine.el
-;; This file is not part of GNU Emacs
+;; This file is NOT part of GNU Emacs.
+
+;;; Commentary:
+
+;; `engine-mode' is a global minor mode for Emacs. It enables you to
+;; easily define search engines, bind them to keybindings, and query
+;; them from the comfort of your editor.
+
+;; For example, suppose we want to be able to easily search GitHub:
+
+;; (defengine github
+;; "https://github.com/search?ref=simplesearch&q=%s")
+
+;; This defines an interactive function `engine/search-github'. When
+;; executed it will take the selected region (or prompt for input, if
+;; no region is selected) and search GitHub for it, displaying the
+;; results in your default browser.
+
+;; The `defengine' macro can also take an optional key combination:
+
+;; (defengine duckduckgo
+;; "https://duckduckgo.com/?q=%s"
+;; "C-c / d")
+
+;; `C-c / d' is now bound to the new function
+;; qengine/search-duckduckgo'! Nifty.
+
+;;; License:
;; This program is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
@@ -24,7 +49,7 @@
;;; Code:
(define-minor-mode engine-mode
- "Define search engines."
+ "Minor mode for defining and querying search engines through Emacs."
:global t
:keymap (make-sparse-keymap))
- [nongnu] elpa/engine-mode 50b0d436e8 42/71: Define prefixed map as an actual prefix command, (continued)
- [nongnu] elpa/engine-mode 50b0d436e8 42/71: Define prefixed map as an actual prefix command, ELPA Syncer, 2022/12/21
- [nongnu] elpa/engine-mode 1bfcc961c5 46/71: Set URL to the bare GitHub repo, ELPA Syncer, 2022/12/21
- [nongnu] elpa/engine-mode 20608906f8 61/71: Document installation with use-package, ELPA Syncer, 2022/12/21
- [nongnu] elpa/engine-mode f36d8bf785 69/71: Prefer HTTPS to HTTP, ELPA Syncer, 2022/12/21
- [nongnu] elpa/engine-mode e0910f141f 58/71: Don't quote term-transformation-hook value, ELPA Syncer, 2022/12/21
- [nongnu] elpa/engine-mode 278d4d9e9c 66/71: Allow nil value for engine/keybinding-prefix, ELPA Syncer, 2022/12/21
- [nongnu] elpa/engine-mode 408932727b 49/71: display the default word in prompt if available, ELPA Syncer, 2022/12/21
- [nongnu] elpa/engine-mode a978c58675 68/71: Add .elpaignore for NonGNU ELPA, ELPA Syncer, 2022/12/21
- [nongnu] elpa/engine-mode fd5a235b2c 51/71: Format with the same search-term many times in a search-engine-url, ELPA Syncer, 2022/12/21
- [nongnu] elpa/engine-mode a1b3e4fb71 33/71: Include animated gif demo, ELPA Syncer, 2022/12/21
- [nongnu] elpa/engine-mode c68054af30 02/71: update package commentary,
ELPA Syncer <=
- [nongnu] elpa/engine-mode 07a5196be8 36/71: Update README with the new prefix `C-x /`, ELPA Syncer, 2022/12/21
- [nongnu] elpa/engine-mode 16ad9403df 40/71: Load cl-lib instead of cl.el for using cl-defmacro, ELPA Syncer, 2022/12/21
- [nongnu] elpa/engine-mode 5d6c6495b3 37/71: Bump verion number to 2.0.0 in comment header, ELPA Syncer, 2022/12/21
- [nongnu] elpa/engine-mode 4a9cc581df 17/71: Add keymap to engine-mode docstring, ELPA Syncer, 2022/12/21
- [nongnu] elpa/engine-mode fbb23e7b1f 45/71: Bump version to 2.1.0, ELPA Syncer, 2022/12/21
- [nongnu] elpa/engine-mode 117a9c0cbc 52/71: Use kbd to convert :keybinding correctly, ELPA Syncer, 2022/12/21
- [nongnu] elpa/engine-mode a5f1ae2b08 70/71: Bump version to 2.2.1, ELPA Syncer, 2022/12/21
- [nongnu] elpa/engine-mode a8e7bd3afb 60/71: Fix documentation for browse-url-browser-function, ELPA Syncer, 2022/12/21
- [nongnu] elpa/engine-mode b6fafabc68 65/71: Better docstrings, ELPA Syncer, 2022/12/21
- [nongnu] elpa/engine-mode 5704591830 64/71: Document binding keymaps with use-package, ELPA Syncer, 2022/12/21