diff options
author | tomas <tomas> | 2004-07-27 14:15:24 +0000 |
---|---|---|
committer | tomas <tomas> | 2004-07-27 14:15:24 +0000 |
commit | 8addf14a396466982f62503a6dfa5793a53b1b8e (patch) | |
tree | 74d9db96683d623e3e789e2e51c7434da7ef6be4 /doc/us/manual.html | |
download | luafilesystem-8addf14a396466982f62503a6dfa5793a53b1b8e.tar.gz luafilesystem-8addf14a396466982f62503a6dfa5793a53b1b8e.tar.bz2 luafilesystem-8addf14a396466982f62503a6dfa5793a53b1b8e.zip |
Initial revision
Diffstat (limited to 'doc/us/manual.html')
-rw-r--r-- | doc/us/manual.html | 144 |
1 files changed, 144 insertions, 0 deletions
diff --git a/doc/us/manual.html b/doc/us/manual.html new file mode 100644 index 0000000..374d033 --- /dev/null +++ b/doc/us/manual.html | |||
@@ -0,0 +1,144 @@ | |||
1 | <! See Copyright Notice in license.html> | ||
2 | <html> | ||
3 | |||
4 | <head> | ||
5 | <title>LuaFileSystem</title> | ||
6 | <style type="text/css"> | ||
7 | ul { list-style-type: disc }; | ||
8 | </style> | ||
9 | </head> | ||
10 | |||
11 | <body bgcolor="#FFFFFF"> | ||
12 | |||
13 | <hr> | ||
14 | |||
15 | <center> | ||
16 | <table border=0 cellspacing=2 cellpadding=2> | ||
17 | <tr><td align=center><a href="http://www.keplerproject.org/luafilesystem"> | ||
18 | <img border=0 alt="LuaFileSystem logo" src="luafilesystem.png"></a> | ||
19 | <tr><td align=center><big><b>LuaFileSystem Reference Manual</b></big> | ||
20 | <tr><td align=center valign=top>File system library for the | ||
21 | <a href="http://www.lua.org">Lua</a> | ||
22 | programming language | ||
23 | </table> | ||
24 | </center> | ||
25 | <p> | ||
26 | |||
27 | <center><small> | ||
28 | <a href="index.html">home</a> · | ||
29 | <a href="#introduction">introduction</a> · | ||
30 | <a href="#reference">reference</a> · | ||
31 | <a href="#example">example</a> | ||
32 | </small></center> | ||
33 | <p> | ||
34 | |||
35 | <hr> | ||
36 | |||
37 | <a name="introduction"></a> | ||
38 | <h2>Introduction</h2> | ||
39 | |||
40 | <p> | ||
41 | LuaFileSystem is a <a href="http://www.lua.org">Lua</a> library | ||
42 | developed to complement the set of functions related to file systems offered | ||
43 | by the standard Lua distribution. | ||
44 | <p> | ||
45 | LuaFileSystem is free software and uses the same | ||
46 | <a href="license.html">license</a> | ||
47 | as Lua 5.0. | ||
48 | </p> | ||
49 | |||
50 | |||
51 | <a name="reference"></a> | ||
52 | <h2>Reference</h2> | ||
53 | |||
54 | <p> | ||
55 | LuaFileSystem offers the following functions: | ||
56 | <ul> | ||
57 | <a name="chdir"></a> | ||
58 | <li> <b><tt>luafilesystem.chdir (path)</tt></b> <br> | ||
59 | Changes the current | ||
60 | working directory to the given <tt>path</tt>. | ||
61 | |||
62 | <a name="getcwd"></a> | ||
63 | <li> <b><tt>luafilesystem.currentdir ()</tt></b> <br> | ||
64 | Returns the current | ||
65 | working directory or <code>nil</code> plus an error string. | ||
66 | |||
67 | <a name="dir"></a> | ||
68 | <li> <b><tt>luafilesystem.dir (path)</tt></b> <br> | ||
69 | Lua iterator over the entries | ||
70 | of a given directory. | ||
71 | |||
72 | <a name="lock"></a> | ||
73 | <li> <b><tt>luafilesystem.lock (filehandle, mode[, start[, length]])</tt></b> <br> | ||
74 | Locks a file or a part of it. | ||
75 | This function works on <em>open files</em>; | ||
76 | the file handle should be specified as the first argument. | ||
77 | The string <code>mode</code> could be either <code>r</code> (for a | ||
78 | read/shared lock) or <code>w</code> (for a write/exclusive lock). | ||
79 | The optional arguments <code>start</code> and <code>length</code> can be | ||
80 | used to specify a starting point and its length; | ||
81 | both should be numbers. | ||
82 | This function returns a boolean indicating if the operation was successful; | ||
83 | in case of error, it returns <code>false</code> plus a string describing the | ||
84 | error. | ||
85 | |||
86 | <a name="mkdir"></a> | ||
87 | <li> <b><tt>luafilesystem.mkdir (dirname)</tt></b> <br> | ||
88 | Creates a new directory. | ||
89 | The argument is the name of the new directory. | ||
90 | |||
91 | <a name="unlock"></a> | ||
92 | <li> <b><tt>luafilesystem.unlock (filehandle[, start[, length]])</tt></b> <br> | ||
93 | Unlocks a file or a part of it. | ||
94 | This function works on <em>open files</em>; | ||
95 | the file handle should be specified as the first argument. | ||
96 | The optional arguments <code>start</code> and <code>length</code> can be | ||
97 | used to specify a starting point and its length; | ||
98 | both should be numbers. | ||
99 | This function returns a boolean indicating if the operation was successful; | ||
100 | in case of error, it returns <code>false</code> plus a string describing the | ||
101 | error. | ||
102 | |||
103 | </ul> | ||
104 | |||
105 | |||
106 | <a name="example"></a> | ||
107 | <h2>Example</h2> | ||
108 | |||
109 | |||
110 | <a name="contents"></a> | ||
111 | <h2>Contents</h2> | ||
112 | <p> | ||
113 | <ul> | ||
114 | <li> <a href="#introduction">Introduction</a> | ||
115 | <li> <a href="#reference">Reference</a> | ||
116 | <ul> | ||
117 | <li> <a href="#chdir">chdir</a> | ||
118 | <li> <a href="#currentdir">currentdir</a> | ||
119 | <li> <a href="#dir">dir</a> | ||
120 | <li> <a href="#lock">lock</a> | ||
121 | <li> <a href="#mkdir">mkdir</a> | ||
122 | <li> <a href="#unlock">unlock</a> | ||
123 | </ul> | ||
124 | <li> <a href="#examples">Examples</a> | ||
125 | </ul> | ||
126 | </p> | ||
127 | |||
128 | |||
129 | <p> | ||
130 | <center><small> | ||
131 | <a href="index.html">home</a> · | ||
132 | <a href="#introduction">introduction</a> · | ||
133 | <a href="#reference">reference</a> · | ||
134 | <a href="#example">example</a> | ||
135 | </small></center> | ||
136 | <p> | ||
137 | |||
138 | <hr> | ||
139 | <small> | ||
140 | $Id: manual.html,v 1.1 2004/07/27 14:15:24 tomas Exp $ | ||
141 | </small> | ||
142 | |||
143 | </body> | ||
144 | </html> | ||