Mercurial > irccd
diff doc/html/api/module/Irccd.File/Irccd.File.stat.md @ 263:48676ca7071c
Docs: use less hierarchy for less indexes
author | David Demelier <markand@malikania.fr> |
---|---|
date | Thu, 15 Sep 2016 13:16:05 +0200 |
parents | |
children | 186864e9f131 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/api/module/Irccd.File/Irccd.File.stat.md Thu Sep 15 13:16:05 2016 +0200 @@ -0,0 +1,33 @@ +--- +function: stat +js: true +summary: > + Get file information at the specified path. + + The returned object may have the following properties if they are available on your system: + + - **atime**: (int) the last access time, + - **blksize**: (int) the block size, + - **blocks**: (int) the number of blocks, + - **ctime**: (int) the creation time, + - **dev**: (int) the device, + - **gid**: (int) the group, + - **ino**: (int) the inode, + - **mode**: (int) the mode, + - **mtime**: (int) the modification time, + - **nlink**: (int) the number of hard links, + - **rdev**: (int), + - **size**: (int) the file size, + - **uid**: (int) the user. +synopsis: "info = Irccd.File.stat(path)" +arguments: + - "**path**: the path to the file." +returns: "The stat information." +throws: "An [Irccd.SystemError](@baseurl@/api/module/Irccd/index.html#types) on failures." +--- + +## Remarks + +<div class="alert alert-warning" role="alert"> +**Warning**: this function is optional and may not be available on your system. +</div>