X-Git-Url: http://cgit.sxemacs.org/?p=gnus;a=blobdiff_plain;f=texi%2Fauth.texi;h=182a023b86680cadcc7ee43b145fdd2dc1346f22;hp=b787fbfecd68a4d82b8eb6664dbfc6c881f10bd7;hb=f0bddc315ea0e052416bdd68b1b3166a9e1e9d22;hpb=34558b00a63b6028f603fde0893bd6e8df9b7e5a diff --git a/texi/auth.texi b/texi/auth.texi index b787fbfec..182a023b8 100644 --- a/texi/auth.texi +++ b/texi/auth.texi @@ -2,15 +2,16 @@ @include gnus-overrides.texi +@set VERSION 0.3 + @setfilename auth @settitle Emacs auth-source Library @value{VERSION} - -@set VERSION 0.3 +@documentencoding UTF-8 @copying This file describes the Emacs auth-source library. -Copyright @copyright{} 2008-2012 Free Software Foundation, Inc. +Copyright @copyright{} 2008--2014 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -18,17 +19,10 @@ under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with the Front-Cover texts being ``A GNU Manual,'' and with the Back-Cover Texts as in (a) below. A copy of the license -is included in the section entitled ``GNU Free Documentation License'' -in the Emacs manual. +is included in the section entitled ``GNU Free Documentation License''. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom.'' - -This document is part of a collection distributed under the GNU Free -Documentation License. If you want to distribute this document -separately from the collection, you can do so by adding a copy of the -license to the document, as described in section 6 of the license. +modify this GNU manual.'' @end quotation @end copying @@ -68,6 +62,7 @@ It is a way for multiple applications to share a single configuration * Secret Service API:: * Help for developers:: * GnuPG and EasyPG Assistant Configuration:: +* GNU Free Documentation License:: The license for this documentation. * Index:: * Function Index:: * Variable Index:: @@ -89,7 +84,7 @@ password (known as the secret). Similarly, the auth-source library supports multiple storage backend, currently either the classic ``netrc'' backend, examples of which you -can see later in this document, or the Secret Service API. This is +can see later in this document, or the Secret Service API@. This is done with EIEIO-based backends and you can write your own if you want. @node Help for users @@ -132,7 +127,7 @@ later. If you have problems with the search, set @code{auth-source-debug} to @code{'trivia} and see what host, port, and user the library is -checking in the @samp{*Messages*} buffer. Ditto for any other +checking in the @file{*Messages*} buffer. Ditto for any other problems, your first step is always to see what's being checked. The second step, of course, is to write a blog entry about it and wait for the answer in the comments. @@ -160,7 +155,8 @@ and simplest configuration is: (setq auth-sources '((:source "~/.authinfo.gpg"))) ;;; even shorter and the @emph{default}: (setq auth-sources '("~/.authinfo.gpg" "~/.authinfo" "~/.netrc")) -;;; use the Secrets API @var{Login} collection (@pxref{Secret Service API}) +;;; use the Secrets API @var{Login} collection +;;; (@pxref{Secret Service API}) (setq auth-sources '("secrets:Login")) @end lisp @@ -173,19 +169,23 @@ have unusual setups and the remaining 10% are @emph{really} unusual). Here's a mixed example using two sources: @lisp -(setq auth-sources '((:source (:secrets default) :host "myserver" :user "joe") +(setq auth-sources '((:source (:secrets default) + :host "myserver" :user "joe") "~/.authinfo.gpg")) @end lisp @end defvar If you don't customize @code{auth-sources}, you'll have to live with -the defaults: any host and any port are looked up in the netrc -file @file{~/.authinfo.gpg}, which is a GnuPG encrypted file -(@pxref{GnuPG and EasyPG Assistant Configuration}). +the defaults: the unencrypted netrc file @file{~/.authinfo} will be +used for any host and any port. + +If that fails, any host and any port are looked up in the netrc file +@file{~/.authinfo.gpg}, which is a GnuPG encrypted file (@pxref{GnuPG +and EasyPG Assistant Configuration}). -If that fails, the unencrypted netrc files @file{~/.authinfo} and -@file{~/.netrc} will be used. +Finally, the unencrypted netrc file @file{~/.netrc} will be used for +any host and any port. The typical netrc line example is without a port. @@ -210,7 +210,7 @@ machine yourmachine.com:80 port http login testuser password testpass @end example This will match any realm and authentication method (basic or digest) -over HTTP. HTTPS is set up similarly. If you want finer controls, +over HTTP@. HTTPS is set up similarly. If you want finer controls, explore the url-auth source code and variables. For Tramp authentication, use: @@ -235,7 +235,7 @@ KDE Wallet (these are GNOME and KDE packages respectively and should be available on most modern GNU/Linux systems). The auth-source library uses the @file{secrets.el} library to connect -through the Secret Service API. You can also use that library in +through the Secret Service API@. You can also use that library in other packages, it's not exclusive to auth-source. @defvar secrets-enabled @@ -382,7 +382,7 @@ The auth-source library lets you control logging output easily. @defvar auth-source-debug Set this variable to @code{'trivia} to see lots of output in -@samp{*Messages*}, or set it to a function that behaves like +@file{*Messages*}, or set it to a function that behaves like @code{message} to do your own logging. @end defvar @@ -470,10 +470,10 @@ It returns the number of items forgotten. @node GnuPG and EasyPG Assistant Configuration @appendix GnuPG and EasyPG Assistant Configuration -If you don't customize @code{auth-sources}, the auth-source library -reads @file{~/.authinfo.gpg}, which is a GnuPG encrypted file. Then -it will check @file{~/.authinfo} but it's not recommended to use such -an unencrypted file. +If the @code{auth-sources} variable contains @file{~/.authinfo.gpg} +before @file{~/.authinfo}, the auth-source library will try to +read the GnuPG encrypted @file{.gpg} file first, before +the unencrypted file. In Emacs 23 or later there is an option @code{auto-encryption-mode} to automatically decrypt @file{*.gpg} files. It is enabled by default. @@ -519,16 +519,20 @@ To set up gpg-agent, follow the instruction in GnuPG manual To set up elisp passphrase cache, set @code{epa-file-cache-passphrase-for-symmetric-encryption}. +@node GNU Free Documentation License +@appendix GNU Free Documentation License +@include doclicense.texi + @node Index -@chapter Index +@unnumbered Index @printindex cp @node Function Index -@chapter Function Index +@unnumbered Function Index @printindex fn @node Variable Index -@chapter Variable Index +@unnumbered Variable Index @printindex vr @bye