(comint-input-ring-size): Increase to 150.
[emacs.git] / lisp / net / browse-url.el
blob098f2988f1b81ff7ce5107c6ad16d1c96b14330a
1 ;;; browse-url.el --- pass a URL to a WWW browser
3 ;; Copyright (C) 1995, 96, 97, 98, 99, 2000, 2001, 2004
4 ;; 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 2, 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., 59 Temple Place - Suite 330,
26 ;; Boston, MA 02111-1307, 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-galeon Galeon Don't know
42 ;; browse-url-epiphany Epiphany Don't know
43 ;; browse-url-netscape Netscape 1.1b1
44 ;; browse-url-mosaic XMosaic/mMosaic <= 2.4
45 ;; browse-url-cci XMosaic 2.5
46 ;; browse-url-w3 w3 0
47 ;; browse-url-w3-gnudoit w3 remotely
48 ;; browse-url-iximosaic IXI Mosaic ?
49 ;; browse-url-lynx-* Lynx 0
50 ;; browse-url-grail Grail 0.3b1
51 ;; browse-url-mmm MMM ?
52 ;; browse-url-generic arbitrary
53 ;; browse-url-default-windows-browser MS-Windows browser
54 ;; browse-url-default-macosx-browser Mac OS X browser
55 ;; browse-url-gnome-moz GNOME interface to Mozilla
56 ;; browse-url-kde KDE konqueror (kfm)
58 ;; [A version of the Netscape browser is now free software
59 ;; <URL:http://www.mozilla.org/>, albeit not GPLed, so it is
60 ;; reasonable to have that as the default.]
62 ;; Note that versions of Netscape before 1.1b1 did not have remote
63 ;; control. <URL:http://www.netscape.com/newsref/std/x-remote.html>.
65 ;; Browsers can cache Web pages so it may be necessary to tell them to
66 ;; reload the current page if it has changed (e.g. if you have edited
67 ;; it). There is currently no perfect automatic solution to this.
69 ;; Netscape allows you to specify the id of the window you want to
70 ;; control but which window DO you want to control and how do you
71 ;; discover its id?
73 ;; William M. Perry's excellent "w3" WWW browser for
74 ;; Emacs <URL:ftp://cs.indiana.edu/pub/elisp/w3/>
75 ;; has a function w3-follow-url-at-point, but that
76 ;; doesn't let you edit the URL like browse-url.
77 ;; The `gnuserv' package that can be used to control it in another
78 ;; Emacs process is available from
79 ;; <URL:ftp://ftp.splode.com/pub/users/friedman/packages/>.
81 ;; Grail is the freely available WWW browser implemented in Python, a
82 ;; cool object-oriented freely available interpreted language. Grail
83 ;; 0.3b1 was the first version to have remote control as distributed.
84 ;; For more information on Grail see
85 ;; <URL:http://grail.cnri.reston.va.us/> and for more information on
86 ;; Python see <url:http://www.python.org/>. Grail support in
87 ;; browse-url.el written by Barry Warsaw <bwarsaw@python.org>.
89 ;; Lynx is now distributed by the FSF. See also
90 ;; <URL:http://lynx.browser.org/>.
92 ;; Free graphical browsers that could be used by `browse-url-generic'
93 ;; include Chimera <URL:ftp://ftp.cs.unlv.edu/pub/chimera> and
94 ;; <URL:http://www.unlv.edu/chimera/>, Arena
95 ;; <URL:ftp://ftp.yggdrasil.com/pub/dist/web/arena> and Amaya
96 ;; <URL:ftp://ftp.w3.org/pub/amaya>. mMosaic
97 ;; <URL:ftp://ftp.enst.fr/pub/mbone/mMosaic/>,
98 ;; <URL:http://www.enst.fr/~dauphin/mMosaic/> (with development
99 ;; support for Java applets and multicast) can be used like Mosaic by
100 ;; setting `browse-url-mosaic-program' appropriately.
102 ;; I [Denis Howe, not Dave Love] recommend Nelson Minar
103 ;; <nelson@santafe.edu>'s excellent html-helper-mode.el for editing
104 ;; HTML and thank Nelson for his many useful comments on this code.
105 ;; <URL:http://www.santafe.edu/%7Enelson/hhm-beta/>
107 ;; See also hm--html-menus <URL:http://www.tnt.uni-hannover.de/%7Emuenkel/
108 ;; software/own/hm--html-menus/>. For composing correct HTML see also
109 ;; PSGML the general SGML structure editor package
110 ;; <URL:ftp://ftp.lysator.liu.se/pub/sgml>; hm--html-menus can be used
111 ;; with this.
113 ;; This package generalises function html-previewer-process in Marc
114 ;; Andreessen's html-mode (LCD modes/html-mode.el.Z). See also the
115 ;; ffap.el package. The huge hyperbole package also contains similar
116 ;; functions.
118 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
119 ;; Help!
121 ;; Can you write and test some code for the Macintrash and Windoze
122 ;; Netscape remote control APIs? (See the URL above).
124 ;; Do any other browsers have remote control?
126 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
127 ;; Usage
129 ;; To display the URL at or before point:
130 ;; M-x browse-url-at-point RET
131 ;; or, similarly but with the opportunity to edit the URL extracted from
132 ;; the buffer, use:
133 ;; M-x browse-url
135 ;; To display a URL by shift-clicking on it, put this in your ~/.emacs
136 ;; file:
137 ;; (global-set-key [S-mouse-2] 'browse-url-at-mouse)
138 ;; (Note that using Shift-mouse-1 is not desirable because
139 ;; that event has a standard meaning in Emacs.)
141 ;; To display the current buffer in a web browser:
142 ;; M-x browse-url-of-buffer RET
144 ;; To display the current region in a web browser:
145 ;; M-x browse-url-of-region RET
147 ;; In Dired, to display the file named on the current line:
148 ;; M-x browse-url-of-dired-file RET
150 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
151 ;; Customisation (~/.emacs)
153 ;; To see what variables are available for customization, type
154 ;; `M-x set-variable browse-url TAB'. Better, use
155 ;; `M-x customize-group browse-url'.
157 ;; Bind the browse-url commands to keys with the `C-c C-z' prefix
158 ;; (as used by html-helper-mode):
159 ;; (global-set-key "\C-c\C-z." 'browse-url-at-point)
160 ;; (global-set-key "\C-c\C-zb" 'browse-url-of-buffer)
161 ;; (global-set-key "\C-c\C-zr" 'browse-url-of-region)
162 ;; (global-set-key "\C-c\C-zu" 'browse-url)
163 ;; (global-set-key "\C-c\C-zv" 'browse-url-of-file)
164 ;; (add-hook 'dired-mode-hook
165 ;; (lambda ()
166 ;; (local-set-key "\C-c\C-zf" 'browse-url-of-dired-file)))
168 ;; Browse URLs in mail messages under RMAIL by clicking mouse-2:
169 ;; (add-hook 'rmail-mode-hook (lambda () ; rmail-mode startup
170 ;; (define-key rmail-mode-map [mouse-2] 'browse-url-at-mouse)))
171 ;; Alternatively, add `goto-address' to `rmail-show-message-hook'.
173 ;; Gnus provides a standard feature to activate URLs in article
174 ;; buffers for invocation of browse-url.
176 ;; Use the Emacs w3 browser when not running under X11:
177 ;; (or (eq window-system 'x)
178 ;; (setq browse-url-browser-function 'browse-url-w3))
180 ;; To always save modified buffers before displaying the file in a browser:
181 ;; (setq browse-url-save-file t)
183 ;; To get round the Netscape caching problem, you could EITHER have
184 ;; write-file in html-helper-mode make Netscape reload the document:
186 ;; (autoload 'browse-url-netscape-reload "browse-url"
187 ;; "Ask a WWW browser to redisplay the current file." t)
188 ;; (add-hook 'html-helper-mode-hook
189 ;; (lambda ()
190 ;; (add-hook 'local-write-file-hooks
191 ;; (lambda ()
192 ;; (let ((local-write-file-hooks))
193 ;; (save-buffer))
194 ;; (browse-url-netscape-reload)
195 ;; t) ; => file written by hook
196 ;; t))) ; append to l-w-f-hooks
198 ;; OR have browse-url-of-file ask Netscape to load and then reload the
199 ;; file:
201 ;; (add-hook 'browse-url-of-file-hook 'browse-url-netscape-reload)
203 ;; You may also want to customise browse-url-netscape-arguments, e.g.
204 ;; (setq browse-url-netscape-arguments '("-install"))
206 ;; or similarly for the other browsers.
208 ;; To invoke different browsers for different URLs:
209 ;; (setq browse-url-browser-function '(("^mailto:" . browse-url-mail)
210 ;; ("." . browse-url-netscape)))
212 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
213 ;;; Code:
215 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
216 ;; Variables
218 (eval-when-compile (require 'thingatpt)
219 (require 'term)
220 (require 'dired)
221 (require 'executable)
222 (require 'w3-auto nil t))
224 (defgroup browse-url nil
225 "Use a web browser to look at a URL."
226 :prefix "browse-url-"
227 :link '(emacs-commentary-link "browse-url")
228 :group 'hypermedia)
230 ;;;###autoload
231 (defcustom browse-url-browser-function
232 (cond
233 ((memq system-type '(windows-nt ms-dos cygwin))
234 'browse-url-default-windows-browser)
235 ((memq system-type '(darwin)) 'browse-url-default-macosx-browser)
236 (t 'browse-url-default-browser))
237 "*Function to display the current buffer in a WWW browser.
238 This is used by the `browse-url-at-point', `browse-url-at-mouse', and
239 `browse-url-of-file' commands.
241 If the value is not a function it should be a list of pairs
242 \(REGEXP . FUNCTION). In this case the function called will be the one
243 associated with the first REGEXP which matches the current URL. The
244 function is passed the URL and any other args of `browse-url'. The last
245 regexp should probably be \".\" to specify a default browser."
246 :type '(choice
247 (function-item :tag "Emacs W3" :value browse-url-w3)
248 (function-item :tag "W3 in another Emacs via `gnudoit'"
249 :value browse-url-w3-gnudoit)
250 (function-item :tag "Mozilla" :value browse-url-mozilla)
251 (function-item :tag "Galeon" :value browse-url-galeon)
252 (function-item :tag "Epiphany" :value browse-url-epiphany)
253 (function-item :tag "Netscape" :value browse-url-netscape)
254 (function-item :tag "Mosaic" :value browse-url-mosaic)
255 (function-item :tag "Mosaic using CCI" :value browse-url-cci)
256 (function-item :tag "IXI Mosaic" :value browse-url-iximosaic)
257 (function-item :tag "Lynx in an xterm window"
258 :value browse-url-lynx-xterm)
259 (function-item :tag "Lynx in an Emacs window"
260 :value browse-url-lynx-emacs)
261 (function-item :tag "Grail" :value browse-url-grail)
262 (function-item :tag "MMM" :value browse-url-mmm)
263 (function-item :tag "KDE" :value browse-url-kde)
264 (function-item :tag "Specified by `Browse Url Generic Program'"
265 :value browse-url-generic)
266 (function-item :tag "Default Windows browser"
267 :value browse-url-default-windows-browser)
268 (function-item :tag "Default Mac OS X browser"
269 :value browse-url-default-macosx-browser)
270 (function-item :tag "GNOME invoking Mozilla"
271 :value browse-url-gnome-moz)
272 (function-item :tag "Default browser"
273 :value browse-url-default-browser)
274 (function :tag "Your own function")
275 (alist :tag "Regexp/function association list"
276 :key-type regexp :value-type function))
277 :version "21.1"
278 :group 'browse-url)
280 (defcustom browse-url-netscape-program "netscape"
281 ;; Info about netscape-remote from Karl Berry.
282 "*The name by which to invoke Netscape.
284 The free program `netscape-remote' from
285 <URL:http://home.netscape.com/newsref/std/remote.c> is said to start
286 up very much quicker than `netscape'. Reported to compile on a GNU
287 system, given vroot.h from the same directory, with cc flags
288 -DSTANDALONE -L/usr/X11R6/lib -lXmu -lX11."
289 :type 'string
290 :group 'browse-url)
292 (defcustom browse-url-netscape-arguments nil
293 "*A list of strings to pass to Netscape as arguments."
294 :type '(repeat (string :tag "Argument"))
295 :group 'browse-url)
297 (defcustom browse-url-netscape-startup-arguments browse-url-netscape-arguments
298 "*A list of strings to pass to Netscape when it starts up.
299 Defaults to the value of `browse-url-netscape-arguments' at the time
300 `browse-url' is loaded."
301 :type '(repeat (string :tag "Argument"))
302 :group 'browse-url)
304 (defcustom browse-url-browser-display nil
305 "*The X display for running the browser, if not same as Emacs'."
306 :type '(choice string (const :tag "Default" nil))
307 :group 'browse-url)
309 (defcustom browse-url-mozilla-program "mozilla"
310 "*The name by which to invoke Mozilla."
311 :type 'string
312 :group 'browse-url)
314 (defcustom browse-url-mozilla-arguments nil
315 "*A list of strings to pass to Mozilla as arguments."
316 :type '(repeat (string :tag "Argument"))
317 :group 'browse-url)
319 (defcustom browse-url-mozilla-startup-arguments browse-url-mozilla-arguments
320 "*A list of strings to pass to Mozilla when it starts up.
321 Defaults to the value of `browse-url-mozilla-arguments' at the time
322 `browse-url' is loaded."
323 :type '(repeat (string :tag "Argument"))
324 :group 'browse-url)
326 (defcustom browse-url-galeon-program "galeon"
327 "*The name by which to invoke Galeon."
328 :type 'string
329 :group 'browse-url)
331 (defcustom browse-url-galeon-arguments nil
332 "*A list of strings to pass to Galeon as arguments."
333 :type '(repeat (string :tag "Argument"))
334 :group 'browse-url)
336 (defcustom browse-url-galeon-startup-arguments browse-url-galeon-arguments
337 "*A list of strings to pass to Galeon when it starts up.
338 Defaults to the value of `browse-url-galeon-arguments' at the time
339 `browse-url' is loaded."
340 :type '(repeat (string :tag "Argument"))
341 :group 'browse-url)
343 (defcustom browse-url-epiphany-program "epiphany"
344 "*The name by which to invoke Epiphany."
345 :type 'string
346 :group 'browse-url)
348 (defcustom browse-url-epiphany-arguments nil
349 "*A list of strings to pass to Epiphany as arguments."
350 :type '(repeat (string :tag "Argument"))
351 :group 'browse-url)
353 (defcustom browse-url-epiphany-startup-arguments browse-url-epiphany-arguments
354 "*A list of strings to pass to Epiphany when it starts up.
355 Defaults to the value of `browse-url-epiphany-arguments' at the time
356 `browse-url' is loaded."
357 :type '(repeat (string :tag "Argument"))
358 :group 'browse-url)
360 ;; GNOME means of invoking either Mozilla or Netrape.
361 (defvar browse-url-gnome-moz-program "gnome-moz-remote")
363 (defcustom browse-url-gnome-moz-arguments '()
364 "*A list of strings passed to the GNOME mozilla viewer as arguments."
365 :version "21.1"
366 :type '(repeat (string :tag "Argument"))
367 :group 'browse-url)
369 (defcustom browse-url-mozilla-new-window-is-tab nil
370 "*Whether to open up new windows in a tab or a new window.
371 If non-nil, then open the URL in a new tab rather than a new window if
372 `browse-url-mozilla' is asked to open it in a new window."
373 :type 'boolean
374 :group 'browse-url)
376 (defcustom browse-url-galeon-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-galeon' is asked to open it in a new window."
380 :type 'boolean
381 :group 'browse-url)
383 (defcustom browse-url-epiphany-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-epiphany' is asked to open it in a new window."
387 :type 'boolean
388 :group 'browse-url)
390 (defcustom browse-url-new-window-flag nil
391 "*If non-nil, always open a new browser window with appropriate browsers.
392 Passing an interactive argument to \\[browse-url], or specific browser
393 commands reverses the effect of this variable. Requires Netscape version
394 1.1N or later or XMosaic version 2.5 or later if using those browsers."
395 :type 'boolean
396 :group 'browse-url)
398 (defcustom browse-url-mosaic-program "xmosaic"
399 "*The name by which to invoke Mosaic (or mMosaic)."
400 :type 'string
401 :version "20.3"
402 :group 'browse-url)
404 (defcustom browse-url-mosaic-arguments nil
405 "*A list of strings to pass to Mosaic as arguments."
406 :type '(repeat (string :tag "Argument"))
407 :group 'browse-url)
409 (defcustom browse-url-mosaic-pidfile "~/.mosaicpid"
410 "*The name of the pidfile created by Mosaic."
411 :type 'string
412 :group 'browse-url)
414 (defcustom browse-url-filename-alist
415 (\` ; Backquote syntax won't work.
416 (("^/\\(ftp@\\|anonymous@\\)?\\([^:]+\\):/*" . "ftp://\\2/")
417 ;; The above loses the username to avoid the browser prompting for
418 ;; it in anonymous cases. If it's not anonymous the next regexp
419 ;; applies.
420 ("^/\\([^:@]+@\\)?\\([^:]+\\):/*" . "ftp://\\1\\2/")
421 (,@ (if (memq system-type '(windows-nt ms-dos cygwin))
422 '(("^\\([a-zA-Z]:\\)[\\/]" . "file:\\1/")
423 ("^[\\/][\\/]+" . "file://"))))
424 ("^/+" . "file:/")))
425 "*An alist of (REGEXP . STRING) pairs used by `browse-url-of-file'.
426 Any substring of a filename matching one of the REGEXPs is replaced by
427 the corresponding STRING using `replace-match', not treating STRING
428 literally. All pairs are applied in the order given. The default
429 value converts ange-ftp/EFS-style file names into ftp URLs and prepends
430 `file:' to any file name beginning with `/'.
432 For example, adding to the default a specific translation of an ange-ftp
433 address to an HTTP URL:
435 (setq browse-url-filename-alist
436 '((\"/webmaster@webserver:/home/www/html/\" .
437 \"http://www.acme.co.uk/\")
438 (\"^/\\(ftp@\\|anonymous@\\)?\\([^:]+\\):/*\" . \"ftp://\\2/\")
439 (\"^/\\([^:@]+@\\)?\\([^:]+\\):/*\" . \"ftp://\\1\\2/\")
440 (\"^/+\" . \"file:/\")))
442 :type '(repeat (cons :format "%v"
443 (regexp :tag "Regexp")
444 (string :tag "Replacement")))
445 :version "20.3"
446 :group 'browse-url)
448 (defcustom browse-url-save-file nil
449 "*If non-nil, save the buffer before displaying its file.
450 Used by the `browse-url-of-file' command."
451 :type 'boolean
452 :group 'browse-url)
454 (defcustom browse-url-of-file-hook nil
455 "*Run after `browse-url-of-file' has asked a browser to load a file.
457 Set this to `browse-url-netscape-reload' to force Netscape to load the
458 file rather than displaying a cached copy."
459 :type 'hook
460 :options '(browse-url-netscape-reload)
461 :group 'browse-url)
463 (defcustom browse-url-CCI-port 3003
464 "*Port to access XMosaic via CCI.
465 This can be any number between 1024 and 65535 but must correspond to
466 the value set in the browser."
467 :type 'integer
468 :group 'browse-url)
470 (defcustom browse-url-CCI-host "localhost"
471 "*Host to access XMosaic via CCI.
472 This should be the host name of the machine running XMosaic with CCI
473 enabled. The port number should be set in `browse-url-CCI-port'."
474 :type 'string
475 :group 'browse-url)
477 (defvar browse-url-temp-file-name nil)
478 (make-variable-buffer-local 'browse-url-temp-file-name)
480 (defcustom browse-url-xterm-program "xterm"
481 "*The name of the terminal emulator used by `browse-url-lynx-xterm'.
482 This might, for instance, be a separate colour version of xterm."
483 :type 'string
484 :group 'browse-url)
486 (defcustom browse-url-xterm-args nil
487 "*A list of strings defining options for `browse-url-xterm-program'.
488 These might set its size, for instance."
489 :type '(repeat (string :tag "Argument"))
490 :group 'browse-url)
492 (defcustom browse-url-lynx-emacs-args (and (not window-system)
493 '("-show_cursor"))
494 "*A list of strings defining options for Lynx in an Emacs buffer.
496 The default is none in a window system, otherwise `-show_cursor' to
497 indicate the position of the current link in the absence of
498 highlighting, assuming the normal default for showing the cursor."
499 :type '(repeat (string :tag "Argument"))
500 :version "20.3"
501 :group 'browse-url)
503 (defcustom browse-url-gnudoit-program "gnudoit"
504 "*The name of the `gnudoit' program used by `browse-url-w3-gnudoit'."
505 :type 'string
506 :group 'browse-url)
508 (defcustom browse-url-gnudoit-args '("-q")
509 "*A list of strings defining options for `browse-url-gnudoit-program'.
510 These might set the port, for instance."
511 :type '(repeat (string :tag "Argument"))
512 :group 'browse-url)
514 (defcustom browse-url-generic-program nil
515 "*The name of the browser program used by `browse-url-generic'."
516 :type '(choice string (const :tag "None" nil))
517 :group 'browse-url)
519 (defcustom browse-url-generic-args nil
520 "*A list of strings defining options for `browse-url-generic-program'."
521 :type '(repeat (string :tag "Argument"))
522 :group 'browse-url)
524 (defcustom browse-url-temp-dir temporary-file-directory
525 "*The name of a directory for browse-url's temporary files.
526 Such files are generated by functions like `browse-url-of-region'.
527 You might want to set this to somewhere with restricted read permissions
528 for privacy's sake."
529 :type 'string
530 :group 'browse-url)
532 (defcustom browse-url-netscape-version
534 "*The version of Netscape you are using.
535 This affects how URL reloading is done; the mechanism changed
536 incompatibly at version 4."
537 :type 'number
538 :group 'browse-url)
540 (defcustom browse-url-lynx-input-field 'avoid
541 "*Action on selecting an existing Lynx buffer at an input field.
542 What to do when sending a new URL to an existing Lynx buffer in Emacs
543 if the Lynx cursor is on an input field (in which case the `g' command
544 would be entered as data). Such fields are recognized by the
545 underlines ____. Allowed values: nil: disregard it, 'warn: warn the
546 user and don't emit the URL, 'avoid: try to avoid the field by moving
547 down (this *won't* always work)."
548 :type '(choice (const :tag "Move to try to avoid field" :value avoid)
549 (const :tag "Disregard" :value nil)
550 (const :tag "Warn, don't emit URL" :value warn))
551 :version "20.3"
552 :group 'browse-url)
554 (defcustom browse-url-lynx-input-attempts 10
555 "*How many times to try to move down from a series of lynx input fields."
556 :type 'integer
557 :group 'browse-url)
559 (defcustom browse-url-lynx-input-delay 0.2
560 "*How many seconds to wait for lynx between moves down from an input field."
561 :type 'number
562 :group 'browse-url)
564 (defcustom browse-url-kde-program "kfmclient"
565 "*The name by which to invoke the KDE web browser."
566 :type 'string
567 :version "21.1"
568 :group 'browse-url)
570 (defcustom browse-url-kde-args '("openURL")
571 "*A list of strings defining options for `browse-url-kde-program'."
572 :type '(repeat (string :tag "Argument"))
573 :group 'browse-url)
575 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
576 ;; URL input
578 (defun browse-url-url-at-point ()
579 (let ((url (thing-at-point 'url)))
580 (set-text-properties 0 (length url) nil url)
581 url))
583 ;; Having this as a separate function called by the browser-specific
584 ;; functions allows them to be stand-alone commands, making it easier
585 ;; to switch between browsers.
587 (defun browse-url-interactive-arg (prompt)
588 "Read a URL from the minibuffer, prompting with PROMPT.
589 If `transient-mark-mode' is non-nil and the mark is active,
590 it defaults to the current region, else to the URL at or before
591 point. If invoked with a mouse button, it moves point to the
592 position clicked before acting.
594 This function returns a list (URL NEW-WINDOW-FLAG)
595 for use in `interactive'."
596 (let ((event (elt (this-command-keys) 0)))
597 (and (listp event) (mouse-set-point event)))
598 (list (read-string prompt (or (and transient-mark-mode mark-active
599 ;; rfc2396 Appendix E.
600 (replace-regexp-in-string
601 "[\t\r\f\n ]+" ""
602 (buffer-substring-no-properties
603 (region-beginning) (region-end))))
604 (browse-url-url-at-point)))
605 (not (eq (null browse-url-new-window-flag)
606 (null current-prefix-arg)))))
608 ;; called-interactive-p needs to be called at a function's top-level, hence
609 ;; this macro. We use that rather than interactive-p because
610 ;; use in a keyboard macro should not change this behavior.
611 (defmacro browse-url-maybe-new-window (arg)
612 `(if (or noninteractive (not (called-interactively-p)))
613 ,arg
614 browse-url-new-window-flag))
616 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
617 ;; Browse current buffer
619 ;;;###autoload
620 (defun browse-url-of-file (&optional file)
621 "Ask a WWW browser to display FILE.
622 Display the current buffer's file if FILE is nil or if called
623 interactively. Turn the filename into a URL with function
624 `browse-url-file-url'. Pass the URL to a browser using the
625 `browse-url' function then run `browse-url-of-file-hook'."
626 (interactive)
627 (or file
628 (setq file (buffer-file-name))
629 (error "Current buffer has no file"))
630 (let ((buf (get-file-buffer file)))
631 (if buf
632 (save-excursion
633 (set-buffer buf)
634 (cond ((not (buffer-modified-p)))
635 (browse-url-save-file (save-buffer))
636 (t (message "%s modified since last save" file))))))
637 (browse-url (browse-url-file-url file))
638 (run-hooks 'browse-url-of-file-hook))
640 (defun browse-url-file-url (file)
641 "Return the URL corresponding to FILE.
642 Use variable `browse-url-filename-alist' to map filenames to URLs."
643 ;; URL-encode special chars, do % first
644 (let ((s 0))
645 (while (setq s (string-match "%" file s))
646 (setq file (replace-match "%25" t t file)
647 s (1+ s))))
648 (while (string-match "[*\"()',=;? ]" file)
649 (let ((enc (format "%%%x" (aref file (match-beginning 0)))))
650 (setq file (replace-match enc t t file))))
651 (dolist (map browse-url-filename-alist)
652 (when (and map (string-match (car map) file))
653 (setq file (replace-match (cdr map) t nil file))))
654 file)
656 ;;;###autoload
657 (defun browse-url-of-buffer (&optional buffer)
658 "Ask a WWW browser to display BUFFER.
659 Display the current buffer if BUFFER is nil. Display only the
660 currently visible part of BUFFER (from a temporary file) if buffer is
661 narrowed."
662 (interactive)
663 (save-excursion
664 (and buffer (set-buffer buffer))
665 (let ((file-name
666 ;; Ignore real name if restricted
667 (and (= (- (point-max) (point-min)) (buffer-size))
668 (or buffer-file-name
669 (and (boundp 'dired-directory) dired-directory)))))
670 (or file-name
671 (progn
672 (or browse-url-temp-file-name
673 (setq browse-url-temp-file-name
674 (convert-standard-filename
675 (make-temp-file
676 (expand-file-name "burl" browse-url-temp-dir)))))
677 (setq file-name browse-url-temp-file-name)
678 (write-region (point-min) (point-max) file-name nil 'no-message)))
679 (browse-url-of-file file-name))))
681 (defun browse-url-delete-temp-file (&optional temp-file-name)
682 ;; Delete browse-url-temp-file-name from the file system
683 ;; If optional arg TEMP-FILE-NAME is non-nil, delete it instead
684 (let ((file-name (or temp-file-name browse-url-temp-file-name)))
685 (if (and file-name (file-exists-p file-name))
686 (delete-file file-name))))
688 (add-hook 'kill-buffer-hook 'browse-url-delete-temp-file)
690 ;;;###autoload
691 (defun browse-url-of-dired-file ()
692 "In Dired, ask a WWW browser to display the file named on this line."
693 (interactive)
694 (browse-url-of-file (dired-get-filename)))
696 ;;;###autoload
697 (defun browse-url-of-region (min max)
698 "Ask a WWW browser to display the current region."
699 (interactive "r")
700 (save-excursion
701 (save-restriction
702 (narrow-to-region min max)
703 (browse-url-of-buffer))))
705 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
706 ;; Browser-independent commands
708 ;; A generic command to call the current browse-url-browser-function
710 ;;;###autoload
711 (defun browse-url (url &rest args)
712 "Ask a WWW browser to load URL.
713 Prompts for a URL, defaulting to the URL at or before point. Variable
714 `browse-url-browser-function' says which browser to use."
715 (interactive (browse-url-interactive-arg "URL: "))
716 (unless (interactive-p)
717 (setq args (or args (list browse-url-new-window-flag))))
718 (if (functionp browse-url-browser-function)
719 (apply browse-url-browser-function url args)
720 ;; The `function' can be an alist; look down it for first match
721 ;; and apply the function (which might be a lambda).
722 (catch 'done
723 (dolist (bf browse-url-browser-function)
724 (when (string-match (car bf) url)
725 (apply (cdr bf) url args)
726 (throw 'done t)))
727 (error "No browse-url-browser-function matching URL %s"
728 url))))
730 ;;;###autoload
731 (defun browse-url-at-point (&optional arg)
732 "Ask a WWW browser to load the URL at or before point.
733 Doesn't let you edit the URL like `browse-url'. Variable
734 `browse-url-browser-function' says which browser to use."
735 (interactive "P")
736 (let ((url (browse-url-url-at-point)))
737 (if url
738 (browse-url url (if arg
739 (not browse-url-new-window-flag)
740 browse-url-new-window-flag))
741 (error "No URL found"))))
743 ;;;###autoload
744 (defun browse-url-at-mouse (event)
745 "Ask a WWW browser to load a URL clicked with the mouse.
746 The URL is the one around or before the position of the mouse click
747 but point is not changed. Doesn't let you edit the URL like
748 `browse-url'. Variable `browse-url-browser-function' says which browser
749 to use."
750 (interactive "e")
751 (save-excursion
752 (mouse-set-point event)
753 ;; This handles browse-url-new-window-flag properly
754 ;; when it gets no arg.
755 (browse-url-at-point)))
757 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
758 ;; Browser-specific commands
760 ;; --- Default MS-Windows browser ---
762 (defun browse-url-default-windows-browser (url &optional new-window)
763 (interactive (browse-url-interactive-arg "URL: "))
764 (if (eq system-type 'ms-dos)
765 (if dos-windows-version
766 (shell-command (concat "start " (shell-quote-argument url)))
767 (error "Browsing URLs is not supported on this system"))
768 (w32-shell-execute "open" url)))
770 (defun browse-url-default-macosx-browser (url &optional new-window)
771 (interactive (browse-url-interactive-arg "URL: "))
772 (start-process (concat "open " url) nil "open" url))
774 ;; --- Netscape ---
776 (defun browse-url-process-environment ()
777 "Set DISPLAY in the environment to the X display the browser will use.
778 This is either the value of variable `browse-url-browser-display' if
779 non-nil, or the same display as Emacs if different from the current
780 environment, otherwise just use the current environment."
781 (let ((display (or browse-url-browser-display (browse-url-emacs-display))))
782 (if display
783 (cons (concat "DISPLAY=" display) process-environment)
784 process-environment)))
786 (defun browse-url-emacs-display ()
787 "Return the X display Emacs is running on.
788 This is nil if the display is the same as the DISPLAY environment variable.
790 Actually Emacs could be using several displays; this just returns the
791 one showing the selected frame."
792 (let ((display (cdr-safe (assq 'display (frame-parameters)))))
793 (and (not (equal display (getenv "DISPLAY")))
794 display)))
796 ;;;###autoload
797 (defun browse-url-default-browser (url &rest args)
798 "Find a suitable browser and ask it to load URL.
799 Default to the URL around or before point.
801 When called interactively, if variable `browse-url-new-window-flag' is
802 non-nil, load the document in a new window, if possible, otherwise use
803 a random existing one. A non-nil interactive prefix argument reverses
804 the effect of `browse-url-new-window-flag'.
806 When called non-interactively, optional second argument NEW-WINDOW is
807 used instead of `browse-url-new-window-flag'.
809 The order attempted is gnome-moz-remote, Mozilla, Galeon, Netscape,
810 Mosaic, IXI Mosaic, Lynx in an xterm, MMM, Konqueror, and then W3."
811 (apply
812 (cond
813 ((executable-find browse-url-gnome-moz-program) 'browse-url-gnome-moz)
814 ((executable-find browse-url-mozilla-program) 'browse-url-mozilla)
815 ((executable-find browse-url-galeon-program) 'browse-url-galeon)
816 ((executable-find browse-url-kde-program) 'browse-url-kde)
817 ((executable-find browse-url-netscape-program) 'browse-url-netscape)
818 ((executable-find browse-url-mosaic-program) 'browse-url-mosaic)
819 ((executable-find "tellw3b") 'browse-url-iximosaic)
820 ((executable-find browse-url-xterm-program) 'browse-url-lynx-xterm)
821 ((executable-find "mmm") 'browse-url-mmm)
822 (t 'browse-url-w3))
823 url args))
825 ;;;###autoload
826 (defun browse-url-netscape (url &optional new-window)
827 "Ask the Netscape WWW browser to load URL.
828 Default to the URL around or before point. The strings in variable
829 `browse-url-netscape-arguments' are also passed to Netscape.
831 When called interactively, if variable `browse-url-new-window-flag' is
832 non-nil, load the document in a new Netscape window, otherwise use a
833 random existing one. A non-nil interactive prefix argument reverses
834 the effect of `browse-url-new-window-flag'.
836 When called non-interactively, optional second argument NEW-WINDOW is
837 used instead of `browse-url-new-window-flag'."
838 (interactive (browse-url-interactive-arg "URL: "))
839 ;; URL encode any `confusing' characters in the URL. This needs to
840 ;; include at least commas; presumably also close parens and dollars.
841 (while (string-match "[,)$]" url)
842 (setq url (replace-match
843 (format "%%%x" (string-to-char (match-string 0 url))) t t url)))
844 (let* ((process-environment (browse-url-process-environment))
845 (process (apply 'start-process
846 (concat "netscape " url) nil
847 browse-url-netscape-program
848 (append
849 browse-url-netscape-arguments
850 (if (eq window-system 'w32)
851 (list url)
852 (append
853 (if new-window '("-noraise"))
854 (list "-remote"
855 (concat "openURL(" url
856 (if (browse-url-maybe-new-window
857 new-window)
858 ",new-window")
859 ")"))))))))
860 (set-process-sentinel process
861 `(lambda (process change)
862 (browse-url-netscape-sentinel process ,url)))))
864 (defun browse-url-netscape-sentinel (process url)
865 "Handle a change to the process communicating with Netscape."
866 (or (eq (process-exit-status process) 0)
867 (let* ((process-environment (browse-url-process-environment)))
868 ;; Netscape not running - start it
869 (message "Starting %s..." browse-url-netscape-program)
870 (apply 'start-process (concat "netscape" url) nil
871 browse-url-netscape-program
872 (append browse-url-netscape-startup-arguments (list url))))))
874 (defun browse-url-netscape-reload ()
875 "Ask Netscape to reload its current document.
876 How depends on `browse-url-netscape-version'."
877 (interactive)
878 ;; Backwards incompatibility reported by
879 ;; <peter.kruse@psychologie.uni-regensburg.de>.
880 (browse-url-netscape-send (if (>= browse-url-netscape-version 4)
881 "xfeDoCommand(reload)"
882 "reload")))
884 (defun browse-url-netscape-send (command)
885 "Send a remote control command to Netscape."
886 (let* ((process-environment (browse-url-process-environment)))
887 (apply 'start-process "netscape" nil
888 browse-url-netscape-program
889 (append browse-url-netscape-arguments
890 (list "-remote" command)))))
892 ;;;###autoload
893 (defun browse-url-mozilla (url &optional new-window)
894 "Ask the Mozilla WWW browser to load URL.
895 Default to the URL around or before point. The strings in variable
896 `browse-url-mozilla-arguments' are also passed to Mozilla.
898 When called interactively, if variable `browse-url-new-window-flag' is
899 non-nil, load the document in a new Mozilla window, otherwise use a
900 random existing one. A non-nil interactive prefix argument reverses
901 the effect of `browse-url-new-window-flag'.
903 If `browse-url-mozilla-new-window-is-tab' is non-nil, then whenever a
904 document would otherwise be loaded in a new window, it is loaded in a
905 new tab in an existing window instead.
907 When called non-interactively, optional second argument NEW-WINDOW is
908 used instead of `browse-url-new-window-flag'."
909 (interactive (browse-url-interactive-arg "URL: "))
910 ;; URL encode any `confusing' characters in the URL. This needs to
911 ;; include at least commas; presumably also close parens and dollars.
912 (while (string-match "[,)$]" url)
913 (setq url (replace-match
914 (format "%%%x" (string-to-char (match-string 0 url))) t t url)))
915 (let* ((process-environment (browse-url-process-environment))
916 (process
917 (apply 'start-process
918 (concat "mozilla " url) nil
919 browse-url-mozilla-program
920 (append
921 browse-url-mozilla-arguments
922 (list "-remote"
923 (concat "openURL("
925 (if (browse-url-maybe-new-window
926 new-window)
927 (if browse-url-mozilla-new-window-is-tab
928 ",new-tab"
929 ",new-window"))
930 ")"))))))
931 (set-process-sentinel process
932 `(lambda (process change)
933 (browse-url-mozilla-sentinel process ,url)))))
935 (defun browse-url-mozilla-sentinel (process url)
936 "Handle a change to the process communicating with Mozilla."
937 (or (eq (process-exit-status process) 0)
938 (let* ((process-environment (browse-url-process-environment)))
939 ;; Mozilla is not running - start it
940 (message "Starting %s..." browse-url-mozilla-program)
941 (apply 'start-process (concat "mozilla " url) nil
942 browse-url-mozilla-program
943 (append browse-url-mozilla-startup-arguments (list url))))))
945 ;;;###autoload
946 (defun browse-url-galeon (url &optional new-window)
947 "Ask the Galeon WWW browser to load URL.
948 Default to the URL around or before point. The strings in variable
949 `browse-url-galeon-arguments' are also passed to Galeon.
951 When called interactively, if variable `browse-url-new-window-flag' is
952 non-nil, load the document in a new Galeon window, otherwise use a
953 random existing one. A non-nil interactive prefix argument reverses
954 the effect of `browse-url-new-window-flag'.
956 If `browse-url-galeon-new-window-is-tab' is non-nil, then whenever a
957 document would otherwise be loaded in a new window, it is loaded in a
958 new tab in an existing window instead.
960 When called non-interactively, optional second argument NEW-WINDOW is
961 used instead of `browse-url-new-window-flag'."
962 (interactive (browse-url-interactive-arg "URL: "))
963 ;; URL encode any `confusing' characters in the URL. This needs to
964 ;; include at least commas; presumably also close parens and dollars.
965 (while (string-match "[,)$]" url)
966 (setq url (replace-match
967 (format "%%%x" (string-to-char (match-string 0 url))) t t url)))
968 (let* ((process-environment (browse-url-process-environment))
969 (process (apply 'start-process
970 (concat "galeon " url)
972 browse-url-galeon-program
973 (append
974 browse-url-galeon-arguments
975 (if (browse-url-maybe-new-window new-window)
976 (if browse-url-galeon-new-window-is-tab
977 '("--new-tab")
978 '("--new-window" "--noraise"))
979 '("--existing"))
980 (list url)))))
981 (set-process-sentinel process
982 `(lambda (process change)
983 (browse-url-galeon-sentinel process ,url)))))
985 (defun browse-url-galeon-sentinel (process url)
986 "Handle a change to the process communicating with Galeon."
987 (or (eq (process-exit-status process) 0)
988 (let* ((process-environment (browse-url-process-environment)))
989 ;; Galeon is not running - start it
990 (message "Starting %s..." browse-url-galeon-program)
991 (apply 'start-process (concat "galeon " url) nil
992 browse-url-galeon-program
993 (append browse-url-galeon-startup-arguments (list url))))))
995 (defun browse-url-epiphany (url &optional new-window)
996 "Ask the Epiphany WWW browser to load URL.
997 Default to the URL around or before point. The strings in variable
998 `browse-url-galeon-arguments' are also passed to Epiphany.
1000 When called interactively, if variable `browse-url-new-window-flag' is
1001 non-nil, load the document in a new Epiphany window, otherwise use a
1002 random existing one. A non-nil interactive prefix argument reverses
1003 the effect of `browse-url-new-window-flag'.
1005 If `browse-url-epiphany-new-window-is-tab' is non-nil, then whenever a
1006 document would otherwise be loaded in a new window, it is loaded in a
1007 new tab in an existing window instead.
1009 When called non-interactively, optional second argument NEW-WINDOW is
1010 used instead of `browse-url-new-window-flag'."
1011 (interactive (browse-url-interactive-arg "URL: "))
1012 ;; URL encode any `confusing' characters in the URL. This needs to
1013 ;; include at least commas; presumably also close parens and dollars.
1014 (while (string-match "[,)$]" url)
1015 (setq url (replace-match
1016 (format "%%%x" (string-to-char (match-string 0 url))) t t url)))
1017 (let* ((process-environment (browse-url-process-environment))
1018 (process (apply 'start-process
1019 (concat "epiphany " url)
1021 browse-url-epiphany-program
1022 (append
1023 browse-url-epiphany-arguments
1024 (if (browse-url-maybe-new-window new-window)
1025 (if browse-url-epiphany-new-window-is-tab
1026 '("--new-tab")
1027 '("--new-window" "--noraise"))
1028 '("--existing"))
1029 (list url)))))
1030 (set-process-sentinel process
1031 `(lambda (process change)
1032 (browse-url-epiphany-sentinel process ,url)))))
1034 (defun browse-url-epiphany-sentinel (process url)
1035 "Handle a change to the process communicating with Epiphany."
1036 (or (eq (process-exit-status process) 0)
1037 (let* ((process-environment (browse-url-process-environment)))
1038 ;; Epiphany is not running - start it
1039 (message "Starting %s..." browse-url-epiphany-program)
1040 (apply 'start-process (concat "epiphany " url) nil
1041 browse-url-epiphany-program
1042 (append browse-url-epiphany-startup-arguments (list url))))))
1044 ;;;###autoload
1045 (defun browse-url-gnome-moz (url &optional new-window)
1046 "Ask Mozilla/Netscape to load URL via the GNOME program `gnome-moz-remote'.
1047 Default to the URL around or before point. The strings in variable
1048 `browse-url-gnome-moz-arguments' are also passed.
1050 When called interactively, if variable `browse-url-new-window-flag' is
1051 non-nil, load the document in a new browser window, otherwise use an
1052 existing one. A non-nil interactive prefix argument reverses the
1053 effect of `browse-url-new-window-flag'.
1055 When called non-interactively, optional second argument NEW-WINDOW is
1056 used instead of `browse-url-new-window-flag'."
1057 (interactive (browse-url-interactive-arg "URL: "))
1058 (apply 'start-process (concat "gnome-moz-remote " url)
1060 browse-url-gnome-moz-program
1061 (append
1062 browse-url-gnome-moz-arguments
1063 (if (browse-url-maybe-new-window new-window)
1064 '("--newwin"))
1065 (list "--raise" url))))
1067 ;; --- Mosaic ---
1069 ;;;###autoload
1070 (defun browse-url-mosaic (url &optional new-window)
1071 "Ask the XMosaic WWW browser to load URL.
1073 Default to the URL around or before point. The strings in variable
1074 `browse-url-mosaic-arguments' are also passed to Mosaic and the
1075 program is invoked according to the variable
1076 `browse-url-mosaic-program'.
1078 When called interactively, if variable `browse-url-new-window-flag' is
1079 non-nil, load the document in a new Mosaic window, otherwise use a
1080 random existing one. A non-nil interactive prefix argument reverses
1081 the effect of `browse-url-new-window-flag'.
1083 When called non-interactively, optional second argument NEW-WINDOW is
1084 used instead of `browse-url-new-window-flag'."
1085 (interactive (browse-url-interactive-arg "Mosaic URL: "))
1086 (let ((pidfile (expand-file-name browse-url-mosaic-pidfile))
1087 pid)
1088 (if (file-readable-p pidfile)
1089 (save-excursion
1090 (find-file pidfile)
1091 (goto-char (point-min))
1092 (setq pid (read (current-buffer)))
1093 (kill-buffer nil)))
1094 (if (and pid (zerop (signal-process pid 0))) ; Mosaic running
1095 (save-excursion
1096 (find-file (format "/tmp/Mosaic.%d" pid))
1097 (erase-buffer)
1098 (insert (if (browse-url-maybe-new-window new-window)
1099 "newwin\n"
1100 "goto\n")
1101 url "\n")
1102 (save-buffer)
1103 (kill-buffer nil)
1104 ;; Send signal SIGUSR to Mosaic
1105 (message "Signalling Mosaic...")
1106 (signal-process pid 'SIGUSR1)
1107 ;; Or you could try:
1108 ;; (call-process "kill" nil 0 nil "-USR1" (int-to-string pid))
1109 (message "Signalling Mosaic...done")
1111 ;; Mosaic not running - start it
1112 (message "Starting %s..." browse-url-mosaic-program)
1113 (apply 'start-process "xmosaic" nil browse-url-mosaic-program
1114 (append browse-url-mosaic-arguments (list url)))
1115 (message "Starting %s...done" browse-url-mosaic-program))))
1117 ;; --- Grail ---
1119 (defvar browse-url-grail
1120 (concat (or (getenv "GRAILDIR") "~/.grail") "/user/rcgrail.py")
1121 "Location of Grail remote control client script `rcgrail.py'.
1122 Typically found in $GRAILDIR/rcgrail.py, or ~/.grail/user/rcgrail.py.")
1124 ;;;###autoload
1125 (defun browse-url-grail (url &optional new-window)
1126 "Ask the Grail WWW browser to load URL.
1127 Default to the URL around or before point. Runs the program in the
1128 variable `browse-url-grail'."
1129 (interactive (browse-url-interactive-arg "Grail URL: "))
1130 (message "Sending URL to Grail...")
1131 (save-excursion
1132 (set-buffer (get-buffer-create " *Shell Command Output*"))
1133 (erase-buffer)
1134 ;; don't worry about this failing.
1135 (if (browse-url-maybe-new-window new-window)
1136 (call-process browse-url-grail nil 0 nil "-b" url)
1137 (call-process browse-url-grail nil 0 nil url))
1138 (message "Sending URL to Grail... done")))
1140 ;; --- Mosaic using CCI ---
1142 ;;;###autoload
1143 (defun browse-url-cci (url &optional new-window)
1144 "Ask the XMosaic WWW browser to load URL.
1145 Default to the URL around or before point.
1147 This function only works for XMosaic version 2.5 or later. You must
1148 select `CCI' from XMosaic's File menu, set the CCI Port Address to the
1149 value of variable `browse-url-CCI-port', and enable `Accept requests'.
1151 When called interactively, if variable `browse-url-new-window-flag' is
1152 non-nil, load the document in a new browser window, otherwise use a
1153 random existing one. A non-nil interactive prefix argument reverses
1154 the effect of `browse-url-new-window-flag'.
1156 When called non-interactively, optional second argument NEW-WINDOW is
1157 used instead of `browse-url-new-window-flag'."
1158 (interactive (browse-url-interactive-arg "Mosaic URL: "))
1159 (open-network-stream "browse-url" " *browse-url*"
1160 browse-url-CCI-host browse-url-CCI-port)
1161 ;; Todo: start browser if fails
1162 (process-send-string "browse-url"
1163 (concat "get url (" url ") output "
1164 (if (browse-url-maybe-new-window new-window)
1165 "new"
1166 "current")
1167 "\r\n"))
1168 (process-send-string "browse-url" "disconnect\r\n")
1169 (delete-process "browse-url"))
1171 ;; --- IXI Mosaic ---
1173 ;;;###autoload
1174 (defun browse-url-iximosaic (url &optional new-window)
1175 ;; new-window ignored
1176 "Ask the IXIMosaic WWW browser to load URL.
1177 Default to the URL around or before point."
1178 (interactive (browse-url-interactive-arg "IXI Mosaic URL: "))
1179 (start-process "tellw3b" nil "tellw3b"
1180 "-service WWW_BROWSER ixi_showurl " url))
1182 ;; --- W3 ---
1184 ;;;###autoload
1185 (defun browse-url-w3 (url &optional new-window)
1186 "Ask the w3 WWW browser to load URL.
1187 Default to the URL around or before point.
1189 When called interactively, if variable `browse-url-new-window-flag' is
1190 non-nil, load the document in a new window. A non-nil interactive
1191 prefix argument reverses the effect of `browse-url-new-window-flag'.
1193 When called non-interactively, optional second argument NEW-WINDOW is
1194 used instead of `browse-url-new-window-flag'."
1195 (interactive (browse-url-interactive-arg "W3 URL: "))
1196 (require 'w3) ; w3-fetch-other-window not autoloaded
1197 (if (browse-url-maybe-new-window new-window)
1198 (w3-fetch-other-window url)
1199 (w3-fetch url)))
1201 ;;;###autoload
1202 (defun browse-url-w3-gnudoit (url &optional new-window)
1203 ;; new-window ignored
1204 "Ask another Emacs running gnuserv to load the URL using the W3 browser.
1205 The `browse-url-gnudoit-program' program is used with options given by
1206 `browse-url-gnudoit-args'. Default to the URL around or before point."
1207 (interactive (browse-url-interactive-arg "W3 URL: "))
1208 (apply 'start-process (concat "gnudoit:" url) nil
1209 browse-url-gnudoit-program
1210 (append browse-url-gnudoit-args
1211 (list (concat "(w3-fetch \"" url "\")")
1212 "(raise-frame)"))))
1214 ;; --- Lynx in an xterm ---
1216 ;;;###autoload
1217 (defun browse-url-lynx-xterm (url &optional new-window)
1218 ;; new-window ignored
1219 "Ask the Lynx WWW browser to load URL.
1220 Default to the URL around or before point. A new Lynx process is run
1221 in an Xterm window using the Xterm program named by `browse-url-xterm-program'
1222 with possible additional arguments `browse-url-xterm-args'."
1223 (interactive (browse-url-interactive-arg "Lynx URL: "))
1224 (apply #'start-process `(,(concat "lynx" url) nil ,browse-url-xterm-program
1225 ,@browse-url-xterm-args "-e" "lynx"
1226 ,url)))
1228 ;; --- Lynx in an Emacs "term" window ---
1230 ;;;###autoload
1231 (defun browse-url-lynx-emacs (url &optional new-buffer)
1232 "Ask the Lynx WWW browser to load URL.
1233 Default to the URL around or before point. With a prefix argument, run
1234 a new Lynx process in a new buffer.
1236 When called interactively, if variable `browse-url-new-window-flag' is
1237 non-nil, load the document in a new lynx in a new term window,
1238 otherwise use any existing one. A non-nil interactive prefix argument
1239 reverses the effect of `browse-url-new-window-flag'.
1241 When called non-interactively, optional second argument NEW-WINDOW is
1242 used instead of `browse-url-new-window-flag'."
1243 (interactive (browse-url-interactive-arg "Lynx URL: "))
1244 (let* ((system-uses-terminfo t) ; Lynx uses terminfo
1245 ;; (term-term-name "vt100") ; ??
1246 (buf (get-buffer "*lynx*"))
1247 (proc (and buf (get-buffer-process buf)))
1248 (n browse-url-lynx-input-attempts))
1249 (if (and (browse-url-maybe-new-window new-buffer) buf)
1250 ;; Rename away the OLD buffer. This isn't very polite, but
1251 ;; term insists on working in a buffer named *lynx* and would
1252 ;; choke on *lynx*<1>
1253 (progn (set-buffer buf)
1254 (rename-uniquely)))
1255 (if (or (browse-url-maybe-new-window new-buffer)
1256 (not buf)
1257 (not proc)
1258 (not (memq (process-status proc) '(run stop))))
1259 ;; start a new lynx
1260 (progn
1261 (setq buf
1262 (apply #'make-term
1263 `("lynx" "lynx" nil ,@browse-url-lynx-emacs-args
1264 ,url)))
1265 (switch-to-buffer buf)
1266 (term-char-mode)
1267 (set-process-sentinel
1268 (get-buffer-process buf)
1269 ;; Don't leave around a dead one (especially because of its
1270 ;; munged keymap.)
1271 (lambda (process event)
1272 (if (not (memq (process-status process) '(run stop)))
1273 (let ((buf (process-buffer process)))
1274 (if buf (kill-buffer buf)))))))
1275 ;; send the url to lynx in the old buffer
1276 (let ((win (get-buffer-window buf t)))
1277 (if win
1278 (select-window win)
1279 (switch-to-buffer buf)))
1280 (if (eq (following-char) ?_)
1281 (cond ((eq browse-url-lynx-input-field 'warn)
1282 (error "Please move out of the input field first"))
1283 ((eq browse-url-lynx-input-field 'avoid)
1284 (while (and (eq (following-char) ?_) (> n 0))
1285 (term-send-down) ; down arrow
1286 (sit-for browse-url-lynx-input-delay))
1287 (if (eq (following-char) ?_)
1288 (error "Cannot move out of the input field, sorry")))))
1289 (term-send-string proc (concat "g" ; goto
1290 "\C-u" ; kill default url
1292 "\r")))))
1294 ;; --- MMM ---
1296 ;;;###autoload
1297 (defun browse-url-mmm (url &optional new-window)
1298 "Ask the MMM WWW browser to load URL.
1299 Default to the URL around or before point."
1300 (interactive (browse-url-interactive-arg "MMM URL: "))
1301 (message "Sending URL to MMM...")
1302 (save-excursion
1303 (set-buffer (get-buffer-create " *Shell Command Output*"))
1304 (erase-buffer)
1305 ;; mmm_remote just SEGVs if the file isn't there...
1306 (if (or (file-exists-p (expand-file-name "~/.mmm_remote"))
1307 ;; location in v 0.4:
1308 (file-exists-p (expand-file-name "~/.mmm/remote")))
1309 (call-process "mmm_remote" nil 0 nil url)
1310 (call-process "mmm" nil 0 nil "-external" url))
1311 (message "Sending URL to MMM... done")))
1313 ;; --- mailto ---
1315 (autoload 'rfc2368-parse-mailto-url "rfc2368")
1317 ;;;###autoload
1318 (defun browse-url-mail (url &optional new-window)
1319 "Open a new mail message buffer within Emacs for the RFC 2368 URL.
1320 Default to using the mailto: URL around or before point as the
1321 recipient's address. Supplying a non-nil interactive prefix argument
1322 will cause the mail to be composed in another window rather than the
1323 current one.
1325 When called interactively, if variable `browse-url-new-window-flag' is
1326 non-nil use `compose-mail-other-window', otherwise `compose-mail'. A
1327 non-nil interactive prefix argument reverses the effect of
1328 `browse-url-new-window-flag'.
1330 When called non-interactively, optional second argument NEW-WINDOW is
1331 used instead of `browse-url-new-window-flag'."
1332 (interactive (browse-url-interactive-arg "Mailto URL: "))
1333 (save-excursion
1334 (let* ((alist (rfc2368-parse-mailto-url url))
1335 (to (assoc "To" alist))
1336 (subject (assoc "Subject" alist))
1337 (body (assoc "Body" alist))
1338 (rest (delete to (delete subject (delete body alist))))
1339 (to (cdr to))
1340 (subject (cdr subject))
1341 (body (cdr body))
1342 (mail-citation-hook (unless body mail-citation-hook)))
1343 (if (browse-url-maybe-new-window new-window)
1344 (compose-mail-other-window to subject rest nil
1345 (if body
1346 (list 'insert body)
1347 (list 'insert-buffer (current-buffer))))
1348 (compose-mail to subject rest nil nil
1349 (if body
1350 (list 'insert body)
1351 (list 'insert-buffer (current-buffer))))))))
1353 ;; --- Random browser ---
1355 ;;;###autoload
1356 (defun browse-url-generic (url &optional new-window)
1357 ;; new-window ignored
1358 "Ask the WWW browser defined by `browse-url-generic-program' to load URL.
1359 Default to the URL around or before point. A fresh copy of the
1360 browser is started up in a new process with possible additional arguments
1361 `browse-url-generic-args'. This is appropriate for browsers which
1362 don't offer a form of remote control."
1363 (interactive (browse-url-interactive-arg "URL: "))
1364 (if (not browse-url-generic-program)
1365 (error "No browser defined (`browse-url-generic-program')"))
1366 (apply 'call-process browse-url-generic-program nil
1367 0 nil
1368 (append browse-url-generic-args (list url))))
1370 ;;;###autoload
1371 (defun browse-url-kde (url &optional new-window)
1372 "Ask the KDE WWW browser to load URL.
1373 Default to the URL around or before point."
1374 (interactive (browse-url-interactive-arg "KDE URL: "))
1375 (message "Sending URL to KDE...")
1376 (apply #'start-process (concat "KDE " url) nil browse-url-kde-program
1377 (append browse-url-kde-args (list url))))
1379 (provide 'browse-url)
1381 ;;; arch-tag: d2079573-5c06-4097-9598-f550fba19430
1382 ;;; browse-url.el ends here