Skip site navigation (1)Skip section navigation (2)
Date:      Sun, 7 Nov 2021 17:55:39 GMT
From:      Mateusz Piotrowski <0mp@FreeBSD.org>
To:        src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org
Subject:   git: 5bee300aefb1 - stable/13 - date.1: Fix some style issues and examples
Message-ID:  <202111071755.1A7Htd65046609@gitrepo.freebsd.org>

next in thread | raw e-mail | index | archive | help
The branch stable/13 has been updated by 0mp (doc, ports committer):

URL: https://cgit.FreeBSD.org/src/commit/?id=5bee300aefb1f9d3ec9a5cd2150b1b5c7374f3ae

commit 5bee300aefb1f9d3ec9a5cd2150b1b5c7374f3ae
Author:     Mateusz Piotrowski <0mp@FreeBSD.org>
AuthorDate: 2021-11-03 10:26:46 +0000
Commit:     Mateusz Piotrowski <0mp@FreeBSD.org>
CommitDate: 2021-11-07 17:54:59 +0000

    date.1: Fix some style issues and examples
    
    - Use Cm instead of Ar or Sq for command modifiers of the -v flag.
    - Remove unnecessary "Ar ..." from the synopsis. It's not clear what it
      was referring to.
    - Add missing arguments to the -f and -v flags.
    - Stylize the dot before "ss" with Cm in the default format in the -f
      flag description.
    - Set LC_ALL=C in the last example so that the output format of
      date(1) always matches the specified format of the -f flag not matter
      the locale.
    - List the -f flag as optional in all usage lines in the synopsis.
    
    MFC after:      3 days
    
    (cherry picked from commit 00133d5c5e6aae01663eca40993abd5e6137425b)
---
 bin/date/date.1 | 49 +++++++++++++++++++++++++++----------------------
 1 file changed, 27 insertions(+), 22 deletions(-)

diff --git a/bin/date/date.1 b/bin/date/date.1
index 931363cc86fb..7dcf77c88b39 100644
--- a/bin/date/date.1
+++ b/bin/date/date.1
@@ -32,7 +32,7 @@
 .\"     @(#)date.1	8.3 (Berkeley) 4/28/95
 .\" $FreeBSD$
 .\"
-.Dd August 25, 2020
+.Dd November 3, 2021
 .Dt DATE 1
 .Os
 .Sh NAME
@@ -49,10 +49,9 @@
 .Sm off
 .Fl v
 .Op Cm + | -
-.Ar val Op Ar ymwdHMS
+.Ar val Op Cm y | m | w | d | H | M | S
 .Sm on
 .Oc
-.Ar ...
 .Op Cm + Ns Ar output_fmt
 .\" Set time with the default input format.
 .Nm
@@ -111,7 +110,7 @@ the time may not be changed by more than 1 second.
 .Pp
 The options are as follows:
 .Bl -tag -width Ds
-.It Fl f
+.It Fl f Ar input_fmt
 Use
 .Ar input_fmt
 as the format string to parse the
@@ -124,7 +123,7 @@ provided rather than using the default
 .Ar mm Oc
 .Ar dd Oc
 .Ar HH
-.Oc Ar MM Op Ar .ss
+.Oc Ar MM Op Cm \&. Ar ss
 .Sm on
 format.
 Parsing is done using
@@ -135,24 +134,24 @@ Use
 output format.
 .Ar FMT
 may be omitted, in which case the default is
-.Sq date .
+.Cm date .
 Valid
 .Ar FMT
 values are
-.Sq date ,
-.Sq hours ,
-.Sq minutes ,
+.Cm date ,
+.Cm hours ,
+.Cm minutes ,
 and
-.Sq seconds .
+.Cm seconds .
 The date and time is formatted to the specified precision.
 When
 .Ar FMT
 is
-.Sq hours
+.Cm hours
 (or the more precise
-.Sq minutes
+.Cm minutes
 or
-.Sq seconds ) ,
+.Cm seconds ) ,
 the
 .St -iso8601
 format includes the timezone.
@@ -196,7 +195,13 @@ Print the date and time of the last modification of
 Display or set the date in
 .Tn UTC
 (Coordinated Universal) time.
-.It Fl v
+.It Xo
+.Fl v
+.Sm off
+.Op Cm + | -
+.Ar val Op Cm y | m | w | d | H | M | S
+.Sm on
+.Xc
 Adjust (i.e., take the current date and display the result of the
 adjustment; not actually set the date) the second, minute, hour, month
 day, week day, month or year according to
@@ -220,14 +225,14 @@ and years are in the range 80-38 or 1980-2038.
 If
 .Ar val
 is numeric, one of either
-.Ar y ,
-.Ar m ,
-.Ar w ,
-.Ar d ,
-.Ar H ,
-.Ar M
+.Cm y ,
+.Cm m ,
+.Cm w ,
+.Cm d ,
+.Cm H ,
+.Cm M
 or
-.Ar S
+.Cm S
 must be used to specify which part of the date is to be adjusted.
 .Pp
 The week day or month may be specified using a name rather than a
@@ -441,7 +446,7 @@ will display
 .Pp
 Finally the command:
 .Pp
-.Dl "date -j -f ""%a %b %d %T %Z %Y"" ""`date`"" ""+%s"""
+.Dl "date -j -f ""%a %b %d %T %Z %Y"" ""`LC_ALL=C date`"" ""+%s"""
 .Pp
 can be used to parse the output from
 .Nm



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?202111071755.1A7Htd65046609>