aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeodor Zlatanov2012-04-06 01:56:38 +0000
committerKatsumi Yamaoka2012-04-06 01:56:38 +0000
commitc8bf3227a2dbd39bf01e9bde419eaca4ee388caf (patch)
treea43c2a23c484f811afb0060ba9f75dfaa475140c
parentf23d2c7d18471ef3c509740d9f1aa2437c9e0cec (diff)
downloademacs-c8bf3227a2dbd39bf01e9bde419eaca4ee388caf.tar.gz
emacs-c8bf3227a2dbd39bf01e9bde419eaca4ee388caf.zip
auth.texi (Secret Service API): Adjust @samp to @code for collection names
-rw-r--r--doc/misc/ChangeLog1
-rw-r--r--doc/misc/auth.texi28
2 files changed, 15 insertions, 14 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog
index f6260ecc4ab..e2f2c949676 100644
--- a/doc/misc/ChangeLog
+++ b/doc/misc/ChangeLog
@@ -1,6 +1,7 @@
12012-04-05 Teodor Zlatanov <tzz@lifelogs.com> 12012-04-05 Teodor Zlatanov <tzz@lifelogs.com>
2 2
3 * auth.texi (Secret Service API): Edit further and give examples. 3 * auth.texi (Secret Service API): Edit further and give examples.
4 (Secret Service API): Adjust @samp to @code for collection names.
4 5
52012-04-04 Glenn Morris <rgm@gnu.org> 62012-04-04 Glenn Morris <rgm@gnu.org>
6 7
diff --git a/doc/misc/auth.texi b/doc/misc/auth.texi
index bb413ad138b..4ce4e337a0f 100644
--- a/doc/misc/auth.texi
+++ b/doc/misc/auth.texi
@@ -260,12 +260,12 @@ sometimes called a @samp{keyring} or @samp{wallet} in GNOME Keyring
260and KDE Wallet but it's the same thing, a group of secrets. 260and KDE Wallet but it's the same thing, a group of secrets.
261Collections are personal and protected so only the owner can open them. 261Collections are personal and protected so only the owner can open them.
262 262
263The most common collection is called @samp{login}. 263The most common collection is called @code{"login"}.
264 264
265A collection can have an alias. The alias @samp{default} is 265A collection can have an alias. The alias @code{"default"} is
266commonly used so the clients don't have to know the specific name of 266commonly used so the clients don't have to know the specific name of
267the collection they open. Other aliases are not supported yet. 267the collection they open. Other aliases are not supported yet.
268Since aliases are globally accessible, set the @samp{default} alias 268Since aliases are globally accessible, set the @code{"default"} alias
269only when you're sure it's appropriate. 269only when you're sure it's appropriate.
270 270
271@defun secrets-list-collections 271@defun secrets-list-collections
@@ -274,27 +274,27 @@ This function returns all the collection names as a list.
274 274
275@defun secrets-set-alias collection alias 275@defun secrets-set-alias collection alias
276Set @var{alias} as alias of collection labeled @var{collection}. 276Set @var{alias} as alias of collection labeled @var{collection}.
277Currently only the alias @samp{default} is supported. 277Currently only the alias @code{"default"} is supported.
278@end defun 278@end defun
279 279
280@defun secrets-get-alias alias 280@defun secrets-get-alias alias
281Return the collection name @var{alias} is referencing to. 281Return the collection name @var{alias} is referencing to.
282Currently only the alias @samp{default} is supported. 282Currently only the alias @code{"default"} is supported.
283@end defun 283@end defun
284 284
285Collections can be created and deleted by the functions 285Collections can be created and deleted by the functions
286@code{secrets-create-collection} and @code{secrets-delete-collection}. 286@code{secrets-create-collection} and @code{secrets-delete-collection}.
287Usually, this is not done from within Emacs. Do not delete standard 287Usually, this is not done from within Emacs. Do not delete standard
288collections such as @samp{login}. 288collections such as @code{"login"}.
289 289
290The special collection @samp{session} exists for the lifetime of the 290The special collection @code{"session"} exists for the lifetime of the
291corresponding client session (in our case, Emacs's lifetime). It is 291corresponding client session (in our case, Emacs's lifetime). It is
292created automatically when Emacs uses the Secret Service interface and 292created automatically when Emacs uses the Secret Service interface and
293it is deleted when Emacs is killed. Therefore, it can be used to 293it is deleted when Emacs is killed. Therefore, it can be used to
294store and retrieve secret items temporarily. The @samp{session} 294store and retrieve secret items temporarily. The @code{"session"}
295collection is better than a persistent collection when the secret 295collection is better than a persistent collection when the secret
296items should not live longer than Emacs. The session collection can 296items should not live longer than Emacs. The session collection can
297be specified either by the string @samp{session}, or by @code{nil}, 297be specified either by the string @code{"session"}, or by @code{nil},
298whenever a collection parameter is needed in the following functions. 298whenever a collection parameter is needed in the following functions.
299 299
300@defun secrets-list-items collection 300@defun secrets-list-items collection
@@ -359,12 +359,12 @@ in @code{secrets-create-item}. Example:
359 359
360The auth-source library uses the @file{secrets.el} library and thus 360The auth-source library uses the @file{secrets.el} library and thus
361the Secret Service API when you specify a source matching 361the Secret Service API when you specify a source matching
362@samp{secrets:COLLECTION}. For instance, you could use 362@code{"secrets:COLLECTION"}. For instance, you could use
363@samp{secrets:session} to use the @samp{session} collection, open only 363@code{"secrets:session"} to use the @code{"session"} collection, open only
364for the lifetime of Emacs. Or you could use @samp{secrets:Login} to 364for the lifetime of Emacs. Or you could use @code{"secrets:Login"} to
365open the @samp{Login} collection. As a special case, you can use the 365open the @code{"Login"} collection. As a special case, you can use the
366symbol @code{default} in @code{auth-sources} (not a string, but a 366symbol @code{default} in @code{auth-sources} (not a string, but a
367symbol) to specify the @samp{default} alias. Here is a contrived 367symbol) to specify the @code{"default"} alias. Here is a contrived
368example that sets @code{auth-sources} to search three collections and 368example that sets @code{auth-sources} to search three collections and
369then fall back to @file{~/.authinfo.gpg}. 369then fall back to @file{~/.authinfo.gpg}.
370 370