X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsd_journal_get_fd.xml;h=3aa79ce100874a130913ec864d8ad5cce666abd6;hb=25b47f96d9601ff566257b2a31bfb5f4bd25d661;hp=33d2980b3b45390d495c79833029babcfa1b6fff;hpb=39c155ea0d8b24895017fd5cf48508924ce2016d;p=elogind.git
diff --git a/man/sd_journal_get_fd.xml b/man/sd_journal_get_fd.xml
index 33d2980b3..3aa79ce10 100644
--- a/man/sd_journal_get_fd.xml
+++ b/man/sd_journal_get_fd.xml
@@ -62,34 +62,34 @@
int sd_journal_get_fd
- sd_journal* j
+ sd_journal *j
int sd_journal_get_events
- sd_journal* j
+ sd_journal *j
int sd_journal_get_timeout
- sd_journal* j
- uint64_t* timeout_usec
+ sd_journal *j
+ uint64_t *timeout_usec
int sd_journal_process
- sd_journal* j
+ sd_journal *j
int sd_journal_wait
- sd_journal* j
+ sd_journal *j
uint64_t timeout_usec
int sd_journal_reliable_fd
- sd_journal* j
+ sd_journal *j
@@ -123,22 +123,28 @@
sd_journal_get_events()
will return the poll() mask to
wait for. This function will return a combination of
- POLLIN and
- POLLOUT and similar to fill into
+ POLLIN and
+ POLLOUT and similar to fill into
the .events field of
- struct pollfd.
+ struct pollfd.
sd_journal_get_timeout()
- will return a timeout value for usage in poll(). This returns a value in microseconds since the epoch of CLOCK_MONOTONIC for timing out poll() in timeout_usec. See
+ will return a timeout value for usage in
+ poll(). This returns a value in
+ microseconds since the epoch of
+ CLOCK_MONOTONIC for timing out
+ poll() in
+ timeout_usec. See
clock_gettime2
for details about
- CLOCK_MONOTONIC. If there's no
- timeout to wait for this will fill in
- (uint64_t) -1 instead. Note that
+ CLOCK_MONOTONIC. If there is no
+ timeout to wait for, this will fill in
+ (uint64_t) -1 instead. Note that
poll() takes a relative timeout
in milliseconds rather than an absolute timeout in
- microseconds. To convert the absolute 'us' timeout into
- relative 'ms', use code like the following:
+ microseconds. To convert the absolute 'us' timeout
+ into relative 'ms', use code like the
+ following:
uint64_t t;
int msec;
@@ -154,7 +160,7 @@ else {
}
The code above does not do any error checking
- for brevity's sake. The calculated msec
+ for brevity's sake. The calculated msec
integer can be passed directly as
poll()'s timeout
parameter.
@@ -174,7 +180,7 @@ else {
synchronously wait until the journal gets changed. The
maximum time this call sleeps may be controlled with
the timeout_usec
- parameter. Pass (uint64_t) -1 to
+ parameter. Pass (uint64_t) -1 to
wait indefinitely. Internally this call simply
combines sd_journal_get_fd(),
sd_journal_get_events(),
@@ -209,8 +215,8 @@ else {
errno-style error code.
sd_journal_get_events()
- returns a combination of POLLIN,
- POLLOUT and suchlike on success or
+ returns a combination of POLLIN,
+ POLLOUT and suchlike on success or
a negative errno-style error code.
sd_journal_reliable_fd()
@@ -222,19 +228,19 @@ else {
sd_journal_process() and
sd_journal_wait() return one of
- SD_JOURNAL_NOP,
- SD_JOURNAL_APPEND or
- SD_JOURNAL_INVALIDATE on success or
+ SD_JOURNAL_NOP,
+ SD_JOURNAL_APPEND or
+ SD_JOURNAL_INVALIDATE on success or
a negative errno-style error code. If
- SD_JOURNAL_NOP is returned the
- journal didn't change since the last invocation. If
- SD_JOURNAL_APPEND is returned new
+ SD_JOURNAL_NOP is returned, the
+ journal did not change since the last invocation. If
+ SD_JOURNAL_APPEND is returned, new
entries have been appended to the end of the
- journal. If SD_JOURNAL_INVALIDATE
+ journal. If SD_JOURNAL_INVALIDATE,
journal files were added or removed (possibly due to
- rotation). In the latter event live-view UIs should
- probably refresh their entire display while in the
- case of SD_JOURNAL_APPEND it is
+ rotation). In the latter event, live-view UIs should
+ probably refresh their entire display, while in the
+ case of SD_JOURNAL_APPEND, it is
sufficient to simply continue reading at the previous
end of the journal.
@@ -247,10 +253,9 @@ else {
sd_journal_reliable_fd(),
sd_journal_process() and
sd_journal_wait() interfaces are
- available as shared library, which can be compiled and
+ available as a shared library, which can be compiled and
linked to with the
- libsystemd-journal
- pkg-config1
+ libsystemd pkg-config1
file.
@@ -325,8 +330,7 @@ int wait_for_changes(sd_journal *j) {
pollfd.events = sd_journal_get_events(j);
poll(&pollfd, 1, msec);
return sd_journal_process(j);
-}
-
+}