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 Free Software Foundation, Inc.
6 ;; Author: Denis Howe <dbh@doc.ic.ac.uk>
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 2, or (at your option)
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; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26 ;; Boston, MA 02110-1301, USA.
30 ;; This package provides functions which read a URL (Uniform Resource
31 ;; Locator) from the minibuffer, defaulting to the URL around point,
32 ;; and ask a World-Wide Web browser to load it. It can also load the
33 ;; URL associated with the current buffer. Different browsers use
34 ;; different methods of remote control so there is one function for
35 ;; each supported browser. If the chosen browser is not running, it
36 ;; is started. Currently there is support for the following browsers,
37 ;; some of them probably now obsolete:
39 ;; Function Browser Earliest version
40 ;; browse-url-mozilla Mozilla Don't know
41 ;; browse-url-firefox Firefox Don't know (tried with 1.0.1)
42 ;; browse-url-galeon Galeon Don't know
43 ;; browse-url-epiphany Epiphany Don't know
44 ;; browse-url-netscape Netscape 1.1b1
45 ;; browse-url-mosaic XMosaic/mMosaic <= 2.4
46 ;; browse-url-cci XMosaic 2.5
48 ;; browse-url-w3-gnudoit w3 remotely
49 ;; browse-url-iximosaic IXI Mosaic ?
50 ;; browse-url-lynx-* Lynx 0
51 ;; browse-url-grail Grail 0.3b1
52 ;; browse-url-mmm MMM ?
53 ;; browse-url-generic arbitrary
54 ;; browse-url-default-windows-browser MS-Windows browser
55 ;; browse-url-default-macosx-browser Mac OS X browser
56 ;; browse-url-gnome-moz GNOME interface to Mozilla
57 ;; browse-url-kde KDE konqueror (kfm)
59 ;; [A version of the Netscape browser is now free software
60 ;; <URL:http://www.mozilla.org/>, albeit not GPLed, so it is
61 ;; reasonable to have that as the default.]
63 ;; Note that versions of Netscape before 1.1b1 did not have remote
64 ;; control. <URL:http://www.netscape.com/newsref/std/x-remote.html>.
66 ;; Browsers can cache Web pages so it may be necessary to tell them to
67 ;; reload the current page if it has changed (e.g. if you have edited
68 ;; it). There is currently no perfect automatic solution to this.
70 ;; Netscape allows you to specify the id of the window you want to
71 ;; control but which window DO you want to control and how do you
74 ;; William M. Perry's excellent "w3" WWW browser for
75 ;; Emacs <URL:ftp://cs.indiana.edu/pub/elisp/w3/>
76 ;; has a function w3-follow-url-at-point, but that
77 ;; doesn't let you edit the URL like browse-url.
78 ;; The `gnuserv' package that can be used to control it in another
79 ;; Emacs process is available from
80 ;; <URL:ftp://ftp.splode.com/pub/users/friedman/packages/>.
82 ;; Grail is the freely available WWW browser implemented in Python, a
83 ;; cool object-oriented freely available interpreted language. Grail
84 ;; 0.3b1 was the first version to have remote control as distributed.
85 ;; For more information on Grail see
86 ;; <URL:http://grail.cnri.reston.va.us/> and for more information on
87 ;; Python see <url:http://www.python.org/>. Grail support in
88 ;; browse-url.el written by Barry Warsaw <bwarsaw@python.org>.
90 ;; Lynx is now distributed by the FSF. See also
91 ;; <URL:http://lynx.browser.org/>.
93 ;; Free graphical browsers that could be used by `browse-url-generic'
94 ;; include Chimera <URL:ftp://ftp.cs.unlv.edu/pub/chimera> and
95 ;; <URL:http://www.unlv.edu/chimera/>, Arena
96 ;; <URL:ftp://ftp.yggdrasil.com/pub/dist/web/arena> and Amaya
97 ;; <URL:ftp://ftp.w3.org/pub/amaya>. mMosaic
98 ;; <URL:ftp://ftp.enst.fr/pub/mbone/mMosaic/>,
99 ;; <URL:http://www.enst.fr/~dauphin/mMosaic/> (with development
100 ;; support for Java applets and multicast) can be used like Mosaic by
101 ;; setting `browse-url-mosaic-program' appropriately.
103 ;; I [Denis Howe, not Dave Love] recommend Nelson Minar
104 ;; <nelson@santafe.edu>'s excellent html-helper-mode.el for editing
105 ;; HTML and thank Nelson for his many useful comments on this code.
106 ;; <URL:http://www.santafe.edu/%7Enelson/hhm-beta/>
108 ;; See also hm--html-menus <URL:http://www.tnt.uni-hannover.de/%7Emuenkel/
109 ;; software/own/hm--html-menus/>. For composing correct HTML see also
110 ;; PSGML the general SGML structure editor package
111 ;; <URL:ftp://ftp.lysator.liu.se/pub/sgml>; hm--html-menus can be used
114 ;; This package generalises function html-previewer-process in Marc
115 ;; Andreessen's html-mode (LCD modes/html-mode.el.Z). See also the
116 ;; ffap.el package. The huge hyperbole package also contains similar
119 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
122 ;; Can you write and test some code for the Macintrash and Windoze
123 ;; Netscape remote control APIs? (See the URL above).
125 ;; Do any other browsers have remote control?
127 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
130 ;; To display the URL at or before point:
131 ;; M-x browse-url-at-point RET
132 ;; or, similarly but with the opportunity to edit the URL extracted from
136 ;; To display a URL by shift-clicking on it, put this in your ~/.emacs
138 ;; (global-set-key [S-mouse-2] 'browse-url-at-mouse)
139 ;; (Note that using Shift-mouse-1 is not desirable because
140 ;; that event has a standard meaning in Emacs.)
142 ;; To display the current buffer in a web browser:
143 ;; M-x browse-url-of-buffer RET
145 ;; To display the current region in a web browser:
146 ;; M-x browse-url-of-region RET
148 ;; In Dired, to display the file named on the current line:
149 ;; M-x browse-url-of-dired-file RET
151 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
152 ;; Customisation (~/.emacs)
154 ;; To see what variables are available for customization, type
155 ;; `M-x set-variable browse-url TAB'. Better, use
156 ;; `M-x customize-group browse-url'.
158 ;; Bind the browse-url commands to keys with the `C-c C-z' prefix
159 ;; (as used by html-helper-mode):
160 ;; (global-set-key "\C-c\C-z." 'browse-url-at-point)
161 ;; (global-set-key "\C-c\C-zb" 'browse-url-of-buffer)
162 ;; (global-set-key "\C-c\C-zr" 'browse-url-of-region)
163 ;; (global-set-key "\C-c\C-zu" 'browse-url)
164 ;; (global-set-key "\C-c\C-zv" 'browse-url-of-file)
165 ;; (add-hook 'dired-mode-hook
167 ;; (local-set-key "\C-c\C-zf" 'browse-url-of-dired-file)))
169 ;; Browse URLs in mail messages under RMAIL by clicking mouse-2:
170 ;; (add-hook 'rmail-mode-hook (lambda () ; rmail-mode startup
171 ;; (define-key rmail-mode-map [mouse-2] 'browse-url-at-mouse)))
172 ;; Alternatively, add `goto-address' to `rmail-show-message-hook'.
174 ;; Gnus provides a standard feature to activate URLs in article
175 ;; buffers for invocation of browse-url.
177 ;; Use the Emacs w3 browser when not running under X11:
178 ;; (or (eq window-system 'x)
179 ;; (setq browse-url-browser-function 'browse-url-w3))
181 ;; To always save modified buffers before displaying the file in a browser:
182 ;; (setq browse-url-save-file t)
184 ;; To get round the Netscape caching problem, you could EITHER have
185 ;; write-file in html-helper-mode make Netscape reload the document:
187 ;; (autoload 'browse-url-netscape-reload "browse-url"
188 ;; "Ask a WWW browser to redisplay the current file." t)
189 ;; (add-hook 'html-helper-mode-hook
191 ;; (add-hook 'local-write-file-hooks
193 ;; (let ((local-write-file-hooks))
195 ;; (browse-url-netscape-reload)
196 ;; t) ; => file written by hook
197 ;; t))) ; append to l-w-f-hooks
199 ;; OR have browse-url-of-file ask Netscape to load and then reload the
202 ;; (add-hook 'browse-url-of-file-hook 'browse-url-netscape-reload)
204 ;; You may also want to customise browse-url-netscape-arguments, e.g.
205 ;; (setq browse-url-netscape-arguments '("-install"))
207 ;; or similarly for the other browsers.
209 ;; To invoke different browsers for different URLs:
210 ;; (setq browse-url-browser-function '(("^mailto:" . browse-url-mail)
211 ;; ("." . browse-url-netscape)))
213 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
216 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
219 (eval-when-compile (require 'thingatpt)
222 (require 'executable)
223 (require 'w3-auto nil t))
225 (defgroup browse-url nil
226 "Use a web browser to look at a URL."
227 :prefix "browse-url-"
228 :link '(emacs-commentary-link "browse-url")
232 (defcustom browse-url-browser-function
234 ((memq system-type '(windows-nt ms-dos cygwin))
235 'browse-url-default-windows-browser)
236 ((memq system-type '(darwin)) 'browse-url-default-macosx-browser)
237 (t 'browse-url-default-browser))
238 "*Function to display the current buffer in a WWW browser.
239 This is used by the `browse-url-at-point', `browse-url-at-mouse', and
240 `browse-url-of-file' commands.
242 If the value is not a function it should be a list of pairs
243 \(REGEXP . FUNCTION). In this case the function called will be the one
244 associated with the first REGEXP which matches the current URL. The
245 function is passed the URL and any other args of `browse-url'. The last
246 regexp should probably be \".\" to specify a default browser."
248 (function-item :tag "Emacs W3" :value browse-url-w3)
249 (function-item :tag "W3 in another Emacs via `gnudoit'"
250 :value browse-url-w3-gnudoit)
251 (function-item :tag "Mozilla" :value browse-url-mozilla)
252 (function-item :tag "Firefox" :value browse-url-firefox)
253 (function-item :tag "Galeon" :value browse-url-galeon)
254 (function-item :tag "Epiphany" :value browse-url-epiphany)
255 (function-item :tag "Netscape" :value browse-url-netscape)
256 (function-item :tag "Mosaic" :value browse-url-mosaic)
257 (function-item :tag "Mosaic using CCI" :value browse-url-cci)
258 (function-item :tag "IXI Mosaic" :value browse-url-iximosaic)
259 (function-item :tag "Lynx in an xterm window"
260 :value browse-url-lynx-xterm)
261 (function-item :tag "Lynx in an Emacs window"
262 :value browse-url-lynx-emacs)
263 (function-item :tag "Grail" :value browse-url-grail)
264 (function-item :tag "MMM" :value browse-url-mmm)
265 (function-item :tag "KDE" :value browse-url-kde)
266 (function-item :tag "Specified by `Browse Url Generic Program'"
267 :value browse-url-generic)
268 (function-item :tag "Default Windows browser"
269 :value browse-url-default-windows-browser)
270 (function-item :tag "Default Mac OS X browser"
271 :value browse-url-default-macosx-browser)
272 (function-item :tag "GNOME invoking Mozilla"
273 :value browse-url-gnome-moz)
274 (function-item :tag "Default browser"
275 :value browse-url-default-browser)
276 (function :tag "Your own function")
277 (alist :tag "Regexp/function association list"
278 :key-type regexp :value-type function))
282 (defcustom browse-url-netscape-program "netscape"
283 ;; Info about netscape-remote from Karl Berry.
284 "*The name by which to invoke Netscape.
286 The free program `netscape-remote' from
287 <URL:http://home.netscape.com/newsref/std/remote.c> is said to start
288 up very much quicker than `netscape'. Reported to compile on a GNU
289 system, given vroot.h from the same directory, with cc flags
290 -DSTANDALONE -L/usr/X11R6/lib -lXmu -lX11."
294 (defcustom browse-url-netscape-arguments nil
295 "*A list of strings to pass to Netscape as arguments."
296 :type '(repeat (string :tag "Argument"))
299 (defcustom browse-url-netscape-startup-arguments browse-url-netscape-arguments
300 "*A list of strings to pass to Netscape when it starts up.
301 Defaults to the value of `browse-url-netscape-arguments' at the time
302 `browse-url' is loaded."
303 :type '(repeat (string :tag "Argument"))
306 (defcustom browse-url-browser-display nil
307 "*The X display for running the browser, if not same as Emacs'."
308 :type '(choice string (const :tag "Default" nil))
311 (defcustom browse-url-mozilla-program "mozilla"
312 "*The name by which to invoke Mozilla."
316 (defcustom browse-url-mozilla-arguments nil
317 "*A list of strings to pass to Mozilla as arguments."
318 :type '(repeat (string :tag "Argument"))
321 (defcustom browse-url-mozilla-startup-arguments browse-url-mozilla-arguments
322 "*A list of strings to pass to Mozilla when it starts up.
323 Defaults to the value of `browse-url-mozilla-arguments' at the time
324 `browse-url' is loaded."
325 :type '(repeat (string :tag "Argument"))
329 (defcustom browse-url-firefox-program "firefox"
330 "*The name by which to invoke Firefox."
334 (defcustom browse-url-firefox-arguments nil
335 "*A list of strings to pass to Firefox as arguments."
336 :type '(repeat (string :tag "Argument"))
339 (defcustom browse-url-firefox-startup-arguments browse-url-firefox-arguments
340 "*A list of strings to pass to Firefox when it starts up.
341 Defaults to the value of `browse-url-firefox-arguments' at the time
342 `browse-url' is loaded."
343 :type '(repeat (string :tag "Argument"))
347 (defcustom browse-url-galeon-program "galeon"
348 "*The name by which to invoke Galeon."
352 (defcustom browse-url-galeon-arguments nil
353 "*A list of strings to pass to Galeon as arguments."
354 :type '(repeat (string :tag "Argument"))
357 (defcustom browse-url-galeon-startup-arguments browse-url-galeon-arguments
358 "*A list of strings to pass to Galeon when it starts up.
359 Defaults to the value of `browse-url-galeon-arguments' at the time
360 `browse-url' is loaded."
361 :type '(repeat (string :tag "Argument"))
364 (defcustom browse-url-epiphany-program "epiphany"
365 "*The name by which to invoke Epiphany."
369 (defcustom browse-url-epiphany-arguments nil
370 "*A list of strings to pass to Epiphany as arguments."
371 :type '(repeat (string :tag "Argument"))
374 (defcustom browse-url-epiphany-startup-arguments browse-url-epiphany-arguments
375 "*A list of strings to pass to Epiphany when it starts up.
376 Defaults to the value of `browse-url-epiphany-arguments' at the time
377 `browse-url' is loaded."
378 :type '(repeat (string :tag "Argument"))
381 ;; GNOME means of invoking either Mozilla or Netrape.
382 (defvar browse-url-gnome-moz-program "gnome-moz-remote")
384 (defcustom browse-url-gnome-moz-arguments '()
385 "*A list of strings passed to the GNOME mozilla viewer as arguments."
387 :type '(repeat (string :tag "Argument"))
390 (defcustom browse-url-mozilla-new-window-is-tab nil
391 "*Whether to open up new windows in a tab or a new window.
392 If non-nil, then open the URL in a new tab rather than a new window if
393 `browse-url-mozilla' is asked to open it in a new window."
397 (defcustom browse-url-firefox-new-window-is-tab nil
398 "*Whether to open up new windows in a tab or a new window.
399 If non-nil, then open the URL in a new tab rather than a new window if
400 `browse-url-firefox' is asked to open it in a new window.
402 This option is currently ignored on MS-Windows, since the necessary
403 functionality is not available there."
407 (defcustom browse-url-galeon-new-window-is-tab nil
408 "*Whether to open up new windows in a tab or a new window.
409 If non-nil, then open the URL in a new tab rather than a new window if
410 `browse-url-galeon' is asked to open it in a new window."
414 (defcustom browse-url-epiphany-new-window-is-tab nil
415 "*Whether to open up new windows in a tab or a new window.
416 If non-nil, then open the URL in a new tab rather than a new window if
417 `browse-url-epiphany' is asked to open it in a new window."
421 (defcustom browse-url-netscape-new-window-is-tab nil
422 "*Whether to open up new windows in a tab or a new window.
423 If non-nil, then open the URL in a new tab rather than a new
424 window if `browse-url-netscape' is asked to open it in a new
429 (defcustom browse-url-new-window-flag nil
430 "*If non-nil, always open a new browser window with appropriate browsers.
431 Passing an interactive argument to \\[browse-url], or specific browser
432 commands reverses the effect of this variable. Requires Netscape version
433 1.1N or later or XMosaic version 2.5 or later if using those browsers."
437 (defcustom browse-url-mosaic-program "xmosaic"
438 "*The name by which to invoke Mosaic (or mMosaic)."
443 (defcustom browse-url-mosaic-arguments nil
444 "*A list of strings to pass to Mosaic as arguments."
445 :type '(repeat (string :tag "Argument"))
448 (defcustom browse-url-mosaic-pidfile "~/.mosaicpid"
449 "*The name of the pidfile created by Mosaic."
453 (defcustom browse-url-filename-alist
454 (\` ; Backquote syntax won't work.
455 (("^/\\(ftp@\\|anonymous@\\)?\\([^:]+\\):/*" . "ftp://\\2/")
456 ;; The above loses the username to avoid the browser prompting for
457 ;; it in anonymous cases. If it's not anonymous the next regexp
459 ("^/\\([^:@]+@\\)?\\([^:]+\\):/*" . "ftp://\\1\\2/")
460 (,@ (if (memq system-type '(windows-nt ms-dos cygwin))
461 '(("^\\([a-zA-Z]:\\)[\\/]" . "file:\\1/")
462 ("^[\\/][\\/]+" . "file://"))))
464 "*An alist of (REGEXP . STRING) pairs used by `browse-url-of-file'.
465 Any substring of a filename matching one of the REGEXPs is replaced by
466 the corresponding STRING using `replace-match', not treating STRING
467 literally. All pairs are applied in the order given. The default
468 value converts ange-ftp/EFS-style file names into ftp URLs and prepends
469 `file:' to any file name beginning with `/'.
471 For example, adding to the default a specific translation of an ange-ftp
472 address to an HTTP URL:
474 (setq browse-url-filename-alist
475 '((\"/webmaster@webserver:/home/www/html/\" .
476 \"http://www.acme.co.uk/\")
477 (\"^/\\(ftp@\\|anonymous@\\)?\\([^:]+\\):/*\" . \"ftp://\\2/\")
478 (\"^/\\([^:@]+@\\)?\\([^:]+\\):/*\" . \"ftp://\\1\\2/\")
479 (\"^/+\" . \"file:/\")))
481 :type '(repeat (cons :format "%v"
482 (regexp :tag "Regexp")
483 (string :tag "Replacement")))
487 (defcustom browse-url-save-file nil
488 "*If non-nil, save the buffer before displaying its file.
489 Used by the `browse-url-of-file' command."
493 (defcustom browse-url-of-file-hook nil
494 "*Run after `browse-url-of-file' has asked a browser to load a file.
496 Set this to `browse-url-netscape-reload' to force Netscape to load the
497 file rather than displaying a cached copy."
499 :options '(browse-url-netscape-reload)
502 (defcustom browse-url-CCI-port 3003
503 "*Port to access XMosaic via CCI.
504 This can be any number between 1024 and 65535 but must correspond to
505 the value set in the browser."
509 (defcustom browse-url-CCI-host "localhost"
510 "*Host to access XMosaic via CCI.
511 This should be the host name of the machine running XMosaic with CCI
512 enabled. The port number should be set in `browse-url-CCI-port'."
516 (defvar browse-url-temp-file-name nil)
517 (make-variable-buffer-local 'browse-url-temp-file-name)
519 (defcustom browse-url-xterm-program "xterm"
520 "*The name of the terminal emulator used by `browse-url-lynx-xterm'.
521 This might, for instance, be a separate color version of xterm."
525 (defcustom browse-url-xterm-args nil
526 "*A list of strings defining options for `browse-url-xterm-program'.
527 These might set its size, for instance."
528 :type '(repeat (string :tag "Argument"))
531 (defcustom browse-url-lynx-emacs-args (and (not window-system)
533 "*A list of strings defining options for Lynx in an Emacs buffer.
535 The default is none in a window system, otherwise `-show_cursor' to
536 indicate the position of the current link in the absence of
537 highlighting, assuming the normal default for showing the cursor."
538 :type '(repeat (string :tag "Argument"))
542 (defcustom browse-url-gnudoit-program "gnudoit"
543 "*The name of the `gnudoit' program used by `browse-url-w3-gnudoit'."
547 (defcustom browse-url-gnudoit-args '("-q")
548 "*A list of strings defining options for `browse-url-gnudoit-program'.
549 These might set the port, for instance."
550 :type '(repeat (string :tag "Argument"))
553 (defcustom browse-url-generic-program nil
554 "*The name of the browser program used by `browse-url-generic'."
555 :type '(choice string (const :tag "None" nil))
558 (defcustom browse-url-generic-args nil
559 "*A list of strings defining options for `browse-url-generic-program'."
560 :type '(repeat (string :tag "Argument"))
563 (defcustom browse-url-temp-dir temporary-file-directory
564 "*The name of a directory for browse-url's temporary files.
565 Such files are generated by functions like `browse-url-of-region'.
566 You might want to set this to somewhere with restricted read permissions
571 (defcustom browse-url-netscape-version
573 "*The version of Netscape you are using.
574 This affects how URL reloading is done; the mechanism changed
575 incompatibly at version 4."
579 (defcustom browse-url-lynx-input-field 'avoid
580 "*Action on selecting an existing Lynx buffer at an input field.
581 What to do when sending a new URL to an existing Lynx buffer in Emacs
582 if the Lynx cursor is on an input field (in which case the `g' command
583 would be entered as data). Such fields are recognized by the
584 underlines ____. Allowed values: nil: disregard it, 'warn: warn the
585 user and don't emit the URL, 'avoid: try to avoid the field by moving
586 down (this *won't* always work)."
587 :type '(choice (const :tag "Move to try to avoid field" :value avoid)
588 (const :tag "Disregard" :value nil)
589 (const :tag "Warn, don't emit URL" :value warn))
593 (defcustom browse-url-lynx-input-attempts 10
594 "*How many times to try to move down from a series of lynx input fields."
598 (defcustom browse-url-lynx-input-delay 0.2
599 "*How many seconds to wait for lynx between moves down from an input field."
603 (defcustom browse-url-kde-program "kfmclient"
604 "*The name by which to invoke the KDE web browser."
609 (defcustom browse-url-kde-args '("openURL")
610 "*A list of strings defining options for `browse-url-kde-program'."
611 :type '(repeat (string :tag "Argument"))
614 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
618 (defun browse-url-url-at-point ()
619 (let ((url (thing-at-point 'url)))
620 (set-text-properties 0 (length url) nil url)
623 ;; Having this as a separate function called by the browser-specific
624 ;; functions allows them to be stand-alone commands, making it easier
625 ;; to switch between browsers.
627 (defun browse-url-interactive-arg (prompt)
628 "Read a URL from the minibuffer, prompting with PROMPT.
629 If `transient-mark-mode' is non-nil and the mark is active,
630 it defaults to the current region, else to the URL at or before
631 point. If invoked with a mouse button, it moves point to the
632 position clicked before acting.
634 This function returns a list (URL NEW-WINDOW-FLAG)
635 for use in `interactive'."
636 (let ((event (elt (this-command-keys) 0)))
637 (and (listp event) (mouse-set-point event)))
638 (list (read-string prompt (or (and transient-mark-mode mark-active
639 ;; rfc2396 Appendix E.
640 (replace-regexp-in-string
642 (buffer-substring-no-properties
643 (region-beginning) (region-end))))
644 (browse-url-url-at-point)))
645 (not (eq (null browse-url-new-window-flag)
646 (null current-prefix-arg)))))
648 ;; called-interactive-p needs to be called at a function's top-level, hence
649 ;; this macro. We use that rather than interactive-p because
650 ;; use in a keyboard macro should not change this behavior.
651 (defmacro browse-url-maybe-new-window (arg)
652 `(if (or noninteractive (not (called-interactively-p)))
654 browse-url-new-window-flag))
656 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
657 ;; Browse current buffer
660 (defun browse-url-of-file (&optional file)
661 "Ask a WWW browser to display FILE.
662 Display the current buffer's file if FILE is nil or if called
663 interactively. Turn the filename into a URL with function
664 `browse-url-file-url'. Pass the URL to a browser using the
665 `browse-url' function then run `browse-url-of-file-hook'."
668 (setq file (buffer-file-name))
669 (error "Current buffer has no file"))
670 (let ((buf (get-file-buffer file)))
674 (cond ((not (buffer-modified-p)))
675 (browse-url-save-file (save-buffer))
676 (t (message "%s modified since last save" file))))))
677 (browse-url (browse-url-file-url file))
678 (run-hooks 'browse-url-of-file-hook))
680 (defun browse-url-file-url (file)
681 "Return the URL corresponding to FILE.
682 Use variable `browse-url-filename-alist' to map filenames to URLs."
683 ;; URL-encode special chars, do % first
685 (while (setq s (string-match "%" file s))
686 (setq file (replace-match "%25" t t file)
688 (while (string-match "[*\"()',=;? ]" file)
689 (let ((enc (format "%%%x" (aref file (match-beginning 0)))))
690 (setq file (replace-match enc t t file))))
691 (dolist (map browse-url-filename-alist)
692 (when (and map (string-match (car map) file))
693 (setq file (replace-match (cdr map) t nil file))))
697 (defun browse-url-of-buffer (&optional buffer)
698 "Ask a WWW browser to display BUFFER.
699 Display the current buffer if BUFFER is nil. Display only the
700 currently visible part of BUFFER (from a temporary file) if buffer is
704 (and buffer (set-buffer buffer))
706 ;; Ignore real name if restricted
707 (and (= (- (point-max) (point-min)) (buffer-size))
709 (and (boundp 'dired-directory) dired-directory)))))
712 (or browse-url-temp-file-name
713 (setq browse-url-temp-file-name
714 (convert-standard-filename
716 (expand-file-name "burl" browse-url-temp-dir)
718 (setq file-name browse-url-temp-file-name)
719 (write-region (point-min) (point-max) file-name nil 'no-message)))
720 (browse-url-of-file file-name))))
722 (defun browse-url-delete-temp-file (&optional temp-file-name)
723 ;; Delete browse-url-temp-file-name from the file system
724 ;; If optional arg TEMP-FILE-NAME is non-nil, delete it instead
725 (let ((file-name (or temp-file-name browse-url-temp-file-name)))
726 (if (and file-name (file-exists-p file-name))
727 (delete-file file-name))))
729 (add-hook 'kill-buffer-hook 'browse-url-delete-temp-file)
732 (defun browse-url-of-dired-file ()
733 "In Dired, ask a WWW browser to display the file named on this line."
735 (browse-url-of-file (dired-get-filename)))
738 (defun browse-url-of-region (min max)
739 "Ask a WWW browser to display the current region."
743 (narrow-to-region min max)
744 (browse-url-of-buffer))))
746 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
747 ;; Browser-independent commands
749 ;; A generic command to call the current browse-url-browser-function
752 (defun browse-url (url &rest args)
753 "Ask a WWW browser to load URL.
754 Prompts for a URL, defaulting to the URL at or before point. Variable
755 `browse-url-browser-function' says which browser to use."
756 (interactive (browse-url-interactive-arg "URL: "))
757 (unless (interactive-p)
758 (setq args (or args (list browse-url-new-window-flag))))
759 (if (functionp browse-url-browser-function)
760 (apply browse-url-browser-function url args)
761 ;; The `function' can be an alist; look down it for first match
762 ;; and apply the function (which might be a lambda).
764 (dolist (bf browse-url-browser-function)
765 (when (string-match (car bf) url)
766 (apply (cdr bf) url args)
768 (error "No browse-url-browser-function matching URL %s"
772 (defun browse-url-at-point (&optional arg)
773 "Ask a WWW browser to load the URL at or before point.
774 Doesn't let you edit the URL like `browse-url'. Variable
775 `browse-url-browser-function' says which browser to use."
777 (let ((url (browse-url-url-at-point)))
779 (browse-url url (if arg
780 (not browse-url-new-window-flag)
781 browse-url-new-window-flag))
782 (error "No URL found"))))
785 (defun browse-url-at-mouse (event)
786 "Ask a WWW browser to load a URL clicked with the mouse.
787 The URL is the one around or before the position of the mouse click
788 but point is not changed. Doesn't let you edit the URL like
789 `browse-url'. Variable `browse-url-browser-function' says which browser
793 (mouse-set-point event)
794 ;; This handles browse-url-new-window-flag properly
795 ;; when it gets no arg.
796 (browse-url-at-point)))
798 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
799 ;; Browser-specific commands
801 ;; --- Default MS-Windows browser ---
803 (defvar dos-windows-version)
805 (defun browse-url-default-windows-browser (url &optional new-window)
806 (interactive (browse-url-interactive-arg "URL: "))
807 (if (eq system-type 'ms-dos)
808 (if dos-windows-version
809 (shell-command (concat "start " (shell-quote-argument url)))
810 (error "Browsing URLs is not supported on this system"))
811 (w32-shell-execute "open" url)))
813 (defun browse-url-default-macosx-browser (url &optional new-window)
814 (interactive (browse-url-interactive-arg "URL: "))
815 (start-process (concat "open " url) nil "open" url))
819 (defun browse-url-process-environment ()
820 "Set DISPLAY in the environment to the X display the browser will use.
821 This is either the value of variable `browse-url-browser-display' if
822 non-nil, or the same display as Emacs if different from the current
823 environment, otherwise just use the current environment."
824 (let ((display (or browse-url-browser-display (browse-url-emacs-display))))
826 (cons (concat "DISPLAY=" display) process-environment)
827 process-environment)))
829 (defun browse-url-emacs-display ()
830 "Return the X display Emacs is running on.
831 This is nil if the display is the same as the DISPLAY environment variable.
833 Actually Emacs could be using several displays; this just returns the
834 one showing the selected frame."
835 (let ((display (cdr-safe (assq 'display (frame-parameters)))))
836 (and (not (equal display (getenv "DISPLAY")))
840 (defun browse-url-default-browser (url &rest args)
841 "Find a suitable browser and ask it to load URL.
842 Default to the URL around or before point.
844 When called interactively, if variable `browse-url-new-window-flag' is
845 non-nil, load the document in a new window, if possible, otherwise use
846 a random existing one. A non-nil interactive prefix argument reverses
847 the effect of `browse-url-new-window-flag'.
849 When called non-interactively, optional second argument NEW-WINDOW is
850 used instead of `browse-url-new-window-flag'.
852 The order attempted is gnome-moz-remote, Mozilla, Firefox,
853 Galeon, Konqueror, Netscape, Mosaic, IXI Mosaic, Lynx in an
854 xterm, MMM, and then W3."
857 ((executable-find browse-url-gnome-moz-program) 'browse-url-gnome-moz)
858 ((executable-find browse-url-mozilla-program) 'browse-url-mozilla)
859 ((executable-find browse-url-firefox-program) 'browse-url-firefox)
860 ((executable-find browse-url-galeon-program) 'browse-url-galeon)
861 ((executable-find browse-url-kde-program) 'browse-url-kde)
862 ((executable-find browse-url-netscape-program) 'browse-url-netscape)
863 ((executable-find browse-url-mosaic-program) 'browse-url-mosaic)
864 ((executable-find "tellw3b") 'browse-url-iximosaic)
865 ((executable-find browse-url-xterm-program) 'browse-url-lynx-xterm)
866 ((executable-find "mmm") 'browse-url-mmm)
867 ((locate-library "w3") 'browse-url-w3)
869 (lambda (&ignore args) (error "No usable browser found"))))
873 (defun browse-url-netscape (url &optional new-window)
874 "Ask the Netscape WWW browser to load URL.
875 Default to the URL around or before point. The strings in variable
876 `browse-url-netscape-arguments' are also passed to Netscape.
878 When called interactively, if variable `browse-url-new-window-flag' is
879 non-nil, load the document in a new Netscape window, otherwise use a
880 random existing one. A non-nil interactive prefix argument reverses
881 the effect of `browse-url-new-window-flag'.
883 If `browse-url-netscape-new-window-is-tab' is non-nil, then
884 whenever a document would otherwise be loaded in a new window, it
885 is loaded in a new tab in an existing window instead.
887 When called non-interactively, optional second argument NEW-WINDOW is
888 used instead of `browse-url-new-window-flag'."
889 (interactive (browse-url-interactive-arg "URL: "))
890 ;; URL encode any `confusing' characters in the URL. This needs to
891 ;; include at least commas; presumably also close parens and dollars.
892 (while (string-match "[,)$]" url)
893 (setq url (replace-match
894 (format "%%%x" (string-to-char (match-string 0 url))) t t url)))
895 (let* ((process-environment (browse-url-process-environment))
897 (apply 'start-process
898 (concat "netscape " url) nil
899 browse-url-netscape-program
901 browse-url-netscape-arguments
902 (if (eq window-system 'w32)
905 (if new-window '("-noraise"))
907 (concat "openURL(" url
908 (if (browse-url-maybe-new-window
910 (if browse-url-netscape-new-window-is-tab
914 (set-process-sentinel process
915 `(lambda (process change)
916 (browse-url-netscape-sentinel process ,url)))))
918 (defun browse-url-netscape-sentinel (process url)
919 "Handle a change to the process communicating with Netscape."
920 (or (eq (process-exit-status process) 0)
921 (let* ((process-environment (browse-url-process-environment)))
922 ;; Netscape not running - start it
923 (message "Starting %s..." browse-url-netscape-program)
924 (apply 'start-process (concat "netscape" url) nil
925 browse-url-netscape-program
926 (append browse-url-netscape-startup-arguments (list url))))))
928 (defun browse-url-netscape-reload ()
929 "Ask Netscape to reload its current document.
930 How depends on `browse-url-netscape-version'."
932 ;; Backwards incompatibility reported by
933 ;; <peter.kruse@psychologie.uni-regensburg.de>.
934 (browse-url-netscape-send (if (>= browse-url-netscape-version 4)
935 "xfeDoCommand(reload)"
938 (defun browse-url-netscape-send (command)
939 "Send a remote control command to Netscape."
940 (let* ((process-environment (browse-url-process-environment)))
941 (apply 'start-process "netscape" nil
942 browse-url-netscape-program
943 (append browse-url-netscape-arguments
944 (list "-remote" command)))))
947 (defun browse-url-mozilla (url &optional new-window)
948 "Ask the Mozilla WWW browser to load URL.
949 Default to the URL around or before point. The strings in variable
950 `browse-url-mozilla-arguments' are also passed to Mozilla.
952 When called interactively, if variable `browse-url-new-window-flag' is
953 non-nil, load the document in a new Mozilla window, otherwise use a
954 random existing one. A non-nil interactive prefix argument reverses
955 the effect of `browse-url-new-window-flag'.
957 If `browse-url-mozilla-new-window-is-tab' is non-nil, then whenever a
958 document would otherwise be loaded in a new window, it is loaded in a
959 new tab in an existing window instead.
961 When called non-interactively, optional second argument NEW-WINDOW is
962 used instead of `browse-url-new-window-flag'."
963 (interactive (browse-url-interactive-arg "URL: "))
964 ;; URL encode any `confusing' characters in the URL. This needs to
965 ;; include at least commas; presumably also close parens and dollars.
966 (while (string-match "[,)$]" url)
967 (setq url (replace-match
968 (format "%%%x" (string-to-char (match-string 0 url))) t t url)))
969 (let* ((process-environment (browse-url-process-environment))
971 (apply 'start-process
972 (concat "mozilla " url) nil
973 browse-url-mozilla-program
975 browse-url-mozilla-arguments
979 (if (browse-url-maybe-new-window
981 (if browse-url-mozilla-new-window-is-tab
985 (set-process-sentinel process
986 `(lambda (process change)
987 (browse-url-mozilla-sentinel process ,url)))))
989 (defun browse-url-mozilla-sentinel (process url)
990 "Handle a change to the process communicating with Mozilla."
991 (or (eq (process-exit-status process) 0)
992 (let* ((process-environment (browse-url-process-environment)))
993 ;; Mozilla is not running - start it
994 (message "Starting %s..." browse-url-mozilla-program)
995 (apply 'start-process (concat "mozilla " url) nil
996 browse-url-mozilla-program
997 (append browse-url-mozilla-startup-arguments (list url))))))
1000 (defun browse-url-firefox (url &optional new-window)
1001 "Ask the Firefox WWW browser to load URL.
1002 Default to the URL around or before point. The strings in
1003 variable `browse-url-firefox-arguments' are also passed to
1006 When called interactively, if variable
1007 `browse-url-new-window-flag' is non-nil, load the document in a
1008 new Firefox window, otherwise use a random existing one. A
1009 non-nil interactive prefix argument reverses the effect of
1010 `browse-url-new-window-flag'.
1012 If `browse-url-firefox-new-window-is-tab' is non-nil, then
1013 whenever a document would otherwise be loaded in a new window, it
1014 is loaded in a new tab in an existing window instead.
1016 When called non-interactively, optional second argument
1017 NEW-WINDOW is used instead of `browse-url-new-window-flag'.
1019 On MS-Windows systems the optional `new-window' parameter is
1020 ignored. Firefox for Windows does not support the \"-remote\"
1021 command line parameter. Therefore, the
1022 `browse-url-new-window-flag' and `browse-url-firefox-new-window-is-tab'
1023 are ignored as well. Firefox on Windows will always open the requested
1024 URL in a new window."
1025 (interactive (browse-url-interactive-arg "URL: "))
1026 ;; URL encode any `confusing' characters in the URL. This needs to
1027 ;; include at least commas; presumably also close parens.
1028 (while (string-match "[,)]" url)
1029 (setq url (replace-match
1030 (format "%%%x" (string-to-char (match-string 0 url))) t t url)))
1031 (let* ((process-environment (browse-url-process-environment))
1033 (apply 'start-process
1034 (concat "firefox " url) nil
1035 browse-url-firefox-program
1037 browse-url-firefox-arguments
1038 (if (or (featurep 'dos-w32)
1039 (string-match "win32" system-configuration))
1044 (if (browse-url-maybe-new-window
1046 (if browse-url-firefox-new-window-is-tab
1050 (set-process-sentinel process
1051 `(lambda (process change)
1052 (browse-url-firefox-sentinel process ,url)))))
1054 (defun browse-url-firefox-sentinel (process url)
1055 "Handle a change to the process communicating with Firefox."
1056 (or (eq (process-exit-status process) 0)
1057 (let* ((process-environment (browse-url-process-environment)))
1058 ;; Firefox is not running - start it
1059 (message "Starting Firefox...")
1060 (apply 'start-process (concat "firefox " url) nil
1061 browse-url-firefox-program
1062 (append browse-url-firefox-startup-arguments (list url))))))
1065 (defun browse-url-galeon (url &optional new-window)
1066 "Ask the Galeon WWW browser to load URL.
1067 Default to the URL around or before point. The strings in variable
1068 `browse-url-galeon-arguments' are also passed to Galeon.
1070 When called interactively, if variable `browse-url-new-window-flag' is
1071 non-nil, load the document in a new Galeon window, otherwise use a
1072 random existing one. A non-nil interactive prefix argument reverses
1073 the effect of `browse-url-new-window-flag'.
1075 If `browse-url-galeon-new-window-is-tab' is non-nil, then whenever a
1076 document would otherwise be loaded in a new window, it is loaded in a
1077 new tab in an existing window instead.
1079 When called non-interactively, optional second argument NEW-WINDOW is
1080 used instead of `browse-url-new-window-flag'."
1081 (interactive (browse-url-interactive-arg "URL: "))
1082 ;; URL encode any `confusing' characters in the URL. This needs to
1083 ;; include at least commas; presumably also close parens and dollars.
1084 (while (string-match "[,)$]" url)
1085 (setq url (replace-match
1086 (format "%%%x" (string-to-char (match-string 0 url))) t t url)))
1087 (let* ((process-environment (browse-url-process-environment))
1088 (process (apply 'start-process
1089 (concat "galeon " url)
1091 browse-url-galeon-program
1093 browse-url-galeon-arguments
1094 (if (browse-url-maybe-new-window new-window)
1095 (if browse-url-galeon-new-window-is-tab
1097 '("--new-window" "--noraise"))
1100 (set-process-sentinel process
1101 `(lambda (process change)
1102 (browse-url-galeon-sentinel process ,url)))))
1104 (defun browse-url-galeon-sentinel (process url)
1105 "Handle a change to the process communicating with Galeon."
1106 (or (eq (process-exit-status process) 0)
1107 (let* ((process-environment (browse-url-process-environment)))
1108 ;; Galeon is not running - start it
1109 (message "Starting %s..." browse-url-galeon-program)
1110 (apply 'start-process (concat "galeon " url) nil
1111 browse-url-galeon-program
1112 (append browse-url-galeon-startup-arguments (list url))))))
1114 (defun browse-url-epiphany (url &optional new-window)
1115 "Ask the Epiphany WWW browser to load URL.
1116 Default to the URL around or before point. The strings in variable
1117 `browse-url-galeon-arguments' are also passed to Epiphany.
1119 When called interactively, if variable `browse-url-new-window-flag' is
1120 non-nil, load the document in a new Epiphany window, otherwise use a
1121 random existing one. A non-nil interactive prefix argument reverses
1122 the effect of `browse-url-new-window-flag'.
1124 If `browse-url-epiphany-new-window-is-tab' is non-nil, then whenever a
1125 document would otherwise be loaded in a new window, it is loaded in a
1126 new tab in an existing window instead.
1128 When called non-interactively, optional second argument NEW-WINDOW is
1129 used instead of `browse-url-new-window-flag'."
1130 (interactive (browse-url-interactive-arg "URL: "))
1131 ;; URL encode any `confusing' characters in the URL. This needs to
1132 ;; include at least commas; presumably also close parens and dollars.
1133 (while (string-match "[,)$]" url)
1134 (setq url (replace-match
1135 (format "%%%x" (string-to-char (match-string 0 url))) t t url)))
1136 (let* ((process-environment (browse-url-process-environment))
1137 (process (apply 'start-process
1138 (concat "epiphany " url)
1140 browse-url-epiphany-program
1142 browse-url-epiphany-arguments
1143 (if (browse-url-maybe-new-window new-window)
1144 (if browse-url-epiphany-new-window-is-tab
1146 '("--new-window" "--noraise"))
1149 (set-process-sentinel process
1150 `(lambda (process change)
1151 (browse-url-epiphany-sentinel process ,url)))))
1153 (defun browse-url-epiphany-sentinel (process url)
1154 "Handle a change to the process communicating with Epiphany."
1155 (or (eq (process-exit-status process) 0)
1156 (let* ((process-environment (browse-url-process-environment)))
1157 ;; Epiphany is not running - start it
1158 (message "Starting %s..." browse-url-epiphany-program)
1159 (apply 'start-process (concat "epiphany " url) nil
1160 browse-url-epiphany-program
1161 (append browse-url-epiphany-startup-arguments (list url))))))
1164 (defun browse-url-gnome-moz (url &optional new-window)
1165 "Ask Mozilla/Netscape to load URL via the GNOME program `gnome-moz-remote'.
1166 Default to the URL around or before point. The strings in variable
1167 `browse-url-gnome-moz-arguments' are also passed.
1169 When called interactively, if variable `browse-url-new-window-flag' is
1170 non-nil, load the document in a new browser window, otherwise use an
1171 existing one. A non-nil interactive prefix argument reverses the
1172 effect of `browse-url-new-window-flag'.
1174 When called non-interactively, optional second argument NEW-WINDOW is
1175 used instead of `browse-url-new-window-flag'."
1176 (interactive (browse-url-interactive-arg "URL: "))
1177 (apply 'start-process (concat "gnome-moz-remote " url)
1179 browse-url-gnome-moz-program
1181 browse-url-gnome-moz-arguments
1182 (if (browse-url-maybe-new-window new-window)
1184 (list "--raise" url))))
1189 (defun browse-url-mosaic (url &optional new-window)
1190 "Ask the XMosaic WWW browser to load URL.
1192 Default to the URL around or before point. The strings in variable
1193 `browse-url-mosaic-arguments' are also passed to Mosaic and the
1194 program is invoked according to the variable
1195 `browse-url-mosaic-program'.
1197 When called interactively, if variable `browse-url-new-window-flag' is
1198 non-nil, load the document in a new Mosaic window, otherwise use a
1199 random existing one. A non-nil interactive prefix argument reverses
1200 the effect of `browse-url-new-window-flag'.
1202 When called non-interactively, optional second argument NEW-WINDOW is
1203 used instead of `browse-url-new-window-flag'."
1204 (interactive (browse-url-interactive-arg "Mosaic URL: "))
1205 (let ((pidfile (expand-file-name browse-url-mosaic-pidfile))
1207 (if (file-readable-p pidfile)
1210 (goto-char (point-min))
1211 (setq pid (read (current-buffer)))
1213 (if (and pid (zerop (signal-process pid 0))) ; Mosaic running
1215 (find-file (format "/tmp/Mosaic.%d" pid))
1217 (insert (if (browse-url-maybe-new-window new-window)
1223 ;; Send signal SIGUSR to Mosaic
1224 (message "Signaling Mosaic...")
1225 (signal-process pid 'SIGUSR1)
1226 ;; Or you could try:
1227 ;; (call-process "kill" nil 0 nil "-USR1" (int-to-string pid))
1228 (message "Signaling Mosaic...done")
1230 ;; Mosaic not running - start it
1231 (message "Starting %s..." browse-url-mosaic-program)
1232 (apply 'start-process "xmosaic" nil browse-url-mosaic-program
1233 (append browse-url-mosaic-arguments (list url)))
1234 (message "Starting %s...done" browse-url-mosaic-program))))
1238 (defvar browse-url-grail
1239 (concat (or (getenv "GRAILDIR") "~/.grail") "/user/rcgrail.py")
1240 "Location of Grail remote control client script `rcgrail.py'.
1241 Typically found in $GRAILDIR/rcgrail.py, or ~/.grail/user/rcgrail.py.")
1244 (defun browse-url-grail (url &optional new-window)
1245 "Ask the Grail WWW browser to load URL.
1246 Default to the URL around or before point. Runs the program in the
1247 variable `browse-url-grail'."
1248 (interactive (browse-url-interactive-arg "Grail URL: "))
1249 (message "Sending URL to Grail...")
1251 (set-buffer (get-buffer-create " *Shell Command Output*"))
1253 ;; don't worry about this failing.
1254 (if (browse-url-maybe-new-window new-window)
1255 (call-process browse-url-grail nil 0 nil "-b" url)
1256 (call-process browse-url-grail nil 0 nil url))
1257 (message "Sending URL to Grail... done")))
1259 ;; --- Mosaic using CCI ---
1262 (defun browse-url-cci (url &optional new-window)
1263 "Ask the XMosaic WWW browser to load URL.
1264 Default to the URL around or before point.
1266 This function only works for XMosaic version 2.5 or later. You must
1267 select `CCI' from XMosaic's File menu, set the CCI Port Address to the
1268 value of variable `browse-url-CCI-port', and enable `Accept requests'.
1270 When called interactively, if variable `browse-url-new-window-flag' is
1271 non-nil, load the document in a new browser window, otherwise use a
1272 random existing one. A non-nil interactive prefix argument reverses
1273 the effect of `browse-url-new-window-flag'.
1275 When called non-interactively, optional second argument NEW-WINDOW is
1276 used instead of `browse-url-new-window-flag'."
1277 (interactive (browse-url-interactive-arg "Mosaic URL: "))
1278 (open-network-stream "browse-url" " *browse-url*"
1279 browse-url-CCI-host browse-url-CCI-port)
1280 ;; Todo: start browser if fails
1281 (process-send-string "browse-url"
1282 (concat "get url (" url ") output "
1283 (if (browse-url-maybe-new-window new-window)
1287 (process-send-string "browse-url" "disconnect\r\n")
1288 (delete-process "browse-url"))
1290 ;; --- IXI Mosaic ---
1293 (defun browse-url-iximosaic (url &optional new-window)
1294 ;; new-window ignored
1295 "Ask the IXIMosaic WWW browser to load URL.
1296 Default to the URL around or before point."
1297 (interactive (browse-url-interactive-arg "IXI Mosaic URL: "))
1298 (start-process "tellw3b" nil "tellw3b"
1299 "-service WWW_BROWSER ixi_showurl " url))
1304 (defun browse-url-w3 (url &optional new-window)
1305 "Ask the w3 WWW browser to load URL.
1306 Default to the URL around or before point.
1308 When called interactively, if variable `browse-url-new-window-flag' is
1309 non-nil, load the document in a new window. A non-nil interactive
1310 prefix argument reverses the effect of `browse-url-new-window-flag'.
1312 When called non-interactively, optional second argument NEW-WINDOW is
1313 used instead of `browse-url-new-window-flag'."
1314 (interactive (browse-url-interactive-arg "W3 URL: "))
1315 (require 'w3) ; w3-fetch-other-window not autoloaded
1316 (if (browse-url-maybe-new-window new-window)
1317 (w3-fetch-other-window url)
1321 (defun browse-url-w3-gnudoit (url &optional new-window)
1322 ;; new-window ignored
1323 "Ask another Emacs running gnuserv to load the URL using the W3 browser.
1324 The `browse-url-gnudoit-program' program is used with options given by
1325 `browse-url-gnudoit-args'. Default to the URL around or before point."
1326 (interactive (browse-url-interactive-arg "W3 URL: "))
1327 (apply 'start-process (concat "gnudoit:" url) nil
1328 browse-url-gnudoit-program
1329 (append browse-url-gnudoit-args
1330 (list (concat "(w3-fetch \"" url "\")")
1333 ;; --- Lynx in an xterm ---
1336 (defun browse-url-lynx-xterm (url &optional new-window)
1337 ;; new-window ignored
1338 "Ask the Lynx WWW browser to load URL.
1339 Default to the URL around or before point. A new Lynx process is run
1340 in an Xterm window using the Xterm program named by `browse-url-xterm-program'
1341 with possible additional arguments `browse-url-xterm-args'."
1342 (interactive (browse-url-interactive-arg "Lynx URL: "))
1343 (apply #'start-process `(,(concat "lynx" url) nil ,browse-url-xterm-program
1344 ,@browse-url-xterm-args "-e" "lynx"
1347 ;; --- Lynx in an Emacs "term" window ---
1350 (defun browse-url-lynx-emacs (url &optional new-buffer)
1351 "Ask the Lynx WWW browser to load URL.
1352 Default to the URL around or before point. With a prefix argument, run
1353 a new Lynx 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 lynx 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 "Lynx URL: "))
1363 (let* ((system-uses-terminfo t) ; Lynx uses terminfo
1364 ;; (term-term-name "vt100") ; ??
1365 (buf (get-buffer "*lynx*"))
1366 (proc (and buf (get-buffer-process buf)))
1367 (n browse-url-lynx-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)
1374 (if (or (browse-url-maybe-new-window new-buffer)
1377 (not (memq (process-status proc) '(run stop))))
1382 `("lynx" "lynx" nil ,@browse-url-lynx-emacs-args
1384 (switch-to-buffer buf)
1386 (set-process-sentinel
1387 (get-buffer-process buf)
1388 ;; Don't leave around a dead one (especially because of its
1390 (lambda (process event)
1391 (if (not (memq (process-status process) '(run stop)))
1392 (let ((buf (process-buffer process)))
1393 (if buf (kill-buffer buf)))))))
1394 ;; send the url to lynx in the old buffer
1395 (let ((win (get-buffer-window buf t)))
1398 (switch-to-buffer buf)))
1399 (if (eq (following-char) ?_)
1400 (cond ((eq browse-url-lynx-input-field 'warn)
1401 (error "Please move out of the input field first"))
1402 ((eq browse-url-lynx-input-field 'avoid)
1403 (while (and (eq (following-char) ?_) (> n 0))
1404 (term-send-down) ; down arrow
1405 (sit-for browse-url-lynx-input-delay))
1406 (if (eq (following-char) ?_)
1407 (error "Cannot move out of the input field, sorry")))))
1408 (term-send-string proc (concat "g" ; goto
1409 "\C-u" ; kill default url
1416 (defun browse-url-mmm (url &optional new-window)
1417 "Ask the MMM WWW browser to load URL.
1418 Default to the URL around or before point."
1419 (interactive (browse-url-interactive-arg "MMM URL: "))
1420 (message "Sending URL to MMM...")
1422 (set-buffer (get-buffer-create " *Shell Command Output*"))
1424 ;; mmm_remote just SEGVs if the file isn't there...
1425 (if (or (file-exists-p (expand-file-name "~/.mmm_remote"))
1426 ;; location in v 0.4:
1427 (file-exists-p (expand-file-name "~/.mmm/remote")))
1428 (call-process "mmm_remote" nil 0 nil url)
1429 (call-process "mmm" nil 0 nil "-external" url))
1430 (message "Sending URL to MMM... done")))
1434 (autoload 'rfc2368-parse-mailto-url "rfc2368")
1437 (defun browse-url-mail (url &optional new-window)
1438 "Open a new mail message buffer within Emacs for the RFC 2368 URL.
1439 Default to using the mailto: URL around or before point as the
1440 recipient's address. Supplying a non-nil interactive prefix argument
1441 will cause the mail to be composed in another window rather than the
1444 When called interactively, if variable `browse-url-new-window-flag' is
1445 non-nil use `compose-mail-other-window', otherwise `compose-mail'. A
1446 non-nil interactive prefix argument reverses the effect of
1447 `browse-url-new-window-flag'.
1449 When called non-interactively, optional second argument NEW-WINDOW is
1450 used instead of `browse-url-new-window-flag'."
1451 (interactive (browse-url-interactive-arg "Mailto URL: "))
1453 (let* ((alist (rfc2368-parse-mailto-url url))
1454 (to (assoc "To" alist))
1455 (subject (assoc "Subject" alist))
1456 (body (assoc "Body" alist))
1457 (rest (delete to (delete subject (delete body alist))))
1459 (subject (cdr subject))
1461 (mail-citation-hook (unless body mail-citation-hook)))
1462 (if (browse-url-maybe-new-window new-window)
1463 (compose-mail-other-window to subject rest nil
1466 (list 'insert-buffer (current-buffer))))
1467 (compose-mail to subject rest nil nil
1470 (list 'insert-buffer (current-buffer))))))))
1472 ;; --- Random browser ---
1475 (defun browse-url-generic (url &optional new-window)
1476 ;; new-window ignored
1477 "Ask the WWW browser defined by `browse-url-generic-program' to load URL.
1478 Default to the URL around or before point. A fresh copy of the
1479 browser is started up in a new process with possible additional arguments
1480 `browse-url-generic-args'. This is appropriate for browsers which
1481 don't offer a form of remote control."
1482 (interactive (browse-url-interactive-arg "URL: "))
1483 (if (not browse-url-generic-program)
1484 (error "No browser defined (`browse-url-generic-program')"))
1485 (apply 'call-process browse-url-generic-program nil
1487 (append browse-url-generic-args (list url))))
1490 (defun browse-url-kde (url &optional new-window)
1491 "Ask the KDE WWW browser to load URL.
1492 Default to the URL around or before point."
1493 (interactive (browse-url-interactive-arg "KDE URL: "))
1494 (message "Sending URL to KDE...")
1495 (apply #'start-process (concat "KDE " url) nil browse-url-kde-program
1496 (append browse-url-kde-args (list url))))
1498 (provide 'browse-url)
1500 ;;; arch-tag: d2079573-5c06-4097-9598-f550fba19430
1501 ;;; browse-url.el ends here