summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org>2018-06-13 10:42:52 +0300
committerSergey Poznyakoff <gray@gnu.org>2018-06-13 10:42:52 +0300
commit830a53abae7c0754535124846635c89e7e8cff1f (patch)
tree88627ed75ff45a1ffd460462f85818c0eaa1320b
parentd894f5a48393adf94e685b4667a281f2795e3f2f (diff)
downloadmailutils-830a53abae7c0754535124846635c89e7e8cff1f.tar.gz
mailutils-830a53abae7c0754535124846635c89e7e8cff1f.tar.bz2
libmu_scm: fix docs
-rw-r--r--doc/texinfo/mu_address.texi31
-rw-r--r--doc/texinfo/mu_body.texi16
-rw-r--r--doc/texinfo/mu_logger.texi14
-rw-r--r--doc/texinfo/mu_mailbox.texi97
-rw-r--r--doc/texinfo/mu_message.texi183
-rw-r--r--doc/texinfo/mu_mime.texi47
-rw-r--r--doc/texinfo/mu_scm.texi38
-rw-r--r--libmu_scm/mu_address.c6
-rw-r--r--libmu_scm/mu_body.c13
-rw-r--r--libmu_scm/mu_mailbox.c5
-rw-r--r--libmu_scm/mu_message.c4
11 files changed, 271 insertions, 183 deletions
diff --git a/doc/texinfo/mu_address.texi b/doc/texinfo/mu_address.texi
index ebebb3cb3..e729a8146 100644
--- a/doc/texinfo/mu_address.texi
+++ b/doc/texinfo/mu_address.texi
@@ -1,43 +1,44 @@
-@c snarfed from "mu_address.c":79
-@deffn {Scheme procedure} mu-address-get-personal address num
+@c snarfed from mu_address.c:73
+@deffn {Scheme Procedure} mu-address-get-personal address [num]
Return personal part of the @var{num}th email address from @var{address}.
@end deffn
-@c snarfed from "mu_address.c":89
-@deffn {Scheme procedure} mu-address-get-comments address num
+@c snarfed from mu_address.c:85
+@deffn {Scheme Procedure} mu-address-get-comments address [num]
Return comment part of the @var{num}th email address from @var{address}.
+@emph{Note}: this function is a placeholder. The required functionality
+is not yet provided by the @command{libmailutils} library.
@end deffn
-@c snarfed from "mu_address.c":99
-@deffn {Scheme procedure} mu-address-get-email address num
+@c snarfed from mu_address.c:95
+@deffn {Scheme Procedure} mu-address-get-email address [num]
Return email part of the @var{num}th email address from @var{address}.
@end deffn
-@c snarfed from "mu_address.c":109
-@deffn {Scheme procedure} mu-address-get-domain address num
+@c snarfed from mu_address.c:105
+@deffn {Scheme Procedure} mu-address-get-domain address [num]
Return domain part of the @var{num}th email address from @var{address}.
@end deffn
-@c snarfed from "mu_address.c":119
-@deffn {Scheme procedure} mu-address-get-local address num
+@c snarfed from mu_address.c:115
+@deffn {Scheme Procedure} mu-address-get-local address [num]
Return local part of the @var{num}th email address from @var{address}.
@end deffn
-@c snarfed from "mu_address.c":129
-@deffn {Scheme procedure} mu-address-get-count address
+@c snarfed from mu_address.c:125
+@deffn {Scheme Procedure} mu-address-get-count address
Return number of parts in email address @var{address}.
@end deffn
-@c snarfed from "mu_address.c":153
-@deffn {Scheme procedure} mu-username->email name
+@c snarfed from mu_address.c:152
+@deffn {Scheme Procedure} mu-username->email [name]
Deduce user's email address from his username. If @var{name} is omitted,
current username is assumed
@end deffn
-
diff --git a/doc/texinfo/mu_body.texi b/doc/texinfo/mu_body.texi
index be23e0a6b..c6b6b910a 100644
--- a/doc/texinfo/mu_body.texi
+++ b/doc/texinfo/mu_body.texi
@@ -1,10 +1,16 @@
-@c snarfed from "mu_body.c":106
-@deffn {Scheme procedure} mu-body-read-line body
+@c snarfed from mu_body.c:90
+@deffn {Scheme Procedure} mu-body? scm
+Return @code{true} if @var{scm} is a Mailutils message body object.
+@end deffn
+
+@c snarfed from mu_body.c:99
+@deffn {Scheme Procedure} mu-body-read-line body
Read next line from the @var{body}.
@end deffn
-@c snarfed from "mu_body.c":167
-@deffn {Scheme procedure} mu-body-write body text
-Append @var{text} to message @var{body}.
+@c snarfed from mu_body.c:142
+@deffn {Scheme Procedure} mu-body-write body text
+Append @var{text} to message @var{body}. The use of this function is not
+recommended. Please, use message ports instead (@pxref{mu-message-get-port}).
@end deffn
diff --git a/doc/texinfo/mu_logger.texi b/doc/texinfo/mu_logger.texi
index f30c8e1ca..f9b67f1df 100644
--- a/doc/texinfo/mu_logger.texi
+++ b/doc/texinfo/mu_logger.texi
@@ -1,16 +1,16 @@
-@c snarfed from "mu_logger.c":26
-@deffn {Scheme procedure} mu-openlog ident option facility
+@c snarfed from mu_logger.c:28
+@deffn {Scheme Procedure} mu-openlog ident option facility
Opens a connection to the system logger for Guile program.
@var{ident}, @var{option} and @var{facility} have the same meaning as in openlog(3)
@end deffn
-@c snarfed from "mu_logger.c":61
-@deffn {Scheme procedure} mu-logger prio text
-Distributes @var{text} via syslogd priority @var{prio}.
+@c snarfed from mu_logger.c:45
+@deffn {Scheme Procedure} mu-logger prio text
+Distributes @var{text} via the syslog priority @var{prio}.
@end deffn
-@c snarfed from "mu_logger.c":83
-@deffn {Scheme procedure} mu-closelog
+@c snarfed from mu_logger.c:64
+@deffn {Scheme Procedure} mu-closelog
Closes the channel to the system logger opened by @code{mu-openlog}.
@end deffn
diff --git a/doc/texinfo/mu_mailbox.texi b/doc/texinfo/mu_mailbox.texi
index 53896da05..3c72d9220 100644
--- a/doc/texinfo/mu_mailbox.texi
+++ b/doc/texinfo/mu_mailbox.texi
@@ -1,19 +1,29 @@
-@c snarfed from "mu_mailbox.c":110
-@deffn {Scheme procedure} mu-mail-directory url
-If @var{url} is given, sets it as a name of the user's mail directory.
-Returns the current value of the mail directory.
+ mu-mailbox?
+@c snarfed from mu_mailbox.c:129
+@deffn {Scheme Procedure} mu-mailbox? scm
+Return @code{true} if @var{scm} is a Mailutils mailbox.
+
+@end deffn
+
+ mu-user-mailbox-url
+@c snarfed from mu_mailbox.c:138
+@deffn {Scheme Procedure} mu-user-mailbox-url user
+Return URL of the default mailbox for user @var{user}.
@end deffn
-@c snarfed from "mu_mailbox.c":125
-@deffn {Scheme procedure} mu-folder-directory url
+ mu-folder-directory
+@c snarfed from mu_mailbox.c:162
+@deffn {Scheme Procedure} mu-folder-directory [url]
If @var{url} is given, sets it as a name of the user's folder directory.
Returns the current value of the folder directory.
@end deffn
-@c snarfed from "mu_mailbox.c":149
-@deffn {Scheme procedure} mu-mailbox-open url mode
-Opens the mailbox specified by @var{url}. @var{mode} is a string, consisting of
-the characters described below, giving the access mode for the mailbox
+ mu-mailbox-open
+@c snarfed from mu_mailbox.c:191
+@deffn {Scheme Procedure} mu-mailbox-open url mode
+Opens the mailbox specified by @var{url}. The @var{mode} argument defines
+access mode for the mailbox. It is a string, consisting of one or more of the
+following characters:
@multitable @columnfractions 0.20 0.70
@headitem @var{mode} @tab Meaning
@@ -25,42 +35,65 @@ the characters described below, giving the access mode for the mailbox
@end deffn
-@c snarfed from "mu_mailbox.c":201
-@deffn {Scheme procedure} mu-mailbox-close mbox
+@c snarfed from mu_mailbox.c:265
+@deffn {Scheme Procedure} mu-mailbox-close mbox
Closes mailbox @var{mbox}.
@end deffn
-@c snarfed from "mu_mailbox.c":216
-@deffn {Scheme procedure} mu-mailbox-get-url mbox
-Returns url of the mailbox @var{mbox}.
+@c snarfed from mu_mailbox.c:280
+@deffn {Scheme Procedure} mu-mailbox-get-url mbox
+Returns URL of the mailbox @var{MBOX}.
@end deffn
-@c snarfed from "mu_mailbox.c":240
-@deffn {Scheme procedure} mu-mailbox-get-port mbox mode
-Returns a port associated with the contents of the @var{mbox}.
-@var{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
-
-@c snarfed from "mu_mailbox.c":262
-@deffn {Scheme procedure} mu-mailbox-get-message mbox msgno
+@c snarfed from mu_mailbox.c:301
+@deffn {Scheme Procedure} mu-mailbox-get-message mbox msgno
Retrieve from message #@var{msgno} from the mailbox @var{mbox}.
@end deffn
-@c snarfed from "mu_mailbox.c":288
-@deffn {Scheme procedure} mu-mailbox-messages-count mbox
+@c snarfed from mu_mailbox.c:327
+@deffn {Scheme Procedure} mu-mailbox-messages-count mbox
Returns number of messages in the mailbox @var{mbox}.
@end deffn
-@c snarfed from "mu_mailbox.c":309
-@deffn {Scheme procedure} mu-mailbox-expunge mbox
+@c snarfed from mu_mailbox.c:348
+@deffn {Scheme Procedure} mu-mailbox-expunge mbox
Expunges deleted messages from the mailbox @var{mbox}.
@end deffn
-@c snarfed from "mu_mailbox.c":328
-@deffn {Scheme procedure} mu-mailbox-append-message mbox mesg
+@c snarfed from mu_mailbox.c:367
+@deffn {Scheme Procedure} mu-mailbox-sync mbox
+Synchronize changes to @var{mbox} with its storage.
+@end deffn
+
+@c snarfed from mu_mailbox.c:388
+@deffn {Scheme Procedure} mu-mailbox-flush mbox [expunge]
+Mark all messages in @var{mbox} as seen and synchronize all changes with its storage. If @var{expunge} is @samp{#t}, expunge deleted messages as well.
+@end deffn
+
+@c snarfed from mu_mailbox.c:412
+@deffn {Scheme Procedure} mu-mailbox-append-message mbox mesg
Appends message @var{mesg} to the mailbox @var{mbox}.
@end deffn
+@c snarfed from mu_mailbox.c:449
+@deffn {Scheme Procedure} mu-mailbox-first-message mbox
+Returns first message from the mailbox @var{mbox}.
+@end deffn
+
+@c snarfed from mu_mailbox.c:476
+@deffn {Scheme Procedure} mu-mailbox-next-message mbox
+Returns next message from the mailbox @var{mbox}.
+@end deffn
+
+@c snarfed from mu_mailbox.c:510
+@deffn {Scheme Procedure} mu-mailbox-more-messages? mbox
+Returns @samp{#t} if there are more messages in the mailbox @var{mbox}
+ahead of current iterator position. Usually this function is used after
+a call to @samp{mu-mailbox-first-message} or @samp{mu-mailbox-next-message}.
+If not, it initializes the iterator and points it to the first message inthe mailbox.
+@end deffn
+
+@c snarfed from mu_mailbox.c:541
+@deffn {Scheme Procedure} mu-mailbox-get-size mbox
+Return size of the mailbox @var{mbox}.
+@end deffn
diff --git a/doc/texinfo/mu_message.texi b/doc/texinfo/mu_message.texi
index ce71997f7..c6433250b 100644
--- a/doc/texinfo/mu_message.texi
+++ b/doc/texinfo/mu_message.texi
@@ -1,141 +1,152 @@
-@c snarfed from "mu_message.c":184
-@deffn {Scheme procedure} mu-message-create
-Creates an empty message.
-
+@c snarfed from mu_message.c:180
+@deffn {Scheme Procedure} mu-message? scm
+Return @code{true} if @var{scm} is a Mailutils message.
@end deffn
-@c snarfed from "mu_message.c":196
-@deffn {Scheme procedure} mu-message-copy mesg
-Creates the copy of the message @var{mesg}.
+@c snarfed from mu_message.c:189
+@deffn {Scheme Procedure} mu-message-create
+Creates an empty message.
+@end deffn
+@c snarfed from mu_message.c:201
+@deffn {Scheme Procedure} mu-message-copy mesg
+Creates a copy of the message @var{mesg}.
@end deffn
-@c snarfed from "mu_message.c":257
-@deffn {Scheme procedure} mu-message-destroy mesg
+@c snarfed from mu_message.c:246
+@deffn {Scheme Procedure} mu-message-destroy mesg
Destroys the message @var{mesg}.
@end deffn
-@c snarfed from "mu_message.c":274
-@deffn {Scheme procedure} mu-message-set-header mesg header value replace
-Sets new @var{value} to the header @var{header} of the message @var{mesg}.
-If @var{header} is already present in the message its value
-is replaced with the supplied one if the optional @var{replace} is
-#t. Otherwise, a new header is created and appended.
+@c snarfed from mu_message.c:263
+@deffn {Scheme Procedure} mu-message-set-header mesg header value [replace]
+Sets header @var{header} of the message @var{mesg} to new @var{value}.
+If @var{header} is already present in the message, its value
+is replaced with the suplied one iff the optional @var{replace} is
+@code{#t}. Otherwise, a new header is created and appended.
@end deffn
-@c snarfed from "mu_message.c":314
-@deffn {Scheme procedure} mu-message-get-size mesg
-Returns the size of the message @var{mesg}
-.
+@c snarfed from mu_message.c:310
+@deffn {Scheme Procedure} mu-message-get-size mesg
+Returns size of the message @var{mesg}.
@end deffn
-@c snarfed from "mu_message.c":328
-@deffn {Scheme procedure} mu-message-get-lines mesg
-Returns number of lines in the given message.
+@c snarfed from mu_message.c:325
+@deffn {Scheme Procedure} mu-message-get-lines mesg
+Returns number of lines in the message @var{msg}.
+@end deffn
+@c snarfed from mu_message.c:368
+@deffn {Scheme Procedure} mu-message-get-envelope mesg
+Returns envelope of the message @var{mesg}.
+The value returned is the envelope line without the "From " prefix.
@end deffn
-@c snarfed from "mu_message.c":349
-@deffn {Scheme procedure} mu-message-get-sender mesg
-Returns email address of the sender of the message @var{mesg}.
+@c snarfed from mu_message.c:403
+@deffn {Scheme Procedure} mu-message-get-envelope-date mesg
+Returns envelope date of the message @var{mesg}.
+@end deffn
+@c snarfed from mu_message.c:433
+@deffn {Scheme Procedure} mu-message-get-sender mesg
+Returns email address of the sender of the message @var{mesg}.
@end deffn
-@c snarfed from "mu_message.c":376
-@deffn {Scheme procedure} mu-message-get-header mesg header
+@c snarfed from mu_message.c:463
+@deffn {Scheme Procedure} mu-message-get-header mesg header
Returns value of the header @var{header} from the message @var{mesg}.
-
@end deffn
-@c snarfed from "mu_message.c":433
-@deffn {Scheme procedure} mu-message-get-header-fields mesg headers
-Returns the list of headers in the message @var{mesg}. Optional argument
+@c snarfed from mu_message.c:527
+@deffn {Scheme Procedure} mu-message-get-header-fields mesg [headers]
+Returns list of headers in the message @var{mesg}. optional argument
@var{headers} gives a list of header names to restrict return value to.
-
@end deffn
-@c snarfed from "mu_message.c":510
-@deffn {Scheme procedure} mu-message-set-header-fields mesg list replace
-Set the headers in the message @var{mesg} from @var{list}
-@var{list} is a list of conses (cons HEADER VALUE). The function sets
-these headers in the message @var{mesg}.
-Optional parameter @var{replace} specifies whether the new header
+@c snarfed from mu_message.c:594
+@deffn {Scheme Procedure} mu-message-set-header-fields mesg list [replace]
+Set headers in the message @var{mesg} to those listed in @var{list},
+which is a list of conses @code{(cons @var{header} @var{value})}.
+
+Optional parameter @var{replace} specifies whether new header
values should replace the headers already present in the
message.
@end deffn
-@c snarfed from "mu_message.c":564
-@deffn {Scheme procedure} mu-message-delete mesg flag
-Mark the message @var{mesg} as deleted. Optional argument @var{flag} allows to toggle
-deletion mark. The message is deleted if it is @code{#t} and undeleted if
-it is @code{#f}
+@c snarfed from mu_message.c:650
+@deffn {Scheme Procedure} mu-message-delete mesg [flag]
+Mark message @var{mesg} as deleted. Optional argument @var{flag} allows to
+toggle the deletion mark. The message is deleted if it is @code{#t} and
+undeleted if it is @code{#f}.
@end deffn
-@c snarfed from "mu_message.c":600
-@deffn {Scheme procedure} mu-message-get-flag mesg flag
-Return value of the attribute @var{flag} of the message @var{mesg}.
+@c snarfed from mu_message.c:685
+@deffn {Scheme Procedure} mu-message-get-flag mesg flag
+Return the value of the attribute @var{flag} of the message @var{mesg}.
@end deffn
-@c snarfed from "mu_message.c":662
-@deffn {Scheme procedure} mu-message-set-flag mesg flag value
-Set the attribute @var{flag} of the message @var{mesg}. If optional @var{value} is #f, the
-attribute is unset.
+@c snarfed from mu_message.c:747
+@deffn {Scheme Procedure} mu-message-set-flag mesg flag [value]
+Set the attribute @var{flag} in message @var{mesg}. If optional @var{value}
+is @samp{#f}, the attribute is unset.
@end deffn
-@c snarfed from "mu_message.c":760
-@deffn {Scheme procedure} mu-message-get-user-flag mesg flag
-Return the value of the user attribute @var{flag} from the message @var{mesg}.
+@c snarfed from mu_message.c:844
+@deffn {Scheme Procedure} mu-message-get-user-flag mesg flag
+Return value of the user-defined attribute @var{flag} from the message @var{mesg}.
@end deffn
-@c snarfed from "mu_message.c":783
-@deffn {Scheme procedure} mu-message-set-user-flag mesg flag value
-Set the given user attribute @var{flag} in the message @var{mesg}. If optional argument
-@var{value} is @samp{#f}, the attribute is unset.
+@c snarfed from mu_message.c:867
+@deffn {Scheme Procedure} mu-message-set-user-flag mesg flag [value]
+Set user-defined attribute @var{flag} in the message @var{mesg}.
+If optional argumen @var{value} is @samp{#f}, the attribute is unset.
@end deffn
-@c snarfed from "mu_message.c":823
-@deffn {Scheme procedure} mu-message-get-port mesg mode full
-Returns a port associated with the given @var{mesg}. @var{mode} is a string
-defining operation mode of the stream. It may contain any of the
+@c snarfed from mu_message.c:905
+@deffn {Scheme Procedure} mu-message-get-port mesg mode [full]
+Returns a port associated with the message @var{mesg}. The @var{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.
-If optional argument @var{full} is specified, it should be a boolean value.
-If it is @samp{#t} then the returned port will allow access to any
-part of the message (including headers). If it is @code{#f} then the port
-accesses only the message body (the default).
+If optional boolean argument @var{full} is @samp{#t} then the returned port
+will allow access to any part of the message (including headers). Otherwise
+the port accesses only the message body (the default).
@end deffn
-@c snarfed from "mu_message.c":870
-@deffn {Scheme procedure} mu-message-get-body mesg
-Returns the message body for the message @var{mesg}.
+@c snarfed from mu_message.c:955
+@deffn {Scheme Procedure} mu-message-get-body mesg
+Returns message body for the message @var{mesg}.
@end deffn
-@c snarfed from "mu_message.c":888
-@deffn {Scheme procedure} mu-message-multipart? mesg
+@c snarfed from mu_message.c:973
+@deffn {Scheme Procedure} mu-message-multipart? mesg
Returns @code{#t} if @var{mesg} is a multipart @acronym{MIME} message.
@end deffn
-@c snarfed from "mu_message.c":904
-@deffn {Scheme procedure} mu-message-get-num-parts mesg
-Returns number of parts in a multipart @acronym{MIME} message. Returns
-@code{#f} if the argument is not a multipart message.
+@c snarfed from mu_message.c:989
+@deffn {Scheme Procedure} mu-message-get-num-parts mesg
+Returns number of parts in a multipart @acronym{MIME} message @var{mesg}.
+Returns @code{#f} if the argument is not a multipart message.
@end deffn
-@c snarfed from "mu_message.c":929
-@deffn {Scheme procedure} mu-message-get-part mesg part
-Returns part #@var{part} from a multipart @acronym{MIME} message @var{mesg}.
+@c snarfed from mu_message.c:1014
+@deffn {Scheme Procedure} mu-message-get-part mesg part
+Returns part #@var{part} of a multipart @acronym{MIME} message @var{mesg}.
@end deffn
-@c snarfed from "mu_message.c":957
-@deffn {Scheme procedure} mu-message-send mesg mailer from to
-Sends the message @var{mesg}. Optional @var{mailer} overrides default mailer settings
-in mu-mailer. Optional @var{from} and @var{to} give sender and receiver addresses.
-
+@c snarfed from mu_message.c:1043
+@deffn {Scheme Procedure} mu-message-send mesg [mailer [from [to]]]
+Sends message @var{mesg}. Optional @var{mailer} overrides default mailer
+settings. Optional @var{from} and @var{to} give sender and receiver
+addresses, respectively.
@end deffn
-@c snarfed from "mu_message.c":1025
-@deffn {Scheme procedure} mu-message-get-uid mesg
-Returns uid of the message @var{mesg}
-
+@c snarfed from mu_message.c:1125
+@deffn {Scheme Procedure} mu-message-get-uid mesg
+Returns UID of the message @var{mesg}
@end deffn
+@c snarfed from mu_message.c:1143
+@deffn {Scheme Procedure} mu-message-from-port port
+Reads one message from @var{port} and returns it.
+@end deffn
diff --git a/doc/texinfo/mu_mime.texi b/doc/texinfo/mu_mime.texi
index e424ae50a..dc2bedc50 100644
--- a/doc/texinfo/mu_mime.texi
+++ b/doc/texinfo/mu_mime.texi
@@ -1,34 +1,37 @@
-@c snarfed from "mu_mime.c":95
-@deffn {Scheme procedure} mu-mime-create flags mesg
-Creates a new @acronym{MIME} object. Both arguments are optional.
-@var{flags} specifies the type of the object to create (@samp{0} is a reasonable
-value). @var{mesg} gives the message to create the @acronym{MIME} object from.
+@c snarfed from mu_mime.c:84
+@deffn {Scheme Procedure} mu-mime? scm
+Return @code{true} if @var{scm} is a Mailutils MIME object.
@end deffn
-@c snarfed from "mu_mime.c":131
-@deffn {Scheme procedure} mu-mime-multipart? mime
-Returns @code{#t} if @var{mime} is a multipart object.
-
+@c snarfed from mu_mime.c:96
+@deffn {Scheme Procedure} mu-mime-create [flags [mesg]]
+Creates a new @acronym{MIME} object. Both arguments are optional.
+@var{Flags} specifies the type of the object to create (@samp{0} is a
+reasonable value). @var{mesg} gives the message to create the
+@acronym{MIME} object from.
@end deffn
-@c snarfed from "mu_mime.c":141
-@deffn {Scheme procedure} mu-mime-get-num-parts mime
-Returns number of parts in the @sc{mime} object @var{mime}.
+@c snarfed from mu_mime.c:132
+@deffn {Scheme Procedure} mu-mime-multipart? mime
+Returns @code{#t} if @var{mime} is a multipart object.
@end deffn
-@c snarfed from "mu_mime.c":160
-@deffn {Scheme procedure} mu-mime-get-part mime num
-Returns @var{num}th part from the @sc{mime} object @var{mime}.
+@c snarfed from mu_mime.c:142
+@deffn {Scheme Procedure} mu-mime-get-num-parts mime
+Returns number of parts in the @acronym{MIME} object @var{mime}.
@end deffn
-@c snarfed from "mu_mime.c":182
-@deffn {Scheme procedure} mu-mime-add-part mime mesg
-Adds @var{mesg} to the @sc{mime} object @var{mime}.
+@c snarfed from mu_mime.c:161
+@deffn {Scheme Procedure} mu-mime-get-part mime num
+Returns @var{num}th part from the @acronym{MIME} object @var{mime}.
@end deffn
-@c snarfed from "mu_mime.c":208
-@deffn {Scheme procedure} mu-mime-get-message mime
-Converts @sc{mime} object @var{mime} to a message.
-
+@c snarfed from mu_mime.c:183
+@deffn {Scheme Procedure} mu-mime-add-part mime mesg
+Adds message @var{mesg} to the @acronym{MIME} object @var{mime}.
@end deffn
+@c snarfed from mu_mime.c:209
+@deffn {Scheme Procedure} mu-mime-get-message mime
+Converts @acronym{MIME} object @var{mime} to a message.
+@end deffn
diff --git a/doc/texinfo/mu_scm.texi b/doc/texinfo/mu_scm.texi
index 61873bb0a..3fb0fbe0c 100644
--- a/doc/texinfo/mu_scm.texi
+++ b/doc/texinfo/mu_scm.texi
@@ -1,6 +1,6 @@
-@c snarfed from "mu_scm.c":130
-@deffn {Scheme procedure} mu-register-format rest
-Registers desired mailutils formats. Any number of arguments can be given.
+@c snarfed from mu_scm.c:109
+@deffn {Scheme Procedure} mu-register-format . rest
+Registers desired mailutils formats. Any number of arguments can be given.
Each argument must be one of the following strings:
@multitable @columnfractions 0.3 0.6
@@ -15,13 +15,39 @@ Each argument must be one of the following strings:
@end multitable
If called without arguments, the function registers all available formats
-
@end deffn
-@c snarfed from "mu_scm.c":163
-@deffn {Scheme procedure} mu-strerror err
+@c snarfed from mu_scm.c:146
+@deffn {Scheme Procedure} mu-strerror err
Return the error message corresponding to @var{err}, which must be
an integer value.
+@end deffn
+
+@c snarfed from mu_util.c:28
+@deffn {Scheme Procedure} mu-getpwuid user
+Look up an entry in the user database. @var{User} can be an integer,
+or a string, giving the behaviour of @code{mu_get_auth_by_uid} or
+@code{mu_get_auth_by_name} respectively.
+
+Returns a vector with fields corresponding to those of the @code{mu_auth_data}
+entry in question. If no matching entry was found, returns @code{#f}.
+@end deffn
+
+@c snarfed from mu_debug.c:24
+@deffn {Scheme Procedure} mu-debug-parse spec
+Parses @var{spec} and sets MU debugging level according to it.
+@end deffn
+
+@c snarfed from mu_debug.c:46
+@deffn {Scheme Procedure} mu-debug-set catlist
+Sets MU debug level according to @var{catlist}, which is a list of
+conses: (cons category level)
+@end deffn
+@c snarfed from mu_debug.c:78
+@deffn {Scheme Procedure} mu-debug-get [catlist [skipunset]]
+Returns a list of MU debugging categories with corresponding levels.
+If @var{catlist} is supplied, it is a list of category names. In this case
+only categories from this list are returned
@end deffn
diff --git a/libmu_scm/mu_address.c b/libmu_scm/mu_address.c
index 33ae59a69..fe2ec2ed1 100644
--- a/libmu_scm/mu_address.c
+++ b/libmu_scm/mu_address.c
@@ -80,7 +80,9 @@ SCM_DEFINE_PUBLIC (scm_mu_address_get_personal, "mu-address-get-personal", 1, 1,
SCM_DEFINE_PUBLIC (scm_mu_address_get_comments, "mu-address-get-comments", 1, 1, 0,
(SCM address, SCM num),
- "Return comment part of the @var{num}th email address from @var{address}.\n")
+"Return comment part of the @var{num}th email address from @var{address}.\n"
+"@emph{Note}: this function is a placeholder. The required functionality\n"
+"is not yet provided by the @command{libmailutils} library.\n")
#define FUNC_NAME s_scm_mu_address_get_comments
{
return _get_address_part (FUNC_NAME,
@@ -90,7 +92,7 @@ SCM_DEFINE_PUBLIC (scm_mu_address_get_comments, "mu-address-get-comments", 1, 1,
SCM_DEFINE_PUBLIC (scm_mu_address_get_email, "mu-address-get-email", 1, 1, 0,
(SCM address, SCM num),
- "Return email part of the @var{num}th email address from @var{address}.\n")
+"Return email part of the @var{num}th email address from @var{address}.\n")
#define FUNC_NAME s_scm_mu_address_get_email
{
return _get_address_part (FUNC_NAME,
diff --git a/libmu_scm/mu_body.c b/libmu_scm/mu_body.c
index bed912851..692d90a9a 100644
--- a/libmu_scm/mu_body.c
+++ b/libmu_scm/mu_body.c
@@ -138,7 +138,8 @@ SCM_DEFINE_PUBLIC (scm_mu_body_read_line, "mu-body-read-line", 1, 0, 0,
SCM_DEFINE_PUBLIC (scm_mu_body_write, "mu-body-write", 2, 0, 0,
(SCM body, SCM text),
- "Append @var{text} to message @var{body}.")
+"Append @var{text} to message @var{body}. The use of this function is not\n"
+"recommended. Please, use message ports instead (@pxref{mu-message-get-port}).\n")
#define FUNC_NAME s_scm_mu_body_write
{
char *ptr;
@@ -155,16 +156,20 @@ SCM_DEFINE_PUBLIC (scm_mu_body_write, "mu-body-write", 2, 0, 0,
status = mu_body_get_streamref (mbp->body, &mbp->stream);
if (status)
mu_scm_error (FUNC_NAME, status,
- "Cannot get body stream", SCM_BOOL_F);
+ "mu_body_get_streamref", SCM_BOOL_F);
+ status = mu_stream_seek (mbp->stream, 0, SEEK_END, NULL);
+ if (status)
+ mu_scm_error (FUNC_NAME, status,
+ "mu_stream_seek", SCM_BOOL_F);
}
-
+
ptr = scm_to_locale_string (text);
len = strlen (ptr);
status = mu_stream_write (mbp->stream, ptr, len, NULL);
free (ptr);
if (status)
mu_scm_error (FUNC_NAME, status,
- "Error writing to stream", SCM_BOOL_F);
+ "mu_stream_write", SCM_BOOL_F);
return SCM_BOOL_T;
}
#undef FUNC_NAME
diff --git a/libmu_scm/mu_mailbox.c b/libmu_scm/mu_mailbox.c
index 52bf08713..1386dd956 100644
--- a/libmu_scm/mu_mailbox.c
+++ b/libmu_scm/mu_mailbox.c
@@ -177,8 +177,9 @@ SCM_DEFINE_PUBLIC (scm_mu_folder_directory, "mu-folder-directory", 0, 1, 0,
SCM_DEFINE_PUBLIC (scm_mu_mailbox_open, "mu-mailbox-open", 2, 0, 0,
(SCM url, SCM mode),
-"Opens the mailbox specified by @var{url}. @var{mode} is a string, consisting of\n"
-"the characters described below, giving the access mode for the mailbox\n"
+"Opens the mailbox specified by @var{url}. The @var{mode} argument defines\n"
+"access mode for the mailbox. It is a string, consisting of one or more of the\n"
+"following characters:\n"
"\n"
"@multitable @columnfractions 0.20 0.70\n"
"@headitem @var{mode} @tab Meaning\n"
diff --git a/libmu_scm/mu_message.c b/libmu_scm/mu_message.c
index 10d2e8416..8eda9d3f2 100644
--- a/libmu_scm/mu_message.c
+++ b/libmu_scm/mu_message.c
@@ -307,7 +307,7 @@ SCM_DEFINE_PUBLIC (scm_mu_message_set_header, "mu-message-set-header", 3, 1, 0,
SCM_DEFINE_PUBLIC (scm_mu_message_get_size, "mu-message-get-size", 1, 0, 0,
(SCM mesg),
- "Returns size of the message @var{mesg}\n.")
+ "Returns size of the message @var{mesg}.\n")
#define FUNC_NAME s_scm_mu_message_get_size
{
mu_message_t msg;
@@ -1039,7 +1039,7 @@ SCM_DEFINE_PUBLIC (scm_mu_message_get_part, "mu-message-get-part", 2, 0, 0,
SCM_DEFINE_PUBLIC (scm_mu_message_send, "mu-message-send", 1, 3, 0,
(SCM mesg, SCM mailer, SCM from, SCM to),
"Sends message @var{mesg}. Optional @var{mailer} overrides default mailer\n"
-"settings. Optional @var{from} and @var{to} give sender and recever\n"
+"settings. Optional @var{from} and @var{to} give sender and receiver\n"
"addresses, respectively.\n")
#define FUNC_NAME s_scm_mu_message_send
{

Return to:

Send suggestions and report system problems to the System administrator.