* sasl-digest.el (sasl-digest-md5-response): Refer client "qop".

[elisp/flim.git] / sasl.texi

diff --git a/sasl.texi b/sasl.texi
index a331e1c..4e538d5 100644 (file)
--- a/sasl.texi
+++ b/sasl.texi
@@ -10,20 +10,53 @@
 
 @settitle Emacs SASL Library @value{VERSION}
 
+@ifinfo
+This file describes the Emacs SASL library.
+
+Copyright (C) 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
+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
+Free Documentation License".
+@end ifinfo
+
+@tex
+
+@titlepage
+@title Emacs SASL Library
+
+@author by Daiki Ueno
+@page
+
+@vskip 0pt plus 1filll
+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
+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
+Free Documentation License".
+@end titlepage
+@page
+
+@end tex
+
 @node Top
 @top Emacs SASL
 This manual describes the Emacs SASL library.
 
-This library provides a common interface to share several authentication
-mechanisms between applications using different protocols.
-
+A common interface to share several authentication mechanisms between
+applications using different protocols.
 
 @menu
-* Overview::                    
-* Mechanisms::                  
-* Clients::                     
-* Steps::                       
-* Backend Drivers::             
+* Overview::                    What Emacs SASL library is.
+* How to use::                  Adding authentication support to your applications.
+* Data types::                  
+* Backend drivers::             Writing your own drivers.
 * Index::                       
 * Function Index::              
 * Variable Index::              
@@ -38,14 +71,42 @@ 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.
+of authentication mechanism drivers (@ref{Backend drivers}).
+
+Backend drivers are designed to be close as possible to the
+authentication mechanism.  You can access the additional configuration
+information anywhere from the implementation.
+
+@node How to use
+@chapter How to use
+
+(Not yet written).
+
+To use Emacs SASL library, please evaluate following expression at the
+beginning of your application program.
+
+@lisp
+(require 'sasl)
+@end lisp
+
+If you want to check existence of sasl.el at runtime, instead you
+can list autoload settings for functions you want.
+
+@node Data types
+@chapter Data types
 
 There are three data types to be used for carrying a negotiated
 security layer---a mechanism, a client parameter and an authentication
 step.
 
+@menu
+* Mechanisms::                  
+* Clients::                     
+* Steps::                       
+@end menu
+
 @node Mechanisms
-@chapter Mechanisms
+@section Mechanisms
 
 A mechanism (@code{sasl-mechanism} object) is a schema of the @sc{sasl}
 authentication mechanism driver.
@@ -72,7 +133,7 @@ Return name of mechanism, a string.
 @end defun
 
 If you want to write an authentication mechanism driver (@ref{Backend
-Drivers}), use @code{sasl-make-mechanism} and modify
+drivers}), use @code{sasl-make-mechanism} and modify
 @code{sasl-mechanisms} and @code{sasl-mechanism-alist} correctly.
 
 @defun sasl-make-mechanism name steps
@@ -92,7 +153,7 @@ of authentication functions.
 @end defun
 
 @node Clients
-@chapter Clients
+@section Clients
 
 A client (@code{sasl-client} object) initialized with four
 parameters---a mechanism, a user name, name of the service and name of
@@ -139,7 +200,7 @@ Return the whole property list of client configuration.
 @end defun
 
 @node Steps
-@chapter Steps
+@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
@@ -179,8 +240,8 @@ Perform the authentication step.
 At the first time STEP should be set to nil.
 @end defun
 
-@node Backend Drivers
-@chapter Backend Drivers
+@node Backend drivers
+@chapter Backend drivers
 
 (Not yet written).