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