Debian Codegraph @

upstream/debian-unstable/man3/sd_journal_get_usage.3

raw
1 '\" t
2 .TH "SD_JOURNAL_GET_USAGE" "3" "" "systemd 261~rc3" "sd_journal_get_usage"
3 .\" -----------------------------------------------------------------
4 .\" * Define some portability stuff
5 .\" -----------------------------------------------------------------
6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 .\" http://bugs.debian.org/507673
8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 .ie \n(.g .ds Aq \(aq
11 .el .ds Aq '
12 .\" -----------------------------------------------------------------
13 .\" * set default formatting
14 .\" -----------------------------------------------------------------
15 .\" disable hyphenation
16 .nh
17 .\" disable justification (adjust text to left margin only)
18 .ad l
19 .\" -----------------------------------------------------------------
20 .\" * MAIN CONTENT STARTS HERE *
21 .\" -----------------------------------------------------------------
22 .SH "NAME"
23 sd_journal_get_usage \- Journal disk usage
24 .SH "SYNOPSIS"
25 .sp
26 .ft B
27 .nf
28 #include <systemd/sd\-journal\&.h>
29 .fi
30 .ft
31 .HP \w'int\ sd_journal_get_usage('u
32 .BI "int sd_journal_get_usage(sd_journal\ *" "j" ", uint64_t\ *" "bytes" ");"
33 .SH "DESCRIPTION"
34 .PP
35 \fBsd_journal_get_usage()\fR
36 determines the total disk space currently used by journal files (in bytes)\&. If
37 \fBSD_JOURNAL_LOCAL_ONLY\fR
38 was passed when opening the journal, this value will only reflect the size of journal files of the local host, otherwise of all hosts\&.
39 .SH "RETURN VALUE"
40 .PP
41 \fBsd_journal_get_usage()\fR
42 returns 0 on success or a negative errno\-style error code\&.
43 .SH "NOTES"
44 .PP
45 All functions listed here are thread\-agnostic and only a single thread may operate on a given object at any given time\&. Different threads may access the same object at different times\&. Multiple independent objects may be used from different threads in parallel\&.
46 .PP
47 Functions described here are available as a shared library, which can be compiled against and linked to with the
48 \fBlibsystemd\fR\ \&\fBpkg-config\fR(1)
49 file\&.
50 .SH "HISTORY"
51 .PP
52 \fBsd_journal_get_usage()\fR
53 was added in version 190\&.
54 .SH "SEE ALSO"
55 .PP
56 \fBsystemd\fR(1), \fBsd-journal\fR(3), \fBsd_journal_open\fR(3)