Fix module lines in several luadoc files
[project/luci.git] / doc / modules / luci.http.protocol.mime.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3 <html>
4 <head>
5     <title>Reference</title>
6     <link rel="stylesheet" href="../luadoc.css" type="text/css" />
7         <!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
8 </head>
9
10 <body>
11 <div id="container">
12
13 <div id="product">
14         <div id="product_logo"></div>
15         <div id="product_name"><big><b></b></big></div>
16         <div id="product_description"></div>
17 </div> <!-- id="product" -->
18
19 <div id="main">
20
21 <div id="navigation">
22
23
24 <h1>LuaDoc</h1>
25 <ul>
26         
27         <li><a href="../index.html">Index</a></li>
28         
29 </ul>
30
31
32 <!-- Module list -->
33
34 <h1>Modules</h1>
35 <ul>
36
37         <li>
38                 <a href="../modules/luci.dispatcher.html">luci.dispatcher</a>
39         </li>
40
41         <li>
42                 <a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
43         </li>
44
45         <li>
46                 <a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
47         </li>
48
49         <li>
50                 <a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
51         </li>
52
53         <li><strong>luci.http.protocol.mime</strong></li>
54         
55         <li>
56                 <a href="../modules/luci.i18n.html">luci.i18n</a>
57         </li>
58
59         <li>
60                 <a href="../modules/luci.ip.html">luci.ip</a>
61         </li>
62
63         <li>
64                 <a href="../modules/luci.ip.cidr.html">luci.ip.cidr</a>
65         </li>
66
67         <li>
68                 <a href="../modules/luci.jsonc.html">luci.jsonc</a>
69         </li>
70
71         <li>
72                 <a href="../modules/luci.jsonc.parser.html">luci.jsonc.parser</a>
73         </li>
74
75         <li>
76                 <a href="../modules/luci.sys.init.html">luci.sys.init</a>
77         </li>
78
79         <li>
80                 <a href="../modules/luci.sys.iptparser.html">luci.sys.iptparser</a>
81         </li>
82
83         <li>
84                 <a href="../modules/luci.sys.net.html">luci.sys.net</a>
85         </li>
86
87         <li>
88                 <a href="../modules/luci.sys.process.html">luci.sys.process</a>
89         </li>
90
91         <li>
92                 <a href="../modules/luci.sys.user.html">luci.sys.user</a>
93         </li>
94
95         <li>
96                 <a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a>
97         </li>
98
99         <li>
100                 <a href="../modules/nixio.html">nixio</a>
101         </li>
102
103         <li>
104                 <a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a>
105         </li>
106
107         <li>
108                 <a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a>
109         </li>
110
111         <li>
112                 <a href="../modules/nixio.File.html">nixio.File</a>
113         </li>
114
115         <li>
116                 <a href="../modules/nixio.README.html">nixio.README</a>
117         </li>
118
119         <li>
120                 <a href="../modules/nixio.Socket.html">nixio.Socket</a>
121         </li>
122
123         <li>
124                 <a href="../modules/nixio.TLSContext.html">nixio.TLSContext</a>
125         </li>
126
127         <li>
128                 <a href="../modules/nixio.TLSSocket.html">nixio.TLSSocket</a>
129         </li>
130
131         <li>
132                 <a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a>
133         </li>
134
135         <li>
136                 <a href="../modules/nixio.bin.html">nixio.bin</a>
137         </li>
138
139         <li>
140                 <a href="../modules/nixio.bit.html">nixio.bit</a>
141         </li>
142
143         <li>
144                 <a href="../modules/nixio.crypto.html">nixio.crypto</a>
145         </li>
146
147         <li>
148                 <a href="../modules/nixio.fs.html">nixio.fs</a>
149         </li>
150
151 </ul>
152
153
154
155 <!-- File list -->
156
157
158
159
160
161
162
163 </div><!-- id="navigation" -->
164
165 <div id="content">
166
167 <h1>Class <code>luci.http.protocol.mime</code></h1>
168
169 <p></p>
170
171
172
173
174
175
176
177 <h2>Functions</h2>
178 <table class="function_list">
179
180         <tr>
181         <td class="name" nowrap><a href="#to_ext">to_ext</a>&nbsp;(mimetype)</td>
182         <td class="summary">
183  
184 Return corresponding extension for a given mime type or nil if the 
185  
186 given mime-type is unknown.</td>
187         </tr>
188
189         <tr>
190         <td class="name" nowrap><a href="#to_mime">to_mime</a>&nbsp;(filename)</td>
191         <td class="summary">
192  
193 Extract extension from a filename and return corresponding mime-type or 
194  
195 "application/octet-stream" if the extension is unknown.</td>
196         </tr>
197
198 </table>
199
200
201
202
203
204
205 <br/>
206 <br/>
207
208
209 <h2><a name="functions"></a>Functions</h2>
210 <dl class="function">
211
212
213
214 <dt><a name="to_ext"></a><strong>to_ext</strong>&nbsp;(mimetype)</dt>
215 <dd>
216
217  
218 Return corresponding extension for a given mime type or nil if the 
219  
220 given mime-type is unknown.
221
222
223 <h3>Parameters</h3>
224 <ul>
225         
226         <li>
227           mimetype: The mimetype to retrieve the extension from
228         </li>
229         
230 </ul>
231
232
233
234
235
236
237 <h3>Return value:</h3>
238 String with the extension or nil for unknown type
239
240
241
242 </dd>
243
244
245
246
247 <dt><a name="to_mime"></a><strong>to_mime</strong>&nbsp;(filename)</dt>
248 <dd>
249
250  
251 Extract extension from a filename and return corresponding mime-type or 
252  
253 "application/octet-stream" if the extension is unknown.
254
255
256 <h3>Parameters</h3>
257 <ul>
258         
259         <li>
260           filename: The filename for which the mime type is guessed
261         </li>
262         
263 </ul>
264
265
266
267
268
269
270 <h3>Return value:</h3>
271 String containign the determined mime type
272
273
274
275 </dd>
276
277
278 </dl>
279
280
281
282
283
284 </div> <!-- id="content" -->
285
286 </div> <!-- id="main" -->
287
288 <div id="about">
289         <p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
290 </div> <!-- id="about" -->
291
292 </div> <!-- id="container" -->
293 </body>
294 </html>