bug-ncurses
[Top][All Lists]
Advanced

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

[PATCH 01/12] captoinfo(1m): Revise synopsis.


From: G. Branden Robinson
Subject: [PATCH 01/12] captoinfo(1m): Revise synopsis.
Date: Thu, 14 Sep 2023 07:47:37 -0500

* Restructure to replace incomplete and erroneous ("[-vn width]")
  synopsis with reference to tic(1).
* Use man(7) font selection macros instead of *roff font selection
  escape sequences, for readability.
* Set ellipsis idiomatically for more attractive typesetter output.
* Synopsize `-V` flag separately since it is a different operation mode
  for the program.
* Relocate paragraph from "NOTES" section describing this program as a
  link to tic(1) to main description.
* Replace description of (some) supported options with mention of these
  as being documented in the tic(1) page, still naming each explicitly
  on the assumption that these options are of particular interest to
  users of this command.
---
 man/captoinfo.1m | 37 ++++++++++++++++++-------------------
 1 file changed, 18 insertions(+), 19 deletions(-)

diff --git a/man/captoinfo.1m b/man/captoinfo.1m
index 55b43f32..ec2ec374 100644
--- a/man/captoinfo.1m
+++ b/man/captoinfo.1m
@@ -35,7 +35,12 @@
 .SH NAME
 \fB@CAPTOINFO@\fP \- convert a \fItermcap\fP description into a \fIterminfo\fP 
description
 .SH SYNOPSIS
-\fB@CAPTOINFO@\fR [\fB\-v\fIn\fR \fIwidth\fR]  [\fB\-V\fR] [\fB\-1\fR] 
[\fB\-w\fR \fIwidth\fR] \fIfile\fR ...
+.B @CAPTOINFO@
+.RI [ tic-option ]
+.I file
+\&.\|.\|.
+.P
+\fB@CAPTOINFO@\fR \fB\-V\fR
 .SH DESCRIPTION
 \fB@CAPTOINFO@\fP looks in each given text
 \fIfile\fP for \fBtermcap\fP descriptions.
@@ -52,21 +57,18 @@ .SH DESCRIPTION
 extracted from that file.
 If the environment variable \fBTERMCAP\fP is not
 set, then the file \fB\*d\fP is read.
-.TP 5
-\fB\-v\fP
-print out tracing information on standard error as the program runs.
-.TP 5
-\fB\-V\fP
-print out the version of the program in use on standard error and exit.
-.TP 5
-\fB\-1\fP
-cause the fields to print out one to a line.
-Otherwise, the fields
-will be printed several to a line to a maximum width of 60
-characters.
-.TP 5
-\fB\-w\fP
-change the output to \fIwidth\fP characters.
+.PP
+This utility is implemented as a link to \fB@TIC@\fP(1M),
+with the latter's
+.B \-I
+option implied.
+You can use other \fB@TIC@\fP options such as
+.BR \-1 ,
+.BR \-f ,
+.BR \-v ,
+.BR \-w ,
+and
+.BR \-x .
 .SH FILES
 .TP 20
 \*d
@@ -181,9 +183,6 @@ .SH TRANSLATIONS FROM NONSTANDARD CAPABILITIES
 capabilities \fBmeml\fP (memory lock) and \fBmemu\fP (memory unlock).
 These will be discarded with a warning message.
 .SH NOTES
-This utility is actually a link to \fB@TIC@\fP(1M), running in \fI\-I\fP mode.
-You can use other \fB@TIC@\fP options such as \fB\-f\fP and  \fB\-x\fP.
-.PP
 The verbose option is not identical to SVr4's.
 Under SVr4, instead of following
 the \fB\-v\fP with a trace level n, you repeat it n times.
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

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