[eba70158] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY accountsservice-download-http
|
---|
[8dfc5c3] | 8 | "https://www.freedesktop.org/software/accountsservice/accountsservice-&accountsservice-version;.tar.xz">
|
---|
[eba70158] | 9 | <!ENTITY accountsservice-download-ftp " ">
|
---|
[b751256] | 10 | <!ENTITY accountsservice-md5sum "03dccfe1b306b7ca19743e86d118e64d">
|
---|
| 11 | <!ENTITY accountsservice-size "621 KB">
|
---|
| 12 | <!ENTITY accountsservice-buildsize "9.8 MB (add 0.5 MB for tests)">
|
---|
| 13 | <!ENTITY accountsservice-time "less than 0.1 SBU (with tests)">
|
---|
[eba70158] | 14 | ]>
|
---|
| 15 |
|
---|
[51dfb3e] | 16 | <sect1 id="accountsservice" xreflabel="AccountsService-&accountsservice-version;">
|
---|
[eba70158] | 17 | <?dbhtml filename="accountsservice.html"?>
|
---|
| 18 |
|
---|
| 19 |
|
---|
| 20 | <title>AccountsService-&accountsservice-version;</title>
|
---|
| 21 |
|
---|
| 22 | <indexterm zone="accountsservice">
|
---|
| 23 | <primary sortas="a-AccountsService">AccountsService</primary>
|
---|
| 24 | </indexterm>
|
---|
| 25 |
|
---|
| 26 | <sect2 role="package">
|
---|
| 27 | <title>Introduction to AccountsService</title>
|
---|
| 28 |
|
---|
| 29 | <para>
|
---|
| 30 | The <application>AccountsService</application> package provides a
|
---|
| 31 | set of <application>D-Bus</application> interfaces for querying
|
---|
| 32 | and manipulating user account information and an implementation
|
---|
| 33 | of those interfaces based on the usermod(8), useradd(8) and
|
---|
| 34 | userdel(8) commands.
|
---|
| 35 | </para>
|
---|
| 36 |
|
---|
[172c283] | 37 | &lfs120_checked;
|
---|
[eba70158] | 38 |
|
---|
| 39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 40 | <itemizedlist spacing="compact">
|
---|
| 41 | <listitem>
|
---|
| 42 | <para>
|
---|
| 43 | Download (HTTP): <ulink url="&accountsservice-download-http;"/>
|
---|
| 44 | </para>
|
---|
| 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>
|
---|
| 48 | Download (FTP): <ulink url="&accountsservice-download-ftp;"/>
|
---|
| 49 | </para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>
|
---|
| 53 | Download MD5 sum: &accountsservice-md5sum;
|
---|
| 54 | </para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>
|
---|
| 58 | Download size: &accountsservice-size;
|
---|
| 59 | </para>
|
---|
| 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
| 62 | <para>
|
---|
| 63 | Estimated disk space required: &accountsservice-buildsize;
|
---|
| 64 | </para>
|
---|
| 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
| 67 | <para>
|
---|
| 68 | Estimated build time: &accountsservice-time;
|
---|
| 69 | </para>
|
---|
| 70 | </listitem>
|
---|
| 71 | </itemizedlist>
|
---|
| 72 |
|
---|
| 73 | <bridgehead renderas="sect3">AccountsService Dependencies</bridgehead>
|
---|
| 74 |
|
---|
| 75 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 76 | <para role="required">
|
---|
[51eb0bf] | 77 | <!--<xref linkend="libgcrypt"/> and-->
|
---|
[eba70158] | 78 | <xref linkend="polkit"/>
|
---|
| 79 | </para>
|
---|
| 80 |
|
---|
| 81 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 82 | <para role="recommended">
|
---|
[1996a17a] | 83 | <xref linkend="gobject-introspection"/>,
|
---|
[51dfb3e] | 84 | <phrase revision="sysv"><xref linkend="elogind"/></phrase>
|
---|
[0fab41a] | 85 | <phrase revision="systemd"><xref role='runtime' linkend="systemd"/>
|
---|
[1996a17a] | 86 | (runtime)</phrase>, and
|
---|
| 87 | <xref linkend="vala"/>
|
---|
[eba70158] | 88 | </para>
|
---|
| 89 |
|
---|
| 90 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 91 | <para role="optional">
|
---|
[a20845e7] | 92 | <xref linkend="gtk-doc"/> and
|
---|
[eba70158] | 93 | <xref linkend="xmlto"/>
|
---|
[1996a17a] | 94 | </para>
|
---|
| 95 |
|
---|
| 96 | <bridgehead renderas="sect4">Optional (for tests)</bridgehead>
|
---|
| 97 | <para role="optional">
|
---|
[e725e77] | 98 | <xref linkend="python-dbusmock"/> and
|
---|
| 99 | <xref linkend="pygobject3"/>
|
---|
[a20845e7] | 100 | <!-- I did not have gtk-doc installed this time, and it worked fine. -->
|
---|
[eba70158] | 101 | </para>
|
---|
| 102 |
|
---|
| 103 | </sect2>
|
---|
| 104 |
|
---|
| 105 | <sect2 role="installation">
|
---|
| 106 | <title>Installation of AccountsService</title>
|
---|
[b751256] | 107 |
|
---|
| 108 | <para>
|
---|
[211a019] | 109 | First, rename a directory whose presence prevents the build system from
|
---|
| 110 | running if <xref linkend="python-dbusmock"/> is not installed:
|
---|
| 111 | </para>
|
---|
| 112 |
|
---|
| 113 | <screen><userinput>mv tests/dbusmock{,-tests}</userinput></screen>
|
---|
| 114 |
|
---|
| 115 | <para>
|
---|
| 116 | Then fix the tests so that the new directory is found:
|
---|
| 117 | </para>
|
---|
| 118 |
|
---|
| 119 | <screen><userinput>sed -e '/accounts_service\.py/s/dbusmock/dbusmock-tests/' \
|
---|
| 120 | -i tests/test-libaccountsservice.py</userinput></screen>
|
---|
| 121 |
|
---|
| 122 | <para>
|
---|
| 123 | Fix one test that fails if the <option>en_IE.UTF-8</option> locale
|
---|
[b751256] | 124 | is not installed:
|
---|
[34623f0e] | 125 | </para>
|
---|
| 126 |
|
---|
[b751256] | 127 | <screen><userinput>sed -i '/^SIMULATED_SYSTEM_LOCALE/s/en_IE.UTF-8/en_HK.iso88591/' tests/test-daemon.py</userinput></screen>
|
---|
| 128 |
|
---|
[eba70158] | 129 | <para>
|
---|
| 130 | Install <application>AccountsService</application> by running the following
|
---|
| 131 | commands:
|
---|
| 132 | </para>
|
---|
| 133 |
|
---|
[51dfb3e] | 134 | <screen revision="sysv"><userinput>mkdir build &&
|
---|
[c89c282] | 135 | cd build &&
|
---|
[1575ce1] | 136 |
|
---|
[91318eb] | 137 | meson setup .. \
|
---|
| 138 | --prefix=/usr \
|
---|
| 139 | --buildtype=release \
|
---|
| 140 | -Dadmin_group=adm \
|
---|
| 141 | -Delogind=true \
|
---|
| 142 | -Dsystemdsystemunitdir=no &&
|
---|
[51dfb3e] | 143 | ninja</userinput></screen>
|
---|
| 144 |
|
---|
| 145 | <screen revision="systemd"><userinput>mkdir build &&
|
---|
[c89c282] | 146 | cd build &&
|
---|
[51dfb3e] | 147 |
|
---|
[91318eb] | 148 | meson setup .. \
|
---|
| 149 | --prefix=/usr \
|
---|
[20f070d8] | 150 | --buildtype=release \
|
---|
[91318eb] | 151 | -Dadmin_group=adm &&
|
---|
[a20845e7] | 152 | ninja</userinput></screen>
|
---|
[eba70158] | 153 |
|
---|
| 154 | <para>
|
---|
[b751256] | 155 | To test the package, issue <command>ninja test</command>.
|
---|
[eba70158] | 156 | </para>
|
---|
| 157 |
|
---|
| 158 | <para>
|
---|
| 159 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 160 | </para>
|
---|
| 161 |
|
---|
[a20845e7] | 162 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[eba70158] | 163 |
|
---|
| 164 | </sect2>
|
---|
| 165 |
|
---|
| 166 | <sect2 role="commands">
|
---|
| 167 | <title>Command Explanations</title>
|
---|
| 168 |
|
---|
[20f070d8] | 169 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 170 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
| 171 |
|
---|
[eba70158] | 172 | <para>
|
---|
[a20845e7] | 173 | <parameter>-Dadmin_group=adm</parameter>: This switch sets
|
---|
[eba70158] | 174 | the group for administrator accounts.
|
---|
| 175 | </para>
|
---|
| 176 |
|
---|
[9a363500] | 177 | <para>
|
---|
[a20845e7] | 178 | <option>-Ddocbook=true</option>: This switch enables building
|
---|
[1996a17a] | 179 | the D-Bus interface API documentation (needs <xref linkend="xmlto"/>).
|
---|
| 180 | </para>
|
---|
| 181 |
|
---|
| 182 | <para>
|
---|
| 183 | <option>-Dgtk_doc=true</option>: This switch enables building
|
---|
| 184 | the libaccountsservice API documentation (needs
|
---|
| 185 | <xref linkend="gtk-doc"/>).
|
---|
| 186 | </para>
|
---|
| 187 |
|
---|
| 188 | <para>
|
---|
| 189 | <option>-Dvapi=false</option>: This switch disables building
|
---|
| 190 | the vala bindings. Use it if you have not installed
|
---|
| 191 | <xref linkend="vala"/>.
|
---|
[9a363500] | 192 | </para>
|
---|
[20f070d8] | 193 |
|
---|
[eba70158] | 194 | </sect2>
|
---|
| 195 |
|
---|
| 196 | <sect2 role="configuration">
|
---|
| 197 | <title>Configuring AccountsService</title>
|
---|
| 198 |
|
---|
[4045ec3d] | 199 | <para>
|
---|
| 200 | To allow users in the adm group to be listed as Administrators,
|
---|
| 201 | execute the following commands as the
|
---|
| 202 | <systemitem class="username">root</systemitem> user:
|
---|
| 203 | </para>
|
---|
| 204 |
|
---|
| 205 | <screen role="root"><userinput>cat > /etc/polkit-1/rules.d/40-adm.rules << "EOF"
|
---|
| 206 | <literal>polkit.addAdminRule(function(action, subject) {
|
---|
| 207 | return ["unix-group:adm"];
|
---|
| 208 | });</literal>
|
---|
| 209 | EOF</userinput></screen>
|
---|
| 210 |
|
---|
[0c77adcb] | 211 | <sect3 id="accountsservice-init" revision="systemd">
|
---|
| 212 | <!-- <title><phrase revision="sysv">Boot Script</phrase>
|
---|
| 213 | <phrase revision="systemd">Systemd Units</phrase></title> -->
|
---|
| 214 | <title>Systemd Unit</title>
|
---|
[048aa04] | 215 | <!-- Automatically started by D-Bus when needed
|
---|
[51dfb3e] | 216 | <para revision="sysv">
|
---|
[eba70158] | 217 | To start the <command>accounts-daemon</command> daemon at boot,
|
---|
[51dfb3e] | 218 | install the
|
---|
| 219 | <filename>/etc/rc.d/init.d/accounts-daemon</filename> init script from
|
---|
| 220 | the <xref linkend="bootscripts"/> package
|
---|
| 221 | by running the following command as the
|
---|
| 222 | <systemitem class="username">root</systemitem> user:
|
---|
| 223 | </para>
|
---|
[048aa04] | 224 |
|
---|
| 225 | <screen role="root" revision="sysv"><userinput>make install-accounts-daemon</userinput></screen>
|
---|
[0c77adcb] | 226 | -->
|
---|
[048aa04] | 227 | <para>
|
---|
[51dfb3e] | 228 | To start the <command>accounts-daemon</command> daemon at boot,
|
---|
[4e207bb] | 229 | enable the previously installed systemd unit
|
---|
[51dfb3e] | 230 | by running the following command as the
|
---|
[eba70158] | 231 | <systemitem class="username">root</systemitem> user:
|
---|
| 232 | </para>
|
---|
| 233 |
|
---|
| 234 | <indexterm zone="accountsservice accountsservice-init">
|
---|
| 235 | <primary sortas="f-accounts-daemon">accounts-daemon</primary>
|
---|
| 236 | </indexterm>
|
---|
| 237 |
|
---|
[048aa04] | 238 | <screen role="root"><userinput>systemctl enable accounts-daemon</userinput></screen>
|
---|
[eba70158] | 239 |
|
---|
| 240 | </sect3>
|
---|
| 241 |
|
---|
| 242 | </sect2>
|
---|
| 243 |
|
---|
| 244 | <sect2 role="content">
|
---|
| 245 | <title>Contents</title>
|
---|
| 246 |
|
---|
| 247 | <segmentedlist>
|
---|
| 248 | <segtitle>Installed Programs</segtitle>
|
---|
| 249 | <segtitle>Installed Libraries</segtitle>
|
---|
| 250 | <segtitle>Installed Directories</segtitle>
|
---|
| 251 |
|
---|
| 252 | <seglistitem>
|
---|
| 253 | <seg>
|
---|
[048aa04] | 254 | accounts-daemon (in
|
---|
| 255 | <filename class="directory">/usr/libexec</filename>)
|
---|
[eba70158] | 256 | </seg>
|
---|
| 257 | <seg>
|
---|
| 258 | libaccountsservice.so
|
---|
| 259 | </seg>
|
---|
| 260 | <seg>
|
---|
| 261 | /usr/include/accountsservice-1.0,
|
---|
[048aa04] | 262 | /usr/share/accountsservice,
|
---|
| 263 | /usr/share/gtk-doc/html/libaccountsservice (optional), and
|
---|
[eba70158] | 264 | /var/lib/AccountsService
|
---|
| 265 | </seg>
|
---|
| 266 | </seglistitem>
|
---|
| 267 | </segmentedlist>
|
---|
| 268 |
|
---|
| 269 | <variablelist>
|
---|
| 270 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 271 | <?dbfo list-presentation="list"?>
|
---|
| 272 | <?dbhtml list-presentation="table"?>
|
---|
| 273 |
|
---|
| 274 | <varlistentry id="accounts-daemon">
|
---|
| 275 | <term><command>accounts-daemon</command></term>
|
---|
| 276 | <listitem>
|
---|
| 277 | <para>
|
---|
[4c24eb0a] | 278 | is the <application>AccountsService</application> daemon
|
---|
[eba70158] | 279 | </para>
|
---|
| 280 | <indexterm zone="accountsservice accounts-daemon">
|
---|
| 281 | <primary sortas="b-accounts-daemon">accounts-daemon</primary>
|
---|
| 282 | </indexterm>
|
---|
| 283 | </listitem>
|
---|
| 284 | </varlistentry>
|
---|
| 285 |
|
---|
| 286 | <varlistentry id="libaccountsservice">
|
---|
| 287 | <term><filename class="libraryfile">libaccountsservice.so</filename></term>
|
---|
| 288 | <listitem>
|
---|
| 289 | <para>
|
---|
[4c24eb0a] | 290 | contains the <application>AccountsService</application> API functions
|
---|
[eba70158] | 291 | </para>
|
---|
| 292 | <indexterm zone="accountsservice libaccountsservice">
|
---|
| 293 | <primary sortas="c-libaccountsservice">libaccountsservice.so</primary>
|
---|
| 294 | </indexterm>
|
---|
| 295 | </listitem>
|
---|
| 296 | </varlistentry>
|
---|
| 297 |
|
---|
| 298 | </variablelist>
|
---|
| 299 |
|
---|
| 300 | </sect2>
|
---|
| 301 |
|
---|
| 302 | </sect1>
|
---|