Commit d3d9b4fd d3d9b4fd9644927658c0f61fe6b6c4b01afd8659 by Sergey Poznyakoff

Fixed use of @deffn

1 parent fbb790c3
......@@ -30,108 +30,108 @@ Using libmu_scm
@node Address Functions
@section Address Functions
@deffn Function mu-address-get-personal ADDRESS NUM
@deffn {Scheme Function} mu-address-get-personal ADDRESS NUM
Return personal part of an email address.
@end deffn
@deffn Function mu-address-get-comments ADDRESS NUM
@deffn {Scheme Function} mu-address-get-comments ADDRESS NUM
@end deffn
@deffn Function mu-address-get-email ADDRESS NUM
@deffn {Scheme Function} mu-address-get-email ADDRESS NUM
Return email part of an email address.
@end deffn
@deffn Function mu-address-get-domain ADDRESS NUM
@deffn {Scheme Function} mu-address-get-domain ADDRESS NUM
Return domain part of an email address
@end deffn
@deffn Function mu-address-get-local ADDRESS NUM
@deffn {Scheme Function} mu-address-get-local ADDRESS NUM
Return local part of an email address.
@end deffn
@deffn Function mu-address-get-count ADDRESS
@deffn {Scheme Function} mu-address-get-count ADDRESS
Return number of parts in email address.
@end deffn
@node Mailbox Functions
@section Mailbox Functions
@deffn Function mu-mailbox-open URL MODE
@deffn {Scheme Function} mu-mailbox-open URL MODE
Opens a mailbox specified by URL.
@end deffn
@deffn Function mu-mailbox-close MBOX
@deffn {Scheme Function} mu-mailbox-close MBOX
Closes mailbox MBOX
@end deffn
@deffn Function mu-mailbox-get-url MBOX
@deffn {Scheme Function} mu-mailbox-get-url MBOX
Returns the URL of the mailbox.
@end deffn
@deffn Function mu-mailbox-get-port MBOX MODE
@deffn {Scheme Function} mu-mailbox-get-port MBOX MODE
Returns a port associated with the contents of the MBOX.
MODE is a string defining operation mode of the stream. It may
contain any of the two characters: @samp{r} for reading, @samp{w} for
writing.
@end deffn
@deffn Function mu-mailbox-get-message MBOX MSGNO
@deffn {Scheme Function} mu-mailbox-get-message MBOX MSGNO
Retrieve from MBOX message # MSGNO.
@end deffn
@deffn Function mu-mailbox-messages-count MBOX
@deffn {Scheme Function} mu-mailbox-messages-count MBOX
Returns number of messages in the mailbox.
@end deffn
@deffn Function mu-mailbox-expunge MBOX
@deffn {Scheme Function} mu-mailbox-expunge MBOX
Expunges deleted messages from the mailbox.
@end deffn
@deffn Function mu-mailbox-url MBOX
@deffn {Scheme Function} mu-mailbox-url MBOX
Returns the URL of the mailbox
@end deffn
@deffn Function mu-mailbox-append-message MBOX MESG
@deffn {Scheme Function} mu-mailbox-append-message MBOX MESG
Appends the message to the mailbox
@end deffn
@node Message Functions
@section Message Functions
@deffn Function mu-message-copy MESG
@deffn {Scheme Function} mu-message-copy MESG
Creates the copy of the given message.
@end deffn
@deffn Function mu-message-set-header MESG HEADER VALUE REPLACE
@deffn {Scheme Function} mu-message-set-header MESG HEADER VALUE REPLACE
Sets new VALUE to the header HEADER of the message MESG.
If the HEADER is already present in the message its value
is replaced with the supplied one if the optional REPLACE is
#t. Otherwise new header is created and appended.
@end deffn
@deffn Function mu-message-get-size MESG
@deffn {Scheme Function} mu-message-get-size MESG
Returns the size of the given message.
@end deffn
@deffn Function mu-message-get-lines MESG
@deffn {Scheme Function} mu-message-get-lines MESG
Returns number of lines in the given message.
@end deffn
@deffn Function mu-message-get-sender MESG
@deffn {Scheme Function} mu-message-get-sender MESG
Returns the sender email address for the message MESG.
@end deffn
@deffn Function mu-message-get-header MESG HEADER
@deffn {Scheme Function} mu-message-get-header MESG HEADER
Returns the header value of the HEADER in the MESG.
@end deffn
@deffn Function mu-message-get-header-fields MESG HEADERS
@deffn {Scheme Function} mu-message-get-header-fields MESG HEADERS
Returns the list of headers in the MESG. If optional HEADERS is
specified it should be a list of header names to restrict return
value to.
@end deffn
@deffn Function mu-message-set-header-fields MESG LIST REPLACE
@deffn {Scheme Function} mu-message-set-header-fields MESG LIST REPLACE
Set the headers in the message MESG from LIST
LIST is a list of (cons HEADER VALUE)
Optional parameter REPLACE specifies whether the new header
......@@ -139,30 +139,30 @@ values should replace the headers already present in the
message.
@end deffn
@deffn Function mu-message-delete MESG FLAG
@deffn {Scheme Function} mu-message-delete MESG FLAG
Mark given message as deleted. Optional FLAG allows to toggle deleted mark
The message is deleted if it is #t and undeleted if it is #f
@end deffn
@deffn Function mu-message-get-flag MESG FLAG
@deffn {Scheme Function} mu-message-get-flag MESG FLAG
Return value of the attribute FLAG.
@end deffn
@deffn Function mu-message-set-flag MESG FLAG VALUE
@deffn {Scheme Function} mu-message-set-flag MESG FLAG VALUE
Set the given attribute of the message. If optional VALUE is #f, the
attribute is unset.
@end deffn
@deffn Function mu-message-get-user-flag MESG FLAG
@deffn {Scheme Function} mu-message-get-user-flag MESG FLAG
Returns value of the user attribute FLAG.
@end deffn
@deffn Function mu-message-set-user-flag MESG FLAG VALUE
@deffn {Scheme Function} mu-message-set-user-flag MESG FLAG VALUE
Set the given user attribute of the message. If optional VALUE is
#f, the attribute is unset.
@end deffn
@deffn Function mu-message-get-port MESG MODE FULL
@deffn {Scheme Function} mu-message-get-port MESG MODE FULL
Returns a port associated with the given MESG. MODE is a string
defining operation mode of the stream. It may contain any of the
two characters: @samp{r} for reading, @samp{w} for writing.
......@@ -172,11 +172,11 @@ part of the message (including headers). If it is #f then the port
accesses only the message body (the default).
@end deffn
@deffn Function mu-message-get-body MESG
@deffn {Scheme Function} mu-message-get-body MESG
Returns the message body for the message MESG.
@end deffn
@deffn Function mu-message-send MESG MAILER
@deffn {Scheme Function} mu-message-send MESG MAILER
Sends the message MESG. Optional MAILER overrides default
mailer settings in mu-mailer.
@end deffn
......@@ -184,42 +184,42 @@ mailer settings in mu-mailer.
@node MIME Functions
@section MIME Functions
@deffn Function mu-mime-create FLAGS MESG
@deffn {Scheme Function} mu-mime-create FLAGS MESG
Creates a new MIME object.
@end deffn
@deffn Function mu-mime-multipart? MIME
@deffn {Scheme Function} mu-mime-multipart? MIME
Returns #t if MIME is a multipart object.
@end deffn
@deffn Function mu-mime-get-num-parts MIME
@deffn {Scheme Function} mu-mime-get-num-parts MIME
Returns number of parts in a MIME object.
@end deffn
@deffn Function mu-mime-get-part MIME PART
@deffn {Scheme Function} mu-mime-get-part MIME PART
Returns part number PART from a MIME object.
@end deffn
@deffn Function mu-mime-add-part MIME MESG
@deffn {Scheme Function} mu-mime-add-part MIME MESG
Adds MESG to the MIME object.
@end deffn
@deffn Function mu-mime-get-message MIME
@deffn {Scheme Function} mu-mime-get-message MIME
Converts MIME object to a message.
@end deffn
@node Log Functions
@section Log Functions
@deffn Function mu-openlog IDENT OPTION FACILITY
@deffn {Scheme Function} mu-openlog IDENT OPTION FACILITY
Opens a connection to the system logger for Guile program.
@end deffn
@deffn Function mu-logger PRIO TEXT
@deffn {Scheme Function} mu-logger PRIO TEXT
Generates a log message to be distributed via syslogd.
@end deffn
@deffn Function mu-closelog
@deffn {Scheme Function} mu-closelog
Closes the channel to the system logger open by mu-openlog.
@end deffn
......
......@@ -117,44 +117,44 @@ struct mu_auth_module @{
@node Initializing the libmuauth
@section Initializing the libmuauth
@deftypefn void mu_auth_init (void)
@deftypefun void mu_auth_init (void)
This function registers the command line capability ``auth''. It must be
called after registering @file{libmuauth} modules and before calling
@code{mu_agrp_parse()}. If an error occurs, this function prints
diagnostic message and aborts the program.
@end deftypefn
@end deftypefun
@deftypefn void MU_AUTH_REGISTER_ALL_MODULES (void)
@deftypefun void MU_AUTH_REGISTER_ALL_MODULES (void)
This macro registers all default modules and calls @code{mu_auth_init()}.
@end deftypefn
@end deftypefun
@node Module Creation and Destruction
@section Module Creation and Destruction
@deftypefn int mu_auth_data_alloc (struct mu_auth_data **ptr, const char *name, const char *passwd, uid_t uid, gid_t gid, const char *gecos, const char *dir, const char *shell, const char *mailbox, int change_uid)
@deftypefun int mu_auth_data_alloc (struct mu_auth_data **ptr, const char *name, const char *passwd, uid_t uid, gid_t gid, const char *gecos, const char *dir, const char *shell, const char *mailbox, int change_uid)
Create a @code{mu_auth_data} structure and initialize it with the given
values. Returns 0 on success and 1 otherwise.
@end deftypefn
@end deftypefun
@deftypefn void mu_auth_data_free (struct mu_auth_data *@var{ptr})
@deftypefun void mu_auth_data_free (struct mu_auth_data *@var{ptr})
Free the @code{mu_auth_data} structure allocated by a call to
@code{mu_auth_data_alloc()}.
@end deftypefn
@end deftypefun
@deftypefn void mu_auth_register_module (struct mu_auth_module *@var{mod})
@deftypefun void mu_auth_register_module (struct mu_auth_module *@var{mod})
Register the module defined by the @var{mod} argument.
@end deftypefn
@end deftypefun
@node Obtaining Authorization Information
@section Obtaining Authorization Information
@cindex libmuauth, obtaining authorization information
@deftypefn int mu_auth_runlist (list_t @var{flist}, void *@var{return_data}, void *@var{key}, void *@var{call_data});
@deftypefun int mu_auth_runlist (list_t @var{flist}, void *@var{return_data}, void *@var{key}, void *@var{call_data});
The list is expected to contain @code{mu_auth_fp} pointers. Each of them
is dereferenced and executed until either the list is exhausted or any
......@@ -167,34 +167,34 @@ parameter.
The function returns 0 if none of the functions from @code{list}
succeeded, i.e. returned non-zero value. Otherwise it returns the
return code from the succeeded function.
@end deftypefn
@end deftypefun
@deftypefn {struct mu_auth_data *} mu_get_auth_by_name (const char *@var{username})
@deftypefun {struct mu_auth_data *} mu_get_auth_by_name (const char *@var{username})
Search the information about given user by its username. Similar to
system's @code{getpwnam} call).
@end deftypefn
@end deftypefun
@deftypefn {struct mu_auth_data *} mu_get_auth_by_uid (uid_t @var{uid})
@deftypefun {struct mu_auth_data *} mu_get_auth_by_uid (uid_t @var{uid})
Search the information about given user by its uid. Similar to
system's @code{getpwuid} call).
@end deftypefn
@end deftypefun
@deftypefn int mu_authenticate (struct mu_auth_data *@var{auth_data}, char *@var{pass})
@deftypefun int mu_authenticate (struct mu_auth_data *@var{auth_data}, char *@var{pass})
Authenticate the user whose data are in @var{auth_data} using password
@var{pass}. Return 0 if the user is authenticated.
@end deftypefn
@end deftypefun
@node Existing Modules
@section Existing Modules
@cindex libmuauth modules
@deftypefn int mu_auth_nosupport (void *return_data, void *key, void *func_data, void *call_data);
@deftypefun int mu_auth_nosupport (void *return_data, void *key, void *func_data, void *call_data);
The ``not-supported'' module. Always returns @code{ENOSYS}.
@end deftypefn
@end deftypefun
@defvar mu_auth_system_module
......