(flyspell-word): Revert last change.
[emacs.git] / lisp / net / browse-url.el
blob8ea4409731e46cd2a59513aef29e878cc2fbcd91
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 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, or (at your option)
16 ;; 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; 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.
28 ;;; Commentary:
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
47 ;; browse-url-w3 w3 0
48 ;; browse-url-w3-gnudoit w3 remotely
49 ;; browse-url-lynx-* Lynx 0
50 ;; browse-url-generic arbitrary
51 ;; browse-url-default-windows-browser MS-Windows browser
52 ;; browse-url-default-macosx-browser Mac OS X browser
53 ;; browse-url-gnome-moz GNOME interface to Mozilla
54 ;; browse-url-kde KDE konqueror (kfm)
56 ;; [A version of the Netscape browser is now free software
57 ;; <URL:http://www.mozilla.org/>, albeit not GPLed, so it is
58 ;; reasonable to have that as the default.]
60 ;; Note that versions of Netscape before 1.1b1 did not have remote
61 ;; control. <URL:http://www.netscape.com/newsref/std/x-remote.html>.
63 ;; Browsers can cache Web pages so it may be necessary to tell them to
64 ;; reload the current page if it has changed (e.g. if you have edited
65 ;; it). There is currently no perfect automatic solution to this.
67 ;; Netscape allows you to specify the id of the window you want to
68 ;; control but which window DO you want to control and how do you
69 ;; discover its id?
71 ;; William M. Perry's excellent "w3" WWW browser for
72 ;; Emacs <URL:ftp://cs.indiana.edu/pub/elisp/w3/>
73 ;; has a function w3-follow-url-at-point, but that
74 ;; doesn't let you edit the URL like browse-url.
75 ;; The `gnuserv' package that can be used to control it in another
76 ;; Emacs process is available from
77 ;; <URL:ftp://ftp.splode.com/pub/users/friedman/packages/>.
79 ;; Lynx is now distributed by the FSF. See also
80 ;; <URL:http://lynx.browser.org/>.
82 ;; Free graphical browsers that could be used by `browse-url-generic'
83 ;; include Chimera <URL:ftp://ftp.cs.unlv.edu/pub/chimera> and
84 ;; <URL:http://www.unlv.edu/chimera/>, Arena
85 ;; <URL:ftp://ftp.yggdrasil.com/pub/dist/web/arena> and Amaya
86 ;; <URL:ftp://ftp.w3.org/pub/amaya>. mMosaic
87 ;; <URL:ftp://ftp.enst.fr/pub/mbone/mMosaic/>,
88 ;; <URL:http://www.enst.fr/~dauphin/mMosaic/> (with development
89 ;; support for Java applets and multicast) can be used like Mosaic by
90 ;; setting `browse-url-mosaic-program' appropriately.
92 ;; I [Denis Howe, not Dave Love] recommend Nelson Minar
93 ;; <nelson@santafe.edu>'s excellent html-helper-mode.el for editing
94 ;; HTML and thank Nelson for his many useful comments on this code.
95 ;; <URL:http://www.santafe.edu/%7Enelson/hhm-beta/>
97 ;; See also hm--html-menus <URL:http://www.tnt.uni-hannover.de/%7Emuenkel/
98 ;; software/own/hm--html-menus/>. For composing correct HTML see also
99 ;; PSGML the general SGML structure editor package
100 ;; <URL:ftp://ftp.lysator.liu.se/pub/sgml>; hm--html-menus can be used
101 ;; with this.
103 ;; This package generalises function html-previewer-process in Marc
104 ;; Andreessen's html-mode (LCD modes/html-mode.el.Z). See also the
105 ;; ffap.el package. The huge hyperbole package also contains similar
106 ;; functions.
108 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
109 ;; Help!
111 ;; Can you write and test some code for the Macintrash and Windoze
112 ;; Netscape remote control APIs? (See the URL above).
114 ;; Do any other browsers have remote control?
116 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
117 ;; Usage
119 ;; To display the URL at or before point:
120 ;; M-x browse-url-at-point RET
121 ;; or, similarly but with the opportunity to edit the URL extracted from
122 ;; the buffer, use:
123 ;; M-x browse-url
125 ;; To display a URL by shift-clicking on it, put this in your ~/.emacs
126 ;; file:
127 ;; (global-set-key [S-mouse-2] 'browse-url-at-mouse)
128 ;; (Note that using Shift-mouse-1 is not desirable because
129 ;; that event has a standard meaning in Emacs.)
131 ;; To display the current buffer in a web browser:
132 ;; M-x browse-url-of-buffer RET
134 ;; To display the current region in a web browser:
135 ;; M-x browse-url-of-region RET
137 ;; In Dired, to display the file named on the current line:
138 ;; M-x browse-url-of-dired-file RET
140 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
141 ;; Customisation (~/.emacs)
143 ;; To see what variables are available for customization, type
144 ;; `M-x set-variable browse-url TAB'. Better, use
145 ;; `M-x customize-group browse-url'.
147 ;; Bind the browse-url commands to keys with the `C-c C-z' prefix
148 ;; (as used by html-helper-mode):
149 ;; (global-set-key "\C-c\C-z." 'browse-url-at-point)
150 ;; (global-set-key "\C-c\C-zb" 'browse-url-of-buffer)
151 ;; (global-set-key "\C-c\C-zr" 'browse-url-of-region)
152 ;; (global-set-key "\C-c\C-zu" 'browse-url)
153 ;; (global-set-key "\C-c\C-zv" 'browse-url-of-file)
154 ;; (add-hook 'dired-mode-hook
155 ;; (lambda ()
156 ;; (local-set-key "\C-c\C-zf" 'browse-url-of-dired-file)))
158 ;; Browse URLs in mail messages under RMAIL by clicking mouse-2:
159 ;; (add-hook 'rmail-mode-hook (lambda () ; rmail-mode startup
160 ;; (define-key rmail-mode-map [mouse-2] 'browse-url-at-mouse)))
161 ;; Alternatively, add `goto-address' to `rmail-show-message-hook'.
163 ;; Gnus provides a standard feature to activate URLs in article
164 ;; buffers for invocation of browse-url.
166 ;; Use the Emacs w3 browser when not running under X11:
167 ;; (or (eq window-system 'x)
168 ;; (setq browse-url-browser-function 'browse-url-w3))
170 ;; To always save modified buffers before displaying the file in a browser:
171 ;; (setq browse-url-save-file t)
173 ;; To get round the Netscape caching problem, you could EITHER have
174 ;; write-file in html-helper-mode make Netscape reload the document:
176 ;; (autoload 'browse-url-netscape-reload "browse-url"
177 ;; "Ask a WWW browser to redisplay the current file." t)
178 ;; (add-hook 'html-helper-mode-hook
179 ;; (lambda ()
180 ;; (add-hook 'local-write-file-hooks
181 ;; (lambda ()
182 ;; (let ((local-write-file-hooks))
183 ;; (save-buffer))
184 ;; (browse-url-netscape-reload)
185 ;; t) ; => file written by hook
186 ;; t))) ; append to l-w-f-hooks
188 ;; OR have browse-url-of-file ask Netscape to load and then reload the
189 ;; file:
191 ;; (add-hook 'browse-url-of-file-hook 'browse-url-netscape-reload)
193 ;; You may also want to customise browse-url-netscape-arguments, e.g.
194 ;; (setq browse-url-netscape-arguments '("-install"))
196 ;; or similarly for the other browsers.
198 ;; To invoke different browsers for different URLs:
199 ;; (setq browse-url-browser-function '(("^mailto:" . browse-url-mail)
200 ;; ("." . browse-url-netscape)))
202 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
203 ;;; Code:
205 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
206 ;; Variables
208 (eval-when-compile (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 "Lynx in an xterm window"
248 :value browse-url-lynx-xterm)
249 (function-item :tag "Lynx in an Emacs window"
250 :value browse-url-lynx-emacs)
251 (function-item :tag "KDE" :value browse-url-kde)
252 (function-item :tag "Specified by `Browse Url Generic Program'"
253 :value browse-url-generic)
254 (function-item :tag "Default Windows browser"
255 :value browse-url-default-windows-browser)
256 (function-item :tag "Default Mac OS X browser"
257 :value browse-url-default-macosx-browser)
258 (function-item :tag "GNOME invoking Mozilla"
259 :value browse-url-gnome-moz)
260 (function-item :tag "Default browser"
261 :value browse-url-default-browser)
262 (function :tag "Your own function")
263 (alist :tag "Regexp/function association list"
264 :key-type regexp :value-type function))
265 :version "21.1"
266 :group 'browse-url)
268 (defcustom browse-url-netscape-program "netscape"
269 ;; Info about netscape-remote from Karl Berry.
270 "The name by which to invoke Netscape.
272 The free program `netscape-remote' from
273 <URL:http://home.netscape.com/newsref/std/remote.c> is said to start
274 up very much quicker than `netscape'. Reported to compile on a GNU
275 system, given vroot.h from the same directory, with cc flags
276 -DSTANDALONE -L/usr/X11R6/lib -lXmu -lX11."
277 :type 'string
278 :group 'browse-url)
280 (defcustom browse-url-netscape-arguments nil
281 "A list of strings to pass to Netscape as arguments."
282 :type '(repeat (string :tag "Argument"))
283 :group 'browse-url)
285 (defcustom browse-url-netscape-startup-arguments browse-url-netscape-arguments
286 "A list of strings to pass to Netscape when it starts up.
287 Defaults to the value of `browse-url-netscape-arguments' at the time
288 `browse-url' is loaded."
289 :type '(repeat (string :tag "Argument"))
290 :group 'browse-url)
292 (defcustom browse-url-browser-display nil
293 "The X display for running the browser, if not same as Emacs'."
294 :type '(choice string (const :tag "Default" nil))
295 :group 'browse-url)
297 (defcustom browse-url-mozilla-program "mozilla"
298 "The name by which to invoke Mozilla."
299 :type 'string
300 :group 'browse-url)
302 (defcustom browse-url-mozilla-arguments nil
303 "A list of strings to pass to Mozilla as arguments."
304 :type '(repeat (string :tag "Argument"))
305 :group 'browse-url)
307 (defcustom browse-url-mozilla-startup-arguments browse-url-mozilla-arguments
308 "A list of strings to pass to Mozilla when it starts up.
309 Defaults to the value of `browse-url-mozilla-arguments' at the time
310 `browse-url' is loaded."
311 :type '(repeat (string :tag "Argument"))
312 :group 'browse-url)
314 ;;;###autoload
315 (defcustom browse-url-firefox-program "firefox"
316 "The name by which to invoke Firefox."
317 :type 'string
318 :group 'browse-url)
320 (defcustom browse-url-firefox-arguments nil
321 "A list of strings to pass to Firefox as arguments."
322 :type '(repeat (string :tag "Argument"))
323 :group 'browse-url)
325 (defcustom browse-url-firefox-startup-arguments browse-url-firefox-arguments
326 "A list of strings to pass to Firefox when it starts up.
327 Defaults to the value of `browse-url-firefox-arguments' at the time
328 `browse-url' is loaded."
329 :type '(repeat (string :tag "Argument"))
330 :group 'browse-url)
332 ;;;###autoload
333 (defcustom browse-url-galeon-program "galeon"
334 "The name by which to invoke Galeon."
335 :type 'string
336 :group 'browse-url)
338 (defcustom browse-url-galeon-arguments nil
339 "A list of strings to pass to Galeon as arguments."
340 :type '(repeat (string :tag "Argument"))
341 :group 'browse-url)
343 (defcustom browse-url-galeon-startup-arguments browse-url-galeon-arguments
344 "A list of strings to pass to Galeon when it starts up.
345 Defaults to the value of `browse-url-galeon-arguments' at the time
346 `browse-url' is loaded."
347 :type '(repeat (string :tag "Argument"))
348 :group 'browse-url)
350 (defcustom browse-url-epiphany-program "epiphany"
351 "The name by which to invoke Epiphany."
352 :type 'string
353 :group 'browse-url)
355 (defcustom browse-url-epiphany-arguments nil
356 "A list of strings to pass to Epiphany as arguments."
357 :type '(repeat (string :tag "Argument"))
358 :group 'browse-url)
360 (defcustom browse-url-epiphany-startup-arguments browse-url-epiphany-arguments
361 "A list of strings to pass to Epiphany when it starts up.
362 Defaults to the value of `browse-url-epiphany-arguments' at the time
363 `browse-url' is loaded."
364 :type '(repeat (string :tag "Argument"))
365 :group 'browse-url)
367 ;; GNOME means of invoking either Mozilla or Netrape.
368 (defvar browse-url-gnome-moz-program "gnome-moz-remote")
370 (defcustom browse-url-gnome-moz-arguments '()
371 "A list of strings passed to the GNOME mozilla viewer as arguments."
372 :version "21.1"
373 :type '(repeat (string :tag "Argument"))
374 :group 'browse-url)
376 (defcustom browse-url-mozilla-new-window-is-tab nil
377 "Whether to open up new windows in a tab or a new window.
378 If non-nil, then open the URL in a new tab rather than a new window if
379 `browse-url-mozilla' is asked to open it in a new window."
380 :type 'boolean
381 :group 'browse-url)
383 (defcustom browse-url-firefox-new-window-is-tab nil
384 "Whether to open up new windows in a tab or a new window.
385 If non-nil, then open the URL in a new tab rather than a new window if
386 `browse-url-firefox' is asked to open it in a new window.
388 This option is currently ignored on MS-Windows, since the necessary
389 functionality is not available there."
390 :type 'boolean
391 :group 'browse-url)
393 (defcustom browse-url-galeon-new-window-is-tab nil
394 "Whether to open up new windows in a tab or a new window.
395 If non-nil, then open the URL in a new tab rather than a new window if
396 `browse-url-galeon' is asked to open it in a new window."
397 :type 'boolean
398 :group 'browse-url)
400 (defcustom browse-url-epiphany-new-window-is-tab nil
401 "Whether to open up new windows in a tab or a new window.
402 If non-nil, then open the URL in a new tab rather than a new window if
403 `browse-url-epiphany' is asked to open it in a new window."
404 :type 'boolean
405 :group 'browse-url)
407 (defcustom browse-url-netscape-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
410 window if `browse-url-netscape' is asked to open it in a new
411 window."
412 :type 'boolean
413 :group 'browse-url)
415 (defcustom browse-url-new-window-flag nil
416 "If non-nil, always open a new browser window with appropriate browsers.
417 Passing an interactive argument to \\[browse-url], or specific browser
418 commands reverses the effect of this variable. Requires Netscape version
419 1.1N or later or XMosaic version 2.5 or later if using those browsers."
420 :type 'boolean
421 :group 'browse-url)
423 (defcustom browse-url-mosaic-program "xmosaic"
424 "The name by which to invoke Mosaic (or mMosaic)."
425 :type 'string
426 :version "20.3"
427 :group 'browse-url)
429 (defcustom browse-url-mosaic-arguments nil
430 "A list of strings to pass to Mosaic as arguments."
431 :type '(repeat (string :tag "Argument"))
432 :group 'browse-url)
434 (defcustom browse-url-mosaic-pidfile "~/.mosaicpid"
435 "The name of the pidfile created by Mosaic."
436 :type 'string
437 :group 'browse-url)
439 (defcustom browse-url-filename-alist
440 `(("^/\\(ftp@\\|anonymous@\\)?\\([^:]+\\):/*" . "ftp://\\2/")
441 ;; The above loses the username to avoid the browser prompting for
442 ;; it in anonymous cases. If it's not anonymous the next regexp
443 ;; applies.
444 ("^/\\([^:@]+@\\)?\\([^:]+\\):/*" . "ftp://\\1\\2/")
445 ,@(if (memq system-type '(windows-nt ms-dos cygwin))
446 '(("^\\([a-zA-Z]:\\)[\\/]" . "file:\\1/")
447 ("^[\\/][\\/]+" . "file://")))
448 ("^/+" . "file:/"))
449 "An alist of (REGEXP . STRING) pairs used by `browse-url-of-file'.
450 Any substring of a filename matching one of the REGEXPs is replaced by
451 the corresponding STRING using `replace-match', not treating STRING
452 literally. All pairs are applied in the order given. The default
453 value converts ange-ftp/EFS-style file names into ftp URLs and prepends
454 `file:' to any file name beginning with `/'.
456 For example, adding to the default a specific translation of an ange-ftp
457 address to an HTTP URL:
459 (setq browse-url-filename-alist
460 '((\"/webmaster@webserver:/home/www/html/\" .
461 \"http://www.acme.co.uk/\")
462 (\"^/\\(ftp@\\|anonymous@\\)?\\([^:]+\\):/*\" . \"ftp://\\2/\")
463 (\"^/\\([^:@]+@\\)?\\([^:]+\\):/*\" . \"ftp://\\1\\2/\")
464 (\"^/+\" . \"file:/\")))"
465 :type '(repeat (cons :format "%v"
466 (regexp :tag "Regexp")
467 (string :tag "Replacement")))
468 :version "20.3"
469 :group 'browse-url)
471 (defcustom browse-url-save-file nil
472 "If non-nil, save the buffer before displaying its file.
473 Used by the `browse-url-of-file' command."
474 :type 'boolean
475 :group 'browse-url)
477 (defcustom browse-url-of-file-hook nil
478 "Run after `browse-url-of-file' has asked a browser to load a file.
480 Set this to `browse-url-netscape-reload' to force Netscape to load the
481 file rather than displaying a cached copy."
482 :type 'hook
483 :options '(browse-url-netscape-reload)
484 :group 'browse-url)
486 (defcustom browse-url-CCI-port 3003
487 "Port to access XMosaic via CCI.
488 This can be any number between 1024 and 65535 but must correspond to
489 the value set in the browser."
490 :type 'integer
491 :group 'browse-url)
493 (defcustom browse-url-CCI-host "localhost"
494 "Host to access XMosaic via CCI.
495 This should be the host name of the machine running XMosaic with CCI
496 enabled. The port number should be set in `browse-url-CCI-port'."
497 :type 'string
498 :group 'browse-url)
500 (defvar browse-url-temp-file-name nil)
501 (make-variable-buffer-local 'browse-url-temp-file-name)
503 (defcustom browse-url-xterm-program "xterm"
504 "The name of the terminal emulator used by `browse-url-lynx-xterm'.
505 This might, for instance, be a separate color version of xterm."
506 :type 'string
507 :group 'browse-url)
509 (defcustom browse-url-xterm-args nil
510 "A list of strings defining options for `browse-url-xterm-program'.
511 These might set its size, for instance."
512 :type '(repeat (string :tag "Argument"))
513 :group 'browse-url)
515 (defcustom browse-url-lynx-emacs-args (and (not window-system)
516 '("-show_cursor"))
517 "A list of strings defining options for Lynx in an Emacs buffer.
519 The default is none in a window system, otherwise `-show_cursor' to
520 indicate the position of the current link in the absence of
521 highlighting, assuming the normal default for showing the cursor."
522 :type '(repeat (string :tag "Argument"))
523 :version "20.3"
524 :group 'browse-url)
526 (defcustom browse-url-gnudoit-program "gnudoit"
527 "The name of the `gnudoit' program used by `browse-url-w3-gnudoit'."
528 :type 'string
529 :group 'browse-url)
531 (defcustom browse-url-gnudoit-args '("-q")
532 "A list of strings defining options for `browse-url-gnudoit-program'.
533 These might set the port, for instance."
534 :type '(repeat (string :tag "Argument"))
535 :group 'browse-url)
537 (defcustom browse-url-generic-program nil
538 "The name of the browser program used by `browse-url-generic'."
539 :type '(choice string (const :tag "None" nil))
540 :group 'browse-url)
542 (defcustom browse-url-generic-args nil
543 "A list of strings defining options for `browse-url-generic-program'."
544 :type '(repeat (string :tag "Argument"))
545 :group 'browse-url)
547 (defcustom browse-url-temp-dir temporary-file-directory
548 "The name of a directory for browse-url's temporary files.
549 Such files are generated by functions like `browse-url-of-region'.
550 You might want to set this to somewhere with restricted read permissions
551 for privacy's sake."
552 :type 'string
553 :group 'browse-url)
555 (defcustom browse-url-netscape-version 3
556 "The version of Netscape you are using.
557 This affects how URL reloading is done; the mechanism changed
558 incompatibly at version 4."
559 :type 'number
560 :group 'browse-url)
562 (defcustom browse-url-lynx-input-field 'avoid
563 "Action on selecting an existing Lynx buffer at an input field.
564 What to do when sending a new URL to an existing Lynx buffer in Emacs
565 if the Lynx cursor is on an input field (in which case the `g' command
566 would be entered as data). Such fields are recognized by the
567 underlines ____. Allowed values: nil: disregard it, 'warn: warn the
568 user and don't emit the URL, 'avoid: try to avoid the field by moving
569 down (this *won't* always work)."
570 :type '(choice (const :tag "Move to try to avoid field" :value avoid)
571 (const :tag "Disregard" :value nil)
572 (const :tag "Warn, don't emit URL" :value warn))
573 :version "20.3"
574 :group 'browse-url)
576 (defcustom browse-url-lynx-input-attempts 10
577 "How many times to try to move down from a series of lynx input fields."
578 :type 'integer
579 :group 'browse-url)
581 (defcustom browse-url-lynx-input-delay 0.2
582 "How many seconds to wait for lynx between moves down from an input field."
583 :type 'number
584 :group 'browse-url)
586 (defcustom browse-url-kde-program "kfmclient"
587 "The name by which to invoke the KDE web browser."
588 :type 'string
589 :version "21.1"
590 :group 'browse-url)
592 (defcustom browse-url-kde-args '("openURL")
593 "A list of strings defining options for `browse-url-kde-program'."
594 :type '(repeat (string :tag "Argument"))
595 :group 'browse-url)
597 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
598 ;; URL input
600 ;;;###autoload
601 (defun browse-url-url-at-point ()
602 (let ((url (thing-at-point 'url)))
603 (set-text-properties 0 (length url) nil url)
604 url))
606 ;; Having this as a separate function called by the browser-specific
607 ;; functions allows them to be stand-alone commands, making it easier
608 ;; to switch between browsers.
610 (defun browse-url-interactive-arg (prompt)
611 "Read a URL from the minibuffer, prompting with PROMPT.
612 If `transient-mark-mode' is non-nil and the mark is active,
613 it defaults to the current region, else to the URL at or before
614 point. If invoked with a mouse button, it moves point to the
615 position clicked before acting.
617 This function returns a list (URL NEW-WINDOW-FLAG)
618 for use in `interactive'."
619 (let ((event (elt (this-command-keys) 0)))
620 (and (listp event) (mouse-set-point event)))
621 (list (read-string prompt (or (and transient-mark-mode mark-active
622 ;; rfc2396 Appendix E.
623 (replace-regexp-in-string
624 "[\t\r\f\n ]+" ""
625 (buffer-substring-no-properties
626 (region-beginning) (region-end))))
627 (browse-url-url-at-point)))
628 (not (eq (null browse-url-new-window-flag)
629 (null current-prefix-arg)))))
631 ;; called-interactive-p needs to be called at a function's top-level, hence
632 ;; this macro. We use that rather than interactive-p because
633 ;; use in a keyboard macro should not change this behavior.
634 (defmacro browse-url-maybe-new-window (arg)
635 `(if (or noninteractive (not (called-interactively-p)))
636 ,arg
637 browse-url-new-window-flag))
639 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
640 ;; Browse current buffer
642 ;;;###autoload
643 (defun browse-url-of-file (&optional file)
644 "Ask a WWW browser to display FILE.
645 Display the current buffer's file if FILE is nil or if called
646 interactively. Turn the filename into a URL with function
647 `browse-url-file-url'. Pass the URL to a browser using the
648 `browse-url' function then run `browse-url-of-file-hook'."
649 (interactive)
650 (or file
651 (setq file (buffer-file-name))
652 (error "Current buffer has no file"))
653 (let ((buf (get-file-buffer file)))
654 (if buf
655 (with-current-buffer buf
656 (cond ((not (buffer-modified-p)))
657 (browse-url-save-file (save-buffer))
658 (t (message "%s modified since last save" file))))))
659 (browse-url (browse-url-file-url file))
660 (run-hooks 'browse-url-of-file-hook))
662 (defun browse-url-file-url (file)
663 "Return the URL corresponding to FILE.
664 Use variable `browse-url-filename-alist' to map filenames to URLs."
665 (let ((coding (and default-enable-multibyte-characters
666 (or file-name-coding-system
667 default-file-name-coding-system))))
668 (if coding (setq file (encode-coding-string file coding))))
669 ;; URL-encode special chars, do % first
670 (let ((s 0))
671 (while (setq s (string-match "%" file s))
672 (setq file (replace-match "%25" t t file)
673 s (1+ s))))
674 (while (string-match "[*\"()',=;? ]" file)
675 (let ((enc (format "%%%x" (aref file (match-beginning 0)))))
676 (setq file (replace-match enc t t file))))
677 (dolist (map browse-url-filename-alist)
678 (when (and map (string-match (car map) file))
679 (setq file (replace-match (cdr map) t nil file))))
680 file)
682 ;;;###autoload
683 (defun browse-url-of-buffer (&optional buffer)
684 "Ask a WWW browser to display BUFFER.
685 Display the current buffer if BUFFER is nil. Display only the
686 currently visible part of BUFFER (from a temporary file) if buffer is
687 narrowed."
688 (interactive)
689 (save-excursion
690 (and buffer (set-buffer buffer))
691 (let ((file-name
692 ;; Ignore real name if restricted
693 (and (= (- (point-max) (point-min)) (buffer-size))
694 (or buffer-file-name
695 (and (boundp 'dired-directory) dired-directory)))))
696 (or file-name
697 (progn
698 (or browse-url-temp-file-name
699 (setq browse-url-temp-file-name
700 (convert-standard-filename
701 (make-temp-file
702 (expand-file-name "burl" browse-url-temp-dir)
703 nil ".html"))))
704 (setq file-name browse-url-temp-file-name)
705 (write-region (point-min) (point-max) file-name nil 'no-message)))
706 (browse-url-of-file file-name))))
708 (defun browse-url-delete-temp-file (&optional temp-file-name)
709 ;; Delete browse-url-temp-file-name from the file system
710 ;; If optional arg TEMP-FILE-NAME is non-nil, delete it instead
711 (let ((file-name (or temp-file-name browse-url-temp-file-name)))
712 (if (and file-name (file-exists-p file-name))
713 (delete-file file-name))))
715 (add-hook 'kill-buffer-hook 'browse-url-delete-temp-file)
717 ;;;###autoload
718 (defun browse-url-of-dired-file ()
719 "In Dired, ask a WWW browser to display the file named on this line."
720 (interactive)
721 (browse-url-of-file (dired-get-filename)))
723 ;;;###autoload
724 (defun browse-url-of-region (min max)
725 "Ask a WWW browser to display the current region."
726 (interactive "r")
727 (save-excursion
728 (save-restriction
729 (narrow-to-region min max)
730 (browse-url-of-buffer))))
732 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
733 ;; Browser-independent commands
735 ;; A generic command to call the current browse-url-browser-function
737 ;;;###autoload
738 (defun browse-url (url &rest args)
739 "Ask a WWW browser to load URL.
740 Prompts for a URL, defaulting to the URL at or before point. Variable
741 `browse-url-browser-function' says which browser to use."
742 (interactive (browse-url-interactive-arg "URL: "))
743 (unless (interactive-p)
744 (setq args (or args (list browse-url-new-window-flag))))
745 (let ((process-environment (copy-sequence process-environment)))
746 ;; When connected to various displays, be careful to use the display of
747 ;; the currently selected frame, rather than the original start display,
748 ;; which may not even exist any more.
749 (if (stringp (frame-parameter (selected-frame) 'display))
750 (setenv "DISPLAY" (frame-parameter (selected-frame) 'display)))
751 (if (functionp browse-url-browser-function)
752 (apply browse-url-browser-function url args)
753 ;; The `function' can be an alist; look down it for first match
754 ;; and apply the function (which might be a lambda).
755 (catch 'done
756 (dolist (bf browse-url-browser-function)
757 (when (string-match (car bf) url)
758 (apply (cdr bf) url args)
759 (throw 'done t)))
760 (error "No browse-url-browser-function matching URL %s"
761 url)))))
763 ;;;###autoload
764 (defun browse-url-at-point (&optional arg)
765 "Ask a WWW browser to load the URL at or before point.
766 Doesn't let you edit the URL like `browse-url'. Variable
767 `browse-url-browser-function' says which browser to use."
768 (interactive "P")
769 (let ((url (browse-url-url-at-point)))
770 (if url
771 (browse-url url (if arg
772 (not browse-url-new-window-flag)
773 browse-url-new-window-flag))
774 (error "No URL found"))))
776 ;;;###autoload
777 (defun browse-url-at-mouse (event)
778 "Ask a WWW browser to load a URL clicked with the mouse.
779 The URL is the one around or before the position of the mouse click
780 but point is not changed. Doesn't let you edit the URL like
781 `browse-url'. Variable `browse-url-browser-function' says which browser
782 to use."
783 (interactive "e")
784 (save-excursion
785 (mouse-set-point event)
786 ;; This handles browse-url-new-window-flag properly
787 ;; when it gets no arg.
788 (browse-url-at-point)))
790 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
791 ;; Browser-specific commands
793 ;; --- Default MS-Windows browser ---
795 (defvar dos-windows-version)
797 (defun browse-url-default-windows-browser (url &optional new-window)
798 (interactive (browse-url-interactive-arg "URL: "))
799 (if (eq system-type 'ms-dos)
800 (if dos-windows-version
801 (shell-command (concat "start " (shell-quote-argument url)))
802 (error "Browsing URLs is not supported on this system"))
803 (w32-shell-execute "open" url)))
805 (defun browse-url-default-macosx-browser (url &optional new-window)
806 (interactive (browse-url-interactive-arg "URL: "))
807 (start-process (concat "open " url) nil "open" url))
809 ;; --- Netscape ---
811 (defun browse-url-process-environment ()
812 "Set DISPLAY in the environment to the X display the browser will use.
813 This is either the value of variable `browse-url-browser-display' if
814 non-nil, or the same display as Emacs if different from the current
815 environment, otherwise just use the current environment."
816 (let ((display (or browse-url-browser-display (browse-url-emacs-display))))
817 (if display
818 (cons (concat "DISPLAY=" display) process-environment)
819 process-environment)))
821 (defun browse-url-emacs-display ()
822 "Return the X display Emacs is running on.
823 This is nil if the display is the same as the DISPLAY environment variable.
825 Actually Emacs could be using several displays; this just returns the
826 one showing the selected frame."
827 (let ((display (cdr-safe (assq 'display (frame-parameters)))))
828 (and (not (equal display (getenv "DISPLAY")))
829 display)))
831 ;;;###autoload
832 (defun browse-url-default-browser (url &rest args)
833 "Find a suitable browser and ask it to load URL.
834 Default to the URL around or before point.
836 When called interactively, if variable `browse-url-new-window-flag' is
837 non-nil, load the document in a new window, if possible, otherwise use
838 a random existing one. A non-nil interactive prefix argument reverses
839 the effect of `browse-url-new-window-flag'.
841 When called non-interactively, optional second argument NEW-WINDOW is
842 used instead of `browse-url-new-window-flag'.
844 The order attempted is gnome-moz-remote, Mozilla, Firefox,
845 Galeon, Konqueror, Netscape, Mosaic, Lynx in an xterm, and then W3."
846 (apply
847 (cond
848 ((executable-find browse-url-gnome-moz-program) 'browse-url-gnome-moz)
849 ((executable-find browse-url-mozilla-program) 'browse-url-mozilla)
850 ((executable-find browse-url-firefox-program) 'browse-url-firefox)
851 ((executable-find browse-url-galeon-program) 'browse-url-galeon)
852 ((executable-find browse-url-kde-program) 'browse-url-kde)
853 ((executable-find browse-url-netscape-program) 'browse-url-netscape)
854 ((executable-find browse-url-mosaic-program) 'browse-url-mosaic)
855 ((executable-find browse-url-xterm-program) 'browse-url-lynx-xterm)
856 ((locate-library "w3") 'browse-url-w3)
858 (lambda (&ignore args) (error "No usable browser found"))))
859 url args))
861 ;;;###autoload
862 (defun browse-url-netscape (url &optional new-window)
863 "Ask the Netscape WWW browser to load URL.
864 Default to the URL around or before point. The strings in variable
865 `browse-url-netscape-arguments' are also passed to Netscape.
867 When called interactively, if variable `browse-url-new-window-flag' is
868 non-nil, load the document in a new Netscape window, otherwise use a
869 random existing one. A non-nil interactive prefix argument reverses
870 the effect of `browse-url-new-window-flag'.
872 If `browse-url-netscape-new-window-is-tab' is non-nil, then
873 whenever a document would otherwise be loaded in a new window, it
874 is loaded in a new tab in an existing window instead.
876 When called non-interactively, optional second argument NEW-WINDOW is
877 used instead of `browse-url-new-window-flag'."
878 (interactive (browse-url-interactive-arg "URL: "))
879 ;; URL encode any `confusing' characters in the URL. This needs to
880 ;; include at least commas; presumably also close parens and dollars.
881 (while (string-match "[,)$]" url)
882 (setq url (replace-match
883 (format "%%%x" (string-to-char (match-string 0 url))) t t url)))
884 (let* ((process-environment (browse-url-process-environment))
885 (process
886 (apply 'start-process
887 (concat "netscape " url) nil
888 browse-url-netscape-program
889 (append
890 browse-url-netscape-arguments
891 (if (eq window-system 'w32)
892 (list url)
893 (append
894 (if new-window '("-noraise"))
895 (list "-remote"
896 (concat "openURL(" url
897 (if (browse-url-maybe-new-window
898 new-window)
899 (if browse-url-netscape-new-window-is-tab
900 ",new-tab"
901 ",new-window"))
902 ")"))))))))
903 (set-process-sentinel process
904 `(lambda (process change)
905 (browse-url-netscape-sentinel process ,url)))))
907 (defun browse-url-netscape-sentinel (process url)
908 "Handle a change to the process communicating with Netscape."
909 (or (eq (process-exit-status process) 0)
910 (let* ((process-environment (browse-url-process-environment)))
911 ;; Netscape not running - start it
912 (message "Starting %s..." browse-url-netscape-program)
913 (apply 'start-process (concat "netscape" url) nil
914 browse-url-netscape-program
915 (append browse-url-netscape-startup-arguments (list url))))))
917 (defun browse-url-netscape-reload ()
918 "Ask Netscape to reload its current document.
919 How depends on `browse-url-netscape-version'."
920 (interactive)
921 ;; Backwards incompatibility reported by
922 ;; <peter.kruse@psychologie.uni-regensburg.de>.
923 (browse-url-netscape-send (if (>= browse-url-netscape-version 4)
924 "xfeDoCommand(reload)"
925 "reload")))
927 (defun browse-url-netscape-send (command)
928 "Send a remote control command to Netscape."
929 (let* ((process-environment (browse-url-process-environment)))
930 (apply 'start-process "netscape" nil
931 browse-url-netscape-program
932 (append browse-url-netscape-arguments
933 (list "-remote" command)))))
935 ;;;###autoload
936 (defun browse-url-mozilla (url &optional new-window)
937 "Ask the Mozilla WWW browser to load URL.
938 Default to the URL around or before point. The strings in variable
939 `browse-url-mozilla-arguments' are also passed to Mozilla.
941 When called interactively, if variable `browse-url-new-window-flag' is
942 non-nil, load the document in a new Mozilla window, otherwise use a
943 random existing one. A non-nil interactive prefix argument reverses
944 the effect of `browse-url-new-window-flag'.
946 If `browse-url-mozilla-new-window-is-tab' is non-nil, then whenever a
947 document would otherwise be loaded in a new window, it is loaded in a
948 new tab in an existing window instead.
950 When called non-interactively, optional second argument NEW-WINDOW is
951 used instead of `browse-url-new-window-flag'."
952 (interactive (browse-url-interactive-arg "URL: "))
953 ;; URL encode any `confusing' characters in the URL. This needs to
954 ;; include at least commas; presumably also close parens and dollars.
955 (while (string-match "[,)$]" url)
956 (setq url (replace-match
957 (format "%%%x" (string-to-char (match-string 0 url))) t t url)))
958 (let* ((process-environment (browse-url-process-environment))
959 (process
960 (apply 'start-process
961 (concat "mozilla " url) nil
962 browse-url-mozilla-program
963 (append
964 browse-url-mozilla-arguments
965 (list "-remote"
966 (concat "openURL("
968 (if (browse-url-maybe-new-window
969 new-window)
970 (if browse-url-mozilla-new-window-is-tab
971 ",new-tab"
972 ",new-window"))
973 ")"))))))
974 (set-process-sentinel process
975 `(lambda (process change)
976 (browse-url-mozilla-sentinel process ,url)))))
978 (defun browse-url-mozilla-sentinel (process url)
979 "Handle a change to the process communicating with Mozilla."
980 (or (eq (process-exit-status process) 0)
981 (let* ((process-environment (browse-url-process-environment)))
982 ;; Mozilla is not running - start it
983 (message "Starting %s..." browse-url-mozilla-program)
984 (apply 'start-process (concat "mozilla " url) nil
985 browse-url-mozilla-program
986 (append browse-url-mozilla-startup-arguments (list url))))))
988 ;;;###autoload
989 (defun browse-url-firefox (url &optional new-window)
990 "Ask the Firefox WWW browser to load URL.
991 Default to the URL around or before point. The strings in
992 variable `browse-url-firefox-arguments' are also passed to
993 Firefox.
995 When called interactively, if variable
996 `browse-url-new-window-flag' is non-nil, load the document in a
997 new Firefox window, otherwise use a random existing one. A
998 non-nil interactive prefix argument reverses the effect of
999 `browse-url-new-window-flag'.
1001 If `browse-url-firefox-new-window-is-tab' is non-nil, then
1002 whenever a document would otherwise be loaded in a new window, it
1003 is loaded in a new tab in an existing window instead.
1005 When called non-interactively, optional second argument
1006 NEW-WINDOW is used instead of `browse-url-new-window-flag'.
1008 On MS-Windows systems the optional `new-window' parameter is
1009 ignored. Firefox for Windows does not support the \"-remote\"
1010 command line parameter. Therefore, the
1011 `browse-url-new-window-flag' and `browse-url-firefox-new-window-is-tab'
1012 are ignored as well. Firefox on Windows will always open the requested
1013 URL in a new window."
1014 (interactive (browse-url-interactive-arg "URL: "))
1015 ;; URL encode any `confusing' characters in the URL. This needs to
1016 ;; include at least commas; presumably also close parens.
1017 (while (string-match "[,)]" url)
1018 (setq url (replace-match
1019 (format "%%%x" (string-to-char (match-string 0 url))) t t url)))
1020 (let* ((process-environment (browse-url-process-environment))
1021 (process
1022 (apply 'start-process
1023 (concat "firefox " url) nil
1024 browse-url-firefox-program
1025 (append
1026 browse-url-firefox-arguments
1027 (if (or (featurep 'dos-w32)
1028 (string-match "win32" system-configuration))
1029 (list url)
1030 (list "-remote"
1031 (concat "openURL("
1033 (if (browse-url-maybe-new-window
1034 new-window)
1035 (if browse-url-firefox-new-window-is-tab
1036 ",new-tab"
1037 ",new-window"))
1038 ")")))))))
1039 (set-process-sentinel process
1040 `(lambda (process change)
1041 (browse-url-firefox-sentinel process ,url)))))
1043 (defun browse-url-firefox-sentinel (process url)
1044 "Handle a change to the process communicating with Firefox."
1045 (or (eq (process-exit-status process) 0)
1046 (let* ((process-environment (browse-url-process-environment)))
1047 ;; Firefox is not running - start it
1048 (message "Starting Firefox...")
1049 (apply 'start-process (concat "firefox " url) nil
1050 browse-url-firefox-program
1051 (append browse-url-firefox-startup-arguments (list url))))))
1053 ;;;###autoload
1054 (defun browse-url-galeon (url &optional new-window)
1055 "Ask the Galeon WWW browser to load URL.
1056 Default to the URL around or before point. The strings in variable
1057 `browse-url-galeon-arguments' are also passed to Galeon.
1059 When called interactively, if variable `browse-url-new-window-flag' is
1060 non-nil, load the document in a new Galeon window, otherwise use a
1061 random existing one. A non-nil interactive prefix argument reverses
1062 the effect of `browse-url-new-window-flag'.
1064 If `browse-url-galeon-new-window-is-tab' is non-nil, then whenever a
1065 document would otherwise be loaded in a new window, it is loaded in a
1066 new tab in an existing window instead.
1068 When called non-interactively, optional second argument NEW-WINDOW is
1069 used instead of `browse-url-new-window-flag'."
1070 (interactive (browse-url-interactive-arg "URL: "))
1071 ;; URL encode any `confusing' characters in the URL. This needs to
1072 ;; include at least commas; presumably also close parens and dollars.
1073 (while (string-match "[,)$]" url)
1074 (setq url (replace-match
1075 (format "%%%x" (string-to-char (match-string 0 url))) t t url)))
1076 (let* ((process-environment (browse-url-process-environment))
1077 (process (apply 'start-process
1078 (concat "galeon " url)
1080 browse-url-galeon-program
1081 (append
1082 browse-url-galeon-arguments
1083 (if (browse-url-maybe-new-window new-window)
1084 (if browse-url-galeon-new-window-is-tab
1085 '("--new-tab")
1086 '("--new-window" "--noraise"))
1087 '("--existing"))
1088 (list url)))))
1089 (set-process-sentinel process
1090 `(lambda (process change)
1091 (browse-url-galeon-sentinel process ,url)))))
1093 (defun browse-url-galeon-sentinel (process url)
1094 "Handle a change to the process communicating with Galeon."
1095 (or (eq (process-exit-status process) 0)
1096 (let* ((process-environment (browse-url-process-environment)))
1097 ;; Galeon is not running - start it
1098 (message "Starting %s..." browse-url-galeon-program)
1099 (apply 'start-process (concat "galeon " url) nil
1100 browse-url-galeon-program
1101 (append browse-url-galeon-startup-arguments (list url))))))
1103 (defun browse-url-epiphany (url &optional new-window)
1104 "Ask the Epiphany WWW browser to load URL.
1105 Default to the URL around or before point. The strings in variable
1106 `browse-url-galeon-arguments' are also passed to Epiphany.
1108 When called interactively, if variable `browse-url-new-window-flag' is
1109 non-nil, load the document in a new Epiphany window, otherwise use a
1110 random existing one. A non-nil interactive prefix argument reverses
1111 the effect of `browse-url-new-window-flag'.
1113 If `browse-url-epiphany-new-window-is-tab' is non-nil, then whenever a
1114 document would otherwise be loaded in a new window, it is loaded in a
1115 new tab in an existing window instead.
1117 When called non-interactively, optional second argument NEW-WINDOW is
1118 used instead of `browse-url-new-window-flag'."
1119 (interactive (browse-url-interactive-arg "URL: "))
1120 ;; URL encode any `confusing' characters in the URL. This needs to
1121 ;; include at least commas; presumably also close parens and dollars.
1122 (while (string-match "[,)$]" url)
1123 (setq url (replace-match
1124 (format "%%%x" (string-to-char (match-string 0 url))) t t url)))
1125 (let* ((process-environment (browse-url-process-environment))
1126 (process (apply 'start-process
1127 (concat "epiphany " url)
1129 browse-url-epiphany-program
1130 (append
1131 browse-url-epiphany-arguments
1132 (if (browse-url-maybe-new-window new-window)
1133 (if browse-url-epiphany-new-window-is-tab
1134 '("--new-tab")
1135 '("--new-window" "--noraise"))
1136 '("--existing"))
1137 (list url)))))
1138 (set-process-sentinel process
1139 `(lambda (process change)
1140 (browse-url-epiphany-sentinel process ,url)))))
1142 (defun browse-url-epiphany-sentinel (process url)
1143 "Handle a change to the process communicating with Epiphany."
1144 (or (eq (process-exit-status process) 0)
1145 (let* ((process-environment (browse-url-process-environment)))
1146 ;; Epiphany is not running - start it
1147 (message "Starting %s..." browse-url-epiphany-program)
1148 (apply 'start-process (concat "epiphany " url) nil
1149 browse-url-epiphany-program
1150 (append browse-url-epiphany-startup-arguments (list url))))))
1152 ;;;###autoload
1153 (defun browse-url-emacs (url &optional new-window)
1154 "Ask Emacs to load URL into a buffer and show it in another window."
1155 (interactive (browse-url-interactive-arg "URL: "))
1156 (require 'url-handlers)
1157 (let ((file-name-handler-alist
1158 (cons (cons url-handler-regexp 'url-file-handler)
1159 file-name-handler-alist)))
1160 ;; Ignore `new-window': with all other browsers the URL is always shown
1161 ;; in another window than the current Emacs one since it's shown in
1162 ;; another application's window.
1163 ;; (if new-window (find-file-other-window url) (find-file url))
1164 (find-file-other-window url)))
1166 ;;;###autoload
1167 (defun browse-url-gnome-moz (url &optional new-window)
1168 "Ask Mozilla/Netscape to load URL via the GNOME program `gnome-moz-remote'.
1169 Default to the URL around or before point. The strings in variable
1170 `browse-url-gnome-moz-arguments' are also passed.
1172 When called interactively, if variable `browse-url-new-window-flag' is
1173 non-nil, load the document in a new browser window, otherwise use an
1174 existing one. A non-nil interactive prefix argument reverses the
1175 effect of `browse-url-new-window-flag'.
1177 When called non-interactively, optional second argument NEW-WINDOW is
1178 used instead of `browse-url-new-window-flag'."
1179 (interactive (browse-url-interactive-arg "URL: "))
1180 (apply 'start-process (concat "gnome-moz-remote " url)
1182 browse-url-gnome-moz-program
1183 (append
1184 browse-url-gnome-moz-arguments
1185 (if (browse-url-maybe-new-window new-window)
1186 '("--newwin"))
1187 (list "--raise" url))))
1189 ;; --- Mosaic ---
1191 ;;;###autoload
1192 (defun browse-url-mosaic (url &optional new-window)
1193 "Ask the XMosaic WWW browser to load URL.
1195 Default to the URL around or before point. The strings in variable
1196 `browse-url-mosaic-arguments' are also passed to Mosaic and the
1197 program is invoked according to the variable
1198 `browse-url-mosaic-program'.
1200 When called interactively, if variable `browse-url-new-window-flag' is
1201 non-nil, load the document in a new Mosaic window, otherwise use a
1202 random existing one. A non-nil interactive prefix argument reverses
1203 the effect of `browse-url-new-window-flag'.
1205 When called non-interactively, optional second argument NEW-WINDOW is
1206 used instead of `browse-url-new-window-flag'."
1207 (interactive (browse-url-interactive-arg "Mosaic URL: "))
1208 (let ((pidfile (expand-file-name browse-url-mosaic-pidfile))
1209 pid)
1210 (if (file-readable-p pidfile)
1211 (save-excursion
1212 (find-file pidfile)
1213 (goto-char (point-min))
1214 (setq pid (read (current-buffer)))
1215 (kill-buffer nil)))
1216 (if (and pid (zerop (signal-process pid 0))) ; Mosaic running
1217 (save-excursion
1218 (find-file (format "/tmp/Mosaic.%d" pid))
1219 (erase-buffer)
1220 (insert (if (browse-url-maybe-new-window new-window)
1221 "newwin\n"
1222 "goto\n")
1223 url "\n")
1224 (save-buffer)
1225 (kill-buffer nil)
1226 ;; Send signal SIGUSR to Mosaic
1227 (message "Signaling Mosaic...")
1228 (signal-process pid 'SIGUSR1)
1229 ;; Or you could try:
1230 ;; (call-process "kill" nil 0 nil "-USR1" (int-to-string pid))
1231 (message "Signaling Mosaic...done")
1233 ;; Mosaic not running - start it
1234 (message "Starting %s..." browse-url-mosaic-program)
1235 (apply 'start-process "xmosaic" nil browse-url-mosaic-program
1236 (append browse-url-mosaic-arguments (list url)))
1237 (message "Starting %s...done" browse-url-mosaic-program))))
1239 ;; --- Mosaic using CCI ---
1241 ;;;###autoload
1242 (defun browse-url-cci (url &optional new-window)
1243 "Ask the XMosaic WWW browser to load URL.
1244 Default to the URL around or before point.
1246 This function only works for XMosaic version 2.5 or later. You must
1247 select `CCI' from XMosaic's File menu, set the CCI Port Address to the
1248 value of variable `browse-url-CCI-port', and enable `Accept requests'.
1250 When called interactively, if variable `browse-url-new-window-flag' is
1251 non-nil, load the document in a new browser window, otherwise use a
1252 random existing one. A non-nil interactive prefix argument reverses
1253 the effect of `browse-url-new-window-flag'.
1255 When called non-interactively, optional second argument NEW-WINDOW is
1256 used instead of `browse-url-new-window-flag'."
1257 (interactive (browse-url-interactive-arg "Mosaic URL: "))
1258 (open-network-stream "browse-url" " *browse-url*"
1259 browse-url-CCI-host browse-url-CCI-port)
1260 ;; Todo: start browser if fails
1261 (process-send-string "browse-url"
1262 (concat "get url (" url ") output "
1263 (if (browse-url-maybe-new-window new-window)
1264 "new"
1265 "current")
1266 "\r\n"))
1267 (process-send-string "browse-url" "disconnect\r\n")
1268 (delete-process "browse-url"))
1270 ;; --- W3 ---
1272 ;;;###autoload
1273 (defun browse-url-w3 (url &optional new-window)
1274 "Ask the w3 WWW browser to load URL.
1275 Default to the URL around or before point.
1277 When called interactively, if variable `browse-url-new-window-flag' is
1278 non-nil, load the document in a new window. A non-nil interactive
1279 prefix argument reverses the effect of `browse-url-new-window-flag'.
1281 When called non-interactively, optional second argument NEW-WINDOW is
1282 used instead of `browse-url-new-window-flag'."
1283 (interactive (browse-url-interactive-arg "W3 URL: "))
1284 (require 'w3) ; w3-fetch-other-window not autoloaded
1285 (if (browse-url-maybe-new-window new-window)
1286 (w3-fetch-other-window url)
1287 (w3-fetch url)))
1289 ;;;###autoload
1290 (defun browse-url-w3-gnudoit (url &optional new-window)
1291 ;; new-window ignored
1292 "Ask another Emacs running gnuserv to load the URL using the W3 browser.
1293 The `browse-url-gnudoit-program' program is used with options given by
1294 `browse-url-gnudoit-args'. Default to the URL around or before point."
1295 (interactive (browse-url-interactive-arg "W3 URL: "))
1296 (apply 'start-process (concat "gnudoit:" url) nil
1297 browse-url-gnudoit-program
1298 (append browse-url-gnudoit-args
1299 (list (concat "(w3-fetch \"" url "\")")
1300 "(raise-frame)"))))
1302 ;; --- Lynx in an xterm ---
1304 ;;;###autoload
1305 (defun browse-url-lynx-xterm (url &optional new-window)
1306 ;; new-window ignored
1307 "Ask the Lynx WWW browser to load URL.
1308 Default to the URL around or before point. A new Lynx process is run
1309 in an Xterm window using the Xterm program named by `browse-url-xterm-program'
1310 with possible additional arguments `browse-url-xterm-args'."
1311 (interactive (browse-url-interactive-arg "Lynx URL: "))
1312 (apply #'start-process `(,(concat "lynx" url) nil ,browse-url-xterm-program
1313 ,@browse-url-xterm-args "-e" "lynx"
1314 ,url)))
1316 ;; --- Lynx in an Emacs "term" window ---
1318 ;;;###autoload
1319 (defun browse-url-lynx-emacs (url &optional new-buffer)
1320 "Ask the Lynx WWW browser to load URL.
1321 Default to the URL around or before point. With a prefix argument, run
1322 a new Lynx process in a new buffer.
1324 When called interactively, if variable `browse-url-new-window-flag' is
1325 non-nil, load the document in a new lynx in a new term window,
1326 otherwise use any existing one. A non-nil interactive prefix argument
1327 reverses the effect of `browse-url-new-window-flag'.
1329 When called non-interactively, optional second argument NEW-WINDOW is
1330 used instead of `browse-url-new-window-flag'."
1331 (interactive (browse-url-interactive-arg "Lynx URL: "))
1332 (let* ((system-uses-terminfo t) ; Lynx uses terminfo
1333 ;; (term-term-name "vt100") ; ??
1334 (buf (get-buffer "*lynx*"))
1335 (proc (and buf (get-buffer-process buf)))
1336 (n browse-url-lynx-input-attempts))
1337 (if (and (browse-url-maybe-new-window new-buffer) buf)
1338 ;; Rename away the OLD buffer. This isn't very polite, but
1339 ;; term insists on working in a buffer named *lynx* and would
1340 ;; choke on *lynx*<1>
1341 (progn (set-buffer buf)
1342 (rename-uniquely)))
1343 (if (or (browse-url-maybe-new-window new-buffer)
1344 (not buf)
1345 (not proc)
1346 (not (memq (process-status proc) '(run stop))))
1347 ;; start a new lynx
1348 (progn
1349 (setq buf
1350 (apply #'make-term
1351 `("lynx" "lynx" nil ,@browse-url-lynx-emacs-args
1352 ,url)))
1353 (switch-to-buffer buf)
1354 (term-char-mode)
1355 (set-process-sentinel
1356 (get-buffer-process buf)
1357 ;; Don't leave around a dead one (especially because of its
1358 ;; munged keymap.)
1359 (lambda (process event)
1360 (if (not (memq (process-status process) '(run stop)))
1361 (let ((buf (process-buffer process)))
1362 (if buf (kill-buffer buf)))))))
1363 ;; send the url to lynx in the old buffer
1364 (let ((win (get-buffer-window buf t)))
1365 (if win
1366 (select-window win)
1367 (switch-to-buffer buf)))
1368 (if (eq (following-char) ?_)
1369 (cond ((eq browse-url-lynx-input-field 'warn)
1370 (error "Please move out of the input field first"))
1371 ((eq browse-url-lynx-input-field 'avoid)
1372 (while (and (eq (following-char) ?_) (> n 0))
1373 (term-send-down) ; down arrow
1374 (sit-for browse-url-lynx-input-delay))
1375 (if (eq (following-char) ?_)
1376 (error "Cannot move out of the input field, sorry")))))
1377 (term-send-string proc (concat "g" ; goto
1378 "\C-u" ; kill default url
1380 "\r")))))
1382 ;; --- mailto ---
1384 (autoload 'rfc2368-parse-mailto-url "rfc2368")
1386 ;;;###autoload
1387 (defun browse-url-mail (url &optional new-window)
1388 "Open a new mail message buffer within Emacs for the RFC 2368 URL.
1389 Default to using the mailto: URL around or before point as the
1390 recipient's address. Supplying a non-nil interactive prefix argument
1391 will cause the mail to be composed in another window rather than the
1392 current one.
1394 When called interactively, if variable `browse-url-new-window-flag' is
1395 non-nil use `compose-mail-other-window', otherwise `compose-mail'. A
1396 non-nil interactive prefix argument reverses the effect of
1397 `browse-url-new-window-flag'.
1399 When called non-interactively, optional second argument NEW-WINDOW is
1400 used instead of `browse-url-new-window-flag'."
1401 (interactive (browse-url-interactive-arg "Mailto URL: "))
1402 (save-excursion
1403 (let* ((alist (rfc2368-parse-mailto-url url))
1404 (to (assoc "To" alist))
1405 (subject (assoc "Subject" alist))
1406 (body (assoc "Body" alist))
1407 (rest (delete to (delete subject (delete body alist))))
1408 (to (cdr to))
1409 (subject (cdr subject))
1410 (body (cdr body))
1411 (mail-citation-hook (unless body mail-citation-hook)))
1412 (if (browse-url-maybe-new-window new-window)
1413 (compose-mail-other-window to subject rest nil
1414 (if body
1415 (list 'insert body)
1416 (list 'insert-buffer (current-buffer))))
1417 (compose-mail to subject rest nil nil
1418 (if body
1419 (list 'insert body)
1420 (list 'insert-buffer (current-buffer))))))))
1422 ;; --- Random browser ---
1424 ;;;###autoload
1425 (defun browse-url-generic (url &optional new-window)
1426 ;; new-window ignored
1427 "Ask the WWW browser defined by `browse-url-generic-program' to load URL.
1428 Default to the URL around or before point. A fresh copy of the
1429 browser is started up in a new process with possible additional arguments
1430 `browse-url-generic-args'. This is appropriate for browsers which
1431 don't offer a form of remote control."
1432 (interactive (browse-url-interactive-arg "URL: "))
1433 (if (not browse-url-generic-program)
1434 (error "No browser defined (`browse-url-generic-program')"))
1435 (apply 'call-process browse-url-generic-program nil
1436 0 nil
1437 (append browse-url-generic-args (list url))))
1439 ;;;###autoload
1440 (defun browse-url-kde (url &optional new-window)
1441 "Ask the KDE WWW browser to load URL.
1442 Default to the URL around or before point."
1443 (interactive (browse-url-interactive-arg "KDE URL: "))
1444 (message "Sending URL to KDE...")
1445 (apply #'start-process (concat "KDE " url) nil browse-url-kde-program
1446 (append browse-url-kde-args (list url))))
1448 (provide 'browse-url)
1450 ;; arch-tag: d2079573-5c06-4097-9598-f550fba19430
1451 ;;; browse-url.el ends here