Mercurial > irccd
annotate man/irccd-api-file.3 @ 1091:52be05336310
irccdctl: misc cleanups
author | David Demelier <markand@malikania.fr> |
---|---|
date | Wed, 21 Jul 2021 16:06:36 +0200 |
parents | cf99df45cb84 |
children | f06e9761cc90 |
rev | line source |
---|---|
932
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
1 .\" |
1018
cf99df45cb84
misc: update copyright years
David Demelier <markand@malikania.fr>
parents:
996
diff
changeset
|
2 .\" Copyright (c) 2013-2021 David Demelier <markand@malikania.fr> |
932
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
3 .\" |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
4 .\" Permission to use, copy, modify, and/or distribute this software for any |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
5 .\" purpose with or without fee is hereby granted, provided that the above |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
6 .\" copyright notice and this permission notice appear in all copies. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
7 .\" |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
15 .\" |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
16 .Dd @IRCCD_MAN_DATE@ |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
17 .Dt IRCCD-API-FILE 3 |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
18 .Os |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
19 .\" NAME |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
20 .Sh NAME |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
21 .Nm Irccd.File |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
22 .Nd file I/O API |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
23 .\" SYNOPSIS |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
24 .Sh SYNOPSIS |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
25 .Vt Irccd.File.SeekCur |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
26 .Vt Irccd.File.SeekEnd |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
27 .Vt Irccd.File.SeekSet |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
28 .Fn Irccd.File.basename "path" |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
29 .Fn Irccd.File.dirname "path" |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
30 .Fn Irccd.File.exists "path" |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
31 .Fn Irccd.File.remove "path" |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
32 .Fn Irccd.File.stat "path" |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
33 .Fn Irccd.File "path, mode" |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
34 .Fn Irccd.File.prototype.basename |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
35 .Fn Irccd.File.prototype.close |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
36 .Fn Irccd.File.prototype.dirname |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
37 .Fn Irccd.File.prototype.lines |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
38 .Fn Irccd.File.prototype.read "amount = undefined" |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
39 .Fn Irccd.File.prototype.readline |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
40 .Fn Irccd.File.prototype.remove |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
41 .Fn Irccd.File.prototype.seek "type, amount" |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
42 .Fn Irccd.File.prototype.stat |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
43 .Fn Irccd.File.prototype.tell |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
44 .Fn Irccd.File.prototype.write "data" |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
45 .\" DESCRIPTION |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
46 .Sh DESCRIPTION |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
47 This module provides routines for opening and writing files on the disk. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
48 .Pp |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
49 For convenience, some functions are available as static functions and some as |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
50 object methods. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
51 .\" CONSTANTS |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
52 .Sh CONSTANTS |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
53 The following constants properties are defined: |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
54 .Pp |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
55 .Bl -tag |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
56 .It Va Irccd.File.SeekCur No (int) |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
57 Seek from the current file position. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
58 .It Va Irccd.File.SeekEnd No (int) |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
59 Seek from end of the file. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
60 .It Va Irccd.File.SeekSet No (int) |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
61 Seek from beginning of the file. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
62 .El |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
63 .\" METHODS |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
64 .Sh METHODS |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
65 .\" Irccd.File.basename |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
66 The |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
67 .Fn Irccd.File.basename |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
68 method returns the file basename from |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
69 .Fa path |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
70 as specified in |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
71 .Xr basename 3 |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
72 POSIX function. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
73 .Pp |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
74 .\" Irccd.File.dirname |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
75 The |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
76 .Fn Irccd.File.dirname |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
77 method returns the file directory name from |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
78 .Fa path |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
79 as specified in |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
80 .Xr dirname 3 |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
81 POSIX function. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
82 .Pp |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
83 .\" Irccd.File.exists |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
84 The |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
85 .Fn Irccd.File.exists |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
86 method checks if the file specified by |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
87 .Fa path |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
88 exists and returns true to indicate success. Warning: using this function is |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
89 usually discouraged as it may introduce a possible race condition. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
90 .Pp |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
91 .\" Irccd.File.remove |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
92 The |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
93 .Fn Irccd.File.remove |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
94 method removes the file at the given |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
95 .Fa path . |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
96 .Pp |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
97 .\" Irccd.File.stat |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
98 The optional |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
99 .Fn Irccd.File.stat |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
100 method returns information from the file at the specified |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
101 .Fa path . |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
102 The returned object has the following properties. Not all properties are |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
103 available and you must check its presence before using it. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
104 .Pp |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
105 .Bl -tag -width 20n -compact -offset Ds |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
106 .It Va atime No (int) |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
107 The last access time. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
108 .It Va blksize No (int) |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
109 The block size. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
110 .It Va blocks No (int) |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
111 The number of blocks. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
112 .It Va ctime No (int) |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
113 The creation time. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
114 .It Va dev No (int) |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
115 The device. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
116 .It Va gid No (int) |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
117 The group numeric id. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
118 .It Va ino No (int) |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
119 The inode. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
120 .It Va mode No (int) |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
121 The mode. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
122 .It Va mtime No (int) |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
123 The modification time. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
124 .It Va nlink No (int) |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
125 The number of hard links. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
126 .It Va rdev No (int) |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
127 No description available. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
128 .It Va size No (int) |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
129 The file size. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
130 .It Va uid No (int) |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
131 The user numeric id. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
132 .El |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
133 .Pp |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
134 .\" Irccd.File |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
135 The |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
136 .Fn Irccd.File |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
137 function constructor opens a file specified by |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
138 .Fa path |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
139 with the specified |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
140 .Fa mode |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
141 similar to |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
142 .Xr fopen 3 |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
143 C standard function. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
144 .Pp |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
145 .\" Irccd.File.prototype.basename |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
146 The |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
147 .Fn Irccd.File.prototype.basename |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
148 method is the synonym of |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
149 .Fn Irccd.File.basename |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
150 method but the path is taken from the file object. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
151 .Pp |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
152 .\" Irccd.File.prototype.close |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
153 The |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
154 .Fn Irccd.File.prototype.close |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
155 method closes the file. It is usually not required as already closed in the |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
156 destructor. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
157 .Pp |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
158 .\" Irccd.File.prototype.dirname |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
159 The |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
160 .Fn Irccd.File.prototype.dirname |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
161 method is the synonym of |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
162 .Fn Irccd.File.dirname |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
163 method but the path is taken from the file object. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
164 .Pp |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
165 .\" Irccd.File.prototype.lines |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
166 The |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
167 .Fn Irccd.File.prototype.lines |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
168 method reads all lines and return an array. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
169 .Pp |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
170 .\" Irccd.File.prototype.read |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
171 The |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
172 .Fn Irccd.File.prototype.read |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
173 method reads the specified |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
174 .Fa amount |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
175 of characters or the whole file if undefined. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
176 .Pp |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
177 .\" Irccd.File.prototype.readline |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
178 The |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
179 .Fn Irccd.File.prototype.readline |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
180 method reads the next line available and returns it. If EOF was reached, |
996 | 181 returns undefined. |
932
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
182 .Pp |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
183 .\" Irccd.File.prototype.remove |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
184 The |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
185 .Fn Irccd.File.prototype.remove |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
186 method is the synonym of |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
187 .Fn Irccd.File.remove |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
188 method but the path is taken from the file object. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
189 .Pp |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
190 .\" Irccd.File.prototype.seek |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
191 The |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
192 .Fn Irccd.File.prototype.seek |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
193 method sets the position in the file to the position |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
194 .Fa amount . |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
195 The type argument must be one of |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
196 .Vt Irccd.File.SeekCur , Irccd.File.SeekEnd |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
197 or |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
198 .Vt Irccd.File.SeekSet . |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
199 .Pp |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
200 .\" Irccd.File.prototype.stat |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
201 The optional |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
202 .Fn Irccd.File.prototype.stat |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
203 method is the synonym of |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
204 .Fn Irccd.File.stat |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
205 method but the path is taken from the file object. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
206 .Pp |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
207 .\" Irccd.File.prototype.tell |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
208 The |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
209 .Fn Irccd.File.prototype.tell |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
210 methods returns the current position in the file. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
211 .Pp |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
212 .\" Irccd.File.prototype.write |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
213 The |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
214 .Fn Irccd.File.prototype.write |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
215 method writes the string |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
216 .Fa data |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
217 to the file. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
218 .Pp |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
219 .\" EXCEPTIONS |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
220 .Sh EXCEPTIONS |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
221 .Bl -tag -width 20n |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
222 .It Bq Er Irccd.SystemError |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
223 On I/O errors. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
224 .It Bq Er Error |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
225 On other errors. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
226 .El |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
227 .\" SEE ALSO |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
228 .Sh SEE ALSO |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
229 .Xr irccd-api 3 |