docs/165841: Grammar improvement and text clarification for adjkerntz(8) man page

Robert Simmons rsimmons0 at gmail.com
Wed Mar 7 23:10:13 UTC 2012


>Number:         165841
>Category:       docs
>Synopsis:       Grammar improvement and text clarification for adjkerntz(8) man page
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Wed Mar 07 23:10:12 UTC 2012
>Closed-Date:
>Last-Modified:
>Originator:     Robert Simmons
>Release:        HEAD
>Organization:
>Environment:
>Description:
My next step in proofreading man pages (more to come).  I've made a couple of parts of the man page read a bit clearer and I've cleaned up a few grammar and punctuation mistakes.
>How-To-Repeat:

>Fix:
I've attached a patch in unified diff format that fixes the problems.

Patch attached with submission follows:

--- src/sbin/adjkerntz/adjkerntz.8	2005-02-13 17:25:15.000000000 -0500
+++ src/sbin/adjkerntz/adjkerntz.8.new	2012-03-07 17:56:50.000000000 -0500
@@ -29,7 +29,8 @@
 .Os
 .Sh NAME
 .Nm adjkerntz
-.Nd "adjust local time CMOS clock to reflect time zone changes and keep current timezone offset for the kernel"
+.Nd "adjust the local time CMOS clock to reflect time zone changes and keep the current timezone
+offset for the kernel"
 .Sh SYNOPSIS
 .Nm
 .Fl i
@@ -38,24 +39,22 @@
 .Sh DESCRIPTION
 The
 .Nm
-utility maintains the proper relationship between the kernel clock, which
-is always set to UTC, and the CMOS clock, which may be set to local
-time.
+utility maintains the proper relationship between the kernel clock, which is
+always set to UTC and the CMOS clock, which may be set to local time.
 The
 .Nm
-utility also informs the kernel about machine timezone shifts to
+utility also informs the kernel about machine timezone shifts in order to
 maintain proper timestamps for local time file systems such as the MS-DOS
 file system.
-The main purpose of this thing is not general fixing of
-initially broken MS-DOS file timestamp idea but keeping
-the same timestamps between
+The main purpose of maintaining these timestamps properly is to keep the
+timestamps of a
 .Fx
-MS-DOS file system
-and MS-DOS operating system installed on the same
-machine.
+MS-DOS file system and an MS-DOS operating system synchronized when they are
+installed on the same system rather than generally fixing broken MS-DOS file
+timestamps.
 If the file
 .Pa /etc/wall_cmos_clock
-exists, it means that CMOS clock keeps local time (MS-DOS and MS-Windows
+exists, it means that the CMOS clock keeps local time (MS-DOS and MS-Windows
 compatible mode).
 If that file does not exist, it means that the CMOS clock keeps UTC time.
 The
@@ -64,8 +63,8 @@
 .Pa machdep.wall_cmos_clock
 kernel variable.
 .Pp
-Adjustments may be needed at system startup and shutdown, and
-whenever a time zone change occurs.
+Adjustments may be needed at system startup and shutdown, and whenever a time
+zone change occurs.
 To handle these different situations,
 .Nm
 is invoked in two ways:
@@ -82,11 +81,11 @@
 utility puts itself into the background.
 Then, for a local time CMOS clock,
 .Nm
-reads the local time from it
-and sets the kernel clock to the corresponding UTC time.
+reads the local time from it and sets the kernel clock to the
+corresponding UTC time.
 The
 .Nm
-utility also stores the local time zone offset into the
+utility also stores the local time zone offset in the
 .Pa machdep.adjkerntz
 kernel variable, for use by subsequent invocations of
 .Em "'adjkerntz -a'"
@@ -94,8 +93,8 @@
 .Pp
 For a local time CMOS clock
 .Em "'adjkerntz -i'"
-pauses, and remains inactive as a background daemon until it
-receives a SIGTERM.
+pauses and remains inactive as a background daemon until it receives a
+SIGTERM.
 The SIGTERM will normally be sent by
 .Xr init 8
 when the system leaves multi-user mode (usually, because the system
@@ -120,7 +119,7 @@
 calculate a new time zone offset.
 It stores the new offset into the
 .Pa machdep.adjkerntz
-kernel variable, and updates the wall CMOS clock to the new local time.
+kernel variable and updates the wall CMOS clock to the new local time.
 If
 .Em "'adjkerntz -a'"
 was started at a nonexistent time (during a timezone change), it exits


>Release-Note:
>Audit-Trail:
>Unformatted:



More information about the freebsd-doc mailing list