File: application.kwc

package info (click to toggle)
erlang-doc-html 1%3A11.b.2-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 23,284 kB
  • ctags: 10,724
  • sloc: erlang: 505; ansic: 323; makefile: 62; perl: 61; sh: 45
file content (319 lines) | stat: -rw-r--r-- 12,494 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
%% Automatically generated. Do not edit.
{srcfile, "application"}.
{appname, "inets"}.
{appvsn, "4.7.6"}.
{module, "ftp"}.
{modulesummary, "A File Transfer Protocol client"}.
{name, "account/2"}.
{fsummary, "Specify which account to use."}.
{name, "append/3"}.
{fsummary, "    Transfer file to remote server, and append it to Remotefile. "}.
{name, "append_bin/3"}.
{fsummary, "Transfer a binary into a remote file."}.
{name, "append_chunk/2"}.
{fsummary, "append a chunk to the remote file."}.
{name, "append_chunk_start/2"}.
{fsummary, "Start transfer of file chunks for appending to File. "}.
{name, "append_chunk_end/1"}.
{fsummary, "Stop transfer of chunks for appending."}.
{name, "cd/2"}.
{fsummary, "Change remote working directory."}.
{name, "close/1"}.
{fsummary, "End ftp session."}.
{name, "delete/2"}.
{fsummary, "Delete a file at the remote server.."}.
{name, "formaterror/1"}.
{fsummary, "Return error diagnostics."}.
{name, "lcd/2"}.
{fsummary, "Change local working directory."}.
{name, "lpwd/1"}.
{fsummary, "Get local current working directory."}.
{name, "ls/2"}.
{fsummary, "List contents of remote directory."}.
{name, "mkdir/2"}.
{fsummary, "Create remote directory."}.
{name, "nlist/2"}.
{fsummary, "List contents of remote directory."}.
{name, "open/3"}.
{name, "open/2"}.
{fsummary, "Start an ftp client."}.
{name, "pwd/1"}.
{fsummary, "Get remote current working directory."}.
{name, "recv/3"}.
{fsummary, "Transfer file from remote server."}.
{name, "recv_bin/2"}.
{fsummary, "Transfer file from remote server as a binary."}.
{name, "recv_chunk_start/2"}.
{fsummary, "Start chunk-reading of the remote file."}.
{name, "recv_chunk/1"}.
{fsummary, "Receive a chunk of the remote file."}.
{name, "rename/3"}.
{fsummary, "Rename a file at the remote server.."}.
{name, "rmdir/2"}.
{fsummary, "Remove a remote directory."}.
{name, "send/3"}.
{fsummary, "Transfer file to remote server."}.
{name, "send_bin/3"}.
{fsummary, "Transfer a binary into a remote file."}.
{name, "send_chunk/2"}.
{fsummary, "Write a chunk to the remote file."}.
{name, "send_chunk_start/2"}.
{fsummary, "Start transfer of file chunks."}.
{name, "send_chunk_end/1"}.
{fsummary, "Stop transfer of chunks."}.
{name, "type/2"}.
{fsummary, "Set transfer type to ascii or binary."}.
{name, "user/3"}.
{fsummary, "User login."}.
{name, "user/4"}.
{fsummary, "User login."}.
{name, "quote/2"}.
{fsummary, "Sends an arbitary FTP command. "}.
{module, "tftp"}.
{modulesummary, "Trivial FTP"}.
{name, "start/1"}.
{fsummary, "Start a daemon process"}.
{name, "read_file/3"}.
{fsummary, "Read a (virtual) file from a TFTP server"}.
{name, "write_file/3"}.
{fsummary, "Write a (virtual) file to a TFTP server"}.
{name, "info/1"}.
{fsummary, "Return information about a daemon, server or client         process"}.
{name, "start/0"}.
{fsummary, "Start the Inets application"}.
{name, "prepare/5"}.
{fsummary, "Prepare to open a file on the client side"}.
{name, "open/5"}.
{fsummary, "Open a file for read or write access"}.
{name, "read/1"}.
{fsummary, "Read a chunk from the file"}.
{name, "write/2"}.
{fsummary, "Write a chunk to the file"}.
{name, "abort/3"}.
{fsummary, "Abort the file transfer"}.
{module, "http"}.
{modulesummary, "An HTTP/1.1 client "}.
{name, "cancel_request/1"}.
{fsummary, " Cancels an asynchronous HTTP-request."}.
{name, "request/1"}.
{fsummary, " Sends a get HTTP-request"}.
{name, "request/4"}.
{fsummary, " Sends a HTTP-request"}.
{name, "set_options/1"}.
{fsummary, " Sets       options to be used for subsequent requests."}.
{name, "verify_cookie/2"}.
{fsummary, " Saves the cookies defined in SetCookieHeaders      in the client manager's cookie database."}.
{name, "cookie_header/1"}.
{fsummary, " Returns the cookie header that would be sent when making a request to Url."}.
{module, "http_base_64"}.
{modulesummary, "Implements base 64 encode and decode, see RFC2045. "}.
{name, "encode/1"}.
{fsummary, "Encodes a plain ASCII string into base64. "}.
{name, "decode/1"}.
{fsummary, " Decodes an base64 encoded string to plain ASCII. "}.
{module, "httpd"}.
{modulesummary, "An implementation of an HTTP 1.1 compliant Web server, as defined in RFC 2616.  "}.
{name, "Module:do/1"}.
{fsummary, "  Called for each request to the Web server. "}.
{name, "Module:load/2"}.
{fsummary, "  Load a configuration directive. "}.
{name, "Module:store/3"}.
{fsummary, "  Alter the value of one or more configuration directive. "}.
{name, "Module:remove/1"}.
{fsummary, "  Callback function that is called when the Web server is closed. "}.
{name, "parse_query/1"}.
{fsummary, "Parse incoming data to erl  and eval        scripts. "}.
{name, "start/0"}.
{name, "start/1"}.
{name, "start_link/0"}.
{name, "start_link/1"}.
{fsummary, "Start a server as specified in the given config file. "}.
{name, "restart/0"}.
{name, "restart/1"}.
{name, "restart/1"}.
{name, "restart/2"}.
{fsummary, "Restart a running server. "}.
{name, "stop/0"}.
{name, "stop/1"}.
{name, "stop/1"}.
{name, "stop/2"}.
{fsummary, "Stop a running server.  "}.
{name, "block/0"}.
{name, "block/1"}.
{name, "block/1"}.
{name, "block/2"}.
{name, "block/2"}.
{name, "block/2"}.
{name, "block/3"}.
{name, "block/3"}.
{name, "block/4"}.
{fsummary, "Block a running server.  "}.
{name, "unblock/0"}.
{name, "unblock/1"}.
{name, "unblock/1"}.
{name, "unblock/2"}.
{fsummary, "Unblock a blocked server.  "}.
{module, "httpd_conf"}.
{modulesummary, "Configuration utility functions to be used by the Erlang Webserver API programmer.  "}.
{name, "check_enum/2"}.
{fsummary, "Check if string is a valid enumeration. "}.
{name, "clean/1"}.
{fsummary, "Remove leading and/or trailing white spaces. "}.
{name, "custom_clean/3"}.
{fsummary, "Remove leading and/or trailing white spaces and custom characters. "}.
{name, "is_directory/1"}.
{fsummary, "Check if a file path is a directory. "}.
{name, "is_file/1"}.
{fsummary, "Check if a file path is a regular file. "}.
{name, "make_integer/1"}.
{fsummary, "Return an integer representation of a string. "}.
{module, "httpd_socket"}.
{modulesummary, "Communication utility functions to be used by the Erlang Webserver API programmer.  "}.
{name, "deliver/3"}.
{fsummary, "Send binary data over socket. "}.
{name, "peername/2"}.
{fsummary, "Return the port and IP-address of the remote socket. "}.
{name, "resolve/0"}.
{fsummary, "Return the official name of the current host. "}.
{module, "httpd_util"}.
{modulesummary, "Miscellaneous utility functions to be used when implementing Erlang Webserver API modules. "}.
{name, "convert_request_date/1"}.
{fsummary, "Convert The the date to the Erlang date format. "}.
{name, "create_etag/1"}.
{fsummary, "Calculates the Etag for a file. "}.
{name, "decode_base64/1"}.
{fsummary, "Convert a base64 encoded string to a plain ascii    string. "}.
{name, "decode_hex/1"}.
{fsummary, "Convert a hex value into its decimal equivalent. "}.
{name, "day/1"}.
{fsummary, "Convert the day of the week (integer [1-7])         to an abbreviated string. "}.
{name, "encode_base64/1"}.
{fsummary, "Convert an ASCII string to a Base64 encoded string."}.
{name, "flatlength/1"}.
{fsummary, "Compute the size of a possibly nested list. "}.
{name, "header/2"}.
{name, "header/2"}.
{name, "header/3"}.
{name, "header/4"}.
{fsummary, "Generate a HTTP 1.1 header. "}.
{name, "hexlist_to_integer/1"}.
{fsummary, "Convert a hexadecimal string to an integer."}.
{name, "integer_tohexlist/1"}.
{fsummary, "Convert an integer to a hexadecimal string."}.
{name, "key1search/2"}.
{name, "key1search/3"}.
{fsummary, "Search a list of key-value tuples for a tuple whose first element is a key. "}.
{name, "lookup/2"}.
{name, "lookup/3"}.
{fsummary, "Extract the first value associated with a key in an ETS table. "}.
{name, "lookup_mime/2"}.
{name, "lookup_mime/3"}.
{fsummary, "Return the mime type associated with a specific file        suffix.  "}.
{name, "lookup_mime_default/2"}.
{name, "lookup_mime_default/3"}.
{fsummary, "Return the mime type associated with a specific file        suffix or the value of the DefaultType. "}.
{name, "message/3"}.
{fsummary, "Return an informative HTTP 1.1 status string in HTML. "}.
{name, "month/1"}.
{fsummary, "Convert the month as an integer (1-12) to an        abbreviated string. "}.
{name, "multi_lookup/2"}.
{fsummary, "Extract the values associated with a key in a ETS table. "}.
{name, "reason_phrase/1"}.
{fsummary, "Return the description of an HTTP 1.1 status code. "}.
{name, "rfc1123_date/0"}.
{name, "rfc1123_date/6"}.
{fsummary, "Return the current date in RFC 1123 format. "}.
{name, "split/3"}.
{fsummary, "Split a string in N chunks using a regular expression. "}.
{name, "split_script_path/1"}.
{fsummary, "Split a RequestLine in a file reference to an executable and a      QueryString or a PathInfo string. "}.
{name, "split_path/1"}.
{fsummary, "Split a RequestLine in a file reference and a QueryString or a      PathInfo string. "}.
{name, "strip/1"}.
{fsummary, "Returns String where the leading and trailing space and tabs has been removed. "}.
{name, "suffix/1"}.
{fsummary, "Extract the file suffix from a given filename. "}.
{name, "to_lower/1"}.
{fsummary, "Convert upper-case letters to lower-case. "}.
{name, "to_upper/1"}.
{fsummary, "Convert lower-case letters to upper-case. "}.
{module, "mod_alias"}.
{modulesummary, "URL ailasing.  "}.
{name, "default_index/2"}.
{fsummary, "Return a new path with the default resource or file appended. "}.
{name, "path/3"}.
{fsummary, "Return the actual file path to a URL. "}.
{name, "real_name/3"}.
{fsummary, "Expand a request uri using Alias config directives. "}.
{name, "real_script_name/3"}.
{fsummary, "Expand a request uri using ScriptAlias config directives. "}.
{module, "mod_auth"}.
{modulesummary, "User authentication using text files, dets or mnesia database. "}.
{name, "add_user/2"}.
{name, "add_user/5"}.
{name, "add_user/6"}.
{fsummary, "Add a user to the user database."}.
{name, "delete_user/2"}.
{name, "delete_user/3"}.
{name, "delete_user/4"}.
{fsummary, "Delete a user from the user database."}.
{name, "get_user/2"}.
{name, "get_user/3"}.
{name, "get_user/4"}.
{fsummary, "Returns a user from the user database."}.
{name, "list_users/1"}.
{name, "list_users/3"}.
{fsummary, "List users in the user database."}.
{name, "add_group_member/3"}.
{name, "add_group_member/4"}.
{name, "add_group_member/5"}.
{fsummary, "Add a user to a group."}.
{name, "delete_group_member/3"}.
{name, "delete_group_member/4"}.
{name, "delete_group_member/5"}.
{fsummary, "Remove a user from a group."}.
{name, "list_group_members/2"}.
{name, "list_group_members/3"}.
{name, "list_group_members/4"}.
{fsummary, "List the members of a group."}.
{name, "list_groups/1"}.
{name, "list_groups/2"}.
{name, "list_groups/3"}.
{fsummary, "List all the groups."}.
{name, "delete_group/2"}.
{name, "delete_group/4"}.
{fsummary, "Deletes a group"}.
{name, "update_password/5"}.
{name, "update_password/6"}.
{fsummary, "Change the AuthAcessPassword"}.
{module, "mod_esi"}.
{modulesummary, "Erlang Server Interface  "}.
{name, "deliver/2"}.
{fsummary, "Sends Data back to client. "}.
{name, "Module:Function/3"}.
{fsummary, "Creates a dynamic web page and returns it chunk by chunk    to the server process by calling mod_esi:deliver/2. "}.
{name, "Module:Function/2"}.
{fsummary, "Creates a dynamic web page and return it as a list.         This functions is deprecated and only keept for backwards       compability. "}.
{module, "mod_security"}.
{modulesummary, "Security Audit and Trailing Functionality "}.
{name, "list_auth_users/1"}.
{name, "list_auth_users/2"}.
{name, "list_auth_users/2"}.
{name, "list_auth_users/3"}.
{fsummary, "List users that have authenticated within the SecurityAuthTimeout time for a given address (if specified), port number and directory        (if specified). "}.
{name, "list_blocked_users/1"}.
{name, "list_blocked_users/2"}.
{name, "list_blocked_users/2"}.
{name, "list_blocked_users/3"}.
{fsummary, "List users that are currently blocked from access to a  specified port number, for a given address (if specified). "}.
{name, "block_user/4"}.
{name, "block_user/5"}.
{fsummary, "Block user from access to a directory for a certain amount of time."}.
{name, "unblock_user/2"}.
{name, "unblock_user/3"}.
{name, "unblock_user/3"}.
{name, "unblock_user/4"}.
{fsummary, "Remove a blocked user from the block list"}.
{name, "event/4"}.
{name, "event/5"}.
{fsummary, "This function is called whenever an event occurs in mod_security"}.