Mercurial > irccd
annotate man/irccd-api-chrono.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:
1002
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-CHRONO 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.Chrono |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
22 .Nd irccd chrono 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 .Fn Irccd.Chrono |
1002
ec5461750efd
man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents:
996
diff
changeset
|
26 .Vt Irccd.Chrono.prototype.elapsed |
996 | 27 .Fn Irccd.Chrono.prototype.reset |
932
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
28 .\" DESCRIPTION |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
29 .Sh DESCRIPTION |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
30 This module keeps track of elapsed time. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
31 .\" METHODS |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
32 .Sh METHODS |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
33 .\" Irccd.Chrono |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
34 The |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
35 .Fn Irccd.Chrono |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
36 constructor function creates a chrono object at the current time. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
37 .Pp |
996 | 38 When constructed successfully, the object has the following properties: |
932
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
39 .Pp |
996 | 40 .Bl -tag -width 18n -offset indent -compact |
41 .It Va elapsed No (int) | |
42 Return the number of milliseconds since creation or last call to | |
43 .El | |
44 .Pp | |
45 .\" Irccd.Chrono.prototype.reset | |
932
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
46 The |
996 | 47 .Fn Irccd.Chrono.prototype.reset |
932
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
48 method starts or restarts accumulating time. |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
49 .\" SEE ALSO |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
50 .Sh SEE ALSO |
0e11221c9bcc
man: split irccd-api into individual ones
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
51 .Xr irccd-api 3 |