[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[eba70158] | 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
|
---|
[23b54336] | 33 | of those interfaces based on the
|
---|
| 34 | <ulink role='man' url='&man;usermod.8'>usermod(8)</ulink>,
|
---|
| 35 | <ulink role='man' url='&man;useradd.8'>useradd(8)</ulink>, and
|
---|
| 36 | <ulink role='man' url='&man;userdel.8'>userdel(8)</ulink> commands.
|
---|
[eba70158] | 37 | </para>
|
---|
| 38 |
|
---|
[42f164e] | 39 | &lfs122_checked;
|
---|
[eba70158] | 40 |
|
---|
| 41 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 42 | <itemizedlist spacing="compact">
|
---|
| 43 | <listitem>
|
---|
| 44 | <para>
|
---|
| 45 | Download (HTTP): <ulink url="&accountsservice-download-http;"/>
|
---|
| 46 | </para>
|
---|
| 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
| 49 | <para>
|
---|
| 50 | Download (FTP): <ulink url="&accountsservice-download-ftp;"/>
|
---|
| 51 | </para>
|
---|
| 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
| 54 | <para>
|
---|
| 55 | Download MD5 sum: &accountsservice-md5sum;
|
---|
| 56 | </para>
|
---|
| 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
| 59 | <para>
|
---|
| 60 | Download size: &accountsservice-size;
|
---|
| 61 | </para>
|
---|
| 62 | </listitem>
|
---|
| 63 | <listitem>
|
---|
| 64 | <para>
|
---|
| 65 | Estimated disk space required: &accountsservice-buildsize;
|
---|
| 66 | </para>
|
---|
| 67 | </listitem>
|
---|
| 68 | <listitem>
|
---|
| 69 | <para>
|
---|
| 70 | Estimated build time: &accountsservice-time;
|
---|
| 71 | </para>
|
---|
| 72 | </listitem>
|
---|
| 73 | </itemizedlist>
|
---|
| 74 |
|
---|
| 75 | <bridgehead renderas="sect3">AccountsService Dependencies</bridgehead>
|
---|
| 76 |
|
---|
| 77 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 78 | <para role="required">
|
---|
[51eb0bf] | 79 | <!--<xref linkend="libgcrypt"/> and-->
|
---|
[eba70158] | 80 | <xref linkend="polkit"/>
|
---|
| 81 | </para>
|
---|
| 82 |
|
---|
| 83 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 84 | <para role="recommended">
|
---|
[c0bc0a9] | 85 | &gobject-introspection;,
|
---|
[51dfb3e] | 86 | <phrase revision="sysv"><xref linkend="elogind"/></phrase>
|
---|
[0fab41a] | 87 | <phrase revision="systemd"><xref role='runtime' linkend="systemd"/>
|
---|
[1996a17a] | 88 | (runtime)</phrase>, and
|
---|
| 89 | <xref linkend="vala"/>
|
---|
[eba70158] | 90 | </para>
|
---|
| 91 |
|
---|
| 92 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 93 | <para role="optional">
|
---|
[a20845e7] | 94 | <xref linkend="gtk-doc"/> and
|
---|
[eba70158] | 95 | <xref linkend="xmlto"/>
|
---|
[1996a17a] | 96 | </para>
|
---|
| 97 |
|
---|
| 98 | <bridgehead renderas="sect4">Optional (for tests)</bridgehead>
|
---|
| 99 | <para role="optional">
|
---|
[e725e77] | 100 | <xref linkend="python-dbusmock"/> and
|
---|
| 101 | <xref linkend="pygobject3"/>
|
---|
[a20845e7] | 102 | <!-- I did not have gtk-doc installed this time, and it worked fine. -->
|
---|
[eba70158] | 103 | </para>
|
---|
| 104 |
|
---|
| 105 | </sect2>
|
---|
| 106 |
|
---|
| 107 | <sect2 role="installation">
|
---|
| 108 | <title>Installation of AccountsService</title>
|
---|
[b751256] | 109 |
|
---|
| 110 | <para>
|
---|
[211a019] | 111 | First, rename a directory whose presence prevents the build system from
|
---|
| 112 | running if <xref linkend="python-dbusmock"/> is not installed:
|
---|
| 113 | </para>
|
---|
| 114 |
|
---|
| 115 | <screen><userinput>mv tests/dbusmock{,-tests}</userinput></screen>
|
---|
| 116 |
|
---|
| 117 | <para>
|
---|
[b6c43e5] | 118 | Then fix a test script so that the new directory is found, and adapt
|
---|
| 119 | it for Python 3.12.0 or later:
|
---|
[211a019] | 120 | </para>
|
---|
| 121 |
|
---|
| 122 | <screen><userinput>sed -e '/accounts_service\.py/s/dbusmock/dbusmock-tests/' \
|
---|
[b6c43e5] | 123 | -e 's/assertEquals/assertEqual/' \
|
---|
[34d1c20] | 124 | -i tests/test-libaccountsservice.py</userinput></screen>
|
---|
[211a019] | 125 |
|
---|
| 126 | <para>
|
---|
| 127 | Fix one test that fails if the <option>en_IE.UTF-8</option> locale
|
---|
[b751256] | 128 | is not installed:
|
---|
[34623f0e] | 129 | </para>
|
---|
| 130 |
|
---|
[b751256] | 131 | <screen><userinput>sed -i '/^SIMULATED_SYSTEM_LOCALE/s/en_IE.UTF-8/en_HK.iso88591/' tests/test-daemon.py</userinput></screen>
|
---|
| 132 |
|
---|
[eba70158] | 133 | <para>
|
---|
| 134 | Install <application>AccountsService</application> by running the following
|
---|
| 135 | commands:
|
---|
| 136 | </para>
|
---|
| 137 |
|
---|
[51dfb3e] | 138 | <screen revision="sysv"><userinput>mkdir build &&
|
---|
[c89c282] | 139 | cd build &&
|
---|
[1575ce1] | 140 |
|
---|
[7c83169b] | 141 | meson setup .. \
|
---|
| 142 | --prefix=/usr \
|
---|
| 143 | --buildtype=release \
|
---|
| 144 | -D admin_group=adm \
|
---|
| 145 | -D elogind=true \
|
---|
| 146 | -D systemdsystemunitdir=no</userinput></screen>
|
---|
[51dfb3e] | 147 |
|
---|
| 148 | <screen revision="systemd"><userinput>mkdir build &&
|
---|
[c89c282] | 149 | cd build &&
|
---|
[51dfb3e] | 150 |
|
---|
[91318eb] | 151 | meson setup .. \
|
---|
| 152 | --prefix=/usr \
|
---|
[20f070d8] | 153 | --buildtype=release \
|
---|
[7c83169b] | 154 | -D admin_group=adm</userinput></screen>
|
---|
[df2e08c8] | 155 |
|
---|
| 156 | <!-- We have to do this after meson setup because mocklibc is extracted
|
---|
| 157 | from a tarball by the meson setup command. -->
|
---|
| 158 | <para>
|
---|
| 159 | Now adapt the shipped mocklibc copy to allow building the test suite
|
---|
| 160 | with GCC 14 or later:
|
---|
| 161 | </para>
|
---|
| 162 |
|
---|
| 163 | <screen><userinput>grep 'print_indent' ../subprojects/mocklibc-1.0/src/netgroup.c \
|
---|
| 164 | | sed 's/ {/;/' >> ../subprojects/mocklibc-1.0/src/netgroup.h &&
|
---|
| 165 | sed -i '1i#include <stdio.h>' \
|
---|
| 166 | ../subprojects/mocklibc-1.0/src/netgroup.h</userinput></screen>
|
---|
| 167 |
|
---|
| 168 | <para>
|
---|
| 169 | Build the package:
|
---|
| 170 | </para>
|
---|
| 171 |
|
---|
| 172 | <screen><userinput>ninja</userinput></screen>
|
---|
[eba70158] | 173 |
|
---|
| 174 | <para>
|
---|
[b751256] | 175 | To test the package, issue <command>ninja test</command>.
|
---|
[eba70158] | 176 | </para>
|
---|
| 177 |
|
---|
| 178 | <para>
|
---|
| 179 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 180 | </para>
|
---|
| 181 |
|
---|
[a20845e7] | 182 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[eba70158] | 183 |
|
---|
| 184 | </sect2>
|
---|
| 185 |
|
---|
| 186 | <sect2 role="commands">
|
---|
| 187 | <title>Command Explanations</title>
|
---|
| 188 |
|
---|
[20f070d8] | 189 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 190 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
| 191 |
|
---|
[eba70158] | 192 | <para>
|
---|
[7c83169b] | 193 | <parameter>-D admin_group=adm</parameter>: This switch sets
|
---|
[eba70158] | 194 | the group for administrator accounts.
|
---|
| 195 | </para>
|
---|
| 196 |
|
---|
[9a363500] | 197 | <para>
|
---|
[7c83169b] | 198 | <option>-D docbook=true</option>: This switch enables building
|
---|
[1996a17a] | 199 | the D-Bus interface API documentation (needs <xref linkend="xmlto"/>).
|
---|
| 200 | </para>
|
---|
| 201 |
|
---|
| 202 | <para>
|
---|
[7c83169b] | 203 | <option>-D gtk_doc=true</option>: This switch enables building
|
---|
[1996a17a] | 204 | the libaccountsservice API documentation (needs
|
---|
| 205 | <xref linkend="gtk-doc"/>).
|
---|
| 206 | </para>
|
---|
| 207 |
|
---|
| 208 | <para>
|
---|
[7c83169b] | 209 | <option>-D vapi=false</option>: This switch disables building
|
---|
[1996a17a] | 210 | the vala bindings. Use it if you have not installed
|
---|
| 211 | <xref linkend="vala"/>.
|
---|
[9a363500] | 212 | </para>
|
---|
[20f070d8] | 213 |
|
---|
[eba70158] | 214 | </sect2>
|
---|
| 215 |
|
---|
| 216 | <sect2 role="configuration">
|
---|
| 217 | <title>Configuring AccountsService</title>
|
---|
| 218 |
|
---|
[4045ec3d] | 219 | <para>
|
---|
| 220 | To allow users in the adm group to be listed as Administrators,
|
---|
| 221 | execute the following commands as the
|
---|
| 222 | <systemitem class="username">root</systemitem> user:
|
---|
| 223 | </para>
|
---|
| 224 |
|
---|
| 225 | <screen role="root"><userinput>cat > /etc/polkit-1/rules.d/40-adm.rules << "EOF"
|
---|
| 226 | <literal>polkit.addAdminRule(function(action, subject) {
|
---|
| 227 | return ["unix-group:adm"];
|
---|
| 228 | });</literal>
|
---|
| 229 | EOF</userinput></screen>
|
---|
| 230 |
|
---|
[eba70158] | 231 | </sect2>
|
---|
| 232 |
|
---|
| 233 | <sect2 role="content">
|
---|
| 234 | <title>Contents</title>
|
---|
| 235 |
|
---|
| 236 | <segmentedlist>
|
---|
| 237 | <segtitle>Installed Programs</segtitle>
|
---|
| 238 | <segtitle>Installed Libraries</segtitle>
|
---|
| 239 | <segtitle>Installed Directories</segtitle>
|
---|
| 240 |
|
---|
| 241 | <seglistitem>
|
---|
| 242 | <seg>
|
---|
[048aa04] | 243 | accounts-daemon (in
|
---|
| 244 | <filename class="directory">/usr/libexec</filename>)
|
---|
[eba70158] | 245 | </seg>
|
---|
| 246 | <seg>
|
---|
| 247 | libaccountsservice.so
|
---|
| 248 | </seg>
|
---|
| 249 | <seg>
|
---|
| 250 | /usr/include/accountsservice-1.0,
|
---|
[048aa04] | 251 | /usr/share/accountsservice,
|
---|
| 252 | /usr/share/gtk-doc/html/libaccountsservice (optional), and
|
---|
[eba70158] | 253 | /var/lib/AccountsService
|
---|
| 254 | </seg>
|
---|
| 255 | </seglistitem>
|
---|
| 256 | </segmentedlist>
|
---|
| 257 |
|
---|
| 258 | <variablelist>
|
---|
| 259 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 260 | <?dbfo list-presentation="list"?>
|
---|
| 261 | <?dbhtml list-presentation="table"?>
|
---|
| 262 |
|
---|
| 263 | <varlistentry id="accounts-daemon">
|
---|
| 264 | <term><command>accounts-daemon</command></term>
|
---|
| 265 | <listitem>
|
---|
| 266 | <para>
|
---|
[4c24eb0a] | 267 | is the <application>AccountsService</application> daemon
|
---|
[eba70158] | 268 | </para>
|
---|
| 269 | <indexterm zone="accountsservice accounts-daemon">
|
---|
| 270 | <primary sortas="b-accounts-daemon">accounts-daemon</primary>
|
---|
| 271 | </indexterm>
|
---|
| 272 | </listitem>
|
---|
| 273 | </varlistentry>
|
---|
| 274 |
|
---|
| 275 | <varlistentry id="libaccountsservice">
|
---|
| 276 | <term><filename class="libraryfile">libaccountsservice.so</filename></term>
|
---|
| 277 | <listitem>
|
---|
| 278 | <para>
|
---|
[4c24eb0a] | 279 | contains the <application>AccountsService</application> API functions
|
---|
[eba70158] | 280 | </para>
|
---|
| 281 | <indexterm zone="accountsservice libaccountsservice">
|
---|
| 282 | <primary sortas="c-libaccountsservice">libaccountsservice.so</primary>
|
---|
| 283 | </indexterm>
|
---|
| 284 | </listitem>
|
---|
| 285 | </varlistentry>
|
---|
| 286 |
|
---|
| 287 | </variablelist>
|
---|
| 288 |
|
---|
| 289 | </sect2>
|
---|
| 290 |
|
---|
| 291 | </sect1>
|
---|