diff --git a/Makefile-man.am b/Makefile-man.am index d0fb9aa1ae..7a9612e311 100644 --- a/Makefile-man.am +++ b/Makefile-man.am @@ -66,6 +66,7 @@ MANPAGES += \ man/systemd-efi-boot-generator.8 \ man/systemd-escape.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 \ @@ -209,6 +210,8 @@ MANPAGES_ALIAS += \ man/systemd-ask-password-wall.service.8 \ 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 \ @@ -321,6 +324,8 @@ man/systemd-ask-password-wall.path.8: man/systemd-ask-password-console.service.8 man/systemd-ask-password-wall.service.8: man/systemd-ask-password-console.service.8 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 @@ -601,6 +606,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) @@ -1738,6 +1749,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 88e11e89d4..69b8fdde2c 100644 --- a/man/systemd-fsck@.service.xml +++ b/man/systemd-fsck@.service.xml @@ -81,10 +81,10 @@ last 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 , emergency mode is - activated, by isolating to - emergency.target. + 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. @@ -125,16 +125,16 @@ See Also systemd1, - fsck8, + fsck8, systemd-quotacheck.service8, - fsck.btrfs8, - fsck.cramfs8, - fsck.ext48, - fsck.fat8, - fsck.hfsplus8, - fsck.minix8, - fsck.ntfs8, - fsck.xfs8 + fsck.btrfs8, + fsck.cramfs8, + fsck.ext48, + fsck.fat8, + fsck.hfsplus8, + fsck.minix8, + fsck.ntfs8, + fsck.xfs8 diff --git a/man/systemd-fsckd.service.xml b/man/systemd-fsckd.service.xml new file mode 100644 index 0000000000..2ad78448f8 --- /dev/null +++ b/man/systemd-fsckd.service.xml @@ -0,0 +1,162 @@ + + + + + + + + systemd-fsckd.service + systemd + + + + Developer + Didier + Roche + didrocks@ubuntu.com + + + + + + systemd-fsckd.service + 8 + + + + systemd-fsckd.service + systemd-fsckd.socket + systemd-fsckd + File system check progress reporting + + + + systemd-fsckd.service + systemd-fsckd.socket + /usr/lib/systemd/systemd-fsckd + + + + Description + + systemd-fsckd.service is a service responsible + for receiving file system check progress, and communicating some + consolidated data to console and plymouth (if running). It also handles + possible check cancellations. + + systemd-fsckd receives messages about file + system check progress from systemd-fsck through a + UNIX domain socket. It can display the progress of the least advanced + fsck as well as the total number of devices being checked in parallel + to the console. It will also send progress messages to plymouth. + Both the raw data and translated messages are sent, so compiled + plymouth themes can use the raw data to display custom messages, and + scripted themes, not supporting i18n, can display the translated + versions. + + systemd-fsckd will instruct plymouth to grab + Control+C keypresses. When the key is pressed, running checks will be + terminated. It will also cancel any newly connected fsck instances for + the lifetime of systemd-fsckd. + + + + Protocol for communication with plymouth + + systemd-fsckd passes the + following messages to the theme: + + Progress update, sent as a plymouth update message: + fsckd:<num_devices>:<progress>:<string> + + + <num_devices> + the current number of devices + being checked (int) + + + <progress> + the current minimum percentage of + all devices being checking (float, from 0 to 100) + + + <string> + a translated message ready to be displayed + by the plymouth theme displaying the data above. It can be overriden + by themes supporting i18n. + + + + + Cancel message, sent as a traditional plymouth message: + fsckd-cancel-msg:<string> + + + <strings> + a translated string ready to be displayed + by the plymouth theme indicating that Control+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 + connections 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 27c325f778..9c7ed5146d 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 a8994a1aea..93c4ea9eba 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 [Socket]