<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
               "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"
[<!ENTITY version SYSTEM "../version.xml">]>
<refentry id="udisks2.conf.5">
  <refentryinfo>
    <title>udisks2.conf</title>
    <date>August 2018</date>
    <productname>udisks</productname>
  </refentryinfo>

  <refmeta>
    <refentrytitle>udisks2.conf</refentrytitle>
    <manvolnum>5</manvolnum>
    <refmiscinfo class="manual">UDisks Daemon Configuration</refmiscinfo>
    <refmiscinfo class="source">udisks2.conf</refmiscinfo>
    <refmiscinfo class="version">&version;</refmiscinfo>
  </refmeta>

  <refnamediv>
    <refname>udisks2.conf</refname>
    <refpurpose>The udisks2 configuration file</refpurpose>
  </refnamediv>

  <refsect1>
    <title>DESCRIPTION</title>
    <para>
      The udisks project provides additional functionality via pluggable
      modules. These plugins can be inserted into the daemon either by D-Bus
      call <function>org.freedesktop.UDisks2.Manager.EnableModules()</function>
      or by running the udisks daemon with
      <option>--force-load-modules</option> command line option.
    </para>

    <para>
      It is also possible to configure the modules loading behavior via
      the configuration file placed at
      <emphasis>@sysconfdir@/udisks2/udisks2.conf</emphasis>.
    </para>
  </refsect1>

  <refsect1>
    <title>CONFIGURATION FILE</title>
    <para>
      The default configuration file <emphasis
      role="bold">udisks2.conf</emphasis> looks like this:
    </para>

    <programlisting>
    [udisks2]
    modules=*
    modules_load_preference=ondemand

    [defaults]
    encryption=luks1
    </programlisting>

    <para>
      <variablelist>
        <varlistentry>
          <term><option>modules = &lt;string list&gt;</option></term>
          <para>
            This variable controls what modules should be loaded. It may
            contain either a comma-separated list of modules to load or a
            single asterisk which stands for all the modules.
          </para>
        </varlistentry>

        <varlistentry>
          <term><option>modules_load_preference = ondemand|onstartup</option></term>
          <para>
            This key tells udisksd when to load the plugins: either at startup
            or on demand by D-Bus
            <function>org.freedesktop.UDisks2.Manager.EnableModules()</function>.
          </para>
        </varlistentry>

        <varlistentry>
          <term><option>encryption = luks1|luks2</option></term>
          <para>
            This variable controls which encryption technology will be used
            by default when creating an encrypted filesystem.
          </para>
        </varlistentry>
      </variablelist>
    </para>
  </refsect1>

  <refsect1>
    <title>AUTHOR</title>
    <para>
      <email><![CDATA[phatina@redhat.com]]></email>
    </para>
  </refsect1>

  <refsect1>
    <title>BUGS</title>
    <para>
      Please send bug reports to either the distribution bug tracker
      or the upstream bug tracker at
      <ulink url="https://github.com/storaged-project/udisks/issues"/>.
    </para>
  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>
    <para>
      <link linkend="udisks.8"><citerefentry><refentrytitle>udisks</refentrytitle><manvolnum>8</manvolnum></citerefentry></link>,
      <link linkend="udisksctl.1"><citerefentry><refentrytitle>udisksctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></link>,
      <link linkend="umount.udisks2.8"><citerefentry><refentrytitle>umount.udisks2</refentrytitle><manvolnum>8</manvolnum></citerefentry></link>
    </para>
  </refsect1>
</refentry>
