HALF ECHO LEARN / REFERENCE COLLECTION

v262.2

man/sd_journal_get_usage.xml

2,459 bytesGit mode 100644Download original fileLGPL-2.1-or-later

Git blob: c849d79becd41943e725ad09f29faee448cf944c

Lines 1–77 of 77

<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
 
<refentry id="sd_journal_get_usage" xmlns:xi="http://www.w3.org/2001/XInclude">
 
  <refentryinfo>
    <title>sd_journal_get_usage</title>
    <productname>systemd</productname>
  </refentryinfo>
 
  <refmeta>
    <refentrytitle>sd_journal_get_usage</refentrytitle>
    <manvolnum>3</manvolnum>
  </refmeta>
 
  <refnamediv>
    <refname>sd_journal_get_usage</refname>
    <refpurpose>Journal disk usage</refpurpose>
  </refnamediv>
 
  <refsynopsisdiv>
    <funcsynopsis>
      <funcsynopsisinfo>#include &lt;systemd/sd-journal.h&gt;</funcsynopsisinfo>
 
      <funcprototype>
        <funcdef>int <function>sd_journal_get_usage</function></funcdef>
        <paramdef>sd_journal *<parameter>j</parameter></paramdef>
        <paramdef>uint64_t *<parameter>bytes</parameter></paramdef>
      </funcprototype>
 
    </funcsynopsis>
  </refsynopsisdiv>
 
  <refsect1>
    <title>Description</title>
 
    <para><function>sd_journal_get_usage()</function> determines the
    total disk space currently used by journal files (in bytes). If
    <constant>SD_JOURNAL_LOCAL_ONLY</constant> was passed when opening
    the journal, this value will only reflect the size of journal
    files of the local host, otherwise of all hosts.</para>
  </refsect1>
 
  <refsect1>
    <title>Return Value</title>
 
    <para><function>sd_journal_get_usage()</function> returns 0 on
    success or a negative errno-style error code.</para>
  </refsect1>
 
  <refsect1>
    <title>Notes</title>
 
    <xi:include href="threads-aware.xml" xpointer="strict"/>
 
    <xi:include href="libsystemd-pkgconfig.xml" xpointer="pkgconfig-text"/>
  </refsect1>
 
  <refsect1>
    <title>History</title>
    <para><function>sd_journal_get_usage()</function> was added in version 190.</para>
  </refsect1>
 
  <refsect1>
    <title>See Also</title>
 
    <para><simplelist type="inline">
      <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
      <member><citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member>
      <member><citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry></member>
    </simplelist></para>
  </refsect1>
 
</refentry>