aboutsummaryrefslogtreecommitdiffstats
path: root/lisp/ffap.el
diff options
context:
space:
mode:
authorJuanma Barranquero2014-03-21 02:12:57 +0100
committerJuanma Barranquero2014-03-21 02:12:57 +0100
commitdada060d9f65ce57fca99bef6e5a69ee88e126cf (patch)
treedc7777479a3e08d9cf4c2de5941c8882aa2b9e4e /lisp/ffap.el
parent1271626ab5d345cdfcd9aca1c528f6ed6152ef96 (diff)
downloademacs-dada060d9f65ce57fca99bef6e5a69ee88e126cf.tar.gz
emacs-dada060d9f65ce57fca99bef6e5a69ee88e126cf.zip
lisp/*.el: Fix typos.
* lisp/align.el (align-regexp): Remove superfluous backslash. * lisp/ffap.el (ffap-ftp-default-user, ffap-url-regexp) (ffap-pass-wildcards-to-dired, dired-at-point-require-prefix) (ffap-rfc-path, ffap-ftp-sans-slash-regexp, ffap-menu-regexp): Fix docstring typos. (ffap-next): Use C-u in docstring. (ffap-machine-p, ffap-list-env, ffap-alist, ffap-alist) (ffap-string-at-point-mode-alist, ffap-menu, ffap-menu-ask): Remove superfluous backslashes. (ffap-string-at-point): Reflow docstring. * lisp/server.el (server-host): Reflow docstring. (server-unload-function): Fix docstring typo. (server-eval-at): Remove superfluous backslash. * lisp/skeleton.el (skeleton-insert): Remove superfluous backslash. (skeleton-insert): Doc fix. (skeleton-insert): Reflow docstring. * lisp/term/tty-colors.el (tty-color-alist, tty-modify-color-alist) (tty-color-approximate, tty-color-by-index, tty-color-values) (tty-color-desc): Remove superfluous backslashes.
Diffstat (limited to 'lisp/ffap.el')
-rw-r--r--lisp/ffap.el40
1 files changed, 20 insertions, 20 deletions
diff --git a/lisp/ffap.el b/lisp/ffap.el
index 7051273a681..119e0ad3078 100644
--- a/lisp/ffap.el
+++ b/lisp/ffap.el
@@ -164,9 +164,9 @@ schemes (e.g. \"ftp\"); in that case, only convert those URLs."
164 :version "24.3") 164 :version "24.3")
165 165
166(defcustom ffap-ftp-default-user "anonymous" 166(defcustom ffap-ftp-default-user "anonymous"
167 "User name in ftp file names generated by `ffap-host-to-path'. 167 "User name in FTP file names generated by `ffap-host-to-path'.
168Note this name may be omitted if it equals the default 168Note this name may be omitted if it equals the default
169\(either `efs-default-user' or `ange-ftp-default-user'\)." 169\(either `efs-default-user' or `ange-ftp-default-user')."
170 :type 'string 170 :type 'string
171 :group 'ffap) 171 :group 'ffap)
172 172
@@ -185,7 +185,7 @@ Note this name may be omitted if it equals the default
185 "\\|" 185 "\\|"
186 "\\(ftp\\|https?\\|telnet\\|gopher\\|www\\|wais\\)://" ; needs host 186 "\\(ftp\\|https?\\|telnet\\|gopher\\|www\\|wais\\)://" ; needs host
187 "\\)") 187 "\\)")
188 "Regexp matching the beginning of a URI, for FFAP. 188 "Regexp matching the beginning of a URI, for ffap.
189If the value is nil, disable URL-matching features in ffap.") 189If the value is nil, disable URL-matching features in ffap.")
190 190
191(defcustom ffap-foo-at-bar-prefix "mailto" 191(defcustom ffap-foo-at-bar-prefix "mailto"
@@ -228,7 +228,7 @@ it passes it on to `dired'."
228 :group 'ffap) 228 :group 'ffap)
229 229
230(defcustom ffap-pass-wildcards-to-dired nil 230(defcustom ffap-pass-wildcards-to-dired nil
231 "If non-nil, pass filenames matching `ffap-dired-wildcards' to dired." 231 "If non-nil, pass filenames matching `ffap-dired-wildcards' to Dired."
232 :type 'boolean 232 :type 'boolean
233 :group 'ffap) 233 :group 'ffap)
234 234
@@ -291,8 +291,8 @@ For a fancy alternative, get `ffap-url.el'."
291 291
292(defcustom dired-at-point-require-prefix nil 292(defcustom dired-at-point-require-prefix nil
293 "If non-nil, reverse the prefix argument to `dired-at-point'. 293 "If non-nil, reverse the prefix argument to `dired-at-point'.
294This is nil so neophytes notice FFAP. Experts may prefer to 294This is nil so neophytes notice ffap. Experts may prefer to
295disable FFAP most of the time." 295disable ffap most of the time."
296 :type 'boolean 296 :type 'boolean
297 :group 'ffap 297 :group 'ffap
298 :version "20.3") 298 :version "20.3")
@@ -343,7 +343,7 @@ Only considers strings that match `ffap-next-regexp'."
343 "Search buffer for next file or URL, and run ffap. 343 "Search buffer for next file or URL, and run ffap.
344Optional argument BACK says to search backwards. 344Optional argument BACK says to search backwards.
345Optional argument WRAP says to try wrapping around if necessary. 345Optional argument WRAP says to try wrapping around if necessary.
346Interactively: use a single prefix to search backwards, 346Interactively: use a single prefix \\[universal-argument] to search backwards,
347double prefix to wrap forward, triple to wrap backwards. 347double prefix to wrap forward, triple to wrap backwards.
348Actual search is done by the function `ffap-next-guess'." 348Actual search is done by the function `ffap-next-guess'."
349 (interactive 349 (interactive
@@ -413,7 +413,7 @@ See `mail-extr.el' for the known domains."
413Depending on the domain (none, known, or unknown), follow the strategy 413Depending on the domain (none, known, or unknown), follow the strategy
414named by the variable `ffap-machine-p-local', `ffap-machine-p-known', 414named by the variable `ffap-machine-p-local', `ffap-machine-p-known',
415or `ffap-machine-p-unknown'. Pinging uses `open-network-stream'. 415or `ffap-machine-p-unknown'. Pinging uses `open-network-stream'.
416Optional SERVICE specifies the port used \(default \"discard\"\). 416Optional SERVICE specifies the port used (default \"discard\").
417Optional QUIET flag suppresses the \"Pinging...\" message. 417Optional QUIET flag suppresses the \"Pinging...\" message.
418Optional STRATEGY overrides the three variables above. 418Optional STRATEGY overrides the three variables above.
419Returned values: 419Returned values:
@@ -642,7 +642,7 @@ Looks at `ffap-ftp-default-user', returns \"\" for \"localhost\"."
642 642
643(defun ffap-list-env (env &optional empty) 643(defun ffap-list-env (env &optional empty)
644 "Return a list of strings parsed from environment variable ENV. 644 "Return a list of strings parsed from environment variable ENV.
645Optional EMPTY is the default list if \(getenv ENV\) is undefined, and 645Optional EMPTY is the default list if (getenv ENV) is undefined, and
646also is substituted for the first empty-string component, if there is one. 646also is substituted for the first empty-string component, if there is one.
647Uses `path-separator' to separate the path into substrings." 647Uses `path-separator' to separate the path into substrings."
648 ;; We cannot use parse-colon-path (files.el), since it kills 648 ;; We cannot use parse-colon-path (files.el), since it kills
@@ -787,12 +787,12 @@ This uses `ffap-file-exists-string', which may try adding suffixes from
787 . ffap-rfc) ; "100% RFC2100 compliant" 787 . ffap-rfc) ; "100% RFC2100 compliant"
788 (dired-mode . ffap-dired) ; maybe in a subdirectory 788 (dired-mode . ffap-dired) ; maybe in a subdirectory
789 ) 789 )
790 "Alist of \(KEY . FUNCTION\) pairs parsed by `ffap-file-at-point'. 790 "Alist of (KEY . FUNCTION) pairs parsed by `ffap-file-at-point'.
791If string NAME at point (maybe \"\") is not a file or URL, these pairs 791If string NAME at point (maybe \"\") is not a file or URL, these pairs
792specify actions to try creating such a string. A pair matches if either 792specify actions to try creating such a string. A pair matches if either
793 KEY is a symbol, and it equals `major-mode', or 793 KEY is a symbol, and it equals `major-mode', or
794 KEY is a string, it should match NAME as a regexp. 794 KEY is a string, it should match NAME as a regexp.
795On a match, \(FUNCTION NAME\) is called and should return a file, an 795On a match, (FUNCTION NAME) is called and should return a file, an
796URL, or nil. If nil, search the alist for further matches.") 796URL, or nil. If nil, search the alist for further matches.")
797 797
798(put 'ffap-alist 'risky-local-variable t) 798(put 'ffap-alist 'risky-local-variable t)
@@ -980,7 +980,7 @@ If t, `ffap-tex-init' will initialize this when needed.")
980(defcustom ffap-rfc-path 980(defcustom ffap-rfc-path
981 (concat (ffap-host-to-filename "ftp.rfc-editor.org") "/in-notes/rfc%s.txt") 981 (concat (ffap-host-to-filename "ftp.rfc-editor.org") "/in-notes/rfc%s.txt")
982 "A `format' string making a filename for RFC documents. 982 "A `format' string making a filename for RFC documents.
983This can be an ange-ftp or tramp remote filename to download, or 983This can be an ange-ftp or Tramp remote filename to download, or
984a local filename if you have full set of RFCs locally. See also 984a local filename if you have full set of RFCs locally. See also
985`ffap-rfc-directories'." 985`ffap-rfc-directories'."
986 :type 'string 986 :type 'string
@@ -1018,8 +1018,8 @@ If a given RFC isn't in these then `ffap-rfc-path' is offered."
1018 ;; Mathematica paths: allow backquotes 1018 ;; Mathematica paths: allow backquotes
1019 (math-mode ",-:$+<>@-Z_[:lower:]~`" "<" "@>;.,!?`:") 1019 (math-mode ",-:$+<>@-Z_[:lower:]~`" "<" "@>;.,!?`:")
1020 ) 1020 )
1021 "Alist of \(MODE CHARS BEG END\), where MODE is a symbol, 1021 "Alist of (MODE CHARS BEG END), where MODE is a symbol,
1022possibly a major-mode name, or one of the symbol 1022possibly a major-mode name, or one of the symbols
1023`file', `url', `machine', and `nocolon'. 1023`file', `url', `machine', and `nocolon'.
1024Function `ffap-string-at-point' uses the data fields as follows: 1024Function `ffap-string-at-point' uses the data fields as follows:
10251. find a maximal string of CHARS around point, 10251. find a maximal string of CHARS around point,
@@ -1032,8 +1032,8 @@ Function `ffap-string-at-point' uses the data fields as follows:
1032 1032
1033(defun ffap-string-at-point (&optional mode) 1033(defun ffap-string-at-point (&optional mode)
1034 "Return a string of characters from around point. 1034 "Return a string of characters from around point.
1035MODE (defaults to value of `major-mode') is a symbol used to look up string 1035MODE (defaults to value of `major-mode') is a symbol used to look up
1036syntax parameters in `ffap-string-at-point-mode-alist'. 1036string syntax parameters in `ffap-string-at-point-mode-alist'.
1037If MODE is not found, we use `file' instead of MODE. 1037If MODE is not found, we use `file' instead of MODE.
1038If the region is active, return a string from the region. 1038If the region is active, return a string from the region.
1039Sets the variable `ffap-string-at-point' and the variable 1039Sets the variable `ffap-string-at-point' and the variable
@@ -1143,7 +1143,7 @@ The two subexpressions are the KEY and VALUE.")
1143 ;; Icky regexp avoids: default: 123: foo::bar cs:pub 1143 ;; Icky regexp avoids: default: 123: foo::bar cs:pub
1144 ;; It does match on: mic@cs: cs:/pub mathcs.emory.edu: (point at end) 1144 ;; It does match on: mic@cs: cs:/pub mathcs.emory.edu: (point at end)
1145 "\\`\\([^:@]+@[^:@]+:\\|[^@.:]+\\.[^@:]+:\\|[^:]+:[~/]\\)\\([^:]\\|\\'\\)") 1145 "\\`\\([^:@]+@[^:@]+:\\|[^@.:]+\\.[^@:]+:\\|[^:]+:[~/]\\)\\([^:]\\|\\'\\)")
1146 "Strings matching this are coerced to ftp file names by ffap. 1146 "Strings matching this are coerced to FTP file names by ffap.
1147That is, ffap just prepends \"/\". Set to nil to disable.") 1147That is, ffap just prepends \"/\". Set to nil to disable.")
1148 1148
1149(defun ffap-file-at-point () 1149(defun ffap-file-at-point ()
@@ -1445,7 +1445,7 @@ and the functions `ffap-file-at-point' and `ffap-url-at-point'."
1445(defcustom ffap-menu-regexp nil 1445(defcustom ffap-menu-regexp nil
1446 "If non-nil, regexp overriding `ffap-next-regexp' in `ffap-menu'. 1446 "If non-nil, regexp overriding `ffap-next-regexp' in `ffap-menu'.
1447Make this more restrictive for faster menu building. 1447Make this more restrictive for faster menu building.
1448For example, try \":/\" for URL (and some ftp) references." 1448For example, try \":/\" for URL (and some FTP) references."
1449 :type '(choice (const nil) regexp) 1449 :type '(choice (const nil) regexp)
1450 :group 'ffap) 1450 :group 'ffap)
1451 1451
@@ -1465,7 +1465,7 @@ These properties may be used to fontify the menu references.")
1465 "Put up a menu of files and URLs mentioned in this buffer. 1465 "Put up a menu of files and URLs mentioned in this buffer.
1466Then set mark, jump to choice, and try to fetch it. The menu is 1466Then set mark, jump to choice, and try to fetch it. The menu is
1467cached in `ffap-menu-alist', and rebuilt by `ffap-menu-rescan'. 1467cached in `ffap-menu-alist', and rebuilt by `ffap-menu-rescan'.
1468The optional RESCAN argument \(a prefix, interactively\) forces 1468The optional RESCAN argument (a prefix, interactively) forces
1469a rebuild. Searches with `ffap-menu-regexp'." 1469a rebuild. Searches with `ffap-menu-regexp'."
1470 (interactive "P") 1470 (interactive "P")
1471 ;; (require 'imenu) -- no longer used, but roughly emulated 1471 ;; (require 'imenu) -- no longer used, but roughly emulated
@@ -1498,7 +1498,7 @@ a rebuild. Searches with `ffap-menu-regexp'."
1498 1498
1499(defun ffap-menu-ask (title alist cont) 1499(defun ffap-menu-ask (title alist cont)
1500 "Prompt from a menu of choices, and then apply some action. 1500 "Prompt from a menu of choices, and then apply some action.
1501Arguments are TITLE, ALIST, and CONT \(a continuation function\). 1501Arguments are TITLE, ALIST, and CONT (a continuation function).
1502This uses either a menu or the minibuffer depending on invocation. 1502This uses either a menu or the minibuffer depending on invocation.
1503The TITLE string is used as either the prompt or menu title. 1503The TITLE string is used as either the prompt or menu title.
1504Each ALIST entry looks like (STRING . DATA) and defines one choice. 1504Each ALIST entry looks like (STRING . DATA) and defines one choice.