man: document systemd-user-sessions.service

5 files changed, 89 insertions, 6 deletions

diff --git a/Makefile.am b/Makefile.am
index d59f6660b1..84cc435b37 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -2944,7 +2944,8 @@ MANPAGES += \
 	man/sd_uid_get_state.3 \
 	man/sd_session_is_active.3 \
 	man/sd_seat_get_active.3 \
-	man/sd_get_seats.3
+	man/sd_get_seats.3 \
+	man/systemd-user-sessions.service.8
 
 MANPAGES_ALIAS += \
 	man/systemd-logind.8 \
@@ -2965,7 +2966,8 @@ MANPAGES_ALIAS += \
 	man/sd_seat_get_sessions.3 \
 	man/sd_seat_can_multi_session.3 \
 	man/sd_get_sessions.3 \
-	man/sd_get_uids.3
+	man/sd_get_uids.3 \
+	man/systemd-user-sessions.8
 
 man/systemd-logind.8: man/systemd-logind.service.8
 man/sd_login_monitor_unref.3: man/sd_login_monitor_new.3
@@ -2986,6 +2988,7 @@ man/sd_seat_get_sessions.3: man/sd_seat_get_active.3
 man/sd_seat_can_multi_session.3: man/sd_seat_get_active.3
 man/sd_get_sessions.3: man/sd_get_seats.3
 man/sd_get_uids.3: man/sd_get_seats.3
+man/systemd-user-sessions.8: man/systemd-user-sessions.service.8
 
 EXTRA_DIST += \
 	src/login/logind-gperf.gperf \
diff --git a/man/systemd-logind.service.xml b/man/systemd-logind.service.xml
index 3e6887299d..9cef4ad6c0 100644
--- a/man/systemd-logind.service.xml
+++ b/man/systemd-logind.service.xml
@@ -112,6 +112,7 @@
                 <title>See Also</title>
                 <para>
                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>systemd-user-sessions.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>pam_systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
diff --git a/man/systemd-user-sessions.service.xml b/man/systemd-user-sessions.service.xml
new file mode 100644
index 0000000000..338b7012bf
--- /dev/null
+++ b/man/systemd-user-sessions.service.xml
@@ -0,0 +1,77 @@
+<?xml version="1.0"?>
+<!--*-nxml-*-->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<!--
+  This file is part of systemd.
+
+  Copyright 2012 Lennart Poettering
+
+  systemd is free software; you can redistribute it and/or modify it
+  under the terms of the GNU Lesser General Public License as published by
+  the Free Software Foundation; either version 2.1 of the License, or
+  (at your option) any later version.
+
+  systemd is distributed in the hope that it will be useful, but
+  WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+  Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public License
+  along with systemd; If not, see <http://www.gnu.org/licenses/>.
+-->
+<refentry id="systemd-user-sessions.service">
+
+        <refentryinfo>
+                <title>systemd-user-sessions.service</title>
+                <productname>systemd</productname>
+
+                <authorgroup>
+                        <author>
+                                <contrib>Developer</contrib>
+                                <firstname>Lennart</firstname>
+                                <surname>Poettering</surname>
+                                <email>lennart@poettering.net</email>
+                        </author>
+                </authorgroup>
+        </refentryinfo>
+
+        <refmeta>
+                <refentrytitle>systemd-user-sessions.service</refentrytitle>
+                <manvolnum>8</manvolnum>
+        </refmeta>
+
+        <refnamediv>
+                <refname>systemd-user-sessions.service</refname>
+                <refname>systemd-user-sessions</refname>
+                <refpurpose>Permit user logins after boot, prohibit user logins at shutdown.</refpurpose>
+        </refnamediv>
+
+        <refsynopsisdiv>
+                <para><filename>systemd-user-sessions.service</filename></para>
+                <para><filename>/usr/lib/systemd/systemd-user-sessions</filename></para>
+        </refsynopsisdiv>
+
+        <refsect1>
+                <title>Description</title>
+
+                <para><filename>systemd-user-sessions.service</filename>
+                is a service that controls user logins. After basic
+                system initialization is complete it removes
+                <filename>/run/login</filename>, thus permitting
+                logins. Before system shutdown it creates
+                <filename>/run/nologin</filename>, thus prohibiting
+                further logins. At the same time it also kills all
+                user processes, so that system shutdown may proceed
+                without any remaining user processes around.</para>
+        </refsect1>
+
+        <refsect1>
+                <title>See Also</title>
+                <para>
+                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>pam_nologin</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+                </para>
+        </refsect1>
+
+</refentry>
diff --git a/src/login/user-sessions.c b/src/login/user-sessions.c
index 98b36c60e8..91531e8f38 100644
--- a/src/login/user-sessions.c
+++ b/src/login/user-sessions.c
@@ -69,17 +69,18 @@ int main(int argc, char*argv[]) {
                 int r, q;
                 char *cgroup_user_tree = NULL;
 
-                if ((r = write_one_line_file_atomic("/run/nologin", "System is going down.")) < 0)
+                r = write_one_line_file_atomic("/run/nologin", "System is going down.");
+                if (r < 0)
                         log_error("Failed to create /run/nologin: %s", strerror(-r));
 
-                if ((q = cg_get_user_path(&cgroup_user_tree)) < 0) {
+                q = cg_get_user_path(&cgroup_user_tree);
+                if (q < 0) {
                         log_error("Failed to determine use path: %s", strerror(-q));
                         goto finish;
                 }
 
                 q = cg_kill_recursive_and_wait(SYSTEMD_CGROUP_CONTROLLER, cgroup_user_tree, true);
                 free(cgroup_user_tree);
-
                 if (q < 0) {
                         log_error("Failed to kill sessions: %s", strerror(-q));
                         goto finish;
diff --git a/units/systemd-user-sessions.service.in b/units/systemd-user-sessions.service.in
index 363093ee1d..0869e73991 100644
--- a/units/systemd-user-sessions.service.in
+++ b/units/systemd-user-sessions.service.in
@@ -7,7 +7,8 @@
 
 [Unit]
 Description=Permit User Sessions
-After=local-fs.target remote-fs.target
+Documentation=man:systemd-user-sessions.service(8)
+After=remote-fs.target
 
 [Service]
 Type=oneshot