man/systemd-homed.service.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
   5
   6 <refentry id="systemd-homed.service" conditional='ENABLE_HOMED'>
   7
   8   <refentryinfo>
   9     <title>systemd-homed.service</title>
  10     <productname>systemd</productname>
  11   </refentryinfo>
  12
  13   <refmeta>
  14     <refentrytitle>systemd-homed.service</refentrytitle>
  15     <manvolnum>8</manvolnum>
  16   </refmeta>
  17
  18   <refnamediv>
  19     <refname>systemd-homed.service</refname>
  20     <refname>systemd-homed</refname>
  21     <refpurpose>Home Area/User Account Manager</refpurpose>
  22   </refnamediv>
  23
  24   <refsynopsisdiv>
  25     <para><filename>systemd-homed.service</filename></para>
  26     <para><filename>/usr/lib/systemd/systemd-homed</filename></para>
  27   </refsynopsisdiv>
  28
  29   <refsect1>
  30     <title>Description</title>
  31
  32     <para><command>systemd-homed</command> is a system service that may be used to create, remove, change or
  33     inspect home areas (directories and network mounts and real or loopback block devices with a filesystem,
  34     optionally encrypted).</para>
  35
  36     <para>Most of <command>systemd-homed</command>'s functionality is accessible through the
  37     <citerefentry><refentrytitle>homectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> command.</para>
  38
  39     <para>See the <ulink url="https://systemd.io/HOME_DIRECTORY">Home Directories</ulink> documentation for
  40     details about the format and design of home areas managed by
  41     <filename>systemd-homed.service</filename>.</para>
  42
  43     <para>Each home directory managed by <filename>systemd-homed.service</filename> synthesizes a local user
  44     and group. These are made available to the system using the <ulink
  45     url="https://systemd.io/USER_GROUP_API">User/Group Record Lookup API via Varlink</ulink>, and thus may be
  46     browsed with
  47     <citerefentry><refentrytitle>userdbctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
  48   </refsect1>
  49
  50   <refsect1>
  51     <title>See Also</title>
  52     <para>
  53       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  54       <citerefentry><refentrytitle>homectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  55       <citerefentry><refentrytitle>userdbctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
  56     </para>
  57   </refsect1>
  58 </refentry>