comparison lisp/url/url-auth.el @ 96486:7369ded3b436

Typo and docstring fixes. * url.el (url-do-setup): * url-dired.el (url-dired-minor-mode): * url-file.el (url-file-find-possibly-compressed-file): * url-gw.el (url-gateway-broken-resolution): * url-handlers.el (url-handler-regexp): * url-imap.el (url-imap-default-port): * url-methods.el (url-scheme-get-property): Fix typos in docstrings. * url-auth.el (url-basic-auth-storage, url-digest-auth): Fix typos in docstrings. (url-digest-auth-storage, url-register-auth-scheme): Reflow docstrings. * url-cache.el (url-cache-prepare): Doc fix. (url-cache-create-filename-human-readable, url-cache-extract): Fix typos in docstrings. * url-dav.el (url-intersection, url-dav-iso8601-regexp) (url-dav-delete-something): Fix typos in docstrings. (url-dav-http-success-p, url-dav-file-name-all-completions) (url-dav-directory-files, url-dav-file-name-completion): Doc fixes. * url-http.el (url-http-idle-sentinel): Doc fix. * url-irc.el (url-irc-default-port): Fix typo in docstring. (url-irc-function): Doc fix. * url-util.el (url-get-url-filename-chars, url-unhex-string): Fix typos in docstrings. (url-file-extension): Doc fix. * url-vars.el (url-current-object, url-current-mime-headers) (url-privacy-level, url-mail-command, url-mime-language-string): Fix typos in docstrings. (url-honor-refresh-requests): Reflow docstring. (url-using-proxy): Doc fix.
author Juanma Barranquero <lekktu@gmail.com>
date Wed, 02 Jul 2008 11:14:38 +0000
parents 26c59cfcaeff
children 1fa392febf9a
comparison
equal deleted inserted replaced
96485:46efd5367c59 96486:7369ded3b436
49 "Where usernames and passwords are stored. 49 "Where usernames and passwords are stored.
50 50
51 Must be a symbol pointing to another variable that will actually store 51 Must be a symbol pointing to another variable that will actually store
52 the information. The value of this variable is an assoc list of assoc 52 the information. The value of this variable is an assoc list of assoc
53 lists. The first assoc list is keyed by the server name. The cdr of 53 lists. The first assoc list is keyed by the server name. The cdr of
54 this is an assoc list based on the 'directory' specified by the url we 54 this is an assoc list based on the 'directory' specified by the URL we
55 are looking up.") 55 are looking up.")
56 56
57 (defun url-basic-auth (url &optional prompt overwrite realm args) 57 (defun url-basic-auth (url &optional prompt overwrite realm args)
58 "Get the username/password for the specified URL. 58 "Get the username/password for the specified URL.
59 If optional argument PROMPT is non-nil, ask for the username/password 59 If optional argument PROMPT is non-nil, ask for the username/password
132 ;;; for the complete documentation on this type. 132 ;;; for the complete documentation on this type.
133 ;;; 133 ;;;
134 ;;; This is very secure 134 ;;; This is very secure
135 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 135 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
136 (defvar url-digest-auth-storage nil 136 (defvar url-digest-auth-storage nil
137 "Where usernames and passwords are stored. Its value is an assoc list of 137 "Where usernames and passwords are stored.
138 assoc lists. The first assoc list is keyed by the server name. The cdr of 138 Its value is an assoc list of assoc lists. The first assoc list is
139 this is an assoc list based on the 'directory' specified by the url we are 139 keyed by the server name. The cdr of this is an assoc list based
140 looking up.") 140 on the 'directory' specified by the url we are looking up.")
141 141
142 (defun url-digest-auth-create-key (username password realm method uri) 142 (defun url-digest-auth-create-key (username password realm method uri)
143 "Create a key for digest authentication method" 143 "Create a key for digest authentication method"
144 (let* ((info (if (stringp uri) 144 (let* ((info (if (stringp uri)
145 (url-generic-parse-url uri) 145 (url-generic-parse-url uri)
149 (list a1 a2))) 149 (list a1 a2)))
150 150
151 (defun url-digest-auth (url &optional prompt overwrite realm args) 151 (defun url-digest-auth (url &optional prompt overwrite realm args)
152 "Get the username/password for the specified URL. 152 "Get the username/password for the specified URL.
153 If optional argument PROMPT is non-nil, ask for the username/password 153 If optional argument PROMPT is non-nil, ask for the username/password
154 to use for the url and its descendants. If optional third argument 154 to use for the URL and its descendants. If optional third argument
155 OVERWRITE is non-nil, overwrite the old username/password pair if it 155 OVERWRITE is non-nil, overwrite the old username/password pair if it
156 is found in the assoc list. If REALM is specified, use that as the realm 156 is found in the assoc list. If REALM is specified, use that as the realm
157 instead of hostname:portnum." 157 instead of hostname:portnum."
158 (if args 158 (if args
159 (let* ((href (if (stringp url) 159 (let* ((href (if (stringp url)
306 306
307 ;;;###autoload 307 ;;;###autoload
308 (defun url-register-auth-scheme (type &optional function rating) 308 (defun url-register-auth-scheme (type &optional function rating)
309 "Register an HTTP authentication method. 309 "Register an HTTP authentication method.
310 310
311 TYPE is a string or symbol specifying the name of the method. This 311 TYPE is a string or symbol specifying the name of the method.
312 should be the same thing you expect to get returned in an Authenticate 312 This should be the same thing you expect to get returned in
313 header in HTTP/1.0 - it will be downcased. 313 an Authenticate header in HTTP/1.0 - it will be downcased.
314 FUNCTION is the function to call to get the authorization information. This 314 FUNCTION is the function to call to get the authorization information.
315 defaults to `url-?-auth', where ? is TYPE 315 This defaults to `url-?-auth', where ? is TYPE.
316 RATING a rating between 1 and 10 of the strength of the authentication. 316 RATING a rating between 1 and 10 of the strength of the authentication.
317 This is used when asking for the best authentication for a specific 317 This is used when asking for the best authentication for a specific
318 URL. The item with the highest rating is returned." 318 URL. The item with the highest rating is returned."
319 (let* ((type (cond 319 (let* ((type (cond
320 ((stringp type) (downcase type)) 320 ((stringp type) (downcase type))