man/sd_journal_get_usage.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3         "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <!--
   6   This file is part of systemd.
   7
   8   Copyright 2012 Lennart Poettering
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  13   (at your option) any later version.
  14
  15   systemd is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 -->
  23
  24 <refentry id="sd_journal_get_usage">
  25
  26         <refentryinfo>
  27                 <title>sd_journal_get_usage</title>
  28                 <productname>systemd</productname>
  29
  30                 <authorgroup>
  31                         <author>
  32                                 <contrib>Developer</contrib>
  33                                 <firstname>Lennart</firstname>
  34                                 <surname>Poettering</surname>
  35                                 <email>lennart@poettering.net</email>
  36                         </author>
  37                 </authorgroup>
  38         </refentryinfo>
  39
  40         <refmeta>
  41                 <refentrytitle>sd_journal_get_usage</refentrytitle>
  42                 <manvolnum>3</manvolnum>
  43         </refmeta>
  44
  45         <refnamediv>
  46                 <refname>sd_journal_get_usage</refname>
  47                 <refpurpose>Journal disk usage</refpurpose>
  48         </refnamediv>
  49
  50         <refsynopsisdiv>
  51                 <funcsynopsis>
  52                         <funcsynopsisinfo>#include &lt;systemd/sd-journal.h&gt;</funcsynopsisinfo>
  53
  54                         <funcprototype>
  55                                 <funcdef>int <function>sd_journal_get_usage</function></funcdef>
  56                                 <paramdef>sd_journal* <parameter>j</parameter></paramdef>
  57                                 <paramdef>uint64_t* <parameter>bytes</parameter></paramdef>
  58                         </funcprototype>
  59
  60                 </funcsynopsis>
  61         </refsynopsisdiv>
  62
  63         <refsect1>
  64                 <title>Description</title>
  65
  66                 <para><function>sd_journal_get_usage()</function>
  67                 determines the total disk space currently used up by
  68                 journal files. If
  69                 <literal>SD_JOURNAL_LOCAL_ONLY</literal> has been
  70                 passed when opening the journal files this value will
  71                 only reflect the size of journal files of the local
  72                 host, otherwise of all hosts.</para>
  73         </refsect1>
  74
  75         <refsect1>
  76                 <title>Return Value</title>
  77
  78                 <para><function>sd_journal_get_usage()</function>
  79                 returns 0 on success or a negative errno-style error
  80                 code.</para>
  81         </refsect1>
  82
  83         <refsect1>
  84                 <title>Notes</title>
  85
  86                 <para>The <function>sd_journal_get_usage()</function>
  87                 interface is available as shared library, which can be
  88                 compiled and linked to with the
  89                 <literal>libsystemd-journal</literal>
  90                 <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
  91                 file.</para>
  92         </refsect1>
  93
  94         <refsect1>
  95                 <title>See Also</title>
  96
  97                 <para>
  98                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  99                         <citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 100                         <citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 101                 </para>
 102         </refsect1>
 103
 104 </refentry>