mirrors/systemd
0
0
Fork 0
mirror of https://github.com/systemd/systemd.git synced 2024-11-26 19:53:45 +08:00
Code Issues Packages Projects Releases Wiki Activity
main
systemd/man/homed.conf.xml

95 lines
4.0 KiB
XML
Raw Permalink Normal View History

man: document homed.conf
2020-05-05 17:02:12 +08:00
<?xml version='1.0'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
man: use same version in public and system ident.
2023-12-25 22:48:33 +08:00
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
license: LGPL-2.1+ -> LGPL-2.1-or-later
2020-11-09 12:23:58 +08:00
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
man: document homed.conf
2020-05-05 17:02:12 +08:00
man: fix conditional in homed.conf.xml
2020-05-27 21:48:02 +08:00
<refentry id="homed.conf" conditional='ENABLE_HOMED'
man: document homed.conf
2020-05-05 17:02:12 +08:00
xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>homed.conf</title>
<productname>systemd</productname>
</refentryinfo>
<refmeta>
<refentrytitle>homed.conf</refentrytitle>
<manvolnum>5</manvolnum>
</refmeta>
<refnamediv>
<refname>homed.conf</refname>
<refname>homed.conf.d</refname>
<refpurpose>Home area/user account manager configuration files</refpurpose>
</refnamediv>
<refsynopsisdiv>
man: use <simplelist> for file lists in synopsis With <para><filename>…</filename></para>, we get a separate "paragraph" for each line, i.e. entries separated by empty lines. This uses up a lot of space and was only done because docbook makes it hard to insert a newline. In some other places, <literallayout> was used, but then we cannot indent the source text (because the whitespace would end up in the final page). We can get the desired result with <simplelist>. With <simplelist> the items are indented in roff output, but not in html output. In some places this looks better then no indentation, and in others it would probably be better to have no indent. But this is a minor issue and we cannot control that. (I didn't convert all spots. There's a bunch of other man pages which have two lines, e.g. an executable and service file, and it doesn't matter there so much.)
2023-12-14 19:52:03 +08:00
<para><simplelist>
<member><filename>/etc/systemd/homed.conf</filename></member>
man: document all the new paths
2024-02-22 17:58:48 +08:00
<member><filename>/run/systemd/homed.conf</filename></member>
man: document /usr/local/lib in search paths
2024-06-05 23:08:57 +08:00
<member><filename>/usr/local/lib/systemd/homed.conf</filename></member>
man: document all the new paths
2024-02-22 17:58:48 +08:00
<member><filename>/usr/lib/systemd/homed.conf</filename></member>
man: use <simplelist> for file lists in synopsis With <para><filename>…</filename></para>, we get a separate "paragraph" for each line, i.e. entries separated by empty lines. This uses up a lot of space and was only done because docbook makes it hard to insert a newline. In some other places, <literallayout> was used, but then we cannot indent the source text (because the whitespace would end up in the final page). We can get the desired result with <simplelist>. With <simplelist> the items are indented in roff output, but not in html output. In some places this looks better then no indentation, and in others it would probably be better to have no indent. But this is a minor issue and we cannot control that. (I didn't convert all spots. There's a bunch of other man pages which have two lines, e.g. an executable and service file, and it doesn't matter there so much.)
2023-12-14 19:52:03 +08:00
<member><filename>/etc/systemd/homed.conf.d/*.conf</filename></member>
<member><filename>/run/systemd/homed.conf.d/*.conf</filename></member>
man: document /usr/local/lib in search paths
2024-06-05 23:08:57 +08:00
<member><filename>/usr/local/lib/systemd/homed.conf.d/*.conf</filename></member>
man: use <simplelist> for file lists in synopsis With <para><filename>…</filename></para>, we get a separate "paragraph" for each line, i.e. entries separated by empty lines. This uses up a lot of space and was only done because docbook makes it hard to insert a newline. In some other places, <literallayout> was used, but then we cannot indent the source text (because the whitespace would end up in the final page). We can get the desired result with <simplelist>. With <simplelist> the items are indented in roff output, but not in html output. In some places this looks better then no indentation, and in others it would probably be better to have no indent. But this is a minor issue and we cannot control that. (I didn't convert all spots. There's a bunch of other man pages which have two lines, e.g. an executable and service file, and it doesn't matter there so much.)
2023-12-14 19:52:03 +08:00
<member><filename>/usr/lib/systemd/homed.conf.d/*.conf</filename></member>
</simplelist></para>
man: document homed.conf
2020-05-05 17:02:12 +08:00
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>These configuration files control default parameters for home areas/user accounts created and
managed by
<citerefentry><refentrytitle>systemd-homed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
</refsect1>
<xi:include href="standard-conf.xml" xpointer="main-conf" />
<refsect1>
<title>Options</title>
tree-wide: drop quotes from around [section] For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
2020-07-06 17:00:06 +08:00
<para>The following options are available in the [Home] section:</para>
man: document homed.conf
2020-05-05 17:02:12 +08:00
<variablelist class='home-directives'>
<varlistentry>
<term><varname>DefaultStorage=</varname></term>
<listitem><para>The default storage to use for home areas. Takes one of <literal>luks</literal>,
<literal>fscrypt</literal>, <literal>directory</literal>, <literal>subvolume</literal>,
<literal>cifs</literal>. For details about these options, see
<citerefentry><refentrytitle>homectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>. If not
configured or assigned the empty string, the default storage is automatically determined: if not
tree-wide: codespell fixes Another batch of codespell fixes as reported by Fossies.org
2020-05-25 05:00:13 +08:00
running in a container environment and <filename>/home/</filename> is not itself encrypted, defaults
man: document homed.conf
2020-05-05 17:02:12 +08:00
to <literal>luks</literal>. Otherwise defaults to <literal>subvolume</literal> if
<filename>/home/</filename> is on a btrfs file system, and <literal>directory</literal>
otherwise. Note that the storage selected on the <command>homectl</command> command line always takes
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
precedence.</para>
<xi:include href="version-info.xml" xpointer="v246"/></listitem>
man: document homed.conf
2020-05-05 17:02:12 +08:00
</varlistentry>
<varlistentry>
<term><varname>DefaultFileSystemType=</varname></term>
<listitem><para>When using <literal>luks</literal> as storage (see above), selects the default file
homed: default to "btrfs" as fs type in the LUKS backend Apparently both Fedora and suse default to btrfs now, it should hence be good enough for us too. This enables a bunch of really nice things for us, most importanly we can resize home directories freely (i.e. both grow *and* shrink) while online. It also allows us to add nice subvolume based home directory snapshotting later on. Also, whenever we mention the three supported types, alaways mention them in alphabetical order, which is also our new order of preference.
2020-08-18 21:11:06 +08:00
system to use inside the user's LUKS volume. Takes one of <literal>btrfs</literal>,
<literal>ext4</literal> or <literal>xfs</literal>. If not specified defaults to
<literal>btrfs</literal>. This setting has no effect if a different storage mechanism is used. The
man: document homed.conf
2020-05-05 17:02:12 +08:00
file system type selected on the <command>homectl</command> command line always takes
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
precedence.</para>
<xi:include href="version-info.xml" xpointer="v246"/></listitem>
man: document homed.conf
2020-05-05 17:02:12 +08:00
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>See Also</title>
man: use <simplelist> for 'See also' sections This is just a slight markup improvement; there should be no difference in rendering.
2023-12-23 02:09:32 +08:00
<para><simplelist type="inline">
<member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>systemd-homed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
</simplelist></para>
man: document homed.conf
2020-05-05 17:02:12 +08:00
</refsect1>
</refentry>
Reference in New Issue Copy Permalink