X-Git-Url: http://cgit.sxemacs.org/?a=blobdiff_plain;f=texi%2Fsasl.texi;h=57391e94272747267860f18d980eb2128ad98106;hb=a521ba0cb6e16c5bac6b9e041ff1d3c4ca93e13f;hp=4e538d58162a809fbacdfc243f1c6fd8f9bb8b18;hpb=904b7e4e098be45915411ecbc7d7fdf75e5b3642;p=gnus diff --git a/texi/sasl.texi b/texi/sasl.texi index 4e538d581..57391e942 100644 --- a/texi/sasl.texi +++ b/texi/sasl.texi @@ -4,6 +4,7 @@ @set VERSION 0.2 +@dircategory Emacs @direntry * SASL: (sasl). The Emacs SASL library. @end direntry @@ -118,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 @@ -203,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)) @@ -237,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 @@ -262,3 +263,7 @@ At the first time STEP should be set to nil. @bye @c End: + +@ignore + arch-tag: dc9650be-a953-40bf-bc55-24fe5f19d875 +@end ignore