diff options
author | Lute Kamstra <lute@gnu.org> | 2008-12-03 05:48:14 +0000 |
---|---|---|
committer | Lute Kamstra <lute@gnu.org> | 2008-12-03 05:48:14 +0000 |
commit | 9201cc281b10650e96296eda8519403e2b508fbd (patch) | |
tree | e86a6ba2b3d0044d996036ccf8430908dca34b26 /lisp/ffap.el | |
parent | 1b17adfd3b07d24b4665ff66fd1b1dcc05f6c823 (diff) | |
download | emacs-9201cc281b10650e96296eda8519403e2b508fbd.tar.gz |
* align.el:
* allout.el:
* apropos.el:
* arc-mode.el:
* autoinsert.el:
* avoid.el:
* battery.el:
* bookmark.el:
* buff-menu.el:
* calculator.el:
* chistory.el:
* cmuscheme.el:
* comint.el:
* compare-w.el:
* dabbrev.el:
* delim-col.el:
* desktop.el:
* diff-mode.el:
* diff.el:
* dired-aux.el:
* dired-x.el:
* dired.el:
* dos-vars.el:
* ediff-diff.el:
* ediff-help.el:
* ediff-init.el:
* ediff-merg.el:
* ediff-mult.el:
* ediff-ptch.el:
* ediff-vers.el:
* ediff-wind.el:
* ediff.el:
* emerge.el:
* facemenu.el:
* faces.el:
* ffap.el:
* filecache.el:
* find-dired.el:
* font-core.el:
* font-lock.el:
* forms.el:
* fringe.el:
* help-at-pt.el:
* hippie-exp.el:
* ido.el:
* image-file.el:
* imenu.el:
* indent.el:
* info.el:
* isearchb.el:
* iswitchb.el:
* jit-lock.el:
* jka-compr.el:
* log-edit.el:
* lpr.el:
* ls-lisp.el:
* man.el:
* menu-bar.el:
* midnight.el:
* mouse-sel.el:
* mouse.el:
* msb.el:
* outline.el:
* paren.el:
* pcmpl-cvs.el:
* pcmpl-gnu.el:
* pcomplete.el:
* pcvs-info.el:
* pcvs-parse.el:
* printing.el:
* ps-mule.el:
* ps-print.el:
* replace.el:
* ruler-mode.el:
* saveplace.el:
* sb-image.el:
* scroll-bar.el:
* sha1.el:
* shadowfile.el:
* shell.el:
* sort.el:
* speedbar.el:
* strokes.el:
* tempo.el:
* term.el:
* terminal.el:
* time-stamp.el:
* time.el:
* tree-widget.el:
* type-break.el:
* vc-cvs.el:
* vc-hg.el:
* vc-mcvs.el:
* vc-rcs.el:
* vc-sccs.el:
* vc.el:
* view.el:
* w32-vars.el:
* whitespace.el:
* wid-edit.el: Remove leading * from docstrings of defcustoms,
deffaces, defconsts and defuns.
Diffstat (limited to 'lisp/ffap.el')
-rw-r--r-- | lisp/ffap.el | 36 |
1 files changed, 18 insertions, 18 deletions
diff --git a/lisp/ffap.el b/lisp/ffap.el index 72efcb33542..c063adf7f10 100644 --- a/lisp/ffap.el +++ b/lisp/ffap.el @@ -148,7 +148,7 @@ If nil, ffap doesn't do shell prompt stripping." ;; This used to test for ange-ftp or efs being present, but it should be ;; harmless (and simpler) to give it this value unconditionally. "\\`/[^/:]+:" - "*File names matching this regexp are treated as remote ffap. + "File names matching this regexp are treated as remote ffap. If nil, ffap neither recognizes nor generates such names." :type '(choice (const :tag "Disable" nil) (const :tag "Standard" "\\`/[^/:]+:") @@ -156,18 +156,18 @@ If nil, ffap neither recognizes nor generates such names." :group 'ffap) (defcustom ffap-url-unwrap-local t - "*If non-nil, convert `file:' URL to local file name before prompting." + "If non-nil, convert `file:' URL to local file name before prompting." :type 'boolean :group 'ffap) (defcustom ffap-url-unwrap-remote t - "*If non-nil, convert `ftp:' URL to remote file name before prompting. + "If non-nil, convert `ftp:' URL to remote file name before prompting. This is ignored if `ffap-ftp-regexp' is nil." :type 'boolean :group 'ffap) (defcustom ffap-ftp-default-user "anonymous" - "*User name in ftp file names generated by `ffap-host-to-path'. + "User name in ftp file names generated by `ffap-host-to-path'. Note this name may be omitted if it equals the default \(either `efs-default-user' or `ange-ftp-default-user'\)." :type 'string @@ -177,7 +177,7 @@ Note this name may be omitted if it equals the default ;; Remote file access built into file system? HP rfa or Andrew afs: "\\`/\\(afs\\|net\\)/." ;; afs only: (and (file-exists-p "/afs") "\\`/afs/.") - "*Matching file names are treated as remote. Use nil to disable." + "Matching file names are treated as remote. Use nil to disable." :type 'regexp :group 'ffap) @@ -194,7 +194,7 @@ Note this name may be omitted if it equals the default "Regexp matching URL's. nil to disable URL features in ffap.") (defcustom ffap-foo-at-bar-prefix "mailto" - "*Presumed URL prefix type of strings like \"<foo.9z@bar>\". + "Presumed URL prefix type of strings like \"<foo.9z@bar>\". Sensible values are nil, \"news\", or \"mailto\"." :type '(choice (const "mailto") (const "news") @@ -213,7 +213,7 @@ Sensible values are nil, \"news\", or \"mailto\"." ;; enabler in your .emacs file. (defcustom ffap-dired-wildcards "[*?][^/]*\\'" - "*A regexp matching filename wildcard characters, or nil. + "A regexp matching filename wildcard characters, or nil. If `find-file-at-point' gets a filename matching this pattern, and `ffap-pass-wildcards-to-dired' is nil, it passes it on to @@ -233,33 +233,33 @@ it passes it on to `dired'." :group 'ffap) (defcustom ffap-pass-wildcards-to-dired nil - "*If non-nil, pass filenames matching `ffap-dired-wildcards' to dired." + "If non-nil, pass filenames matching `ffap-dired-wildcards' to dired." :type 'boolean :group 'ffap) (defcustom ffap-newfile-prompt nil ;; Suggestion from RHOGEE, 11 Jul 1994. Disabled, I think this is ;; better handled by `find-file-not-found-hooks'. - "*Whether `find-file-at-point' prompts about a nonexistent file." + "Whether `find-file-at-point' prompts about a nonexistent file." :type 'boolean :group 'ffap) (defcustom ffap-require-prefix nil ;; Suggestion from RHOGEE, 20 Oct 1994. - "*If set, reverses the prefix argument to `find-file-at-point'. + "If set, reverses the prefix argument to `find-file-at-point'. This is nil so neophytes notice ffap. Experts may prefer to disable ffap most of the time." :type 'boolean :group 'ffap) (defcustom ffap-file-finder 'find-file - "*The command called by `find-file-at-point' to find a file." + "The command called by `find-file-at-point' to find a file." :type 'function :group 'ffap) (put 'ffap-file-finder 'risky-local-variable t) (defcustom ffap-directory-finder 'dired - "*The command called by `dired-at-point' to find a directory." + "The command called by `dired-at-point' to find a directory." :type 'function :group 'ffap) (put 'ffap-directory-finder 'risky-local-variable t) @@ -271,7 +271,7 @@ ffap most of the time." ;; Remote control references: ;; http://www.ncsa.uiuc.edu/SDG/Software/XMosaic/remote-control.html ;; http://home.netscape.com/newsref/std/x-remote.html - "*A function of one argument, called by ffap to fetch an URL. + "A function of one argument, called by ffap to fetch an URL. Reasonable choices are `w3-fetch' or a `browse-url-*' function. For a fancy alternative, get `ffap-url.el'." :type '(choice (const w3-fetch) @@ -309,7 +309,7 @@ For a fancy alternative, get `ffap-url.el'." ;; It pays to put a big fancy regexp here, since ffap-guesser is ;; much more time-consuming than regexp searching: "[/:.~[:alpha:]]/\\|@[[:alpha:]][-[:alnum:]]*\\." - "*Regular expression governing movements of `ffap-next'." + "Regular expression governing movements of `ffap-next'." :type 'regexp :group 'ffap) @@ -375,14 +375,14 @@ Actual search is done by `ffap-next-guess'." ;; particular, if `Pinging...' is broken or takes too long on your ;; machine, try setting these all to accept or reject. (defcustom ffap-machine-p-local 'reject ; this happens often - "*What `ffap-machine-p' does with hostnames that have no domain. + "What `ffap-machine-p' does with hostnames that have no domain. Value should be a symbol, one of `ping', `accept', and `reject'." :type '(choice (const ping) (const accept) (const reject)) :group 'ffap) (defcustom ffap-machine-p-known 'ping ; `accept' for higher speed - "*What `ffap-machine-p' does with hostnames that have a known domain. + "What `ffap-machine-p' does with hostnames that have a known domain. Value should be a symbol, one of `ping', `accept', and `reject'. See `mail-extr.el' for the known domains." :type '(choice (const ping) @@ -390,7 +390,7 @@ See `mail-extr.el' for the known domains." (const reject)) :group 'ffap) (defcustom ffap-machine-p-unknown 'reject - "*What `ffap-machine-p' does with hostnames that have an unknown domain. + "What `ffap-machine-p' does with hostnames that have an unknown domain. Value should be a symbol, one of `ping', `accept', and `reject'. See `mail-extr.el' for the known domains." :type '(choice (const ping) @@ -1770,7 +1770,7 @@ Only intended for interactive use." (defcustom dired-at-point-require-prefix nil - "*If set, reverses the prefix argument to `dired-at-point'. + "If set, reverses the prefix argument to `dired-at-point'. This is nil so neophytes notice ffap. Experts may prefer to disable ffap most of the time." :type 'boolean |