summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicolas Goaziou <n.goaziou@gmail.com>2014-02-28 18:06:16 +0100
committerNicolas Goaziou <n.goaziou@gmail.com>2014-02-28 18:07:38 +0100
commitc2f4803cbd9da0f3252353317749fa5f1a8d28e2 (patch)
tree0cc2801d61a00a192e4fe12dccbefc69a57e76a8
parent27fd4d2141fff1c708b5914d4da79a8291fd131c (diff)
downloadorg-mode-c2f4803cbd9da0f3252353317749fa5f1a8d28e2.tar.gz
Small docstring update
* lisp/org.el (org-open-at-point): Update documentation.
-rw-r--r--lisp/org.el22
1 files changed, 17 insertions, 5 deletions
diff --git a/lisp/org.el b/lisp/org.el
index ba8ea8b..8ff8137 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -10442,12 +10442,24 @@ they must return nil.")
(defvar org-link-search-inhibit-query nil) ;; dynamically scoped
(defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
(defun org-open-at-point (&optional arg reference-buffer)
- "Open link at point.
+ "Open link, timestamp, footnote or tags at point.
-Normally, files will be opened by an appropriate application. If
-the optional prefix argument ARG is non-nil, Emacs will visit the
-file. With a double prefix argument, try to open outside of
-Emacs, in the application the system uses for this file type.
+When point is on a link, follow it. Normally, files will be
+opened by an appropriate application. If the optional prefix
+argument ARG is non-nil, Emacs will visit the file. With
+a double prefix argument, try to open outside of Emacs, in the
+application the system uses for this file type.
+
+When point is on a timestamp, open the agenda at the day
+specified.
+
+When point is a footnote definition, move to the first reference
+found. If it is on a reference, move to the associated
+definition.
+
+When point is on a headline, display a list of every link in the
+entry, so it is possible to pick one, or all, of them. If point
+is on a tag, call `org-tags-view' instead.
When optional argument REFERENCE-BUFFER is non-nil, it should
specify a buffer from where the link search should happen. This