* net/browse-url.el (browse-url-filename-alist): On Windows, add
[emacs.git] / lisp / net / browse-url.el
blobe52f4cb924a747c6fa476d40c4e79eea4d77d3dc
1 ;;; browse-url.el --- pass a URL to a WWW browser
3 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
4 ;; 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
6 ;; Author: Denis Howe <dbh@doc.ic.ac.uk>
7 ;; Maintainer: FSF
8 ;; Created: 03 Apr 1995
9 ;; Keywords: hypertext, hypermedia, mouse
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;; This package provides functions which read a URL (Uniform Resource
29 ;; Locator) from the minibuffer, defaulting to the URL around point,
30 ;; and ask a World-Wide Web browser to load it. It can also load the
31 ;; URL associated with the current buffer. Different browsers use
32 ;; different methods of remote control so there is one function for
33 ;; each supported browser. If the chosen browser is not running, it
34 ;; is started. Currently there is support for the following browsers,
35 ;; some of them probably now obsolete:
37 ;; Function Browser Earliest version
38 ;; browse-url-mozilla Mozilla Don't know
39 ;; browse-url-firefox Firefox Don't know (tried with 1.0.1)
40 ;; browse-url-galeon Galeon Don't know
41 ;; browse-url-epiphany Epiphany Don't know
42 ;; browse-url-netscape Netscape 1.1b1
43 ;; browse-url-mosaic XMosaic/mMosaic <= 2.4
44 ;; browse-url-cci XMosaic 2.5
45 ;; browse-url-w3 w3 0
46 ;; browse-url-w3-gnudoit w3 remotely
47 ;; browse-url-text-* Any text browser 0
48 ;; browse-url-generic arbitrary
49 ;; browse-url-default-windows-browser MS-Windows browser
50 ;; browse-url-default-macosx-browser Mac OS X browser
51 ;; browse-url-gnome-moz GNOME interface to Mozilla
52 ;; browse-url-kde KDE konqueror (kfm)
53 ;; browse-url-elinks Elinks Don't know (tried with 0.12.GIT)
55 ;; [A version of the Netscape browser is now free software
56 ;; <URL:http://www.mozilla.org/>, albeit not GPLed, so it is
57 ;; reasonable to have that as the default.]
59 ;; Note that versions of Netscape before 1.1b1 did not have remote
60 ;; control. <URL:http://www.netscape.com/newsref/std/x-remote.html>.
62 ;; Browsers can cache Web pages so it may be necessary to tell them to
63 ;; reload the current page if it has changed (e.g. if you have edited
64 ;; it). There is currently no perfect automatic solution to this.
66 ;; Netscape allows you to specify the id of the window you want to
67 ;; control but which window DO you want to control and how do you
68 ;; discover its id?
70 ;; William M. Perry's excellent "w3" WWW browser for
71 ;; Emacs <URL:ftp://cs.indiana.edu/pub/elisp/w3/>
72 ;; has a function w3-follow-url-at-point, but that
73 ;; doesn't let you edit the URL like browse-url.
74 ;; The `gnuserv' package that can be used to control it in another
75 ;; Emacs process is available from
76 ;; <URL:ftp://ftp.splode.com/pub/users/friedman/packages/>.
78 ;; Lynx is now distributed by the FSF. See also
79 ;; <URL:http://lynx.browser.org/>.
81 ;; Free graphical browsers that could be used by `browse-url-generic'
82 ;; include Chimera <URL:ftp://ftp.cs.unlv.edu/pub/chimera> and
83 ;; <URL:http://www.unlv.edu/chimera/>, Arena
84 ;; <URL:ftp://ftp.yggdrasil.com/pub/dist/web/arena> and Amaya
85 ;; <URL:ftp://ftp.w3.org/pub/amaya>. mMosaic
86 ;; <URL:ftp://ftp.enst.fr/pub/mbone/mMosaic/>,
87 ;; <URL:http://www.enst.fr/~dauphin/mMosaic/> (with development
88 ;; support for Java applets and multicast) can be used like Mosaic by
89 ;; setting `browse-url-mosaic-program' appropriately.
91 ;; I [Denis Howe, not Dave Love] recommend Nelson Minar
92 ;; <nelson@santafe.edu>'s excellent html-helper-mode.el for editing
93 ;; HTML and thank Nelson for his many useful comments on this code.
94 ;; <URL:http://www.santafe.edu/%7Enelson/hhm-beta/>
96 ;; See also hm--html-menus <URL:http://www.tnt.uni-hannover.de/%7Emuenkel/
97 ;; software/own/hm--html-menus/>. For composing correct HTML see also
98 ;; PSGML the general SGML structure editor package
99 ;; <URL:ftp://ftp.lysator.liu.se/pub/sgml>; hm--html-menus can be used
100 ;; with this.
102 ;; This package generalises function html-previewer-process in Marc
103 ;; Andreessen's html-mode (LCD modes/html-mode.el.Z). See also the
104 ;; ffap.el package. The huge hyperbole package also contains similar
105 ;; functions.
107 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
108 ;; Help!
110 ;; Can you write and test some code for the Macintrash and Windoze
111 ;; Netscape remote control APIs? (See the URL above).
113 ;; Do any other browsers have remote control?
115 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
116 ;; Usage
118 ;; To display the URL at or before point:
119 ;; M-x browse-url-at-point RET
120 ;; or, similarly but with the opportunity to edit the URL extracted from
121 ;; the buffer, use:
122 ;; M-x browse-url
124 ;; To display a URL by shift-clicking on it, put this in your ~/.emacs
125 ;; file:
126 ;; (global-set-key [S-mouse-2] 'browse-url-at-mouse)
127 ;; (Note that using Shift-mouse-1 is not desirable because
128 ;; that event has a standard meaning in Emacs.)
130 ;; To display the current buffer in a web browser:
131 ;; M-x browse-url-of-buffer RET
133 ;; To display the current region in a web browser:
134 ;; M-x browse-url-of-region RET
136 ;; In Dired, to display the file named on the current line:
137 ;; M-x browse-url-of-dired-file RET
139 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
140 ;; Customisation (~/.emacs)
142 ;; To see what variables are available for customization, type
143 ;; `M-x set-variable browse-url TAB'. Better, use
144 ;; `M-x customize-group browse-url'.
146 ;; Bind the browse-url commands to keys with the `C-c C-z' prefix
147 ;; (as used by html-helper-mode):
148 ;; (global-set-key "\C-c\C-z." 'browse-url-at-point)
149 ;; (global-set-key "\C-c\C-zb" 'browse-url-of-buffer)
150 ;; (global-set-key "\C-c\C-zr" 'browse-url-of-region)
151 ;; (global-set-key "\C-c\C-zu" 'browse-url)
152 ;; (global-set-key "\C-c\C-zv" 'browse-url-of-file)
153 ;; (add-hook 'dired-mode-hook
154 ;; (lambda ()
155 ;; (local-set-key "\C-c\C-zf" 'browse-url-of-dired-file)))
157 ;; Browse URLs in mail messages under RMAIL by clicking mouse-2:
158 ;; (add-hook 'rmail-mode-hook (lambda () ; rmail-mode startup
159 ;; (define-key rmail-mode-map [mouse-2] 'browse-url-at-mouse)))
160 ;; Alternatively, add `goto-address' to `rmail-show-message-hook'.
162 ;; Gnus provides a standard feature to activate URLs in article
163 ;; buffers for invocation of browse-url.
165 ;; Use the Emacs w3 browser when not running under X11:
166 ;; (or (eq window-system 'x)
167 ;; (setq browse-url-browser-function 'browse-url-w3))
169 ;; To always save modified buffers before displaying the file in a browser:
170 ;; (setq browse-url-save-file t)
172 ;; To get round the Netscape caching problem, you could EITHER have
173 ;; write-file in html-helper-mode make Netscape reload the document:
175 ;; (autoload 'browse-url-netscape-reload "browse-url"
176 ;; "Ask a WWW browser to redisplay the current file." t)
177 ;; (add-hook 'html-helper-mode-hook
178 ;; (lambda ()
179 ;; (add-hook 'local-write-file-hooks
180 ;; (lambda ()
181 ;; (let ((local-write-file-hooks))
182 ;; (save-buffer))
183 ;; (browse-url-netscape-reload)
184 ;; t) ; => file written by hook
185 ;; t))) ; append to l-w-f-hooks
187 ;; OR have browse-url-of-file ask Netscape to load and then reload the
188 ;; file:
190 ;; (add-hook 'browse-url-of-file-hook 'browse-url-netscape-reload)
192 ;; You may also want to customise browse-url-netscape-arguments, e.g.
193 ;; (setq browse-url-netscape-arguments '("-install"))
195 ;; or similarly for the other browsers.
197 ;; To invoke different browsers for different URLs:
198 ;; (setq browse-url-browser-function '(("^mailto:" . browse-url-mail)
199 ;; ("." . browse-url-netscape)))
201 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
202 ;;; Code:
204 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
205 ;; Variables
207 (eval-when-compile (require 'cl)
208 (require 'thingatpt)
209 (require 'term)
210 (require 'dired)
211 (require 'executable)
212 (require 'w3-auto nil t))
214 (defgroup browse-url nil
215 "Use a web browser to look at a URL."
216 :prefix "browse-url-"
217 :link '(emacs-commentary-link "browse-url")
218 :group 'hypermedia)
220 ;;;###autoload
221 (defcustom browse-url-browser-function
222 (cond
223 ((memq system-type '(windows-nt ms-dos cygwin))
224 'browse-url-default-windows-browser)
225 ((memq system-type '(darwin)) 'browse-url-default-macosx-browser)
226 (t 'browse-url-default-browser))
227 "Function to display the current buffer in a WWW browser.
228 This is used by the `browse-url-at-point', `browse-url-at-mouse', and
229 `browse-url-of-file' commands.
231 If the value is not a function it should be a list of pairs
232 \(REGEXP . FUNCTION). In this case the function called will be the one
233 associated with the first REGEXP which matches the current URL. The
234 function is passed the URL and any other args of `browse-url'. The last
235 regexp should probably be \".\" to specify a default browser."
236 :type '(choice
237 (function-item :tag "Emacs W3" :value browse-url-w3)
238 (function-item :tag "W3 in another Emacs via `gnudoit'"
239 :value browse-url-w3-gnudoit)
240 (function-item :tag "Mozilla" :value browse-url-mozilla)
241 (function-item :tag "Firefox" :value browse-url-firefox)
242 (function-item :tag "Galeon" :value browse-url-galeon)
243 (function-item :tag "Epiphany" :value browse-url-epiphany)
244 (function-item :tag "Netscape" :value browse-url-netscape)
245 (function-item :tag "Mosaic" :value browse-url-mosaic)
246 (function-item :tag "Mosaic using CCI" :value browse-url-cci)
247 (function-item :tag "Text browser in an xterm window"
248 :value browse-url-text-xterm)
249 (function-item :tag "Text browser in an Emacs window"
250 :value browse-url-text-emacs)
251 (function-item :tag "KDE" :value browse-url-kde)
252 (function-item :tag "Elinks" :value browse-url-elinks)
253 (function-item :tag "Specified by `Browse Url Generic Program'"
254 :value browse-url-generic)
255 (function-item :tag "Default Windows browser"
256 :value browse-url-default-windows-browser)
257 (function-item :tag "Default Mac OS X browser"
258 :value browse-url-default-macosx-browser)
259 (function-item :tag "GNOME invoking Mozilla"
260 :value browse-url-gnome-moz)
261 (function-item :tag "Default browser"
262 :value browse-url-default-browser)
263 (function :tag "Your own function")
264 (alist :tag "Regexp/function association list"
265 :key-type regexp :value-type function))
266 :version "21.1"
267 :group 'browse-url)
269 (defcustom browse-url-netscape-program "netscape"
270 ;; Info about netscape-remote from Karl Berry.
271 "The name by which to invoke Netscape.
273 The free program `netscape-remote' from
274 <URL:http://home.netscape.com/newsref/std/remote.c> is said to start
275 up very much quicker than `netscape'. Reported to compile on a GNU
276 system, given vroot.h from the same directory, with cc flags
277 -DSTANDALONE -L/usr/X11R6/lib -lXmu -lX11."
278 :type 'string
279 :group 'browse-url)
281 (defcustom browse-url-netscape-arguments nil
282 "A list of strings to pass to Netscape as arguments."
283 :type '(repeat (string :tag "Argument"))
284 :group 'browse-url)
286 (defcustom browse-url-netscape-startup-arguments browse-url-netscape-arguments
287 "A list of strings to pass to Netscape when it starts up.
288 Defaults to the value of `browse-url-netscape-arguments' at the time
289 `browse-url' is loaded."
290 :type '(repeat (string :tag "Argument"))
291 :group 'browse-url)
293 (defcustom browse-url-browser-display nil
294 "The X display for running the browser, if not same as Emacs'."
295 :type '(choice string (const :tag "Default" nil))
296 :group 'browse-url)
298 (defcustom browse-url-mozilla-program "mozilla"
299 "The name by which to invoke Mozilla."
300 :type 'string
301 :group 'browse-url)
303 (defcustom browse-url-mozilla-arguments nil
304 "A list of strings to pass to Mozilla as arguments."
305 :type '(repeat (string :tag "Argument"))
306 :group 'browse-url)
308 (defcustom browse-url-mozilla-startup-arguments browse-url-mozilla-arguments
309 "A list of strings to pass to Mozilla when it starts up.
310 Defaults to the value of `browse-url-mozilla-arguments' at the time
311 `browse-url' is loaded."
312 :type '(repeat (string :tag "Argument"))
313 :group 'browse-url)
315 ;;;###autoload
316 (defcustom browse-url-firefox-program (purecopy "firefox")
317 "The name by which to invoke Firefox."
318 :type 'string
319 :group 'browse-url)
321 (defcustom browse-url-firefox-arguments nil
322 "A list of strings to pass to Firefox as arguments."
323 :type '(repeat (string :tag "Argument"))
324 :group 'browse-url)
326 (defcustom browse-url-firefox-startup-arguments browse-url-firefox-arguments
327 "A list of strings to pass to Firefox when it starts up.
328 Defaults to the value of `browse-url-firefox-arguments' at the time
329 `browse-url' is loaded."
330 :type '(repeat (string :tag "Argument"))
331 :group 'browse-url)
333 ;;;###autoload
334 (defcustom browse-url-galeon-program (purecopy "galeon")
335 "The name by which to invoke Galeon."
336 :type 'string
337 :group 'browse-url)
339 (defcustom browse-url-galeon-arguments nil
340 "A list of strings to pass to Galeon as arguments."
341 :type '(repeat (string :tag "Argument"))
342 :group 'browse-url)
344 (defcustom browse-url-galeon-startup-arguments browse-url-galeon-arguments
345 "A list of strings to pass to Galeon when it starts up.
346 Defaults to the value of `browse-url-galeon-arguments' at the time
347 `browse-url' is loaded."
348 :type '(repeat (string :tag "Argument"))
349 :group 'browse-url)
351 (defcustom browse-url-epiphany-program "epiphany"
352 "The name by which to invoke Epiphany."
353 :type 'string
354 :group 'browse-url)
356 (defcustom browse-url-epiphany-arguments nil
357 "A list of strings to pass to Epiphany as arguments."
358 :type '(repeat (string :tag "Argument"))
359 :group 'browse-url)
361 (defcustom browse-url-epiphany-startup-arguments browse-url-epiphany-arguments
362 "A list of strings to pass to Epiphany when it starts up.
363 Defaults to the value of `browse-url-epiphany-arguments' at the time
364 `browse-url' is loaded."
365 :type '(repeat (string :tag "Argument"))
366 :group 'browse-url)
368 ;; GNOME means of invoking either Mozilla or Netrape.
369 (defvar browse-url-gnome-moz-program "gnome-moz-remote")
371 (defcustom browse-url-gnome-moz-arguments '()
372 "A list of strings passed to the GNOME mozilla viewer as arguments."
373 :version "21.1"
374 :type '(repeat (string :tag "Argument"))
375 :group 'browse-url)
377 (defcustom browse-url-mozilla-new-window-is-tab nil
378 "Whether to open up new windows in a tab or a new window.
379 If non-nil, then open the URL in a new tab rather than a new window if
380 `browse-url-mozilla' is asked to open it in a new window."
381 :type 'boolean
382 :group 'browse-url)
384 (defcustom browse-url-firefox-new-window-is-tab nil
385 "Whether to open up new windows in a tab or a new window.
386 If non-nil, then open the URL in a new tab rather than a new window if
387 `browse-url-firefox' is asked to open it in a new window.
389 This option is currently ignored on MS-Windows, since the necessary
390 functionality is not available there."
391 :type 'boolean
392 :group 'browse-url)
394 (defcustom browse-url-galeon-new-window-is-tab nil
395 "Whether to open up new windows in a tab or a new window.
396 If non-nil, then open the URL in a new tab rather than a new window if
397 `browse-url-galeon' is asked to open it in a new window."
398 :type 'boolean
399 :group 'browse-url)
401 (defcustom browse-url-epiphany-new-window-is-tab nil
402 "Whether to open up new windows in a tab or a new window.
403 If non-nil, then open the URL in a new tab rather than a new window if
404 `browse-url-epiphany' is asked to open it in a new window."
405 :type 'boolean
406 :group 'browse-url)
408 (defcustom browse-url-netscape-new-window-is-tab nil
409 "Whether to open up new windows in a tab or a new window.
410 If non-nil, then open the URL in a new tab rather than a new
411 window if `browse-url-netscape' is asked to open it in a new
412 window."
413 :type 'boolean
414 :group 'browse-url)
416 (defcustom browse-url-new-window-flag nil
417 "Non-nil means always open a new browser window with appropriate browsers.
418 Passing an interactive argument to \\[browse-url], or specific browser
419 commands reverses the effect of this variable. Requires Netscape version
420 1.1N or later or XMosaic version 2.5 or later if using those browsers."
421 :type 'boolean
422 :group 'browse-url)
424 (defcustom browse-url-mosaic-program "xmosaic"
425 "The name by which to invoke Mosaic (or mMosaic)."
426 :type 'string
427 :version "20.3"
428 :group 'browse-url)
430 (defcustom browse-url-mosaic-arguments nil
431 "A list of strings to pass to Mosaic as arguments."
432 :type '(repeat (string :tag "Argument"))
433 :group 'browse-url)
435 (defcustom browse-url-mosaic-pidfile "~/.mosaicpid"
436 "The name of the pidfile created by Mosaic."
437 :type 'string
438 :group 'browse-url)
440 (defcustom browse-url-filename-alist
441 `(("^/\\(ftp@\\|anonymous@\\)?\\([^:]+\\):/*" . "ftp://\\2/")
442 ;; The above loses the username to avoid the browser prompting for
443 ;; it in anonymous cases. If it's not anonymous the next regexp
444 ;; applies.
445 ("^/\\([^:@]+@\\)?\\([^:]+\\):/*" . "ftp://\\1\\2/")
446 ,@(if (memq system-type '(windows-nt ms-dos cygwin))
447 '(("^\\([a-zA-Z]:\\)[\\/]" . "file:///\\1/")
448 ("^[\\/][\\/]+" . "file://")))
449 ("^/+" . "file:///"))
450 "An alist of (REGEXP . STRING) pairs used by `browse-url-of-file'.
451 Any substring of a filename matching one of the REGEXPs is replaced by
452 the corresponding STRING using `replace-match', not treating STRING
453 literally. All pairs are applied in the order given. The default
454 value converts ange-ftp/EFS-style file names into ftp URLs and prepends
455 `file:' to any file name beginning with `/'.
457 For example, adding to the default a specific translation of an ange-ftp
458 address to an HTTP URL:
460 (setq browse-url-filename-alist
461 '((\"/webmaster@webserver:/home/www/html/\" .
462 \"http://www.acme.co.uk/\")
463 (\"^/\\(ftp@\\|anonymous@\\)?\\([^:]+\\):/*\" . \"ftp://\\2/\")
464 (\"^/\\([^:@]+@\\)?\\([^:]+\\):/*\" . \"ftp://\\1\\2/\")
465 (\"^/+\" . \"file:/\")))"
466 :type '(repeat (cons :format "%v"
467 (regexp :tag "Regexp")
468 (string :tag "Replacement")))
469 :version "23.1"
470 :group 'browse-url)
472 (defcustom browse-url-save-file nil
473 "If non-nil, save the buffer before displaying its file.
474 Used by the `browse-url-of-file' command."
475 :type 'boolean
476 :group 'browse-url)
478 (defcustom browse-url-of-file-hook nil
479 "Run after `browse-url-of-file' has asked a browser to load a file.
481 Set this to `browse-url-netscape-reload' to force Netscape to load the
482 file rather than displaying a cached copy."
483 :type 'hook
484 :options '(browse-url-netscape-reload)
485 :group 'browse-url)
487 (defcustom browse-url-CCI-port 3003
488 "Port to access XMosaic via CCI.
489 This can be any number between 1024 and 65535 but must correspond to
490 the value set in the browser."
491 :type 'integer
492 :group 'browse-url)
494 (defcustom browse-url-CCI-host "localhost"
495 "Host to access XMosaic via CCI.
496 This should be the host name of the machine running XMosaic with CCI
497 enabled. The port number should be set in `browse-url-CCI-port'."
498 :type 'string
499 :group 'browse-url)
501 (defvar browse-url-temp-file-name nil)
502 (make-variable-buffer-local 'browse-url-temp-file-name)
504 (defcustom browse-url-xterm-program "xterm"
505 "The name of the terminal emulator used by `browse-url-text-xterm'.
506 This might, for instance, be a separate color version of xterm."
507 :type 'string
508 :group 'browse-url)
510 (defcustom browse-url-xterm-args nil
511 "A list of strings defining options for `browse-url-xterm-program'.
512 These might set its size, for instance."
513 :type '(repeat (string :tag "Argument"))
514 :group 'browse-url)
516 (defcustom browse-url-gnudoit-program "gnudoit"
517 "The name of the `gnudoit' program used by `browse-url-w3-gnudoit'."
518 :type 'string
519 :group 'browse-url)
521 (defcustom browse-url-gnudoit-args '("-q")
522 "A list of strings defining options for `browse-url-gnudoit-program'.
523 These might set the port, for instance."
524 :type '(repeat (string :tag "Argument"))
525 :group 'browse-url)
527 (defcustom browse-url-generic-program nil
528 "The name of the browser program used by `browse-url-generic'."
529 :type '(choice string (const :tag "None" nil))
530 :group 'browse-url)
532 (defcustom browse-url-generic-args nil
533 "A list of strings defining options for `browse-url-generic-program'."
534 :type '(repeat (string :tag "Argument"))
535 :group 'browse-url)
537 (defcustom browse-url-temp-dir temporary-file-directory
538 "The name of a directory for browse-url's temporary files.
539 Such files are generated by functions like `browse-url-of-region'.
540 You might want to set this to somewhere with restricted read permissions
541 for privacy's sake."
542 :type 'string
543 :group 'browse-url)
545 (defcustom browse-url-netscape-version 3
546 "The version of Netscape you are using.
547 This affects how URL reloading is done; the mechanism changed
548 incompatibly at version 4."
549 :type 'number
550 :group 'browse-url)
552 (defcustom browse-url-text-browser "lynx"
553 "The name of the text browser to invoke."
554 :type 'string
555 :group 'browse-url
556 :version "23.1")
558 (defcustom browse-url-text-emacs-args (and (not window-system)
559 '("-show_cursor"))
560 "A list of strings defining options for a text browser in an Emacs buffer.
562 The default is none in a window system, otherwise `-show_cursor' to
563 indicate the position of the current link in the absence of
564 highlighting, assuming the normal default for showing the cursor."
565 :type '(repeat (string :tag "Argument"))
566 :version "23.1"
567 :group 'browse-url)
569 (defcustom browse-url-text-input-field 'avoid
570 "Action on selecting an existing text browser buffer at an input field.
571 What to do when sending a new URL to an existing text browser buffer in Emacs
572 if the browser cursor is on an input field (in which case the `g' command
573 would be entered as data). Such fields are recognized by the
574 underlines ____. Allowed values: nil: disregard it, `warn': warn the
575 user and don't emit the URL, `avoid': try to avoid the field by moving
576 down (this *won't* always work)."
577 :type '(choice (const :tag "Move to try to avoid field" :value avoid)
578 (const :tag "Disregard" :value nil)
579 (const :tag "Warn, don't emit URL" :value warn))
580 :version "23.1"
581 :group 'browse-url)
583 (defcustom browse-url-text-input-attempts 10
584 "How many times to try to move down from a series of text browser input fields."
585 :type 'integer
586 :version "23.1"
587 :group 'browse-url)
589 (defcustom browse-url-text-input-delay 0.2
590 "Seconds to wait for a text browser between moves down from an input field."
591 :type 'number
592 :version "23.1"
593 :group 'browse-url)
595 (defcustom browse-url-kde-program "kfmclient"
596 "The name by which to invoke the KDE web browser."
597 :type 'string
598 :version "21.1"
599 :group 'browse-url)
601 (defcustom browse-url-kde-args '("openURL")
602 "A list of strings defining options for `browse-url-kde-program'."
603 :type '(repeat (string :tag "Argument"))
604 :group 'browse-url)
606 (defcustom browse-url-elinks-wrapper '("xterm" "-e")
607 "*Wrapper command prepended to the Elinks command-line."
608 :type '(repeat (string :tag "Wrapper"))
609 :group 'browse-url)
611 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
612 ;; URL encoding
614 (defun browse-url-url-encode-chars (text chars)
615 "URL-encode the chars in TEXT that match CHARS.
616 CHARS is a regexp-like character alternative (e.g., \"[,)$]\")."
617 (let ((encoded-text (copy-sequence text))
618 (s 0))
619 (while (setq s (string-match chars encoded-text s))
620 (setq encoded-text
621 (replace-match (format "%%%x"
622 (string-to-char (match-string 0 encoded-text)))
623 t t encoded-text)
624 s (1+ s)))
625 encoded-text))
627 (defun browse-url-encode-url (url)
628 "Escape annoying characters in URL.
629 The annoying characters are those that can mislead a webbrowser
630 regarding its parameter treatment. For instance, `,' can
631 be misleading because it could be used to separate URLs."
632 (browse-url-url-encode-chars url "[,)$]"))
634 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
635 ;; URL input
637 ;;;###autoload
638 (defun browse-url-url-at-point ()
639 (let ((url (thing-at-point 'url)))
640 (set-text-properties 0 (length url) nil url)
641 url))
643 ;; Having this as a separate function called by the browser-specific
644 ;; functions allows them to be stand-alone commands, making it easier
645 ;; to switch between browsers.
647 (defun browse-url-interactive-arg (prompt)
648 "Read a URL from the minibuffer, prompting with PROMPT.
649 If `transient-mark-mode' is non-nil and the mark is active,
650 it defaults to the current region, else to the URL at or before
651 point. If invoked with a mouse button, it moves point to the
652 position clicked before acting.
654 This function returns a list (URL NEW-WINDOW-FLAG)
655 for use in `interactive'."
656 (let ((event (elt (this-command-keys) 0)))
657 (and (listp event) (mouse-set-point event)))
658 (list (read-string prompt (or (and transient-mark-mode mark-active
659 ;; rfc2396 Appendix E.
660 (replace-regexp-in-string
661 "[\t\r\f\n ]+" ""
662 (buffer-substring-no-properties
663 (region-beginning) (region-end))))
664 (browse-url-url-at-point)))
665 (not (eq (null browse-url-new-window-flag)
666 (null current-prefix-arg)))))
668 ;; called-interactive-p needs to be called at a function's top-level, hence
669 ;; this macro. We use that rather than interactive-p because
670 ;; use in a keyboard macro should not change this behavior.
671 (defmacro browse-url-maybe-new-window (arg)
672 `(if (or noninteractive (not (called-interactively-p 'any)))
673 ,arg
674 browse-url-new-window-flag))
676 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
677 ;; Browse current buffer
679 ;;;###autoload
680 (defun browse-url-of-file (&optional file)
681 "Ask a WWW browser to display FILE.
682 Display the current buffer's file if FILE is nil or if called
683 interactively. Turn the filename into a URL with function
684 `browse-url-file-url'. Pass the URL to a browser using the
685 `browse-url' function then run `browse-url-of-file-hook'."
686 (interactive)
687 (or file
688 (setq file (buffer-file-name))
689 (error "Current buffer has no file"))
690 (let ((buf (get-file-buffer file)))
691 (if buf
692 (with-current-buffer buf
693 (cond ((not (buffer-modified-p)))
694 (browse-url-save-file (save-buffer))
695 (t (message "%s modified since last save" file))))))
696 (browse-url (browse-url-file-url file))
697 (run-hooks 'browse-url-of-file-hook))
699 (defun browse-url-file-url (file)
700 "Return the URL corresponding to FILE.
701 Use variable `browse-url-filename-alist' to map filenames to URLs."
702 ;; De-munge Cygwin filenames before passing them to Windows browser.
703 (if (eq system-type 'cygwin)
704 (let ((winfile (with-output-to-string
705 (call-process "cygpath" nil standard-output
706 nil "-m" file))))
707 (setq file (substring winfile 0 -1))))
708 (let ((coding (and (default-value 'enable-multibyte-characters)
709 (or file-name-coding-system
710 default-file-name-coding-system))))
711 (if coding (setq file (encode-coding-string file coding))))
712 (setq file (browse-url-url-encode-chars file "[*\"()',=;?% ]"))
713 (dolist (map browse-url-filename-alist)
714 (when (and map (string-match (car map) file))
715 (setq file (replace-match (cdr map) t nil file))))
716 file)
718 ;;;###autoload
719 (defun browse-url-of-buffer (&optional buffer)
720 "Ask a WWW browser to display BUFFER.
721 Display the current buffer if BUFFER is nil. Display only the
722 currently visible part of BUFFER (from a temporary file) if buffer is
723 narrowed."
724 (interactive)
725 (save-excursion
726 (and buffer (set-buffer buffer))
727 (let ((file-name
728 ;; Ignore real name if restricted
729 (and (= (- (point-max) (point-min)) (buffer-size))
730 (or buffer-file-name
731 (and (boundp 'dired-directory) dired-directory)))))
732 (or file-name
733 (progn
734 (or browse-url-temp-file-name
735 (setq browse-url-temp-file-name
736 (convert-standard-filename
737 (make-temp-file
738 (expand-file-name "burl" browse-url-temp-dir)
739 nil ".html"))))
740 (setq file-name browse-url-temp-file-name)
741 (write-region (point-min) (point-max) file-name nil 'no-message)))
742 (browse-url-of-file file-name))))
744 (defun browse-url-delete-temp-file (&optional temp-file-name)
745 ;; Delete browse-url-temp-file-name from the file system
746 ;; If optional arg TEMP-FILE-NAME is non-nil, delete it instead
747 (let ((file-name (or temp-file-name browse-url-temp-file-name)))
748 (if (and file-name (file-exists-p file-name))
749 (delete-file file-name))))
751 (add-hook 'kill-buffer-hook 'browse-url-delete-temp-file)
753 ;;;###autoload
754 (defun browse-url-of-dired-file ()
755 "In Dired, ask a WWW browser to display the file named on this line."
756 (interactive)
757 (browse-url-of-file (dired-get-filename)))
759 ;;;###autoload
760 (defun browse-url-of-region (min max)
761 "Ask a WWW browser to display the current region."
762 (interactive "r")
763 (save-excursion
764 (save-restriction
765 (narrow-to-region min max)
766 (browse-url-of-buffer))))
768 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
769 ;; Browser-independent commands
771 ;; A generic command to call the current browse-url-browser-function
773 ;;;###autoload
774 (defun browse-url (url &rest args)
775 "Ask a WWW browser to load URL.
776 Prompts for a URL, defaulting to the URL at or before point. Variable
777 `browse-url-browser-function' says which browser to use."
778 (interactive (browse-url-interactive-arg "URL: "))
779 (unless (called-interactively-p 'interactive)
780 (setq args (or args (list browse-url-new-window-flag))))
781 (let ((process-environment (copy-sequence process-environment)))
782 ;; When connected to various displays, be careful to use the display of
783 ;; the currently selected frame, rather than the original start display,
784 ;; which may not even exist any more.
785 (if (stringp (frame-parameter (selected-frame) 'display))
786 (setenv "DISPLAY" (frame-parameter (selected-frame) 'display)))
787 (if (and (consp browse-url-browser-function)
788 (not (functionp browse-url-browser-function)))
789 ;; The `function' can be an alist; look down it for first match
790 ;; and apply the function (which might be a lambda).
791 (catch 'done
792 (dolist (bf browse-url-browser-function)
793 (when (string-match (car bf) url)
794 (apply (cdr bf) url args)
795 (throw 'done t)))
796 (error "No browse-url-browser-function matching URL %s"
797 url))
798 ;; Unbound symbols go down this leg, since void-function from
799 ;; apply is clearer than wrong-type-argument from dolist.
800 (apply browse-url-browser-function url args))))
802 ;;;###autoload
803 (defun browse-url-at-point (&optional arg)
804 "Ask a WWW browser to load the URL at or before point.
805 Doesn't let you edit the URL like `browse-url'. Variable
806 `browse-url-browser-function' says which browser to use."
807 (interactive "P")
808 (let ((url (browse-url-url-at-point)))
809 (if url
810 (browse-url url (if arg
811 (not browse-url-new-window-flag)
812 browse-url-new-window-flag))
813 (error "No URL found"))))
815 ;;;###autoload
816 (defun browse-url-at-mouse (event)
817 "Ask a WWW browser to load a URL clicked with the mouse.
818 The URL is the one around or before the position of the mouse click
819 but point is not changed. Doesn't let you edit the URL like
820 `browse-url'. Variable `browse-url-browser-function' says which browser
821 to use."
822 (interactive "e")
823 (save-excursion
824 (mouse-set-point event)
825 ;; This handles browse-url-new-window-flag properly
826 ;; when it gets no arg.
827 (browse-url-at-point)))
829 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
830 ;; Browser-specific commands
832 ;; --- Default MS-Windows browser ---
834 (defvar dos-windows-version)
835 (declare-function w32-shell-execute "w32fns.c") ;; Defined in C.
837 (defun browse-url-default-windows-browser (url &optional new-window)
838 (interactive (browse-url-interactive-arg "URL: "))
839 (cond ((eq system-type 'ms-dos)
840 (if dos-windows-version
841 (shell-command (concat "start " (shell-quote-argument url)))
842 (error "Browsing URLs is not supported on this system")))
843 ((eq system-type 'cygwin)
844 (call-process "cygstart" nil nil nil url))
845 (t (w32-shell-execute "open" url))))
847 (defun browse-url-default-macosx-browser (url &optional new-window)
848 (interactive (browse-url-interactive-arg "URL: "))
849 (start-process (concat "open " url) nil "open" url))
851 ;; --- Netscape ---
853 (defun browse-url-process-environment ()
854 "Set DISPLAY in the environment to the X display the browser will use.
855 This is either the value of variable `browse-url-browser-display' if
856 non-nil, or the same display as Emacs if different from the current
857 environment, otherwise just use the current environment."
858 (let ((display (or browse-url-browser-display (browse-url-emacs-display))))
859 (if display
860 (cons (concat "DISPLAY=" display) process-environment)
861 process-environment)))
863 (defun browse-url-emacs-display ()
864 "Return the X display Emacs is running on.
865 This is nil if the display is the same as the DISPLAY environment variable.
867 Actually Emacs could be using several displays; this just returns the
868 one showing the selected frame."
869 (let ((display (cdr-safe (assq 'display (frame-parameters)))))
870 (and (not (equal display (getenv "DISPLAY")))
871 display)))
873 ;;;###autoload
874 (defun browse-url-default-browser (url &rest args)
875 "Find a suitable browser and ask it to load URL.
876 Default to the URL around or before point.
878 When called interactively, if variable `browse-url-new-window-flag' is
879 non-nil, load the document in a new window, if possible, otherwise use
880 a random existing one. A non-nil interactive prefix argument reverses
881 the effect of `browse-url-new-window-flag'.
883 When called non-interactively, optional second argument NEW-WINDOW is
884 used instead of `browse-url-new-window-flag'.
886 The order attempted is gnome-moz-remote, Mozilla, Firefox,
887 Galeon, Konqueror, Netscape, Mosaic, Lynx in an xterm, and then W3."
888 (apply
889 (cond
890 ((executable-find browse-url-gnome-moz-program) 'browse-url-gnome-moz)
891 ((executable-find browse-url-mozilla-program) 'browse-url-mozilla)
892 ((executable-find browse-url-firefox-program) 'browse-url-firefox)
893 ((executable-find browse-url-galeon-program) 'browse-url-galeon)
894 ((executable-find browse-url-kde-program) 'browse-url-kde)
895 ((executable-find browse-url-netscape-program) 'browse-url-netscape)
896 ((executable-find browse-url-mosaic-program) 'browse-url-mosaic)
897 ((executable-find browse-url-xterm-program) 'browse-url-text-xterm)
898 ((locate-library "w3") 'browse-url-w3)
900 (lambda (&rest ignore) (error "No usable browser found"))))
901 url args))
903 ;;;###autoload
904 (defun browse-url-netscape (url &optional new-window)
905 "Ask the Netscape WWW browser to load URL.
906 Default to the URL around or before point. The strings in variable
907 `browse-url-netscape-arguments' are also passed to Netscape.
909 When called interactively, if variable `browse-url-new-window-flag' is
910 non-nil, load the document in a new Netscape window, otherwise use a
911 random existing one. A non-nil interactive prefix argument reverses
912 the effect of `browse-url-new-window-flag'.
914 If `browse-url-netscape-new-window-is-tab' is non-nil, then
915 whenever a document would otherwise be loaded in a new window, it
916 is loaded in a new tab in an existing window instead.
918 When called non-interactively, optional second argument NEW-WINDOW is
919 used instead of `browse-url-new-window-flag'."
920 (interactive (browse-url-interactive-arg "URL: "))
921 (setq url (browse-url-encode-url url))
922 (let* ((process-environment (browse-url-process-environment))
923 (process
924 (apply 'start-process
925 (concat "netscape " url) nil
926 browse-url-netscape-program
927 (append
928 browse-url-netscape-arguments
929 (if (eq window-system 'w32)
930 (list url)
931 (append
932 (if new-window '("-noraise"))
933 (list "-remote"
934 (concat "openURL(" url
935 (if (browse-url-maybe-new-window
936 new-window)
937 (if browse-url-netscape-new-window-is-tab
938 ",new-tab"
939 ",new-window"))
940 ")"))))))))
941 (set-process-sentinel process
942 `(lambda (process change)
943 (browse-url-netscape-sentinel process ,url)))))
945 (defun browse-url-netscape-sentinel (process url)
946 "Handle a change to the process communicating with Netscape."
947 (or (eq (process-exit-status process) 0)
948 (let* ((process-environment (browse-url-process-environment)))
949 ;; Netscape not running - start it
950 (message "Starting %s..." browse-url-netscape-program)
951 (apply 'start-process (concat "netscape" url) nil
952 browse-url-netscape-program
953 (append browse-url-netscape-startup-arguments (list url))))))
955 (defun browse-url-netscape-reload ()
956 "Ask Netscape to reload its current document.
957 How depends on `browse-url-netscape-version'."
958 (interactive)
959 ;; Backwards incompatibility reported by
960 ;; <peter.kruse@psychologie.uni-regensburg.de>.
961 (browse-url-netscape-send (if (>= browse-url-netscape-version 4)
962 "xfeDoCommand(reload)"
963 "reload")))
965 (defun browse-url-netscape-send (command)
966 "Send a remote control command to Netscape."
967 (let* ((process-environment (browse-url-process-environment)))
968 (apply 'start-process "netscape" nil
969 browse-url-netscape-program
970 (append browse-url-netscape-arguments
971 (list "-remote" command)))))
973 ;;;###autoload
974 (defun browse-url-mozilla (url &optional new-window)
975 "Ask the Mozilla WWW browser to load URL.
976 Default to the URL around or before point. The strings in variable
977 `browse-url-mozilla-arguments' are also passed to Mozilla.
979 When called interactively, if variable `browse-url-new-window-flag' is
980 non-nil, load the document in a new Mozilla window, otherwise use a
981 random existing one. A non-nil interactive prefix argument reverses
982 the effect of `browse-url-new-window-flag'.
984 If `browse-url-mozilla-new-window-is-tab' is non-nil, then whenever a
985 document would otherwise be loaded in a new window, it is loaded in a
986 new tab in an existing window instead.
988 When called non-interactively, optional second argument NEW-WINDOW is
989 used instead of `browse-url-new-window-flag'."
990 (interactive (browse-url-interactive-arg "URL: "))
991 (setq url (browse-url-encode-url url))
992 (let* ((process-environment (browse-url-process-environment))
993 (process
994 (apply 'start-process
995 (concat "mozilla " url) nil
996 browse-url-mozilla-program
997 (append
998 browse-url-mozilla-arguments
999 (list "-remote"
1000 (concat "openURL("
1002 (if (browse-url-maybe-new-window
1003 new-window)
1004 (if browse-url-mozilla-new-window-is-tab
1005 ",new-tab"
1006 ",new-window"))
1007 ")"))))))
1008 (set-process-sentinel process
1009 `(lambda (process change)
1010 (browse-url-mozilla-sentinel process ,url)))))
1012 (defun browse-url-mozilla-sentinel (process url)
1013 "Handle a change to the process communicating with Mozilla."
1014 (or (eq (process-exit-status process) 0)
1015 (let* ((process-environment (browse-url-process-environment)))
1016 ;; Mozilla is not running - start it
1017 (message "Starting %s..." browse-url-mozilla-program)
1018 (apply 'start-process (concat "mozilla " url) nil
1019 browse-url-mozilla-program
1020 (append browse-url-mozilla-startup-arguments (list url))))))
1022 ;;;###autoload
1023 (defun browse-url-firefox (url &optional new-window)
1024 "Ask the Firefox WWW browser to load URL.
1025 Default to the URL around or before point. The strings in
1026 variable `browse-url-firefox-arguments' are also passed to
1027 Firefox.
1029 When called interactively, if variable
1030 `browse-url-new-window-flag' is non-nil, load the document in a
1031 new Firefox window, otherwise use a random existing one. A
1032 non-nil interactive prefix argument reverses the effect of
1033 `browse-url-new-window-flag'.
1035 If `browse-url-firefox-new-window-is-tab' is non-nil, then
1036 whenever a document would otherwise be loaded in a new window, it
1037 is loaded in a new tab in an existing window instead.
1039 When called non-interactively, optional second argument
1040 NEW-WINDOW is used instead of `browse-url-new-window-flag'.
1042 On MS-Windows systems the optional `new-window' parameter is
1043 ignored. Firefox for Windows does not support the \"-remote\"
1044 command line parameter. Therefore, the
1045 `browse-url-new-window-flag' and `browse-url-firefox-new-window-is-tab'
1046 are ignored as well. Firefox on Windows will always open the requested
1047 URL in a new window."
1048 (interactive (browse-url-interactive-arg "URL: "))
1049 (setq url (browse-url-encode-url url))
1050 (let* ((process-environment (browse-url-process-environment))
1051 (process
1052 (apply 'start-process
1053 (concat "firefox " url) nil
1054 browse-url-firefox-program
1055 (append
1056 browse-url-firefox-arguments
1057 (if (or (featurep 'dos-w32)
1058 (string-match "win32" system-configuration))
1059 (list url)
1060 (list "-remote"
1061 (concat "openURL("
1063 (if (browse-url-maybe-new-window
1064 new-window)
1065 (if browse-url-firefox-new-window-is-tab
1066 ",new-tab"
1067 ",new-window"))
1068 ")")))))))
1069 (set-process-sentinel process
1070 `(lambda (process change)
1071 (browse-url-firefox-sentinel process ,url)))))
1073 (defun browse-url-firefox-sentinel (process url)
1074 "Handle a change to the process communicating with Firefox."
1075 (or (eq (process-exit-status process) 0)
1076 (let* ((process-environment (browse-url-process-environment)))
1077 ;; Firefox is not running - start it
1078 (message "Starting Firefox...")
1079 (apply 'start-process (concat "firefox " url) nil
1080 browse-url-firefox-program
1081 (append browse-url-firefox-startup-arguments (list url))))))
1083 ;;;###autoload
1084 (defun browse-url-galeon (url &optional new-window)
1085 "Ask the Galeon WWW browser to load URL.
1086 Default to the URL around or before point. The strings in variable
1087 `browse-url-galeon-arguments' are also passed to Galeon.
1089 When called interactively, if variable `browse-url-new-window-flag' is
1090 non-nil, load the document in a new Galeon window, otherwise use a
1091 random existing one. A non-nil interactive prefix argument reverses
1092 the effect of `browse-url-new-window-flag'.
1094 If `browse-url-galeon-new-window-is-tab' is non-nil, then whenever a
1095 document would otherwise be loaded in a new window, it is loaded in a
1096 new tab in an existing window instead.
1098 When called non-interactively, optional second argument NEW-WINDOW is
1099 used instead of `browse-url-new-window-flag'."
1100 (interactive (browse-url-interactive-arg "URL: "))
1101 (setq url (browse-url-encode-url url))
1102 (let* ((process-environment (browse-url-process-environment))
1103 (process (apply 'start-process
1104 (concat "galeon " url)
1106 browse-url-galeon-program
1107 (append
1108 browse-url-galeon-arguments
1109 (if (browse-url-maybe-new-window new-window)
1110 (if browse-url-galeon-new-window-is-tab
1111 '("--new-tab")
1112 '("--new-window" "--noraise"))
1113 '("--existing"))
1114 (list url)))))
1115 (set-process-sentinel process
1116 `(lambda (process change)
1117 (browse-url-galeon-sentinel process ,url)))))
1119 (defun browse-url-galeon-sentinel (process url)
1120 "Handle a change to the process communicating with Galeon."
1121 (or (eq (process-exit-status process) 0)
1122 (let* ((process-environment (browse-url-process-environment)))
1123 ;; Galeon is not running - start it
1124 (message "Starting %s..." browse-url-galeon-program)
1125 (apply 'start-process (concat "galeon " url) nil
1126 browse-url-galeon-program
1127 (append browse-url-galeon-startup-arguments (list url))))))
1129 (defun browse-url-epiphany (url &optional new-window)
1130 "Ask the Epiphany WWW browser to load URL.
1131 Default to the URL around or before point. The strings in variable
1132 `browse-url-galeon-arguments' are also passed to Epiphany.
1134 When called interactively, if variable `browse-url-new-window-flag' is
1135 non-nil, load the document in a new Epiphany window, otherwise use a
1136 random existing one. A non-nil interactive prefix argument reverses
1137 the effect of `browse-url-new-window-flag'.
1139 If `browse-url-epiphany-new-window-is-tab' is non-nil, then whenever a
1140 document would otherwise be loaded in a new window, it is loaded in a
1141 new tab in an existing window instead.
1143 When called non-interactively, optional second argument NEW-WINDOW is
1144 used instead of `browse-url-new-window-flag'."
1145 (interactive (browse-url-interactive-arg "URL: "))
1146 (setq url (browse-url-encode-url url))
1147 (let* ((process-environment (browse-url-process-environment))
1148 (process (apply 'start-process
1149 (concat "epiphany " url)
1151 browse-url-epiphany-program
1152 (append
1153 browse-url-epiphany-arguments
1154 (if (browse-url-maybe-new-window new-window)
1155 (if browse-url-epiphany-new-window-is-tab
1156 '("--new-tab")
1157 '("--new-window" "--noraise"))
1158 '("--existing"))
1159 (list url)))))
1160 (set-process-sentinel process
1161 `(lambda (process change)
1162 (browse-url-epiphany-sentinel process ,url)))))
1164 (defun browse-url-epiphany-sentinel (process url)
1165 "Handle a change to the process communicating with Epiphany."
1166 (or (eq (process-exit-status process) 0)
1167 (let* ((process-environment (browse-url-process-environment)))
1168 ;; Epiphany is not running - start it
1169 (message "Starting %s..." browse-url-epiphany-program)
1170 (apply 'start-process (concat "epiphany " url) nil
1171 browse-url-epiphany-program
1172 (append browse-url-epiphany-startup-arguments (list url))))))
1174 (defvar url-handler-regexp)
1176 ;;;###autoload
1177 (defun browse-url-emacs (url &optional new-window)
1178 "Ask Emacs to load URL into a buffer and show it in another window."
1179 (interactive (browse-url-interactive-arg "URL: "))
1180 (require 'url-handlers)
1181 (let ((file-name-handler-alist
1182 (cons (cons url-handler-regexp 'url-file-handler)
1183 file-name-handler-alist)))
1184 ;; Ignore `new-window': with all other browsers the URL is always shown
1185 ;; in another window than the current Emacs one since it's shown in
1186 ;; another application's window.
1187 ;; (if new-window (find-file-other-window url) (find-file url))
1188 (find-file-other-window url)))
1190 ;;;###autoload
1191 (defun browse-url-gnome-moz (url &optional new-window)
1192 "Ask Mozilla/Netscape to load URL via the GNOME program `gnome-moz-remote'.
1193 Default to the URL around or before point. The strings in variable
1194 `browse-url-gnome-moz-arguments' are also passed.
1196 When called interactively, if variable `browse-url-new-window-flag' is
1197 non-nil, load the document in a new browser window, otherwise use an
1198 existing one. A non-nil interactive prefix argument reverses the
1199 effect of `browse-url-new-window-flag'.
1201 When called non-interactively, optional second argument NEW-WINDOW is
1202 used instead of `browse-url-new-window-flag'."
1203 (interactive (browse-url-interactive-arg "URL: "))
1204 (apply 'start-process (concat "gnome-moz-remote " url)
1206 browse-url-gnome-moz-program
1207 (append
1208 browse-url-gnome-moz-arguments
1209 (if (browse-url-maybe-new-window new-window)
1210 '("--newwin"))
1211 (list "--raise" url))))
1213 ;; --- Mosaic ---
1215 ;;;###autoload
1216 (defun browse-url-mosaic (url &optional new-window)
1217 "Ask the XMosaic WWW browser to load URL.
1219 Default to the URL around or before point. The strings in variable
1220 `browse-url-mosaic-arguments' are also passed to Mosaic and the
1221 program is invoked according to the variable
1222 `browse-url-mosaic-program'.
1224 When called interactively, if variable `browse-url-new-window-flag' is
1225 non-nil, load the document in a new Mosaic window, otherwise use a
1226 random existing one. A non-nil interactive prefix argument reverses
1227 the effect of `browse-url-new-window-flag'.
1229 When called non-interactively, optional second argument NEW-WINDOW is
1230 used instead of `browse-url-new-window-flag'."
1231 (interactive (browse-url-interactive-arg "Mosaic URL: "))
1232 (let ((pidfile (expand-file-name browse-url-mosaic-pidfile))
1233 pid)
1234 (if (file-readable-p pidfile)
1235 (save-excursion
1236 (find-file pidfile)
1237 (goto-char (point-min))
1238 (setq pid (read (current-buffer)))
1239 (kill-buffer nil)))
1240 (if (and pid (zerop (signal-process pid 0))) ; Mosaic running
1241 (save-excursion
1242 (find-file (format "/tmp/Mosaic.%d" pid))
1243 (erase-buffer)
1244 (insert (if (browse-url-maybe-new-window new-window)
1245 "newwin\n"
1246 "goto\n")
1247 url "\n")
1248 (save-buffer)
1249 (kill-buffer nil)
1250 ;; Send signal SIGUSR to Mosaic
1251 (message "Signaling Mosaic...")
1252 (signal-process pid 'SIGUSR1)
1253 ;; Or you could try:
1254 ;; (call-process "kill" nil 0 nil "-USR1" (int-to-string pid))
1255 (message "Signaling Mosaic...done")
1257 ;; Mosaic not running - start it
1258 (message "Starting %s..." browse-url-mosaic-program)
1259 (apply 'start-process "xmosaic" nil browse-url-mosaic-program
1260 (append browse-url-mosaic-arguments (list url)))
1261 (message "Starting %s...done" browse-url-mosaic-program))))
1263 ;; --- Mosaic using CCI ---
1265 ;;;###autoload
1266 (defun browse-url-cci (url &optional new-window)
1267 "Ask the XMosaic WWW browser to load URL.
1268 Default to the URL around or before point.
1270 This function only works for XMosaic version 2.5 or later. You must
1271 select `CCI' from XMosaic's File menu, set the CCI Port Address to the
1272 value of variable `browse-url-CCI-port', and enable `Accept requests'.
1274 When called interactively, if variable `browse-url-new-window-flag' is
1275 non-nil, load the document in a new browser window, otherwise use a
1276 random existing one. A non-nil interactive prefix argument reverses
1277 the effect of `browse-url-new-window-flag'.
1279 When called non-interactively, optional second argument NEW-WINDOW is
1280 used instead of `browse-url-new-window-flag'."
1281 (interactive (browse-url-interactive-arg "Mosaic URL: "))
1282 (open-network-stream "browse-url" " *browse-url*"
1283 browse-url-CCI-host browse-url-CCI-port)
1284 ;; Todo: start browser if fails
1285 (process-send-string "browse-url"
1286 (concat "get url (" url ") output "
1287 (if (browse-url-maybe-new-window new-window)
1288 "new"
1289 "current")
1290 "\r\n"))
1291 (process-send-string "browse-url" "disconnect\r\n")
1292 (delete-process "browse-url"))
1294 ;; --- W3 ---
1296 ;; External.
1297 (declare-function w3-fetch-other-window "ext:w3m" (&optional url))
1298 (declare-function w3-fetch "ext:w3m" (&optional url target))
1300 ;;;###autoload
1301 (defun browse-url-w3 (url &optional new-window)
1302 "Ask the w3 WWW browser to load URL.
1303 Default to the URL around or before point.
1305 When called interactively, if variable `browse-url-new-window-flag' is
1306 non-nil, load the document in a new window. A non-nil interactive
1307 prefix argument reverses the effect of `browse-url-new-window-flag'.
1309 When called non-interactively, optional second argument NEW-WINDOW is
1310 used instead of `browse-url-new-window-flag'."
1311 (interactive (browse-url-interactive-arg "W3 URL: "))
1312 (require 'w3) ; w3-fetch-other-window not autoloaded
1313 (if (browse-url-maybe-new-window new-window)
1314 (w3-fetch-other-window url)
1315 (w3-fetch url)))
1317 ;;;###autoload
1318 (defun browse-url-w3-gnudoit (url &optional new-window)
1319 ;; new-window ignored
1320 "Ask another Emacs running gnuserv to load the URL using the W3 browser.
1321 The `browse-url-gnudoit-program' program is used with options given by
1322 `browse-url-gnudoit-args'. Default to the URL around or before point."
1323 (interactive (browse-url-interactive-arg "W3 URL: "))
1324 (apply 'start-process (concat "gnudoit:" url) nil
1325 browse-url-gnudoit-program
1326 (append browse-url-gnudoit-args
1327 (list (concat "(w3-fetch \"" url "\")")
1328 "(raise-frame)"))))
1330 ;; --- Lynx in an xterm ---
1332 ;;;###autoload
1333 (defun browse-url-text-xterm (url &optional new-window)
1334 ;; new-window ignored
1335 "Ask a text browser to load URL.
1336 URL defaults to the URL around or before point.
1337 This runs the text browser specified by `browse-url-text-browser'.
1338 in an Xterm window using the Xterm program named by `browse-url-xterm-program'
1339 with possible additional arguments `browse-url-xterm-args'."
1340 (interactive (browse-url-interactive-arg "Text browser URL: "))
1341 (apply #'start-process `(,(concat browse-url-text-browser url)
1342 nil ,browse-url-xterm-program
1343 ,@browse-url-xterm-args "-e" ,browse-url-text-browser
1344 ,url)))
1346 ;; --- Lynx in an Emacs "term" window ---
1348 ;;;###autoload
1349 (defun browse-url-text-emacs (url &optional new-buffer)
1350 "Ask a text browser to load URL.
1351 URL defaults to the URL around or before point.
1352 This runs the text browser specified by `browse-url-text-browser'.
1353 With a prefix argument, it runs a new browser process in a new buffer.
1355 When called interactively, if variable `browse-url-new-window-flag' is
1356 non-nil, load the document in a new browser process in a new term window,
1357 otherwise use any existing one. A non-nil interactive prefix argument
1358 reverses the effect of `browse-url-new-window-flag'.
1360 When called non-interactively, optional second argument NEW-WINDOW is
1361 used instead of `browse-url-new-window-flag'."
1362 (interactive (browse-url-interactive-arg "Text browser URL: "))
1363 (let* ((system-uses-terminfo t) ; Lynx uses terminfo
1364 ;; (term-term-name "vt100") ; ??
1365 (buf (get-buffer "*text browser*"))
1366 (proc (and buf (get-buffer-process buf)))
1367 (n browse-url-text-input-attempts))
1368 (if (and (browse-url-maybe-new-window new-buffer) buf)
1369 ;; Rename away the OLD buffer. This isn't very polite, but
1370 ;; term insists on working in a buffer named *lynx* and would
1371 ;; choke on *lynx*<1>
1372 (progn (set-buffer buf)
1373 (rename-uniquely)))
1374 (if (or (browse-url-maybe-new-window new-buffer)
1375 (not buf)
1376 (not proc)
1377 (not (memq (process-status proc) '(run stop))))
1378 ;; start a new text browser
1379 (progn
1380 (setq buf
1381 (apply #'make-term
1382 `(,browse-url-text-browser
1383 ,browse-url-text-browser
1384 nil ,@browse-url-text-emacs-args
1385 ,url)))
1386 (switch-to-buffer buf)
1387 (term-char-mode)
1388 (set-process-sentinel
1389 (get-buffer-process buf)
1390 ;; Don't leave around a dead one (especially because of its
1391 ;; munged keymap.)
1392 (lambda (process event)
1393 (if (not (memq (process-status process) '(run stop)))
1394 (let ((buf (process-buffer process)))
1395 (if buf (kill-buffer buf)))))))
1396 ;; Send the url to the text browser in the old buffer
1397 (let ((win (get-buffer-window buf t)))
1398 (if win
1399 (select-window win)
1400 (switch-to-buffer buf)))
1401 (if (eq (following-char) ?_)
1402 (cond ((eq browse-url-text-input-field 'warn)
1403 (error "Please move out of the input field first"))
1404 ((eq browse-url-text-input-field 'avoid)
1405 (while (and (eq (following-char) ?_) (> n 0))
1406 (term-send-down) ; down arrow
1407 (sit-for browse-url-text-input-delay))
1408 (if (eq (following-char) ?_)
1409 (error "Cannot move out of the input field, sorry")))))
1410 (term-send-string proc (concat "g" ; goto
1411 "\C-u" ; kill default url
1413 "\r")))))
1415 ;; --- mailto ---
1417 (autoload 'rfc2368-parse-mailto-url "rfc2368")
1419 ;;;###autoload
1420 (defun browse-url-mail (url &optional new-window)
1421 "Open a new mail message buffer within Emacs for the RFC 2368 URL.
1422 Default to using the mailto: URL around or before point as the
1423 recipient's address. Supplying a non-nil interactive prefix argument
1424 will cause the mail to be composed in another window rather than the
1425 current one.
1427 When called interactively, if variable `browse-url-new-window-flag' is
1428 non-nil use `compose-mail-other-window', otherwise `compose-mail'. A
1429 non-nil interactive prefix argument reverses the effect of
1430 `browse-url-new-window-flag'.
1432 When called non-interactively, optional second argument NEW-WINDOW is
1433 used instead of `browse-url-new-window-flag'."
1434 (interactive (browse-url-interactive-arg "Mailto URL: "))
1435 (save-excursion
1436 (let* ((alist (rfc2368-parse-mailto-url url))
1437 (to (assoc "To" alist))
1438 (subject (assoc "Subject" alist))
1439 (body (assoc "Body" alist))
1440 (rest (delete to (delete subject (delete body alist))))
1441 (to (cdr to))
1442 (subject (cdr subject))
1443 (body (cdr body))
1444 (mail-citation-hook (unless body mail-citation-hook)))
1445 (if (browse-url-maybe-new-window new-window)
1446 (compose-mail-other-window to subject rest nil
1447 (if body
1448 (list 'insert body)
1449 (list 'insert-buffer (current-buffer))))
1450 (compose-mail to subject rest nil nil
1451 (if body
1452 (list 'insert body)
1453 (list 'insert-buffer (current-buffer))))))))
1455 ;; --- Random browser ---
1457 ;;;###autoload
1458 (defun browse-url-generic (url &optional new-window)
1459 ;; new-window ignored
1460 "Ask the WWW browser defined by `browse-url-generic-program' to load URL.
1461 Default to the URL around or before point. A fresh copy of the
1462 browser is started up in a new process with possible additional arguments
1463 `browse-url-generic-args'. This is appropriate for browsers which
1464 don't offer a form of remote control."
1465 (interactive (browse-url-interactive-arg "URL: "))
1466 (if (not browse-url-generic-program)
1467 (error "No browser defined (`browse-url-generic-program')"))
1468 (apply 'call-process browse-url-generic-program nil
1469 0 nil
1470 (append browse-url-generic-args (list url))))
1472 ;;;###autoload
1473 (defun browse-url-kde (url &optional new-window)
1474 "Ask the KDE WWW browser to load URL.
1475 Default to the URL around or before point."
1476 (interactive (browse-url-interactive-arg "KDE URL: "))
1477 (message "Sending URL to KDE...")
1478 (apply #'start-process (concat "KDE " url) nil browse-url-kde-program
1479 (append browse-url-kde-args (list url))))
1481 (defun browse-url-elinks-new-window (url)
1482 "Ask the Elinks WWW browser to load URL in a new window."
1483 (let ((process-environment (browse-url-process-environment)))
1484 (apply #'start-process
1485 (append (list (concat "elinks:" url)
1486 nil)
1487 browse-url-elinks-wrapper
1488 (list "elinks" url)))))
1490 ;;;###autoload
1491 (defun browse-url-elinks (url &optional new-window)
1492 "Ask the Elinks WWW browser to load URL.
1493 Default to the URL around the point.
1495 The document is loaded in a new tab of a running Elinks or, if
1496 none yet running, a newly started instance.
1498 The Elinks command will be prepended by the program+arguments
1499 from `browse-url-elinks-wrapper'."
1500 (interactive (browse-url-interactive-arg "URL: "))
1501 (setq url (browse-url-encode-url url))
1502 (if new-window
1503 (browse-url-elinks-new-window url)
1504 (let ((process-environment (browse-url-process-environment))
1505 (elinks-ping-process (start-process "elinks-ping" nil
1506 "elinks" "-remote" "ping()")))
1507 (set-process-sentinel elinks-ping-process
1508 `(lambda (process change)
1509 (browse-url-elinks-sentinel process ,url))))))
1511 (defun browse-url-elinks-sentinel (process url)
1512 "Determines if Elinks is running or a new one has to be started."
1513 (let ((exit-status (process-exit-status process)))
1514 ;; Try to determine if an instance is running or if we have to
1515 ;; create a new one.
1516 (case exit-status
1518 ;; No instance, start a new one.
1519 (browse-url-elinks-new-window url))
1521 ;; Found an instance, open URL in new tab.
1522 (let ((process-environment (browse-url-process-environment)))
1523 (start-process (concat "elinks:" url) nil
1524 "elinks" "-remote"
1525 (concat "openURL(\"" url "\",new-tab)"))))
1526 (otherwise
1527 (error "Unrecognized exit-code %d of process `elinks'"
1528 exit-status)))))
1530 (provide 'browse-url)
1532 ;; arch-tag: d2079573-5c06-4097-9598-f550fba19430
1533 ;;; browse-url.el ends here