Mercurial > emacs
annotate doc/misc/auth.texi @ 110523:a5ad4f188e19
Synch Semantic to CEDET 1.0.
Move CEDET ChangeLog entries to new file lisp/cedet/ChangeLog.
* semantic.el (semantic-version): Update to 2.0.
(semantic-mode-map): Add "," and "m" bindings.
(navigate-menu): Update.
* semantic/symref.el (semantic-symref-calculate-rootdir):
New function.
(semantic-symref-detect-symref-tool): Use it.
* semantic/symref/grep.el (semantic-symref-grep-shell): New var.
(semantic-symref-perform-search): Use it. Calculate root dir with
semantic-symref-calculate-rootdir.
(semantic-symref-derive-find-filepatterns): Improve error message.
* semantic/symref/list.el
(semantic-symref-results-mode-map): New bindings.
(semantic-symref-auto-expand-results): New option.
(semantic-symref-results-dump): Obey auto-expand.
(semantic-symref-list-expand-all, semantic-symref-regexp)
(semantic-symref-list-contract-all)
(semantic-symref-list-map-open-hits)
(semantic-symref-list-update-open-hits)
(semantic-symref-list-create-macro-on-open-hit)
(semantic-symref-list-call-macro-on-open-hits): New functions.
(semantic-symref-list-menu-entries)
(semantic-symref-list-menu): New vars.
(semantic-symref-list-map-open-hits): Move cursor to beginning of
match before calling the mapped function.
* semantic/doc.el
(semantic-documentation-comment-preceeding-tag): Do nothing if the
mode doesn't provide comment-start-skip.
* semantic/scope.el
(semantic-analyze-scope-nested-tags-default): Strip duplicates.
(semantic-analyze-scoped-inherited-tag-map): Take the tag we are
looking for as part of the scoped tags list.
* semantic/html.el (semantic-default-html-setup): Add
senator-step-at-tag-classes.
* semantic/decorate/include.el
(semantic-decoration-on-unknown-includes): Change light bgcolor.
(semantic-decoration-on-includes-highlight-default): Check that
the include tag has a postion.
* semantic/complete.el (semantic-collector-local-members):
(semantic-complete-read-tag-local-members)
(semantic-complete-jump-local-members): New class and functions.
(semantic-complete-self-insert): Save excursion before completing.
* semantic/analyze/complete.el
(semantic-analyze-possible-completions-default): If no completions
are found, return the raw by-name-only completion list. Add FLAGS
arguments. Add support for 'no-tc (type constraint) and
'no-unique, or no stripping duplicates.
(semantic-analyze-possible-completions-default): Add FLAGS arg.
* semantic/util-modes.el
(semantic-stickyfunc-show-only-functions-p): New option.
(semantic-stickyfunc-fetch-stickyline): Don't show stickytext for
the very first line in a buffer.
* semantic/util.el (semantic-hack-search)
(semantic-recursive-find-nonterminal-by-name)
(semantic-current-tag-interactive): Deleted.
(semantic-describe-buffer): Fix expand-nonterminal. Add
lex-syntax-mods, type relation separator char, and command
separation char.
(semantic-sanity-check): Only message if called interactively.
* semantic/tag.el (semantic-tag-deep-copy-one-tag): Copy the
:filename property and the tag position.
* semantic/lex-spp.el (semantic-lex-spp-lex-text-string):
Add recursion limit.
* semantic/imenu.el (semantic-imenu-bucketize-type-members):
Make this buffer local, not the obsoleted variable.
* semantic/idle.el: Add breadcrumbs support.
(semantic-idle-summary-current-symbol-info-default)
(semantic-idle-tag-highlight)
(semantic-idle-completion-list-default): Use
semanticdb-without-unloaded-file-searches for speed, and to
conform to the controls that specify if the idle timer is supposed
to be parsing unparsed includes.
(semantic-idle-symbol-highlight-face)
(semantic-idle-symbol-maybe-highlight): Rename from *-summary-*.
Callers changed.
(semantic-idle-work-parse-neighboring-files-flag): Default to nil.
(semantic-idle-work-update-headers-flag): New var.
(semantic-idle-work-for-one-buffer): Use it.
(semantic-idle-local-symbol-highlight): Rename from
semantic-idle-tag-highlight.
(semantic-idle-truncate-long-summaries): New option.
* semantic/ia.el (semantic-ia-cache)
(semantic-ia-get-completions): Deleted. Callers changed.
(semantic-ia-show-variants): New command.
(semantic-ia-show-doc): If doc is empty, don't make a temp buffer.
(semantic-ia-show-summary): If there isn't anything to show, say so.
* semantic/grammar.el (semantic-grammar-create-package):
Save the buffer even in batch mode.
* semantic/fw.el
(semanticdb-without-unloaded-file-searches): New macro.
* semantic/dep.el (semantic-dependency-find-file-on-path):
Fix case dereferencing ede-object when it is a list.
* semantic/db-typecache.el (semanticdb-expand-nested-tag)
(semanticdb-typecache-faux-namespace): New functions.
(semanticdb-typecache-file-tags)
(semanticdb-typecache-merge-streams): Use them.
(semanticdb-typecache-file-tags): When deriving tags from a file,
give the mode a chance to monkey with the tag copy.
(semanticdb-typecache-find-default): Wrap find in save-excursion.
(semanticdb-typecache-find-by-name-helper): Merge found names down.
* semantic/db-global.el
(semanticdb-enable-gnu-global-in-buffer): Don't show messages if
GNU Global is not available and we don't want to throw an error.
* semantic/db-find.el (semanticdb-find-result-nth-in-buffer):
When trying to normalize the tag to a buffer, don't error if
set-buffer method doesn't exist.
* semantic/db-file.el (semanticdb-save-db): Simplify msg.
* semantic/db.el (semanticdb-refresh-table): If forcing a
refresh on a file not in a buffer, use semantic-find-file-noselect
and delete the buffer after use.
(semanticdb-current-database-list): When calculating root via
hooks, force it through true-filename and skip the list of
possible roots.
* semantic/ctxt.el (semantic-ctxt-imported-packages): New.
* semantic/analyze/debug.el
(semantic-analyzer-debug-insert-tag): Reset standard output to
current buffer.
(semantic-analyzer-debug-global-symbol)
(semantic-analyzer-debug-missing-innertype): Change "prefix" to
"symbol" in messages.
* semantic/analyze/refs.el: (semantic-analyze-refs-impl)
(semantic-analyze-refs-proto): When calculating value, make sure
the found tag is 'similar' to the originating tag.
(semantic--analyze-refs-find-tags-with-parent): Attempt to
identify matches via imported symbols of parents.
(semantic--analyze-refs-full-lookup-with-parents): Do a deep
search during the brute search.
* semantic/analyze.el
(semantic-analyze-find-tag-sequence-default): Be robust to
calculated scopes being nil.
* semantic/bovine/c.el (semantic-c-describe-environment): Add
project macro symbol array.
(semantic-c-parse-lexical-token): Add recursion limit.
(semantic-ctxt-imported-packages, semanticdb-expand-nested-tag):
New overrides.
(semantic-expand-c-tag-namelist): Split a full type from a typedef
out to its own tag.
(semantic-expand-c-tag-namelist): Do not split out a typedef'd
inline type if it is an anonymous type.
(semantic-c-reconstitute-token): Use the optional initializers as
a clue that some function is probably a constructor. When
defining the type of these constructors, split the parent name,
and use only the class part, if applicable.
* semantic/bovine/c-by.el:
* semantic/wisent/python-wy.el: Regenerate.
author | Chong Yidong <cyd@stupidchicken.com> |
---|---|
date | Sat, 18 Sep 2010 22:49:54 -0400 |
parents | a91e94388547 |
children | 60516122d066 376148b31b5e |
rev | line source |
---|---|
102054 | 1 \input texinfo @c -*-texinfo-*- |
102371 | 2 @setfilename ../../info/auth |
102059
9bcea07061a8
consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents:
102054
diff
changeset
|
3 @settitle Emacs auth-source Library @value{VERSION} |
102054 | 4 |
104692 | 5 @set VERSION 0.2 |
102054 | 6 |
7 @copying | |
8 This file describes the Emacs auth-source library. | |
9 | |
106815 | 10 Copyright @copyright{} 2008, 2009, 2010 Free Software Foundation, Inc. |
102054 | 11 |
12 @quotation | |
13 Permission is granted to copy, distribute and/or modify this document | |
14 under the terms of the GNU Free Documentation License, Version 1.3 or | |
15 any later version published by the Free Software Foundation; with no | |
16 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,'' | |
17 and with the Back-Cover Texts as in (a) below. A copy of the license | |
18 is included in the section entitled ``GNU Free Documentation License'' | |
19 in the Emacs manual. | |
20 | |
21 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and | |
22 modify this GNU manual. Buying copies from the FSF supports it in | |
23 developing GNU and promoting software freedom.'' | |
24 | |
25 This document is part of a collection distributed under the GNU Free | |
26 Documentation License. If you want to distribute this document | |
27 separately from the collection, you can do so by adding a copy of the | |
28 license to the document, as described in section 6 of the license. | |
29 @end quotation | |
30 @end copying | |
31 | |
102059
9bcea07061a8
consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents:
102054
diff
changeset
|
32 @dircategory Emacs |
9bcea07061a8
consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents:
102054
diff
changeset
|
33 @direntry |
109274
a91e94388547
Minor doc/misc/*.texi direntry fixes.
Glenn Morris <rgm@gnu.org>
parents:
106815
diff
changeset
|
34 * Auth-source: (auth). The Emacs auth-source library. |
102059
9bcea07061a8
consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents:
102054
diff
changeset
|
35 @end direntry |
102054 | 36 |
37 @titlepage | |
38 @title Emacs auth-source Library | |
39 @author by Ted Zlatanov | |
40 @page | |
41 @vskip 0pt plus 1filll | |
42 @insertcopying | |
43 @end titlepage | |
44 | |
102059
9bcea07061a8
consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents:
102054
diff
changeset
|
45 @contents |
102054 | 46 |
102059
9bcea07061a8
consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents:
102054
diff
changeset
|
47 @ifnottex |
102054 | 48 @node Top |
49 @top Emacs auth-source | |
50 This manual describes the Emacs auth-source library. | |
51 | |
52 It is a way for multiple applications to share a single configuration | |
53 (in Emacs and in files) for user convenience. | |
54 | |
102059
9bcea07061a8
consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents:
102054
diff
changeset
|
55 @insertcopying |
9bcea07061a8
consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents:
102054
diff
changeset
|
56 |
102054 | 57 @menu |
58 * Overview:: Overview of the auth-source library. | |
59 * Help for users:: | |
60 * Help for developers:: | |
61 * Index:: | |
62 * Function Index:: | |
63 * Variable Index:: | |
64 @end menu | |
102059
9bcea07061a8
consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents:
102054
diff
changeset
|
65 @end ifnottex |
102054 | 66 |
67 @node Overview | |
68 @chapter Overview | |
69 | |
104891
2c607b344f3b
2009-09-02 Teodor Zlatanov <tzz@lifelogs.com>
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
104692
diff
changeset
|
70 The auth-source library is simply a way for Emacs and Gnus, among |
2c607b344f3b
2009-09-02 Teodor Zlatanov <tzz@lifelogs.com>
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
104692
diff
changeset
|
71 others, to find the answer to the old burning question ``I have a |
2c607b344f3b
2009-09-02 Teodor Zlatanov <tzz@lifelogs.com>
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
104692
diff
changeset
|
72 server name and a port, what are my user name and password?'' |
104692 | 73 |
74 The auth-source library actually supports more than just the user name | |
75 (known as the login) or the password, but only those two are in use | |
76 today in Emacs or Gnus. Similarly, the auth-source library can in | |
77 theory support multiple storage formats, but currently it only | |
78 understands the classic ``netrc'' format, examples of which you can | |
79 see later in this document. | |
102054 | 80 |
81 @node Help for users | |
82 @chapter Help for users | |
83 | |
104692 | 84 ``Netrc'' files are a de facto standard. They look like this: |
85 @example | |
104891
2c607b344f3b
2009-09-02 Teodor Zlatanov <tzz@lifelogs.com>
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
104692
diff
changeset
|
86 machine @var{mymachine} login @var{myloginname} password @var{mypassword} port @var{myport} |
104692 | 87 @end example |
102054 | 88 |
104891
2c607b344f3b
2009-09-02 Teodor Zlatanov <tzz@lifelogs.com>
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
104692
diff
changeset
|
89 The machine is the server (either a DNS name or an IP address). |
2c607b344f3b
2009-09-02 Teodor Zlatanov <tzz@lifelogs.com>
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
104692
diff
changeset
|
90 |
104692 | 91 The port is optional. If it's missing, auth-source will assume any |
92 port is OK. Actually the port is a protocol name or a port number so | |
104891
2c607b344f3b
2009-09-02 Teodor Zlatanov <tzz@lifelogs.com>
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
104692
diff
changeset
|
93 you can have separate entries for port @var{143} and for protocol |
2c607b344f3b
2009-09-02 Teodor Zlatanov <tzz@lifelogs.com>
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
104692
diff
changeset
|
94 @var{imap} if you fancy that. Anyway, you can just omit the port if |
2c607b344f3b
2009-09-02 Teodor Zlatanov <tzz@lifelogs.com>
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
104692
diff
changeset
|
95 you don't need it. |
2c607b344f3b
2009-09-02 Teodor Zlatanov <tzz@lifelogs.com>
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
104692
diff
changeset
|
96 |
2c607b344f3b
2009-09-02 Teodor Zlatanov <tzz@lifelogs.com>
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
104692
diff
changeset
|
97 The login and password are simply your login credentials to the server. |
104692 | 98 |
104891
2c607b344f3b
2009-09-02 Teodor Zlatanov <tzz@lifelogs.com>
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
104692
diff
changeset
|
99 ``Netrc'' files are usually called @code{.authinfo} or @code{.netrc}; |
2c607b344f3b
2009-09-02 Teodor Zlatanov <tzz@lifelogs.com>
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
104692
diff
changeset
|
100 nowadays @code{.authinfo} seems to be more popular and the auth-source |
2c607b344f3b
2009-09-02 Teodor Zlatanov <tzz@lifelogs.com>
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
104692
diff
changeset
|
101 library encourages this confusion by making it the default, as you'll |
2c607b344f3b
2009-09-02 Teodor Zlatanov <tzz@lifelogs.com>
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
104692
diff
changeset
|
102 see later. |
104692 | 103 |
104891
2c607b344f3b
2009-09-02 Teodor Zlatanov <tzz@lifelogs.com>
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
104692
diff
changeset
|
104 If you have problems with the port, set @code{auth-source-debug} to |
2c607b344f3b
2009-09-02 Teodor Zlatanov <tzz@lifelogs.com>
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
104692
diff
changeset
|
105 @code{t} and see what port the library is checking in the |
2c607b344f3b
2009-09-02 Teodor Zlatanov <tzz@lifelogs.com>
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
104692
diff
changeset
|
106 @code{*Messages*} buffer. Ditto for any other problems, your first |
2c607b344f3b
2009-09-02 Teodor Zlatanov <tzz@lifelogs.com>
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
104692
diff
changeset
|
107 step is always to see what's being checked. The second step, of |
2c607b344f3b
2009-09-02 Teodor Zlatanov <tzz@lifelogs.com>
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
104692
diff
changeset
|
108 course, is to write a blog entry about it and wait for the answer in |
2c607b344f3b
2009-09-02 Teodor Zlatanov <tzz@lifelogs.com>
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
104692
diff
changeset
|
109 the comments. |
2c607b344f3b
2009-09-02 Teodor Zlatanov <tzz@lifelogs.com>
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
104692
diff
changeset
|
110 |
2c607b344f3b
2009-09-02 Teodor Zlatanov <tzz@lifelogs.com>
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
104692
diff
changeset
|
111 You can customize the variable @code{auth-sources}. The following may |
104692 | 112 be needed if you are using an older version of Emacs or if the |
113 auth-source library is not loaded for some other reason. | |
102054 | 114 |
115 @lisp | |
104692 | 116 (require 'auth-source) ;; probably not necessary |
102054 | 117 (customize-variable 'auth-sources) ;; optional, do it once |
118 @end lisp | |
119 | |
120 @defvar auth-sources | |
121 | |
104891
2c607b344f3b
2009-09-02 Teodor Zlatanov <tzz@lifelogs.com>
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
104692
diff
changeset
|
122 The @code{auth-sources} variable tells the auth-source library where |
102054 | 123 your netrc files live for a particular host and protocol. While you |
124 can get fancy, the default and simplest configuration is: | |
125 | |
126 @lisp | |
127 (setq auth-sources '((:source "~/.authinfo.gpg" :host t :protocol t))) | |
128 @end lisp | |
129 | |
104692 | 130 This says ``for any host and any protocol, use just that one file.'' |
131 Sweet simplicity. In fact, this is already the default, so unless you | |
132 want to move your netrc file, it will just work if you have that | |
133 file. You may not, though, so make sure it exists. | |
134 | |
104891
2c607b344f3b
2009-09-02 Teodor Zlatanov <tzz@lifelogs.com>
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
104692
diff
changeset
|
135 By adding multiple entries to @code{auth-sources} with a particular |
104692 | 136 host or protocol, you can have specific netrc files for that host or |
137 protocol. Usually this is unnecessary but may make sense if you have | |
138 shared netrc files or some other unusual setup (90% of Emacs users | |
139 have unusual setups and the remaining 10% are @emph{really} unusual). | |
102054 | 140 |
141 @end defvar | |
142 | |
104891
2c607b344f3b
2009-09-02 Teodor Zlatanov <tzz@lifelogs.com>
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
104692
diff
changeset
|
143 If you don't customize @code{auth-sources}, you'll have to live with |
102054 | 144 the defaults: any host and any port are looked up in the netrc |
145 file @code{~/.authinfo.gpg}. This is an encrypted file if and only if | |
146 you set up EPA, which is strongly recommended. | |
147 | |
148 @lisp | |
149 (require 'epa-file) | |
150 (epa-file-enable) | |
104692 | 151 ;;; VERY important if you want symmetric encryption |
152 ;;; irrelevant if you don't | |
153 (setq epa-file-cache-passphrase-for-symmetric-encryption t) | |
102054 | 154 @end lisp |
155 | |
104692 | 156 The simplest working netrc line example is one without a port. |
157 | |
158 @example | |
159 machine YOURMACHINE login YOU password YOURPASSWORD | |
160 @end example | |
161 | |
162 This will match any authentication port. Simple, right? But what if | |
163 there's a SMTP server on port 433 of that machine that needs a | |
164 different password from the IMAP server? | |
165 | |
166 @example | |
167 machine YOURMACHINE login YOU password SMTPPASSWORD port 433 | |
168 machine YOURMACHINE login YOU password GENERALPASSWORD | |
169 @end example | |
170 | |
102054 | 171 For url-auth authentication (HTTP/HTTPS), you need to put this in your |
172 netrc file: | |
173 | |
174 @example | |
175 machine yourmachine.com:80 port http login testuser password testpass | |
176 @end example | |
177 | |
104692 | 178 This will match any realm and authentication method (basic or digest) |
179 over HTTP. HTTPS is set up similarly. If you want finer controls, | |
180 explore the url-auth source code and variables. | |
102054 | 181 |
182 For Tramp authentication, use: | |
183 | |
184 @example | |
185 machine yourmachine.com port scp login testuser password testpass | |
186 @end example | |
187 | |
188 Note that the port denotes the Tramp connection method. When you | |
189 don't use a port entry, you match any Tramp method, as explained | |
104692 | 190 earlier. Since Tramp has about 88 connection methods, this may be |
191 necessary if you have an unusual (see earlier comment on those) setup. | |
102054 | 192 |
193 @node Help for developers | |
194 @chapter Help for developers | |
195 | |
196 The auth-source library only has one function for external use. | |
197 | |
198 @defun auth-source-user-or-password mode host port | |
199 | |
200 Retrieve appropriate authentication tokens, determined by @var{mode}, | |
104891
2c607b344f3b
2009-09-02 Teodor Zlatanov <tzz@lifelogs.com>
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
104692
diff
changeset
|
201 for host @var{host} and @var{port}. If @code{auth-source-debug} is t, |
2c607b344f3b
2009-09-02 Teodor Zlatanov <tzz@lifelogs.com>
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
104692
diff
changeset
|
202 debugging messages will be printed. Set @code{auth-source-debug} to a |
104692 | 203 function to use that function for logging. The parameters passed will |
204 be the same that the @code{message} function takes, that is, a string | |
205 formatting spec and optional parameters. | |
102054 | 206 |
207 If @var{mode} is a list of strings, the function will return a list of | |
104692 | 208 strings or @code{nil} objects (thus you can avoid parsing the netrc |
209 file more than once). If it's a string, the function will return a | |
210 string or a @code{nil} object. Currently only the modes ``login'' and | |
211 ``password'' are recognized but more may be added in the future. | |
102054 | 212 |
213 @var{host} is a string containing the host name. | |
214 | |
215 @var{port} contains the protocol name (e.g. ``imap'') or | |
216 a port number. It must be a string, corresponding to the port in the | |
217 users' netrc files. | |
218 | |
219 @example | |
220 ;; IMAP example | |
221 (setq auth (auth-source-user-or-password | |
222 '("login" "password") | |
223 "anyhostnamehere" | |
224 "imap")) | |
225 (nth 0 auth) ; the login name | |
226 (nth 1 auth) ; the password | |
227 @end example | |
228 | |
229 @end defun | |
230 | |
231 @node Index | |
232 @chapter Index | |
233 @printindex cp | |
234 | |
235 @node Function Index | |
236 @chapter Function Index | |
237 @printindex fn | |
238 | |
239 @node Variable Index | |
240 @chapter Variable Index | |
241 @printindex vr | |
242 | |
243 @bye | |
244 | |
245 @c End: | |
246 | |
247 @ignore | |
248 arch-tag: 7b835fd3-473f-40fc-9776-1c4e49d26c94 | |
249 @end ignore |