summaryrefslogtreecommitdiff
path: root/README.md
blob: 574dca5c0e743bc0ff1d9d5fa2c342d7f8464e24 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
Dispatch Context Sensitive Commands
===================================

Find here the source for do-at-point.el and the command `do-at-point`,
that uses `thing-at-point` to cycle through various "things" to select
and then dispatch appropriate actions on these selections.

See also Omar AntolĂ­n Camarena's [Embark] package, which provides a
more feature-full implementation of the same concept, with am emphasis
on interacting with the minibuffer.

[Embark]:
	https://github.com/oantolin/embark

Installation
------------

Do-at-point.el is avaliable from [GNU ELPA].  It can be installed by
invoking

	M-x package-install RET do-at-point RET

[GNU ELPA]:
	http://elpa.gnu.org/packages/do-at-point.html

Usage
-----

The main and presently only entry point for this package is the
autoloaded `do-at-point` command itself.  Bind it to a convenient key,
for example

    (global-set-key (kbd "C-'") #'do-at-point)

There are some options that users may configure.  After having have
loaded the package consult `M-x apropos-user-option RET do-at-point-
RET` for an overview.

Contribute
----------

As do-at-point.el is distributed as part of [GNU ELPA], and therefore
requires a [copyright assignment] to the [FSF], for all non-trivial
code contributions.

[copyright assignment]:
	https://www.gnu.org/software/emacs/manual/html_node/emacs/Copyright-Assignment.html
[FSF]:
	https://www.fsf.org/

Source code
-----------

Do-at-point.el is developed on [SourceHut].

[SourceHut]:
	https://git.sr.ht/~pkal/do-at-point

Bugs and Patches
----------------

Bugs, patches, comments or questions can be submitted to my [public
inbox].

[public inbox]:
	https://lists.sr.ht/~pkal/public-inbox

Distribution
------------

Do-at-point.el and all other source files in this directory are
distributed under the [GNU Public License], Version 3 (like Emacs
itself).

[GNU Public License]:
	https://www.gnu.org/licenses/gpl-3.0.en.html