Attach are some small improvements to the cal --help message.
thanks,
Pádraig
>From 7f9626bda704e0614fde691c7d5a290ddd30a87f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?P=C3=A1draig=20Brady?= <P@xxxxxxxxxxxxxx>
Date: Mon, 7 Oct 2013 04:01:39 +0100
Subject: [PATCH] docs: improve the cal --help
* misc-utils/cal.c: Mention that the current month is implicit
if not specified. Also remove mention of the "current" month
from the option description as a specific date may be specified.
* misc-utils/cal.1: Likewise.
---
misc-utils/cal.1 | 4 ++--
misc-utils/cal.c | 8 +++++---
2 files changed, 7 insertions(+), 5 deletions(-)
diff --git a/misc-utils/cal.1 b/misc-utils/cal.1
index 4e7570d..0e686dd 100644
--- a/misc-utils/cal.1
+++ b/misc-utils/cal.1
@@ -51,7 +51,7 @@ Display single month output.
(This is the default.)
.TP
\fB\-3\fR, \fB\-\-three\fR
-Display prev/current/next month output.
+Display three months spanning the date.
.TP
\fB\-s\fR, \fB\-\-sunday\fR
Display Sunday as the first day of the week.
@@ -63,7 +63,7 @@ Display Monday as the first day of the week.
Display Julian dates (days one-based, numbered from January 1).
.TP
\fB\-y\fR, \fB\-\-year\fR
-Display a calendar for the current year.
+Display a calendar for the whole year.
.TP
\fB\-\-color\fR [\fIwhen\fR]
Colorize output. The
diff --git a/misc-utils/cal.c b/misc-utils/cal.c
index d31b51d..c4ae2b8 100644
--- a/misc-utils/cal.c
+++ b/misc-utils/cal.c
@@ -807,13 +807,15 @@ static void __attribute__ ((__noreturn__)) usage(FILE * out)
fputs(USAGE_HEADER, out);
fprintf(out, _(" %s [options] [[[day] month] year]\n"), program_invocation_short_name);
+ fprintf(out, _("\nIf no options are specified, output the current month\n"));
+
fputs(USAGE_OPTIONS, out);
- fputs(_(" -1, --one show only current month (default)\n"), out);
- fputs(_(" -3, --three show previous, current and next month\n"), out);
+ fputs(_(" -1, --one show only a single month (default)\n"), out);
+ fputs(_(" -3, --three show three months spanning the date\n"), out);
fputs(_(" -s, --sunday Sunday as first day of week\n"), out);
fputs(_(" -m, --monday Monday as first day of week\n"), out);
fputs(_(" -j, --julian output Julian dates\n"), out);
- fputs(_(" -y, --year show whole current year\n"), out);
+ fputs(_(" -y, --year show the whole year\n"), out);
fputs(_(" --color[=<when>] colorize messages (auto, always or never)\n"), out);
fputs(USAGE_SEPARATOR, out);
--
1.7.7.6
