bug-ncurses
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH 10/23] test/gdc.6: Revise.


From: G. Branden Robinson
Subject: [PATCH 10/23] test/gdc.6: Revise.
Date: Sat, 22 Jun 2024 12:48:41 -0500

Content:
* Document options in synopsis.
* Consistently refer to optional operand using the same term, "count".
* Stop assuming width of host machine's `int`.
* Use ncurses man page terminology as a hint to the struggling
  programmer.

Style:
* Recast description.  Discuss operand before "OPTIONS" section, not
  after it.
* Recast `-d` option as stem sentence, like the others.
* Set file names in italics, not roman.

Markup:
* Protect file name literals from hyphenation.
* Favor man(7) font style macros over *roff font selection escape
  sequences.
---
 test/gdc.6 | 76 +++++++++++++++++++++++++++++++++++-------------------
 1 file changed, 50 insertions(+), 26 deletions(-)

diff --git a/test/gdc.6 b/test/gdc.6
index 3a0026443..9d3f14db9 100644
--- a/test/gdc.6
+++ b/test/gdc.6
@@ -41,42 +41,66 @@
 .\}
 .SH NAME
 gdc \-
-grand digital clock (curses)
+grand digital clock using
+.I curses
 .SH SYNOPSIS
-.B gdc \fP[\fIoptions\fP] [\fIn\fP]
+.B gdc
+.RB [ \-dns ]
+.RB [ \-t
+.IB hh : mm : ss\c
+]
+.RI [ count ]
 .SH DESCRIPTION
-.I Gdc
-runs a digital clock made of reverse-video blanks on a terminal screen.
-If the terminal supports color,
-the clock is drawn in red.
-You can make the clock stop, pause, or resume by pressing a \*(``q\*('',
-\*(``s\*('' or space, respectively.
+.I gdc
+uses
+.I curses
+to display a clock on the terminal.
+It constructs the digits from reverse-video blank characters.
+If the terminal type supports color,
+the digits are drawn in red.
+Make the clock stop,
+pause,
+or resume by typing \*(``q\*('',
+\*(``s\*('',
+or space,
+respectively.
+.PP
+Given a numeric operand,
+the clock
+stops after
+.I count
+seconds.
+Normally,
+.I gdc
+runs \*(``forever\*(''
+(at least 2 billion seconds).
 .SH OPTIONS
 .TP
 .B \-d
-use terminal's default colors for the background.
+uses the terminal's default background color.
 .TP
 .B \-n
-redirects input to /dev/null,
-making it ignore the stop/pause commands.
-You can still stop it by pressing the interrupt key.
+reads input from
+.IR \%/dev/null ,
+making
+.I gdc
+ignore the stop and pause commands.
+You can still stop it with a terminal interrupt.
 .TP
 .B \-s
-makes digits scroll as they change.
+scrolls the digits up as they change.
 When running on a fast display,
-the program breaks up the scrolling into subsecond repaints,
+the program breaks up the scrolling into sub-second redraws,
 making the operation appear smooth.
 .TP
-.B \-t \fIhh:mm:ss\fP
-specify starting time (default is \*(``now\*('').
-.PP
-With an optional numeric argument
-.I num
-it stops after
-.I num
-seconds.
-Normally it runs \*(``forever\*('' (counting down from 2 billion seconds).
+.BR \-t \ \c
+.IB hh : mm : ss
+uses the specified time instead of the current time.
 .SH AUTHORS
-Amos Shapir, modified for curses by John Lupien.
-.br
-Improvements for ncurses by Thomas Dickey.
+Amos Shapir,
+John Lupien
+(modifications for
+.IR curses ),
+Thomas Dickey
+(improvements for
+.IR \%ncurses )
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

[Prev in Thread] Current Thread [Next in Thread]