aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard M. Stallman2002-03-18 04:24:09 +0000
committerRichard M. Stallman2002-03-18 04:24:09 +0000
commit1665be4714b025899471f37faa45d2b644a547ff (patch)
treec41290e774f2fceb785a82618d9fde0b1b695e15
parenta3ec4ba0ff947248a499980880073b0871dad129 (diff)
downloademacs-1665be4714b025899471f37faa45d2b644a547ff.tar.gz
emacs-1665be4714b025899471f37faa45d2b644a547ff.zip
Put * in user option doc strings.
(browse-url-mosaic-pidfile): New variable. (browse-url-mosaic): Use it. (browse-url-filename-alist): Don't begin docstring with *, you don't want to set this one with M-x set-variable.
-rw-r--r--lisp/net/browse-url.el53
1 files changed, 29 insertions, 24 deletions
diff --git a/lisp/net/browse-url.el b/lisp/net/browse-url.el
index 1cdf9c631fd..40fa16306ae 100644
--- a/lisp/net/browse-url.el
+++ b/lisp/net/browse-url.el
@@ -272,7 +272,7 @@ regexp should probably be \".\" to specify a default browser."
272 272
273(defcustom browse-url-netscape-program "netscape" 273(defcustom browse-url-netscape-program "netscape"
274 ;; Info about netscape-remote from Karl Berry. 274 ;; Info about netscape-remote from Karl Berry.
275 "The name by which to invoke Netscape. 275 "*The name by which to invoke Netscape.
276 276
277The free program `netscape-remote' from 277The free program `netscape-remote' from
278<URL:http://home.netscape.com/newsref/std/remote.c> is said to start 278<URL:http://home.netscape.com/newsref/std/remote.c> is said to start
@@ -283,12 +283,12 @@ system, given vroot.h from the same directory, with cc flags
283 :group 'browse-url) 283 :group 'browse-url)
284 284
285(defcustom browse-url-netscape-arguments nil 285(defcustom browse-url-netscape-arguments nil
286 "A list of strings to pass to Netscape as arguments." 286 "*A list of strings to pass to Netscape as arguments."
287 :type '(repeat (string :tag "Argument")) 287 :type '(repeat (string :tag "Argument"))
288 :group 'browse-url) 288 :group 'browse-url)
289 289
290(defcustom browse-url-netscape-startup-arguments browse-url-netscape-arguments 290(defcustom browse-url-netscape-startup-arguments browse-url-netscape-arguments
291 "A list of strings to pass to Netscape when it starts up. 291 "*A list of strings to pass to Netscape when it starts up.
292Defaults to the value of `browse-url-netscape-arguments' at the time 292Defaults to the value of `browse-url-netscape-arguments' at the time
293`browse-url' is loaded." 293`browse-url' is loaded."
294 :type '(repeat (string :tag "Argument")) 294 :type '(repeat (string :tag "Argument"))
@@ -301,17 +301,17 @@ Defaults to the value of `browse-url-netscape-arguments' at the time
301 :group 'browse-url) 301 :group 'browse-url)
302 302
303(defcustom browse-url-mozilla-program "mozilla" 303(defcustom browse-url-mozilla-program "mozilla"
304 "The name by which to invoke Mozilla." 304 "*The name by which to invoke Mozilla."
305 :type 'string 305 :type 'string
306 :group 'browse-url) 306 :group 'browse-url)
307 307
308(defcustom browse-url-mozilla-arguments nil 308(defcustom browse-url-mozilla-arguments nil
309 "A list of strings to pass to Mozilla as arguments." 309 "*A list of strings to pass to Mozilla as arguments."
310 :type '(repeat (string :tag "Argument")) 310 :type '(repeat (string :tag "Argument"))
311 :group 'browse-url) 311 :group 'browse-url)
312 312
313(defcustom browse-url-mozilla-startup-arguments browse-url-mozilla-arguments 313(defcustom browse-url-mozilla-startup-arguments browse-url-mozilla-arguments
314 "A list of strings to pass to Mozilla when it starts up. 314 "*A list of strings to pass to Mozilla when it starts up.
315Defaults to the value of `browse-url-mozilla-arguments' at the time 315Defaults to the value of `browse-url-mozilla-arguments' at the time
316`browse-url' is loaded." 316`browse-url' is loaded."
317 :type '(repeat (string :tag "Argument")) 317 :type '(repeat (string :tag "Argument"))
@@ -319,24 +319,24 @@ Defaults to the value of `browse-url-mozilla-arguments' at the time
319 319
320;;;###autoload 320;;;###autoload
321(defcustom browse-url-galeon-program "galeon" 321(defcustom browse-url-galeon-program "galeon"
322 "The name by which to invoke Galeon." 322 "*The name by which to invoke Galeon."
323 :type 'string 323 :type 'string
324 :group 'browse-url) 324 :group 'browse-url)
325 325
326(defcustom browse-url-galeon-arguments nil 326(defcustom browse-url-galeon-arguments nil
327 "A list of strings to pass to Galeon as arguments." 327 "*A list of strings to pass to Galeon as arguments."
328 :type '(repeat (string :tag "Argument")) 328 :type '(repeat (string :tag "Argument"))
329 :group 'browse-url) 329 :group 'browse-url)
330 330
331(defcustom browse-url-galeon-startup-arguments browse-url-galeon-arguments 331(defcustom browse-url-galeon-startup-arguments browse-url-galeon-arguments
332 "A list of strings to pass to Galeon when it starts up. 332 "*A list of strings to pass to Galeon when it starts up.
333Defaults to the value of `browse-url-galeon-arguments' at the time 333Defaults to the value of `browse-url-galeon-arguments' at the time
334`browse-url' is loaded." 334`browse-url' is loaded."
335 :type '(repeat (string :tag "Argument")) 335 :type '(repeat (string :tag "Argument"))
336 :group 'browse-url) 336 :group 'browse-url)
337 337
338(defcustom browse-url-galeon-new-window-is-tab nil 338(defcustom browse-url-galeon-new-window-is-tab nil
339 "Whether to open up new windows in a tab or a new window. 339 "*Whether to open up new windows in a tab or a new window.
340If non-nil, then open the URL in a new tab rather than a new window if 340If 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." 341`browse-url-galeon' is asked to open it in a new window."
342 :type 'boolean 342 :type 'boolean
@@ -352,16 +352,21 @@ commands reverses the effect of this variable. Requires Netscape version
352 :group 'browse-url) 352 :group 'browse-url)
353 353
354(defcustom browse-url-mosaic-program "xmosaic" 354(defcustom browse-url-mosaic-program "xmosaic"
355 "The name by which to invoke Mosaic (or mMosaic)." 355 "*The name by which to invoke Mosaic (or mMosaic)."
356 :type 'string 356 :type 'string
357 :version "20.3" 357 :version "20.3"
358 :group 'browse-url) 358 :group 'browse-url)
359 359
360(defcustom browse-url-mosaic-arguments nil 360(defcustom browse-url-mosaic-arguments nil
361 "A list of strings to pass to Mosaic as arguments." 361 "*A list of strings to pass to Mosaic as arguments."
362 :type '(repeat (string :tag "Argument")) 362 :type '(repeat (string :tag "Argument"))
363 :group 'browse-url) 363 :group 'browse-url)
364 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
365(defcustom browse-url-filename-alist 370(defcustom browse-url-filename-alist
366 (\` ; Backquote syntax won't work. 371 (\` ; Backquote syntax won't work.
367 (("^/\\(ftp@\\|anonymous@\\)?\\([^:]+\\):/*" . "ftp://\\2/") 372 (("^/\\(ftp@\\|anonymous@\\)?\\([^:]+\\):/*" . "ftp://\\2/")
@@ -373,7 +378,7 @@ commands reverses the effect of this variable. Requires Netscape version
373 '(("^\\([a-zA-Z]:\\)[\\/]" . "file:\\1/") 378 '(("^\\([a-zA-Z]:\\)[\\/]" . "file:\\1/")
374 ("^[\\/][\\/]+" . "file://")))) 379 ("^[\\/][\\/]+" . "file://"))))
375 ("^/+" . "file:/"))) 380 ("^/+" . "file:/")))
376 "An alist of (REGEXP . STRING) pairs used by `browse-url-of-file'. 381 "*An alist of (REGEXP . STRING) pairs used by `browse-url-of-file'.
377Any substring of a filename matching one of the REGEXPs is replaced by 382Any substring of a filename matching one of the REGEXPs is replaced by
378the corresponding STRING using `replace-match', not treating STRING 383the corresponding STRING using `replace-match', not treating STRING
379literally. All pairs are applied in the order given. The default 384literally. All pairs are applied in the order given. The default
@@ -404,7 +409,7 @@ Used by the `browse-url-of-file' command."
404 :group 'browse-url) 409 :group 'browse-url)
405 410
406(defcustom browse-url-of-file-hook nil 411(defcustom browse-url-of-file-hook nil
407 "Run after `browse-url-of-file' has asked a browser to load a file. 412 "*Run after `browse-url-of-file' has asked a browser to load a file.
408 413
409Set this to `browse-url-netscape-reload' to force Netscape to load the 414Set this to `browse-url-netscape-reload' to force Netscape to load the
410file rather than displaying a cached copy." 415file rather than displaying a cached copy."
@@ -422,7 +427,7 @@ Emacs 19.29 accepts 'SIGUSR1, earlier versions require an integer
422which is 30 on SunOS and 16 on HP-UX and Solaris.") 427which is 30 on SunOS and 16 on HP-UX and Solaris.")
423 428
424(defcustom browse-url-CCI-port 3003 429(defcustom browse-url-CCI-port 3003
425 "Port to access XMosaic via CCI. 430 "*Port to access XMosaic via CCI.
426This can be any number between 1024 and 65535 but must correspond to 431This can be any number between 1024 and 65535 but must correspond to
427the value set in the browser." 432the value set in the browser."
428 :type 'integer 433 :type 'integer
@@ -439,7 +444,7 @@ enabled. The port number should be set in `browse-url-CCI-port'."
439(make-variable-buffer-local 'browse-url-temp-file-name) 444(make-variable-buffer-local 'browse-url-temp-file-name)
440 445
441(defcustom browse-url-xterm-program "xterm" 446(defcustom browse-url-xterm-program "xterm"
442 "The name of the terminal emulator used by `browse-url-lynx-xterm'. 447 "*The name of the terminal emulator used by `browse-url-lynx-xterm'.
443This might, for instance, be a separate colour version of xterm." 448This might, for instance, be a separate colour version of xterm."
444 :type 'string 449 :type 'string
445 :group 'browse-url) 450 :group 'browse-url)
@@ -452,7 +457,7 @@ These might set its size, for instance."
452 457
453(defcustom browse-url-lynx-emacs-args (and (not window-system) 458(defcustom browse-url-lynx-emacs-args (and (not window-system)
454 '("-show_cursor")) 459 '("-show_cursor"))
455 "A list of strings defining options for Lynx in an Emacs buffer. 460 "*A list of strings defining options for Lynx in an Emacs buffer.
456 461
457The default is none in a window system, otherwise `-show_cursor' to 462The default is none in a window system, otherwise `-show_cursor' to
458indicate the position of the current link in the absence of 463indicate the position of the current link in the absence of
@@ -462,7 +467,7 @@ highlighting, assuming the normal default for showing the cursor."
462 :group 'browse-url) 467 :group 'browse-url)
463 468
464(defcustom browse-url-gnudoit-program "gnudoit" 469(defcustom browse-url-gnudoit-program "gnudoit"
465 "The name of the `gnudoit' program used by `browse-url-w3-gnudoit'." 470 "*The name of the `gnudoit' program used by `browse-url-w3-gnudoit'."
466 :type 'string 471 :type 'string
467 :group 'browse-url) 472 :group 'browse-url)
468 473
@@ -484,7 +489,7 @@ These might set the port, for instance."
484 :group 'browse-url) 489 :group 'browse-url)
485 490
486(defcustom browse-url-temp-dir temporary-file-directory 491(defcustom browse-url-temp-dir temporary-file-directory
487 "The name of a directory for browse-url's temporary files. 492 "*The name of a directory for browse-url's temporary files.
488Such files are generated by functions like `browse-url-of-region'. 493Such files are generated by functions like `browse-url-of-region'.
489You might want to set this to somewhere with restricted read permissions 494You might want to set this to somewhere with restricted read permissions
490for privacy's sake." 495for privacy's sake."
@@ -493,7 +498,7 @@ for privacy's sake."
493 498
494(defcustom browse-url-netscape-version 499(defcustom browse-url-netscape-version
495 3 500 3
496 "The version of Netscape you are using. 501 "*The version of Netscape you are using.
497This affects how URL reloading is done; the mechanism changed 502This affects how URL reloading is done; the mechanism changed
498incompatibly at version 4." 503incompatibly at version 4."
499 :type 'number 504 :type 'number
@@ -517,10 +522,10 @@ down (this *won't* always work)."
517 "*How many times to try to move down from a series of lynx input fields.") 522 "*How many times to try to move down from a series of lynx input fields.")
518 523
519(defcustom browse-url-lynx-input-delay 0.2 524(defcustom browse-url-lynx-input-delay 0.2
520 "How many seconds to wait for lynx between moves down from an input field.") 525 "*How many seconds to wait for lynx between moves down from an input field.")
521 526
522(defcustom browse-url-kde-program "kfmclient" 527(defcustom browse-url-kde-program "kfmclient"
523 "The name by which to invoke the KDE web browser." 528 "*The name by which to invoke the KDE web browser."
524 :type 'string 529 :type 'string
525 :version "21.1" 530 :version "21.1"
526 :group 'browse-url) 531 :group 'browse-url)
@@ -927,7 +932,7 @@ used instead of `browse-url-new-window-flag'."
927;; GNOME means of invoking either Mozilla or Netrape. 932;; GNOME means of invoking either Mozilla or Netrape.
928 933
929(defcustom browse-url-gnome-moz-arguments '() 934(defcustom browse-url-gnome-moz-arguments '()
930 "A list of strings passed to the GNOME mozilla viewer as arguments." 935 "*A list of strings passed to the GNOME mozilla viewer as arguments."
931 :version "21.1" 936 :version "21.1"
932 :type '(repeat (string :tag "Argument")) 937 :type '(repeat (string :tag "Argument"))
933 :group 'browse-url) 938 :group 'browse-url)
@@ -974,7 +979,7 @@ the effect of `browse-url-new-window-flag'.
974When called non-interactively, optional second argument NEW-WINDOW is 979When called non-interactively, optional second argument NEW-WINDOW is
975used instead of `browse-url-new-window-flag'." 980used instead of `browse-url-new-window-flag'."
976 (interactive (browse-url-interactive-arg "Mosaic URL: ")) 981 (interactive (browse-url-interactive-arg "Mosaic URL: "))
977 (let ((pidfile (expand-file-name "~/.mosaicpid")) 982 (let ((pidfile (expand-file-name browse-url-mosaic-pidfile))
978 pid) 983 pid)
979 (if (file-readable-p pidfile) 984 (if (file-readable-p pidfile)
980 (save-excursion 985 (save-excursion