X-Git-Url: http://git.chise.org/gitweb/?a=blobdiff_plain;f=sasl.texi;h=8d73326430789f59d747f716ae176f852f37f82e;hb=e7dcab499b32c4dc78996c955f8d18f84e1fc662;hp=6d6e9ec8c69b639db2d33350a3bb78688a0e8c4e;hpb=cfbeb2aa70dd2506c32ce4a2e1d232731a93701d;p=elisp%2Fflim.git diff --git a/sasl.texi b/sasl.texi index 6d6e9ec..8d73326 100644 --- a/sasl.texi +++ b/sasl.texi @@ -4,12 +4,48 @@ @set VERSION 0.2 +@dircategory Emacs @direntry * SASL: (sasl). The Emacs SASL library. @end direntry @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. @@ -83,7 +119,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 @@ -168,19 +204,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)) @@ -202,7 +238,7 @@ 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