Skip to content

John McEleney / mailutils

Go to a project
Toggle navigation
Toggle navigation pinning
Commit d3d9b4fd d3d9b4fd9644927658c0f61fe6b6c4b01afd8659 by Sergey Poznyakoff
Options

Fixed use of @deffn

1 parent fbb790c3
Expand all
Inline Side-by-side
Showing 3 changed files with 60 additions and 60 deletions
...@@ -30,108 +30,108 @@ Using libmu_scm ...@@ -30,108 +30,108 @@ Using libmu_scm
30 @node Address Functions 30 @node Address Functions
31 @section Address Functions 31 @section Address Functions
32 32
33 @deffn Function mu-address-get-personal ADDRESS NUM 33 @deffn {Scheme Function} mu-address-get-personal ADDRESS NUM
34 Return personal part of an email address. 34 Return personal part of an email address.
35 @end deffn 35 @end deffn
36 36
37 @deffn Function mu-address-get-comments ADDRESS NUM 37 @deffn {Scheme Function} mu-address-get-comments ADDRESS NUM
38 @end deffn 38 @end deffn
39 39
40 @deffn Function mu-address-get-email ADDRESS NUM 40 @deffn {Scheme Function} mu-address-get-email ADDRESS NUM
41 Return email part of an email address. 41 Return email part of an email address.
42 @end deffn 42 @end deffn
43 43
44 @deffn Function mu-address-get-domain ADDRESS NUM 44 @deffn {Scheme Function} mu-address-get-domain ADDRESS NUM
45 Return domain part of an email address 45 Return domain part of an email address
46 @end deffn 46 @end deffn
47 47
48 @deffn Function mu-address-get-local ADDRESS NUM 48 @deffn {Scheme Function} mu-address-get-local ADDRESS NUM
49 Return local part of an email address. 49 Return local part of an email address.
50 @end deffn 50 @end deffn
51 51
52 @deffn Function mu-address-get-count ADDRESS 52 @deffn {Scheme Function} mu-address-get-count ADDRESS
53 Return number of parts in email address. 53 Return number of parts in email address.
54 @end deffn 54 @end deffn
55 55
56 @node Mailbox Functions 56 @node Mailbox Functions
57 @section Mailbox Functions 57 @section Mailbox Functions
58 58
59 @deffn Function mu-mailbox-open URL MODE 59 @deffn {Scheme Function} mu-mailbox-open URL MODE
60 Opens a mailbox specified by URL. 60 Opens a mailbox specified by URL.
61 @end deffn 61 @end deffn
62 62
63 @deffn Function mu-mailbox-close MBOX 63 @deffn {Scheme Function} mu-mailbox-close MBOX
64 Closes mailbox MBOX 64 Closes mailbox MBOX
65 @end deffn 65 @end deffn
66 66
67 @deffn Function mu-mailbox-get-url MBOX 67 @deffn {Scheme Function} mu-mailbox-get-url MBOX
68 Returns the URL of the mailbox. 68 Returns the URL of the mailbox.
69 @end deffn 69 @end deffn
70 70
71 @deffn Function mu-mailbox-get-port MBOX MODE 71 @deffn {Scheme Function} mu-mailbox-get-port MBOX MODE
72 Returns a port associated with the contents of the MBOX. 72 Returns a port associated with the contents of the MBOX.
73 MODE is a string defining operation mode of the stream. It may 73 MODE is a string defining operation mode of the stream. It may
74 contain any of the two characters: @samp{r} for reading, @samp{w} for 74 contain any of the two characters: @samp{r} for reading, @samp{w} for
75 writing. 75 writing.
76 @end deffn 76 @end deffn
77 77
78 @deffn Function mu-mailbox-get-message MBOX MSGNO 78 @deffn {Scheme Function} mu-mailbox-get-message MBOX MSGNO
79 Retrieve from MBOX message # MSGNO. 79 Retrieve from MBOX message # MSGNO.
80 @end deffn 80 @end deffn
81 81
82 @deffn Function mu-mailbox-messages-count MBOX 82 @deffn {Scheme Function} mu-mailbox-messages-count MBOX
83 Returns number of messages in the mailbox. 83 Returns number of messages in the mailbox.
84 @end deffn 84 @end deffn
85 85
86 @deffn Function mu-mailbox-expunge MBOX 86 @deffn {Scheme Function} mu-mailbox-expunge MBOX
87 Expunges deleted messages from the mailbox. 87 Expunges deleted messages from the mailbox.
88 @end deffn 88 @end deffn
89 89
90 @deffn Function mu-mailbox-url MBOX 90 @deffn {Scheme Function} mu-mailbox-url MBOX
91 Returns the URL of the mailbox 91 Returns the URL of the mailbox
92 @end deffn 92 @end deffn
93 93
94 @deffn Function mu-mailbox-append-message MBOX MESG 94 @deffn {Scheme Function} mu-mailbox-append-message MBOX MESG
95 Appends the message to the mailbox 95 Appends the message to the mailbox
96 @end deffn 96 @end deffn
97 97
98 @node Message Functions 98 @node Message Functions
99 @section Message Functions 99 @section Message Functions
100 100
101 @deffn Function mu-message-copy MESG 101 @deffn {Scheme Function} mu-message-copy MESG
102 Creates the copy of the given message. 102 Creates the copy of the given message.
103 @end deffn 103 @end deffn
104 104
105 @deffn Function mu-message-set-header MESG HEADER VALUE REPLACE 105 @deffn {Scheme Function} mu-message-set-header MESG HEADER VALUE REPLACE
106 Sets new VALUE to the header HEADER of the message MESG. 106 Sets new VALUE to the header HEADER of the message MESG.
107 If the HEADER is already present in the message its value 107 If the HEADER is already present in the message its value
108 is replaced with the supplied one if the optional REPLACE is 108 is replaced with the supplied one if the optional REPLACE is
109 #t. Otherwise new header is created and appended. 109 #t. Otherwise new header is created and appended.
110 @end deffn 110 @end deffn
111 111
112 @deffn Function mu-message-get-size MESG 112 @deffn {Scheme Function} mu-message-get-size MESG
113 Returns the size of the given message. 113 Returns the size of the given message.
114 @end deffn 114 @end deffn
115 115
116 @deffn Function mu-message-get-lines MESG 116 @deffn {Scheme Function} mu-message-get-lines MESG
117 Returns number of lines in the given message. 117 Returns number of lines in the given message.
118 @end deffn 118 @end deffn
119 119
120 @deffn Function mu-message-get-sender MESG 120 @deffn {Scheme Function} mu-message-get-sender MESG
121 Returns the sender email address for the message MESG. 121 Returns the sender email address for the message MESG.
122 @end deffn 122 @end deffn
123 123
124 @deffn Function mu-message-get-header MESG HEADER 124 @deffn {Scheme Function} mu-message-get-header MESG HEADER
125 Returns the header value of the HEADER in the MESG. 125 Returns the header value of the HEADER in the MESG.
126 @end deffn 126 @end deffn
127 127
128 @deffn Function mu-message-get-header-fields MESG HEADERS 128 @deffn {Scheme Function} mu-message-get-header-fields MESG HEADERS
129 Returns the list of headers in the MESG. If optional HEADERS is 129 Returns the list of headers in the MESG. If optional HEADERS is
130 specified it should be a list of header names to restrict return 130 specified it should be a list of header names to restrict return
131 value to. 131 value to.
132 @end deffn 132 @end deffn
133 133
134 @deffn Function mu-message-set-header-fields MESG LIST REPLACE 134 @deffn {Scheme Function} mu-message-set-header-fields MESG LIST REPLACE
135 Set the headers in the message MESG from LIST 135 Set the headers in the message MESG from LIST
136 LIST is a list of (cons HEADER VALUE) 136 LIST is a list of (cons HEADER VALUE)
137 Optional parameter REPLACE specifies whether the new header 137 Optional parameter REPLACE specifies whether the new header
...@@ -139,30 +139,30 @@ values should replace the headers already present in the ...@@ -139,30 +139,30 @@ values should replace the headers already present in the
139 message. 139 message.
140 @end deffn 140 @end deffn
141 141
142 @deffn Function mu-message-delete MESG FLAG 142 @deffn {Scheme Function} mu-message-delete MESG FLAG
143 Mark given message as deleted. Optional FLAG allows to toggle deleted mark 143 Mark given message as deleted. Optional FLAG allows to toggle deleted mark
144 The message is deleted if it is #t and undeleted if it is #f 144 The message is deleted if it is #t and undeleted if it is #f
145 @end deffn 145 @end deffn
146 146
147 @deffn Function mu-message-get-flag MESG FLAG 147 @deffn {Scheme Function} mu-message-get-flag MESG FLAG
148 Return value of the attribute FLAG. 148 Return value of the attribute FLAG.
149 @end deffn 149 @end deffn
150 150
151 @deffn Function mu-message-set-flag MESG FLAG VALUE 151 @deffn {Scheme Function} mu-message-set-flag MESG FLAG VALUE
152 Set the given attribute of the message. If optional VALUE is #f, the 152 Set the given attribute of the message. If optional VALUE is #f, the
153 attribute is unset. 153 attribute is unset.
154 @end deffn 154 @end deffn
155 155
156 @deffn Function mu-message-get-user-flag MESG FLAG 156 @deffn {Scheme Function} mu-message-get-user-flag MESG FLAG
157 Returns value of the user attribute FLAG. 157 Returns value of the user attribute FLAG.
158 @end deffn 158 @end deffn
159 159
160 @deffn Function mu-message-set-user-flag MESG FLAG VALUE 160 @deffn {Scheme Function} mu-message-set-user-flag MESG FLAG VALUE
161 Set the given user attribute of the message. If optional VALUE is 161 Set the given user attribute of the message. If optional VALUE is
162 #f, the attribute is unset. 162 #f, the attribute is unset.
163 @end deffn 163 @end deffn
164 164
165 @deffn Function mu-message-get-port MESG MODE FULL 165 @deffn {Scheme Function} mu-message-get-port MESG MODE FULL
166 Returns a port associated with the given MESG. MODE is a string 166 Returns a port associated with the given MESG. MODE is a string
167 defining operation mode of the stream. It may contain any of the 167 defining operation mode of the stream. It may contain any of the
168 two characters: @samp{r} for reading, @samp{w} for writing. 168 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 ...@@ -172,11 +172,11 @@ part of the message (including headers). If it is #f then the port
172 accesses only the message body (the default). 172 accesses only the message body (the default).
173 @end deffn 173 @end deffn
174 174
175 @deffn Function mu-message-get-body MESG 175 @deffn {Scheme Function} mu-message-get-body MESG
176 Returns the message body for the message MESG. 176 Returns the message body for the message MESG.
177 @end deffn 177 @end deffn
178 178
179 @deffn Function mu-message-send MESG MAILER 179 @deffn {Scheme Function} mu-message-send MESG MAILER
180 Sends the message MESG. Optional MAILER overrides default 180 Sends the message MESG. Optional MAILER overrides default
181 mailer settings in mu-mailer. 181 mailer settings in mu-mailer.
182 @end deffn 182 @end deffn
...@@ -184,42 +184,42 @@ mailer settings in mu-mailer. ...@@ -184,42 +184,42 @@ mailer settings in mu-mailer.
184 @node MIME Functions 184 @node MIME Functions
185 @section MIME Functions 185 @section MIME Functions
186 186
187 @deffn Function mu-mime-create FLAGS MESG 187 @deffn {Scheme Function} mu-mime-create FLAGS MESG
188 Creates a new MIME object. 188 Creates a new MIME object.
189 @end deffn 189 @end deffn
190 190
191 @deffn Function mu-mime-multipart? MIME 191 @deffn {Scheme Function} mu-mime-multipart? MIME
192 Returns #t if MIME is a multipart object. 192 Returns #t if MIME is a multipart object.
193 @end deffn 193 @end deffn
194 194
195 @deffn Function mu-mime-get-num-parts MIME 195 @deffn {Scheme Function} mu-mime-get-num-parts MIME
196 Returns number of parts in a MIME object. 196 Returns number of parts in a MIME object.
197 @end deffn 197 @end deffn
198 198
199 @deffn Function mu-mime-get-part MIME PART 199 @deffn {Scheme Function} mu-mime-get-part MIME PART
200 Returns part number PART from a MIME object. 200 Returns part number PART from a MIME object.
201 @end deffn 201 @end deffn
202 202
203 @deffn Function mu-mime-add-part MIME MESG 203 @deffn {Scheme Function} mu-mime-add-part MIME MESG
204 Adds MESG to the MIME object. 204 Adds MESG to the MIME object.
205 @end deffn 205 @end deffn
206 206
207 @deffn Function mu-mime-get-message MIME 207 @deffn {Scheme Function} mu-mime-get-message MIME
208 Converts MIME object to a message. 208 Converts MIME object to a message.
209 @end deffn 209 @end deffn
210 210
211 @node Log Functions 211 @node Log Functions
212 @section Log Functions 212 @section Log Functions
213 213
214 @deffn Function mu-openlog IDENT OPTION FACILITY 214 @deffn {Scheme Function} mu-openlog IDENT OPTION FACILITY
215 Opens a connection to the system logger for Guile program. 215 Opens a connection to the system logger for Guile program.
216 @end deffn 216 @end deffn
217 217
218 @deffn Function mu-logger PRIO TEXT 218 @deffn {Scheme Function} mu-logger PRIO TEXT
219 Generates a log message to be distributed via syslogd. 219 Generates a log message to be distributed via syslogd.
220 @end deffn 220 @end deffn
221 221
222 @deffn Function mu-closelog 222 @deffn {Scheme Function} mu-closelog
223 Closes the channel to the system logger open by mu-openlog. 223 Closes the channel to the system logger open by mu-openlog.
224 @end deffn 224 @end deffn
225 225
......
...@@ -117,44 +117,44 @@ struct mu_auth_module @{ ...@@ -117,44 +117,44 @@ struct mu_auth_module @{
117 @node Initializing the libmuauth 117 @node Initializing the libmuauth
118 @section Initializing the libmuauth 118 @section Initializing the libmuauth
119 119
120 @deftypefn void mu_auth_init (void) 120 @deftypefun void mu_auth_init (void)
121 121
122 This function registers the command line capability ``auth''. It must be 122 This function registers the command line capability ``auth''. It must be
123 called after registering @file{libmuauth} modules and before calling 123 called after registering @file{libmuauth} modules and before calling
124 @code{mu_agrp_parse()}. If an error occurs, this function prints 124 @code{mu_agrp_parse()}. If an error occurs, this function prints
125 diagnostic message and aborts the program. 125 diagnostic message and aborts the program.
126 @end deftypefn 126 @end deftypefun
127 127
128 @deftypefn void MU_AUTH_REGISTER_ALL_MODULES (void) 128 @deftypefun void MU_AUTH_REGISTER_ALL_MODULES (void)
129 129
130 This macro registers all default modules and calls @code{mu_auth_init()}. 130 This macro registers all default modules and calls @code{mu_auth_init()}.
131 @end deftypefn 131 @end deftypefun
132 132
133 @node Module Creation and Destruction 133 @node Module Creation and Destruction
134 @section Module Creation and Destruction 134 @section Module Creation and Destruction
135 135
136 @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) 136 @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)
137 137
138 Create a @code{mu_auth_data} structure and initialize it with the given 138 Create a @code{mu_auth_data} structure and initialize it with the given
139 values. Returns 0 on success and 1 otherwise. 139 values. Returns 0 on success and 1 otherwise.
140 @end deftypefn 140 @end deftypefun
141 141
142 @deftypefn void mu_auth_data_free (struct mu_auth_data *@var{ptr}) 142 @deftypefun void mu_auth_data_free (struct mu_auth_data *@var{ptr})
143 143
144 Free the @code{mu_auth_data} structure allocated by a call to 144 Free the @code{mu_auth_data} structure allocated by a call to
145 @code{mu_auth_data_alloc()}. 145 @code{mu_auth_data_alloc()}.
146 @end deftypefn 146 @end deftypefun
147 147
148 @deftypefn void mu_auth_register_module (struct mu_auth_module *@var{mod}) 148 @deftypefun void mu_auth_register_module (struct mu_auth_module *@var{mod})
149 149
150 Register the module defined by the @var{mod} argument. 150 Register the module defined by the @var{mod} argument.
151 @end deftypefn 151 @end deftypefun
152 152
153 @node Obtaining Authorization Information 153 @node Obtaining Authorization Information
154 @section Obtaining Authorization Information 154 @section Obtaining Authorization Information
155 @cindex libmuauth, obtaining authorization information 155 @cindex libmuauth, obtaining authorization information
156 156
157 @deftypefn int mu_auth_runlist (list_t @var{flist}, void *@var{return_data}, void *@var{key}, void *@var{call_data}); 157 @deftypefun int mu_auth_runlist (list_t @var{flist}, void *@var{return_data}, void *@var{key}, void *@var{call_data});
158 158
159 The list is expected to contain @code{mu_auth_fp} pointers. Each of them 159 The list is expected to contain @code{mu_auth_fp} pointers. Each of them
160 is dereferenced and executed until either the list is exhausted or any 160 is dereferenced and executed until either the list is exhausted or any
...@@ -167,34 +167,34 @@ parameter. ...@@ -167,34 +167,34 @@ parameter.
167 The function returns 0 if none of the functions from @code{list} 167 The function returns 0 if none of the functions from @code{list}
168 succeeded, i.e. returned non-zero value. Otherwise it returns the 168 succeeded, i.e. returned non-zero value. Otherwise it returns the
169 return code from the succeeded function. 169 return code from the succeeded function.
170 @end deftypefn 170 @end deftypefun
171 171
172 @deftypefn {struct mu_auth_data *} mu_get_auth_by_name (const char *@var{username}) 172 @deftypefun {struct mu_auth_data *} mu_get_auth_by_name (const char *@var{username})
173 173
174 Search the information about given user by its username. Similar to 174 Search the information about given user by its username. Similar to
175 system's @code{getpwnam} call). 175 system's @code{getpwnam} call).
176 176
177 @end deftypefn 177 @end deftypefun
178 178
179 @deftypefn {struct mu_auth_data *} mu_get_auth_by_uid (uid_t @var{uid}) 179 @deftypefun {struct mu_auth_data *} mu_get_auth_by_uid (uid_t @var{uid})
180 Search the information about given user by its uid. Similar to 180 Search the information about given user by its uid. Similar to
181 system's @code{getpwuid} call). 181 system's @code{getpwuid} call).
182 @end deftypefn 182 @end deftypefun
183 183
184 @deftypefn int mu_authenticate (struct mu_auth_data *@var{auth_data}, char *@var{pass}) 184 @deftypefun int mu_authenticate (struct mu_auth_data *@var{auth_data}, char *@var{pass})
185 185
186 Authenticate the user whose data are in @var{auth_data} using password 186 Authenticate the user whose data are in @var{auth_data} using password
187 @var{pass}. Return 0 if the user is authenticated. 187 @var{pass}. Return 0 if the user is authenticated.
188 @end deftypefn 188 @end deftypefun
189 189
190 @node Existing Modules 190 @node Existing Modules
191 @section Existing Modules 191 @section Existing Modules
192 @cindex libmuauth modules 192 @cindex libmuauth modules
193 193
194 @deftypefn int mu_auth_nosupport (void *return_data, void *key, void *func_data, void *call_data); 194 @deftypefun int mu_auth_nosupport (void *return_data, void *key, void *func_data, void *call_data);
195 195
196 The ``not-supported'' module. Always returns @code{ENOSYS}. 196 The ``not-supported'' module. Always returns @code{ENOSYS}.
197 @end deftypefn 197 @end deftypefun
198 198
199 @defvar mu_auth_system_module 199 @defvar mu_auth_system_module
200 200
......