diff options
| author | Glenn Morris | 2012-04-04 16:44:56 -0400 |
|---|---|---|
| committer | Glenn Morris | 2012-04-04 16:44:56 -0400 |
| commit | 3c93d00f977f6d6922e4735be5794f588a5af01f (patch) | |
| tree | 86b8f7c56e24fd0cac309ac139945d7255e00f83 /doc/misc | |
| parent | aebd5f1a83c8ffc4f857f3f353c4a06e008cee88 (diff) | |
| download | emacs-3c93d00f977f6d6922e4735be5794f588a5af01f.tar.gz emacs-3c93d00f977f6d6922e4735be5794f588a5af01f.zip | |
Markup fixes for auth.texi
* doc/misc/auth.texi (Help for users, Help for developers)
(GnuPG and EasyPG Assistant Configuration): Markup fixes.
Diffstat (limited to 'doc/misc')
| -rw-r--r-- | doc/misc/ChangeLog | 2 | ||||
| -rw-r--r-- | doc/misc/auth.texi | 26 |
2 files changed, 15 insertions, 13 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog index e6ded4f653c..525b03e929d 100644 --- a/doc/misc/ChangeLog +++ b/doc/misc/ChangeLog | |||
| @@ -2,6 +2,8 @@ | |||
| 2 | 2 | ||
| 3 | * auth.texi (Secret Service API): Copyedits. | 3 | * auth.texi (Secret Service API): Copyedits. |
| 4 | (Help for developers): Fill in some missing function doc-strings. | 4 | (Help for developers): Fill in some missing function doc-strings. |
| 5 | (Help for users, Help for developers) | ||
| 6 | (GnuPG and EasyPG Assistant Configuration): Markup fixes. | ||
| 5 | 7 | ||
| 6 | 2012-04-04 Michael Albinus <michael.albinus@gmx.de> | 8 | 2012-04-04 Michael Albinus <michael.albinus@gmx.de> |
| 7 | 9 | ||
diff --git a/doc/misc/auth.texi b/doc/misc/auth.texi index 08e093f57ac..83975659405 100644 --- a/doc/misc/auth.texi +++ b/doc/misc/auth.texi | |||
| @@ -113,7 +113,7 @@ The @code{user} is the user name. It's known as @var{:user} in | |||
| 113 | 113 | ||
| 114 | Spaces are always OK as far as auth-source is concerned (but other | 114 | Spaces are always OK as far as auth-source is concerned (but other |
| 115 | programs may not like them). Just put the data in quotes, escaping | 115 | programs may not like them). Just put the data in quotes, escaping |
| 116 | quotes as you'd expect with @code{\}. | 116 | quotes as you'd expect with @samp{\}. |
| 117 | 117 | ||
| 118 | All these are optional. You could just say (but we don't recommend | 118 | All these are optional. You could just say (but we don't recommend |
| 119 | it, we're just showing that it's possible) | 119 | it, we're just showing that it's possible) |
| @@ -125,14 +125,14 @@ password @var{mypassword} | |||
| 125 | to use the same password everywhere. Again, @emph{DO NOT DO THIS} or | 125 | to use the same password everywhere. Again, @emph{DO NOT DO THIS} or |
| 126 | you will be pwned as the kids say. | 126 | you will be pwned as the kids say. |
| 127 | 127 | ||
| 128 | ``Netrc'' files are usually called @code{.authinfo} or @code{.netrc}; | 128 | ``Netrc'' files are usually called @file{.authinfo} or @file{.netrc}; |
| 129 | nowadays @code{.authinfo} seems to be more popular and the auth-source | 129 | nowadays @file{.authinfo} seems to be more popular and the auth-source |
| 130 | library encourages this confusion by accepting both, as you'll see | 130 | library encourages this confusion by accepting both, as you'll see |
| 131 | later. | 131 | later. |
| 132 | 132 | ||
| 133 | If you have problems with the search, set @code{auth-source-debug} to | 133 | If you have problems with the search, set @code{auth-source-debug} to |
| 134 | @code{'trivia} and see what host, port, and user the library is | 134 | @code{'trivia} and see what host, port, and user the library is |
| 135 | checking in the @code{*Messages*} buffer. Ditto for any other | 135 | checking in the @samp{*Messages*} buffer. Ditto for any other |
| 136 | problems, your first step is always to see what's being checked. The | 136 | problems, your first step is always to see what's being checked. The |
| 137 | second step, of course, is to write a blog entry about it and wait for | 137 | second step, of course, is to write a blog entry about it and wait for |
| 138 | the answer in the comments. | 138 | the answer in the comments. |
| @@ -181,11 +181,11 @@ Here's a mixed example using two sources: | |||
| 181 | 181 | ||
| 182 | If you don't customize @code{auth-sources}, you'll have to live with | 182 | If you don't customize @code{auth-sources}, you'll have to live with |
| 183 | the defaults: any host and any port are looked up in the netrc | 183 | the defaults: any host and any port are looked up in the netrc |
| 184 | file @code{~/.authinfo.gpg}, which is a GnuPG encrypted file | 184 | file @file{~/.authinfo.gpg}, which is a GnuPG encrypted file |
| 185 | (@pxref{GnuPG and EasyPG Assistant Configuration}). | 185 | (@pxref{GnuPG and EasyPG Assistant Configuration}). |
| 186 | 186 | ||
| 187 | If that fails, the unencrypted netrc files @code{~/.authinfo} and | 187 | If that fails, the unencrypted netrc files @file{~/.authinfo} and |
| 188 | @code{~/.netrc} will be used. | 188 | @file{~/.netrc} will be used. |
| 189 | 189 | ||
| 190 | The typical netrc line example is without a port. | 190 | The typical netrc line example is without a port. |
| 191 | 191 | ||
| @@ -363,9 +363,9 @@ Search items in @var{collection} with @var{attributes}. | |||
| 363 | The auth-source library lets you control logging output easily. | 363 | The auth-source library lets you control logging output easily. |
| 364 | 364 | ||
| 365 | @defvar auth-source-debug | 365 | @defvar auth-source-debug |
| 366 | Set this variable to 'trivia to see lots of output in *Messages*, or | 366 | Set this variable to @code{'trivia} to see lots of output in |
| 367 | set it to a function that behaves like @code{message} to do your own | 367 | @samp{*Messages*}, or set it to a function that behaves like |
| 368 | logging. | 368 | @code{message} to do your own logging. |
| 369 | @end defvar | 369 | @end defvar |
| 370 | 370 | ||
| 371 | The auth-source library only has a few functions for external use. | 371 | The auth-source library only has a few functions for external use. |
| @@ -453,12 +453,12 @@ It returns the number of items forgotten. | |||
| 453 | @appendix GnuPG and EasyPG Assistant Configuration | 453 | @appendix GnuPG and EasyPG Assistant Configuration |
| 454 | 454 | ||
| 455 | If you don't customize @code{auth-sources}, the auth-source library | 455 | If you don't customize @code{auth-sources}, the auth-source library |
| 456 | reads @code{~/.authinfo.gpg}, which is a GnuPG encrypted file. Then | 456 | reads @file{~/.authinfo.gpg}, which is a GnuPG encrypted file. Then |
| 457 | it will check @code{~/.authinfo} but it's not recommended to use such | 457 | it will check @file{~/.authinfo} but it's not recommended to use such |
| 458 | an unencrypted file. | 458 | an unencrypted file. |
| 459 | 459 | ||
| 460 | In Emacs 23 or later there is an option @code{auto-encryption-mode} to | 460 | In Emacs 23 or later there is an option @code{auto-encryption-mode} to |
| 461 | automatically decrypt @code{*.gpg} files. It is enabled by default. | 461 | automatically decrypt @file{*.gpg} files. It is enabled by default. |
| 462 | If you are using earlier versions of Emacs, you will need: | 462 | If you are using earlier versions of Emacs, you will need: |
| 463 | 463 | ||
| 464 | @lisp | 464 | @lisp |