From 2c2b21017fcf68c136b568b35b4cafcfc9ee3786 Mon Sep 17 00:00:00 2001 From: Didier Roche Date: Mon, 26 Jan 2015 17:34:59 +0100 Subject: [PATCH 12/13] Add man page and references to it. Add man page explaining the plymouth theme protocol, usage of the daemon as well as the socket activation part. Adapt existing fsck man page. --- Makefile-man.am | 12 +++ man/systemd-fsck@.service.xml | 6 +- man/systemd-fsckd.service.xml | 172 +++++++++++++++++++++++++++++++++++++++++ units/systemd-fsckd.service.in | 1 + units/systemd-fsckd.socket | 2 +- 5 files changed, 190 insertions(+), 3 deletions(-) create mode 100644 man/systemd-fsckd.service.xml diff --git a/Makefile-man.am b/Makefile-man.am index 105853e..f2e13e8 100644 --- a/Makefile-man.am +++ b/Makefile-man.am @@ -67,6 +67,7 @@ MANPAGES += \ man/systemd-escape.1 \ man/systemd-firstboot.1 \ man/systemd-fsck@.service.8 \ + man/systemd-fsckd.service.8 \ man/systemd-fstab-generator.8 \ man/systemd-getty-generator.8 \ man/systemd-gpt-auto-generator.8 \ @@ -210,6 +211,8 @@ MANPAGES_ALIAS += \ man/systemd-firstboot.service.1 \ man/systemd-fsck-root.service.8 \ man/systemd-fsck.8 \ + man/systemd-fsckd.8 \ + man/systemd-fsckd.socket.8 \ man/systemd-hibernate-resume.8 \ man/systemd-hibernate.service.8 \ man/systemd-hybrid-sleep.service.8 \ @@ -323,6 +326,8 @@ man/systemd-ask-password-wall.service.8: man/systemd-ask-password-console.servic man/systemd-firstboot.service.1: man/systemd-firstboot.1 man/systemd-fsck-root.service.8: man/systemd-fsck@.service.8 man/systemd-fsck.8: man/systemd-fsck@.service.8 +man/systemd-fsckd.8: man/systemd-fsckd.service.8 +man/systemd-fsckd.socket.8: man/systemd-fsckd.service.8 man/systemd-hibernate-resume.8: man/systemd-hibernate-resume@.service.8 man/systemd-hibernate.service.8: man/systemd-suspend.service.8 man/systemd-hybrid-sleep.service.8: man/systemd-suspend.service.8 @@ -606,6 +611,12 @@ man/systemd-fsck-root.service.html: man/systemd-fsck@.service.html man/systemd-fsck.html: man/systemd-fsck@.service.html $(html-alias) +man/systemd-fsckd.html: man/systemd-fsckd.service.html + $(html-alias) + +man/systemd-fsckd.socket.html: man/systemd-fsckd.service.html + $(html-alias) + man/systemd-hibernate-resume.html: man/systemd-hibernate-resume@.service.html $(html-alias) @@ -1732,6 +1743,7 @@ EXTRA_DIST += \ man/systemd-escape.xml \ man/systemd-firstboot.xml \ man/systemd-fsck@.service.xml \ + man/systemd-fsckd.service.xml \ man/systemd-fstab-generator.xml \ man/systemd-getty-generator.xml \ man/systemd-gpt-auto-generator.xml \ diff --git a/man/systemd-fsck@.service.xml b/man/systemd-fsck@.service.xml index ee66f37..9b37a80 100644 --- a/man/systemd-fsck@.service.xml +++ b/man/systemd-fsck@.service.xml @@ -87,8 +87,9 @@ check, number of mounts, unclean unmount, etc. systemd-fsck will forward - file system checking progress to the console. If a - file system check fails for a service without + file system checking progress to + systemd-fsckd.service + socket . If a file system check fails for a service without , emergency mode is activated, by isolating to emergency.target. @@ -142,6 +143,7 @@ systemd1, fsck8, + systemd-fsckd.service8, systemd-quotacheck.service8, fsck.btrfs8, fsck.cramfs8, diff --git a/man/systemd-fsckd.service.xml b/man/systemd-fsckd.service.xml new file mode 100644 index 0000000..4b6510e --- /dev/null +++ b/man/systemd-fsckd.service.xml @@ -0,0 +1,172 @@ + + + + + + + + systemd-fsckd.service + systemd + + + + Developer + Didier + Roche + didrocks@ubuntu.com + + + + + + systemd-fsckd.service + 8 + + + + systemd-fsckd.service + systemd-fsckd.socket + systemd-fsckd + File system checker log reporting + + + + systemd-fsckd.service + systemd-fsckd.socket + /usr/lib/systemd/systemd-fsckd + + + + Description + + systemd-fsckd.service is a + service responsible for fetching file system check + progress, and communicating some consolidated data + to console and plymouth (if running). It handles + as well eventual check cancellations. + systemd-fsck-root.service or + systemd-fsck@.service will get the + progress from fsck and send each individual infos to + systemd-fsckd, through socket activation + by systemd-fsckd.socket. + + systemd-fsckd accepts + systemd-fsck UNIX domain + sockets communication, fetch the lower progress value of + any fsck running in parallel with the number of devices + being currently check. It communicates to plymouth some + translated strings written to /dev/console + in addition to this metadata in case the plymouth theme + is a script, not supporting, i18n. The themes can use the + raw metadata (see below) to display their own custom messages. + + + The first time it connects to plymouth, a request + to grab c or C keypresses is sent, as well as a text message. + When the cancel key is pressed, it forwards this info to + various running systemd-fsck + processes which will then terminate the checks. It will as well + cancel any new systemd-fsck for the lifetime + of systemd-fsckd. + + + + Protocol with plymouth + + systemd-fsckd pass through + libplymouth following messages to the theme: + + Progress update, send as a plymouth update message: + fsckd:<nb_devices>:<progress>:<string> + + + <nb_devices> + corresponds to the current number of devices + being checked (int) + + + <progress> + corresponds to the current minimum percentage of + all devices being checking (float, from 0 to 100) + + + <string> + is a translated message ready to be displayed + by the plymouth theme displaying both data above. It can be overriden + by themes supporting i18n. + + + + + Cancel message, sent as a traditional plymouth message: + fsckd-cancel-msg:<string> + + + <strings> + is a translated string ready to be displayed + by the plymouth theme indicating that c or C can be used to cancel + current checks. It can be overriden (matching only + fsckd-cancel-msg prefix) + by themes supporting i18n. + + + + + + + Options + + The following options are understood: + + + + + + + + + + Exit status + + On success, 0 is returned, a non-zero failure + code otherwise. Note that the daemon stays idle for + a while to accept new systemd-fsck + connexions before exiting. + + + + See Also + + systemd1, + systemd-fsck8, + fsck8, + systemd-quotacheck.service8, + fsck.btrfs8, + fsck.cramfs8, + fsck.ext48, + fsck.fat8, + fsck.hfsplus8, + fsck.minix8, + fsck.ntfs8, + fsck.xfs8 + + + + diff --git a/units/systemd-fsckd.service.in b/units/systemd-fsckd.service.in index 27c325f..9c7ed51 100644 --- a/units/systemd-fsckd.service.in +++ b/units/systemd-fsckd.service.in @@ -7,6 +7,7 @@ [Unit] Description=File System Check Daemon to report status +Documentation=man:systemd-fsckd.service(8) DefaultDependencies=no Requires=systemd-fsckd.socket Before=shutdown.target diff --git a/units/systemd-fsckd.socket b/units/systemd-fsckd.socket index 46373fc..5258b96 100644 --- a/units/systemd-fsckd.socket +++ b/units/systemd-fsckd.socket @@ -7,7 +7,7 @@ [Unit] Description=fsck to fsckd communication Socket -Documentation=man:systemd-fsck@.service(8) man:systemd-fsck-root.service(8) +Documentation=man:systemd-fsckd.service(8) man:systemd-fsck@.service(8) man:systemd-fsck-root.service(8) DefaultDependencies=no Before=sockets.target -- 2.1.4