summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2020-06-13 17:11:00 +0200
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2020-06-14 19:54:26 +0200
commit387536b3a922879852021458b1d84791112dedd7 (patch)
treef167729b1fe4bd1c269186b54215480ab6e1e2a7 /man
parent4677c3da976d54d806ca5ced008f4917e88a0204 (diff)
downloadsystemd-387536b3a922879852021458b1d84791112dedd7.tar.gz
man: mention systemd-user-runtime-dir in user@.service too
_riotingpacifist was complaining on reddit [1] that systemd-user-runtime-dir is not documented anywhere. So let's add the binary name as page alias. [1] https://www.reddit.com/r/linux/comments/h086fd/why_linuxs_systemd_is_still_divisive_after_all/ftllr66/ This page should be in section 8, like all .service descriptions. Also extend the text a bit to make it clearer that systemd --user is the same executable but running in a different mode (which might be certainly a bit confusing to users.)
Diffstat (limited to 'man')
-rw-r--r--man/rules/meson.build5
-rw-r--r--man/user@.service.xml27
2 files changed, 19 insertions, 13 deletions
diff --git a/man/rules/meson.build b/man/rules/meson.build
index e8dcfd7bff..e6083004ea 100644
--- a/man/rules/meson.build
+++ b/man/rules/meson.build
@@ -1096,7 +1096,10 @@ manpages = [
''],
['udev_new', '3', ['udev_ref', 'udev_unref'], ''],
['udevadm', '8', [], ''],
- ['user@.service', '5', ['user-runtime-dir@.service'], ''],
+ ['user@.service',
+ '5',
+ ['systemd-user-runtime-dir', 'user-runtime-dir@.service'],
+ ''],
['userdbctl', '1', [], 'ENABLE_USERDB'],
['vconsole.conf', '5', [], 'ENABLE_VCONSOLE']
]
diff --git a/man/user@.service.xml b/man/user@.service.xml
index f4603df073..cb95d04392 100644
--- a/man/user@.service.xml
+++ b/man/user@.service.xml
@@ -17,34 +17,37 @@
<refnamediv>
<refname>user@.service</refname>
<refname>user-runtime-dir@.service</refname>
- <refpurpose>System units to manage user processes</refpurpose>
+ <refname>systemd-user-runtime-dir</refname>
+ <refpurpose>System units to start the user manager</refpurpose>
</refnamediv>
<refsynopsisdiv>
<para><filename>user@<replaceable>UID</replaceable>.service</filename></para>
<para><filename>user-runtime-dir@<replaceable>UID</replaceable>.service</filename></para>
+ <para><filename>/usr/lib/systemd/systemd-user-runtime-dir</filename></para>
<para><filename>user-<replaceable>UID</replaceable>.slice</filename></para>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para>The
- <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+ <para>The <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
system manager (PID 1) starts user manager instances as
- <filename>user@<replaceable>UID</replaceable>.service</filename>, where the user's numerical UID
- is used as the instance identifier. Each <command>systemd --user</command> instance manages a
- hierarchy of its own units. See
- <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> for
- a discussion of systemd units and
- <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>1</manvolnum></citerefentry>
- for a list of units that form the basis of the unit hierarchies of system and user units.</para>
+ <filename>user@<replaceable>UID</replaceable>.service</filename>, with the user's numerical UID used as
+ the instance identifier. These instances use the same executable as the system manager, but running in a
+ mode where it starts a different set of units. Each <command>systemd --user</command> instance manages a
+ hierarchy of units specific to that user. See
+ <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> for a
+ discussion of units and
+ <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>1</manvolnum></citerefentry> for a
+ list of units that form the basis of the unit hierarchies of system and user units.</para>
<para><filename>user@<replaceable>UID</replaceable>.service</filename> is accompanied by the
system unit <filename>user-runtime-dir@<replaceable>UID</replaceable>.service</filename>, which
creates the user's runtime directory
<filename>/run/user/<replaceable>UID</replaceable></filename>, and then removes it when this
- unit is stopped.</para>
+ unit is stopped. <filename>user-runtime-dir@<replaceable>UID</replaceable>.service</filename>
+ executes the <filename>systemd-user-runtime-dir</filename> binary to do the actual work.</para>
<para>User processes may be started by the <filename>user@.service</filename> instance, in which
case they will be part of that unit in the system hierarchy. They may also be started elsewhere,
@@ -53,7 +56,7 @@
display manager like <command>gdm</command>, in which case they form a .scope unit (see
<citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
Both <filename>user@<replaceable>UID</replaceable>.service</filename> and the scope units are
- collected under a <filename>user-<replaceable>UID</replaceable>.slice</filename>.</para>
+ collected under the <filename>user-<replaceable>UID</replaceable>.slice</filename>.</para>
<para>Individual <filename>user-<replaceable>UID</replaceable>.slice</filename> slices are
collected under <filename>user.slice</filename>, see