Change the sanity check on save to use the release date
[fake-hwclock.git] / fake-hwclock.8
index b3f14ba..9da62ae 100644 (file)
@@ -1,4 +1,4 @@
-.TH FAKE-HWCLOCK 8 "5 April 2012" Debian
+.TH FAKE-HWCLOCK 8 "1 October 2014" Debian
 .SH NAME
 fake-hwclock \- Control fake hardware clock
 .SH SYNOPSIS
@@ -14,6 +14,15 @@ the system is rebooted. Since lots of software assumes that time only moves
 forward this is a bad thing. NTP can (and should where practical) be used to
 sync with an external timeserver but it is not available early in the boot
 process and may be unavailable for other reasons.
+
+The design expectation of \fBfake-hwclock\fP is that it will be run
+very late at shutdown and very early at boot. This will ensure that
+fsck has a vaguely sensible idea of system time at boot and won't
+complain that the last-modified time in the filesystem is not hugely
+in the past or future. Some users may not worry about this too use
+case, in which case it is possible to modify the init system
+configuration to move things earlier/later as appropriate.
+
 .SH DESCRIPTION
 \fBfake-hwclock\fP sets and queries a fake "hardware clock" which stores the
 time in a file. This program may be run by the system administrator
@@ -25,7 +34,9 @@ If no command is given then fake-hwclock acts as if the save command was used.
 .SS
 .TP
 \fBsave\fP
-Save the time to the file.
+Save the time to the file. As a sanity check, fake-hwclock will not
+move the saved clock backwards to a time/date earlier than its own
+release date. Use "force" to over-ride this check.
 .TP
 \fBload\fP
 Load the time from the file. If force is specified fake-hwclock will move the