source: gnome/core/polkit-gnome.xml@ 808c12f

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY polkit-gnome-download-http "&gnome-download-http;/polkit-gnome/&polkit-gnome-version;/polkit-gnome-&polkit-gnome-version;.tar.xz">
  <!ENTITY polkit-gnome-download-ftp "&gnome-download-ftp;/polkit-gnome/&polkit-gnome-version;/polkit-gnome-&polkit-gnome-version;.tar.xz">
  <!ENTITY polkit-gnome-md5sum        "e1188c42fb61ec4ab3b26dde59145bca">
  <!ENTITY polkit-gnome-size          "305 KB">
  <!ENTITY polkit-gnome-buildsize     "4.5 MB">
  <!ENTITY polkit-gnome-time          "less than 0.1 SBU">
]>

<sect1 id="polkit-gnome" xreflabel="polkit-gnome-&polkit-gnome-version;">
  <?dbhtml filename="polkit-gnome.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>polkit-gnome-&polkit-gnome-version;</title>

  <indexterm zone="polkit-gnome">
    <primary sortas="a-polkit-gnome">polkit-gnome</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to polkit-gnome</title>

    <para>The <application>polkit-gnome</application> package provides an
    Authentication Agent for <application>polkit</application> that integrates
    well with the <application>GNOME</application> desktop environment.</para>

    &lfs70_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&polkit-gnome-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&polkit-gnome-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &polkit-gnome-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &polkit-gnome-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &polkit-gnome-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &polkit-gnome-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">polkit-gnome Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="gtk3"/> and
    <xref linkend="polkit"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="gtk-doc"/></para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/polkit-gnome"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of polkit-gnome</title>

    <para>Install <application>polkit-gnome</application> by running the following
    commands:</para>

<screen><userinput>./configure --prefix=/usr \
    --libexecdir=/usr/lib/polkit-gnome &amp;&amp;
make</userinput></screen>

    <!-- technically, it does, but it only checks the xml translations -->
    <para>This package does not come with a test suite.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="../../xincludes/gtk-doc-rebuild.xml"/>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring polkit-gnome</title>

    <sect3 id="polkit-gnome-config">

      <title>Config Files</title>

      <para><filename>none</filename></para>

    </sect3>

    <sect3>

      <title>Automatic startup</title>

      <para>For <application>polkit-gnome</application> to work correctly, 
      it needs to be started on user logon.</para>

      <para>Issue the following commands as the 
      <systemitem class="username">root</systemitem>user to create 
      startup file for <application>polkit-gnome</application>:</para>

<screen role="root"><userinput>mkdir -p /etc/xdg/autostart &amp;&amp;
cat &gt; /etc/xdg/autostart/polkit-gnome-authentication-agent-1.desktop &lt;&lt; "EOF"
<literal>[Desktop Entry]
Name=PolicyKit Authentication Agent
Comment=PolicyKit Authentication Agent
Exec=/usr/lib/polkit-gnome/polkit-gnome-authentication-agent-1
Terminal=false
Type=Application
Categories=
NoDisplay=true
OnlyShowIn=GNOME;XFCE;Unity;
AutostartCondition=GNOME3 unless-session gnome</literal>
EOF</userinput></screen>

    </sect3>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>polkit-gnome-authentication-agent-1</seg>
        <seg>none</seg>
        <seg>/usr/lib/polkit-gnome</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="polkit-gnome-authentication-agent-1">
        <term><command>polkit-gnome-authentication-agent-1</command></term>
        <listitem>
          <para>is the polkit-gnome authentication agent.</para>
          <indexterm zone="polkit-gnome polkit-gnome-authentication-agent-1">
            <primary
            sortas="b-polkit-gnome-authentication-agent-1">polkit-gnome-authentication-agent-1</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>