comparison doc/html/api/module/Irccd.Directory/index.md @ 0:1158cffe5a5e

Initial import
author David Demelier <markand@malikania.fr>
date Mon, 08 Feb 2016 16:43:14 +0100
parents
children 904ee87bc808
comparison
equal deleted inserted replaced
-1:000000000000 0:1158cffe5a5e
1 ---
2 module: Irccd.Directory
3 summary: Open an read directories.
4 ---
5
6 ## Usage
7
8 This module can be used to iterate, find, remove or create directories.
9
10 Use this module with care.
11
12 ## Constants
13
14 The following properties are defined:
15
16 - **Dot**: (int) list "." directory,
17 - **DotDot**: (int) list ".." directory,
18 - **TypeUnknown**: (int) unknown type file,
19 - **TypeDir**: (int) entry is a directory,
20 - **TypeFile**: (int) entry is a file,
21 - **TypeLink**: (int) entry is a link.
22
23 ## Functions
24
25 - [find](function/find.html)
26 - [mkdir](function/mkdir.html)
27 - [remove](function/remove.html)
28
29 ## Methods
30
31 - [(constructor)](method/constructor.html)
32 - [find](method/find.html)
33 - [remove](method/remove.html)