summaryrefslogtreecommitdiff
path: root/lisp/net/browse-url.el
diff options
context:
space:
mode:
authorGlenn Morris <rgm@gnu.org>2012-02-08 22:14:22 -0500
committerGlenn Morris <rgm@gnu.org>2012-02-08 22:14:22 -0500
commitd95b247d1d8fbfae4c739f6a1f47069b7807964c (patch)
tree2548eabde33e8364aef869673b59541b1fb9910e /lisp/net/browse-url.el
parent54cdb2530e755f4fe4cb08ad740c14aedfd85a1c (diff)
downloademacs-d95b247d1d8fbfae4c739f6a1f47069b7807964c.tar.gz
Doc fixes for browse-url
* lisp/net/browse-url.el (browse-url-can-use-xdg-open, browse-url-xdg-open): Doc fixes.
Diffstat (limited to 'lisp/net/browse-url.el')
-rw-r--r--lisp/net/browse-url.el9
1 files changed, 7 insertions, 2 deletions
diff --git a/lisp/net/browse-url.el b/lisp/net/browse-url.el
index f378277d5f0..99f3c53f025 100644
--- a/lisp/net/browse-url.el
+++ b/lisp/net/browse-url.el
@@ -944,7 +944,9 @@ used instead of `browse-url-new-window-flag'."
url args))
(defun browse-url-can-use-xdg-open ()
- "Check if xdg-open can be used, i.e. we are on Gnome, KDE, Xfce4 or LXDE."
+ "Return non-nil if the \"xdg-open\" program can be used.
+xdg-open is a desktop utility that calls your preferred web browser.
+This requires you to be running either Gnome, KDE, Xfce4 or LXDE."
(and (getenv "DISPLAY")
(executable-find "xdg-open")
;; xdg-open may call gnome-open and that does not wait for its child
@@ -974,7 +976,10 @@ used instead of `browse-url-new-window-flag'."
;;;###autoload
-(defun browse-url-xdg-open (url &optional new-window)
+(defun browse-url-xdg-open (url &optional ignored)
+ "Pass the specified URL to the \"xdg-open\" command.
+xdg-open is a desktop utility that calls your preferred web browser.
+The optional argument IGNORED is not used."
(interactive (browse-url-interactive-arg "URL: "))
(call-process "xdg-open" nil 0 nil url))