blackbeard420/notcurses
1
0
Fork 0
mirror of https://github.com/dankamongmen/notcurses synced 2025-03-09 09:09:03 -04:00
Code Issues Projects Releases Wiki Activity

[notcurses_input.3] update to specify CLOCK_MONOTONIC

Browse Source
This commit is contained in:
nick black 2021-10-26 09:59:33 -04:00
parent b9c4d359af
commit 95f659d62b
No known key found for this signature in database
GPG Key ID: 5F43400C21CBFACC
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/man/man3/notcurses_input.3.md
View File

@ -71,10 +71,10 @@ to fill whenever it reads.
**notcurses_get** allows a **struct timespec** to be specified as a timeout.
If **ts** is **NULL**, **notcurses_get** will block until it reads input, or
is interrupted by a signal. If its values are zeroes, there will be no blocking.
Otherwise, **ts** specifies an absolute deadline (using the same source and
timezone as **gettimeofday(2)**). On timeout, 0 is returned. Event
details will be reported in **ni**, unless **ni** is NULL.
is interrupted by a signal. If its values are zeroes, there will be no
blocking. Otherwise, **ts** specifies an absolute deadline (taken against
**CLOCK_MONOTONIC**; see **clock_gettime(2)**). On timeout, 0 is returned.
Event details will be reported in **ni**, unless **ni** is NULL.
**notcurses_inputready_fd** provides a file descriptor suitable for use with
I/O multiplexors such as **poll(2)**. This file descriptor might or might not
@ -195,9 +195,12 @@ Mouse events in the top and left margins will never be delivered to the
application (as is intended), but mouse events in the bottom and right margins
sometimes can be if the event occurs prior to a window resize.
On some operating systems, **CLOCK_REALTIME** is used as the basis for
timeouts instead of **CLOCK_MONOTONIC**. This ought be fixed.
# SEE ALSO
**gettimeofday(2)**,
**clock_gettime(2)**,
**poll(2)**,
**notcurses(3)**,
**notcurses_refresh(3)**,