Merge from emacs--devo--0
[gnus] / texi / sasl.texi
index 4e538d5..193eb8f 100644 (file)
@@ -4,6 +4,7 @@
 
 @set VERSION 0.2
 
+@dircategory Emacs
 @direntry
 * SASL: (sasl).   The Emacs SASL library.
 @end direntry
 @ifinfo
 This file describes the Emacs SASL library.
 
-Copyright (C) 2000 Daiki Ueno.
+Copyright @copyright{} 2000, 2004, 2005, 2006, 2007, 2008
+Free Software Foundation, Inc.
 
 Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU Free Documentation License, Version 1.1 or
+under the terms of the GNU Free Documentation License, Version 1.2 or
 any later version published by the Free Software Foundation; with no
 Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
 Texts.  A copy of the license is included in the section entitled "GNU
@@ -35,7 +37,7 @@ Free Documentation License".
 Copyright @copyright{} 2000 Daiki Ueno.
 
 Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU Free Documentation License, Version 1.1 or
+under the terms of the GNU Free Documentation License, Version 1.2 or
 any later version published by the Free Software Foundation; with no
 Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
 Texts.  A copy of the license is included in the section entitled "GNU
@@ -56,7 +58,7 @@ applications using different protocols.
 * Overview::                    What Emacs SASL library is.
 * How to use::                  Adding authentication support to your applications.
 * Data types::                  
-* Backend drivers::             Writing your own drivers.
+* Back end drivers::             Writing your own drivers.
 * Index::                       
 * Function Index::              
 * Variable Index::              
@@ -71,9 +73,9 @@ adding authentication support to various application protocols.
 
 The toplevel interface of this library is inspired by Java @sc{sasl}
 Application Program Interface.  It defines an abstraction over a series
-of authentication mechanism drivers (@ref{Backend drivers}).
+of authentication mechanism drivers (@ref{Back end drivers}).
 
-Backend drivers are designed to be close as possible to the
+Back end drivers are designed to be close as possible to the
 authentication mechanism.  You can access the additional configuration
 information anywhere from the implementation.
 
@@ -118,7 +120,7 @@ A list of mechanism names.
 @defun sasl-find-mechanism mechanisms
 
 Retrieve an apropriate mechanism.
-This function compares MECHANISMS and @code{sasl-mechanisms} then
+This function compares @var{mechanisms} and @code{sasl-mechanisms} then
 returns apropriate @code{sasl-mechanism} object.
 
 @example
@@ -132,7 +134,7 @@ returns apropriate @code{sasl-mechanism} object.
 Return name of mechanism, a string.
 @end defun
 
-If you want to write an authentication mechanism driver (@ref{Backend
+If you want to write an authentication mechanism driver (@ref{Back end
 drivers}), use @code{sasl-make-mechanism} and modify
 @code{sasl-mechanisms} and @code{sasl-mechanism-alist} correctly.
 
@@ -203,19 +205,19 @@ Return the whole property list of client configuration.
 @section Steps
 
 A step (@code{sasl-step} object) is an abstraction of authentication
-"step" which holds the response value and the next entry point for the
+``step'' which holds the response value and the next entry point for the
 authentication process (the latter is not accessible).
 
 @defun sasl-step-data step
-Return the data which STEP holds, a string.
+Return the data which @var{step} holds, a string.
 @end defun
 
 @defun sasl-step-set-data step data
-Store DATA string to STEP.
+Store @var{data} string to @var{step}.
 @end defun
 
 To get the initial response, you should call the function
-@code{sasl-next-step} with the second argument nil.
+@code{sasl-next-step} with the second argument @code{nil}.
 
 @example
 (setq name (sasl-mechanism-name mechanism))
@@ -237,11 +239,11 @@ To go on with the authentication process, all you have to do is call
 
 @defun sasl-next-step client step
 Perform the authentication step.
-At the first time STEP should be set to nil.
+At the first time @var{step} should be set to @code{nil}.
 @end defun
 
-@node Backend drivers
-@chapter Backend drivers
+@node Back end drivers
+@chapter Back end drivers
 
 (Not yet written).
 
@@ -262,3 +264,7 @@ At the first time STEP should be set to nil.
 @bye
 
 @c End:
+
+@ignore
+   arch-tag: dc9650be-a953-40bf-bc55-24fe5f19d875
+@end ignore