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