Bug#956434: twm.1: Fix some formatting in the manual
Package: twm
Version: 1:1.0.10-1
Severity: minor
Tags: patch
Dear Maintainer,
Summary:
Remove a superfluous paragraph macro (PP).
Remove a trailing space in the output line.
Reduce space between words.
Use '\-' for an option, not '-'.
Remove repeated words.
Add a comma after 'e.g.' and 'i.e.' (man-pages(7)).
Split long lines into shorter ones.
Use '\-' (minus) as an arithmetic sign, not '-'.
####
Details:
Input file is twm.1
chk_man: Next line: execute mandoc -T lint twm.1
mandoc: twm.1:40:11: WARNING: cannot parse date, using it verbatim: twm 1.0.10
mandoc: twm.1:99:2: WARNING: skipping paragraph macro: PP empty
mandoc: twm.1:120:2: WARNING: skipping paragraph macro: PP after SH
mandoc: twm.1:165:2: WARNING: skipping paragraph macro: PP after SH
mandoc: twm.1:849:2: WARNING: skipping paragraph macro: PP after SH
mandoc: twm.1:1186:2: WARNING: skipping paragraph macro: PP after SH
mandoc: twm.1:1262:2: WARNING: skipping paragraph macro: PP after SH
mandoc: twm.1:1276:2: WARNING: skipping paragraph macro: PP after SH
#######
Test nr. 2:
Enable and fix warnings from 'test-groff'.
Output is from: test-groff -b -e -mandoc -T utf8 -rF0 -t -w w -z
[ "test-groff" is a developmental version of "groff" ]
Input file is ./twm.1
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an-old.tmac':381: macro 'IP'
troff: <twm.1>:377: warning: trailing space
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an-old.tmac':381: macro 'IP'
troff: <twm.1>:646: warning: trailing space
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an-old.tmac':381: macro 'IP'
troff: <twm.1>:731: warning: trailing space
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an-old.tmac':381: macro 'IP'
troff: <twm.1>:761: warning: trailing space
####
Test nr. 12:
Reduce space between words.
867:The \fIbitmapname\fP may refer to one of the built-in bitmaps
996:from f.destroy. The intent here is to delete a single window, not
#####
Test nr. 25:
Change a HYPHEN-MINUS (code 0x55, 2D) to a minus (\-), if in front of a
name for an option.
84:information requested by the user (usually through \fI-geometry\fP
765:programs that do not support an \fI-iconic\fP command line option or
#####
Test nr. 27:
Find a repeated word
! 410 --> if
! 826 --> of
! 1239 --> the
#####
Test nr. 35:
Add a comma after "e.g." and "i.e.", or use English words
(man-pages(7)).
Abbreviation points should be protected against being interpreted as
an end of sentence, if they are not, and that independent of the
current place on the line.
126:The \fIscreennumber\fP is a small positive number (e.g. 0, 1, etc.)
127:representing the screen number (e.g. the last number in the DISPLAY environment
160:by double quote characters (e.g. "blue") and are case-sensitive.
186:(e.g. to determine whether or not to enable autoraise as shown above), a string
686:unquoted, signed number (e.g. 999). This variable has an effect only
1087:integer in double quotes (e.g. "999" ). This function has an effect only
1169:specified by the argument \fIstring\fP. If \fIstring\fP is empty (i.e. ""),
1173:argument \fIstring\fP. \fIString\fP may be a number (e.g. \fB"0"\fP or
#####
Test nr. 37:
Split lines longer than 80 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
twm.1: line 249 length 90
and may only be given within a \fBColor\fP, \fBGrayscale\fP or \fBMonochrome\fP list. The
twm.1: line 256 length 94
\fBColor\fP, \fBGrayscale\fP or \fBMonochrome\fP list. The optional \fIwincolorlist\fP allows
twm.1: line 393 length 84
only be specified inside of a \fBColor\fP, \fBGrayscale\fP or \fBMonochrome\fP list.
twm.1: line 400 length 88
may only be specified inside of a \fBColor\fP, \fBGrayscale\fP or \fBMonochrome\fP list.
#####
Test nr. 42:
Remove superfluous quotation marks (") from the argument of a
single-font macro.
125:.B "$HOME/.twmrc.\fIscreennumber\fP"
132:.B "$HOME/.twmrc"
#####
Test nr. 48:
The name of a man page is set in bold and the section in roman (see
man-pages(7).
54:startup script. When used from \fIxdm(1)\fP or \fIxinit(1)\fP without
145:Widgets\fP manual and \fIxrdb(1)\fP).
340:the glyph image and mask in \fIbitmap(1)\fP form.
1277:X(7), Xserver(1), xdm(1), xrdb(1)
#####
Patch:
--- twm.1 2018-09-06 13:16:24.000000000 +0000
+++ twm.1.new 2020-04-11 01:01:14.000000000 +0000
@@ -51,7 +51,11 @@ click-to-type and pointer-driven keyboar
key and pointer button bindings.
.PP
This program is usually started by the user's session manager or
-startup script. When used from \fIxdm(1)\fP or \fIxinit(1)\fP without
+startup script. When used from
+.BR xdm (1)
+or
+.BR xinit (1)
+without
a session manager, \fItwm\fP is frequently executed in the foreground
as the last client. When run this way, exiting \fItwm\fP causes the
session to be terminated (i.e., logged out).
@@ -81,7 +85,7 @@ when the outline is in the desired posit
clicking in the title or highlight region raises the window without moving it.
.PP
When new windows are created, \fItwm\fP will honor any size and location
-information requested by the user (usually through \fI-geometry\fP
+information requested by the user (usually through \fI\-geometry\fP
command line argument or resources for the individual applications).
Otherwise, an outline of the window's default size, its titlebar, and lines
dividing the
@@ -96,7 +100,6 @@ will give the window its current positio
to touch the bottom the screen.
.SH OPTIONS
\fITwm\fP accepts the following command line options:
-.PP
.TP 8
.B \-display \fIdpy\fP
This option specifies the X server to use.
@@ -117,19 +120,18 @@ This option indicates that \fItwm\fP sho
an unexpected X Error event is received. This can be useful when debugging
applications but can be distracting in regular use.
.SH CUSTOMIZATION
-.PP
Much of \fItwm\fP's appearance and behavior can be controlled by providing
a startup file in one of the following locations (searched in order for
each screen being managed when \fItwm\fP begins):
.TP 8
-.B "$HOME/.twmrc.\fIscreennumber\fP"
-The \fIscreennumber\fP is a small positive number (e.g. 0, 1, etc.)
-representing the screen number (e.g. the last number in the DISPLAY environment
+.B $HOME/.twmrc.\fIscreennumber\fP
+The \fIscreennumber\fP is a small positive number (e.g., 0, 1, etc.)
+representing the screen number (e.g., the last number in the DISPLAY environment
variable \fIhost:displaynum.screennum\fP) that would be used to contact that
screen of the display. This is intended for displays with multiple screens of
differing visual types.
.TP 8
-.B "$HOME/.twmrc"
+.B $HOME/.twmrc
This is the usual name for an individual user's startup file.
.TP 8
.B /usr/share/X11/twm/system.twmrc
@@ -142,7 +144,8 @@ If no startup files are found, \fItwm\fP
described above. The only resource used by \fItwm\fP is
\fIbitmapFilePath\fP for a colon-separated list of directories to search
when looking for bitmap files (for more information, see the \fIAthena
-Widgets\fP manual and \fIxrdb(1)\fP).
+Widgets\fP manual and
+.BR xrdb (1)).
.PP
\fITwm\fP startup files are logically broken up into three types of
specifications: \fIVariables\fP, \fIBindings\fP, \fIMenus\fP. The
@@ -157,12 +160,11 @@ user-defined menus (containing functions
commands to be executed).
.PP
Variable names and keywords are case-insensitive. Strings must be surrounded
-by double quote characters (e.g. "blue") and are case-sensitive.
+by double quote characters (e.g., "blue") and are case-sensitive.
A pound sign (#) outside
of a string causes the remainder of the line in which the character appears to
be treated as a comment.
.SH VARIABLES
-.PP
Many of the aspects of \fItwm\fP's user interface are controlled by variables
that may be set in the user's startup file. Some of the options are
enabled or disabled simply by the presence of a particular keyword. Other
@@ -183,7 +185,7 @@ or
}
.EE
When a variable containing a list of strings representing windows is searched
-(e.g. to determine whether or not to enable autoraise as shown above), a string
+(e.g., to determine whether or not to enable autoraise as shown above), a string
must be an exact, case-sensitive match to
the window's name (given by the WM_NAME window property), resource name
or class name (both given by the WM_CLASS window property). The preceding
@@ -246,14 +248,16 @@ The default is "black".
.IP "\fBBorderTileBackground\fP \fIstring\fP [{ \fIwincolorlist\fP }]" 8
This variable specifies the default background color in the gray pattern
used in unhighlighted borders (only if \fBNoHighlight\fP hasn't been set),
-and may only be given within a \fBColor\fP, \fBGrayscale\fP or \fBMonochrome\fP list. The
-optional \fIwincolorlist\fP allows per-window colors to be specified.
-The default is "white".
+and may only be given within a \fBColor\fP, \fBGrayscale\fP or \fBMonochrome\fP
+list.
+The optional \fIwincolorlist\fP allows per-window colors to be specified.
+The default is "white".
.IP "\fBBorderTileForeground\fP \fIstring\fP [{ \fIwincolorlist\fP }]" 8
This variable specifies the default foreground color in the gray pattern
used in unhighlighted borders (only
if \fBNoHighlight\fP hasn't been set), and may only be given within a
-\fBColor\fP, \fBGrayscale\fP or \fBMonochrome\fP list. The optional \fIwincolorlist\fP allows
+\fBColor\fP, \fBGrayscale\fP or \fBMonochrome\fP list.
+The optional \fIwincolorlist\fP allows
per-window colors to be specified. The default is "black".
.IP "\fBBorderWidth\fP \fIpixels\fP" 8
This variable specifies the width in pixels of the border surrounding
@@ -304,7 +308,7 @@ For example:
{
MenuBackground "gray50"
MenuForeground "blue"
- BorderColor "red" { "XTerm" "yellow" }
+ BorderColor "red" { "XTerm" "yellow" }
TitleForeground "yellow"
TitleBackground "blue"
}
@@ -337,7 +341,9 @@ from bitmap files, the following syntax
\fIcursorname\fP "\fIimage\fP" "\fImask\fP"
.EE
The \fIimage\fP and \fImask\fP strings specify the names of files containing
-the glyph image and mask in \fIbitmap(1)\fP form.
+the glyph image and mask in
+.BR bitmap (1)
+form.
The bitmap files are located in the same manner as icon bitmap files.
The following example shows the default cursor definitions:
.EX 0
@@ -346,14 +352,14 @@ The following example shows the default
Frame "top_left_arrow"
Title "top_left_arrow"
Icon "top_left_arrow"
- IconMgr "top_left_arrow"
+ IconMgr "top_left_arrow"
Move "fleur"
Resize "fleur"
Menu "sb_left_arrow"
Button "hand2"
Wait "watch"
Select "dot"
- Destroy "pirate"
+ Destroy "pirate"
}
.EE
.IP "\fBDecorateTransients\fP" 8
@@ -374,7 +380,7 @@ as icons while other windows are handled
.IP "\fBDontMoveOff\fP" 8
This variable indicates that windows should not be allowed to be moved off the
screen. It can be overridden by the \fBf.forcemove\fP function.
-.IP "\fBDontSqueezeTitle\fP [{ \fIwin-list\fP }] " 8
+.IP "\fBDontSqueezeTitle\fP [{ \fIwin-list\fP }]" 8
This variable indicates that titlebars should not be squeezed to their
minimum size as described under \fBSqueezeTitle\fP below.
If the optional window list is supplied, only those windows will be
@@ -390,14 +396,16 @@ This variable specifies a list of color
the screen has a GrayScale default visual. See the description of \fBColors\fP.
.IP "\fBIconBackground\fP \fIstring\fP [{ \fIwin-list\fP }]" 8
This variable specifies the background color of icons, and may
-only be specified inside of a \fBColor\fP, \fBGrayscale\fP or \fBMonochrome\fP list.
+only be specified inside of a \fBColor\fP, \fBGrayscale\fP or
+\fBMonochrome\fP list.
The optional \fIwin-list\fP is a list of window names and colors so that
per-window colors may be specified. See the \fBBorderColor\fP
variable for a complete description of the \fIwin-list\fP.
The default is "white".
.IP "\fBIconBorderColor\fP \fIstring\fP [{ \fIwin-list\fP }]" 8
This variable specifies the color of the border used for icon windows, and
-may only be specified inside of a \fBColor\fP, \fBGrayscale\fP or \fBMonochrome\fP list.
+may only be specified inside of a \fBColor\fP, \fBGrayscale\fP or
+\fBMonochrome\fP list.
The optional \fIwin-list\fP is a list of window names and colors so that
per-window colors may be specified. See the \fBBorderColor\fP
variable for a complete description of the \fIwin-list\fP.
@@ -407,7 +415,7 @@ This variable specifies the width in pix
icon windows. The default is 2.
.IP "\fBIconDirectory\fP \fIstring\fP" 8
This variable specifies the directory that should be searched if
-if a bitmap file cannot be found in any of the directories
+a bitmap file cannot be found in any of the directories
in the \fBbitmapFilePath\fP resource.
.IP "\fBIconFont\fP \fIstring\fP" 8
This variable specifies the font to be used to display icon names within
@@ -484,8 +492,8 @@ the number of columns in this icon manag
.EX 0
\fBIconManagers\fP
{
- "XTerm" "=300x5+800+5" 5
- "myhost" "=400x5+100+5" 2
+ "XTerm" "=300x5+800+5" 5
+ "myhost" "=400x5+100+5" 2
}
.EE
Clients whose name or class is ``XTerm'' will have an entry created
@@ -516,7 +524,7 @@ should be used as their icons. For exam
\fBIcons\fP
{
"XTerm" "xterm.icon"
- "xfd" "xfd_icon"
+ "xfd" "xfd_icon"
}
.EE
Windows that match ``XTerm'' and would not be iconified by unmapping, and
@@ -643,7 +651,7 @@ This variable indicates that client wind
should be ignored. If the optional \fIwin-list\fP is given, only requests on
those windows will be ignored. This is typically used to prevent applications
from relentlessly popping themselves to the front of the window stack.
-.IP "\fBNoTitle\fP [{ \fIwin-list\fP }] " 8
+.IP "\fBNoTitle\fP [{ \fIwin-list\fP }]" 8
This variable indicates that windows should not have titlebars. If the
optional \fIwin-list\fP is given, only those windows will not have titlebars.
\fBMakeTitle\fP may be used with this option to force titlebars to be put
@@ -683,7 +691,7 @@ may be specified:
The default for \fITitleHighlight\fP is to use an even stipple pattern.
.IP "\fBPriority\fP \fIpriority\fP" 8
This variable sets \fItwm\fP's priority. \fIpriority\fP should be an
-unquoted, signed number (e.g. 999). This variable has an effect only
+unquoted, signed number (e.g., 999). This variable has an effect only
if the server supports the SYNC extension.
.IP "\fBRandomPlacement\fP" 8
This variable indicates that windows with no specified geometry should
@@ -728,7 +736,7 @@ This variable indicates that the icon ma
This variable indicates that entries in the icon manager should be
sorted alphabetically rather than by simply appending new windows to
the end.
-.IP "\fBSqueezeTitle\fP [{ \fIsqueeze-list\fP }] " 8
+.IP "\fBSqueezeTitle\fP [{ \fIsqueeze-list\fP }]" 8
This variable indicates that \fItwm\fP should attempt to use the SHAPE
extension to make titlebars occupy only as much screen space as they need,
rather than extending all the way across the top of the window.
@@ -744,7 +752,7 @@ are numbers specifying a ratio giving th
the titlebar is justified. The ratio is measured from left to right if
the numerator is positive, and right to left if negative. A denominator
of 0 indicates that the numerator should be measured in pixels. For
-convenience, the ratio 0/0 is the same as 1/2 for \fBcenter\fP and -1/1
+convenience, the ratio 0/0 is the same as 1/2 for \fBcenter\fP and \-1/1
for \fBright\fP. For example:
.EX 0
\fBSqueezeTitle\fP
@@ -758,11 +766,11 @@ for \fBright\fP. For example:
.EE
The \fBDontSqueezeTitle\fP list can be used to turn off squeezing on
certain titles.
-.IP "\fBStartIconified\fP [{ \fIwin-list\fP }] " 8
+.IP "\fBStartIconified\fP [{ \fIwin-list\fP }]" 8
This variable indicates that client windows should initially be left as
icons until explicitly deiconified by the user. If the optional \fIwin-list\fP
is given, only those windows will be started iconic. This is useful for
-programs that do not support an \fI-iconic\fP command line option or
+programs that do not support an \fI\-iconic\fP command line option or
resource.
.IP "\fBTitleBackground\fP \fIstring\fP [{ \fIwin-list\fP }]" 8
This variable specifies the background color used in titlebars,
@@ -823,7 +831,7 @@ where it is. The default is for \fBf.wa
This variable specifies the value to use when drawing window outlines for
moving and resizing. This should be set to a value that will result in a
variety of
-of distinguishable colors when exclusive-or'ed with the contents of the
+distinguishable colors when exclusive-or'ed with the contents of the
user's typical screen. Setting this variable to 1 often gives nice results
if adjacent colors in the default colormap are distinct. By default,
\fItwm\fP will attempt to cause temporary lines to appear at the opposite
@@ -846,7 +854,6 @@ This variable specifies the function to
from the \fBTwmWindows\fP menu. If this variable is not set, the window
will be deiconified and raised.
.SH BINDINGS
-.PP
After the desired variables have been set, functions may be attached
titlebuttons and key and pointer buttons. Titlebuttons may be added
from the left or right side and appear in the titlebar from left-to-right
@@ -864,7 +871,7 @@ or
.EX 0
\fBRightTitleButton\fP "\fIbitmapname\fP" = \fIfunction\fP
.EE
-The \fIbitmapname\fP may refer to one of the built-in bitmaps
+The \fIbitmapname\fP may refer to one of the built-in bitmaps
(which are scaled to match \fBTitleFont\fP) by using the appropriate
colon-prefixed name described above.
.PP
@@ -993,7 +1000,7 @@ property. The application is supposed t
the indicated window. If the window has not requested
WM_DELETE_WINDOW messages, the keyboard bell will be rung indicating that
the user should choose an alternative method. Note this is very different
-from f.destroy. The intent here is to delete a single window, not
+from f.destroy. The intent here is to delete a single window, not
necessarily the entire application.
.IP "\fBf.deltastop\fP" 8
This function allows a user-defined function to be aborted if the pointer has
@@ -1084,7 +1091,7 @@ windows on the current or preceding scre
.IP "\fBf.priority\fP \fIstring\fP" 8
This function sets the priority of the client owning the selected window to
the numeric value of the argument \fIstring\fP, which should be a signed
-integer in double quotes (e.g. "999" ). This function has an effect only
+integer in double quotes (e.g., "999"). This function has an effect only
if the server supports the SYNC extension.
.IP "\fBf.quit\fP" 8
This function causes \fItwm\fP to restore the window's borders and exit. If
@@ -1166,11 +1173,11 @@ if the variable \fBWarpUnmapped\fP is se
.IP "\fBf.warptoiconmgr\fP \fIstring\fP" 8
This function warps the pointer to the icon manager entry
associated with the window containing the pointer in the icon manager
-specified by the argument \fIstring\fP. If \fIstring\fP is empty (i.e. ""),
+specified by the argument \fIstring\fP. If \fIstring\fP is empty (i.e., ""),
the current icon manager is chosen.
.IP "\fBf.warptoscreen\fP \fIstring\fP" 8
This function warps the pointer to the screen specified by the
-argument \fIstring\fP. \fIString\fP may be a number (e.g. \fB"0"\fP or
+argument \fIstring\fP. \fIString\fP may be a number (e.g., \fB"0"\fP or
\fB"1"\fP), the word \fB"next"\fP (indicating the current screen plus 1,
skipping over any unmanaged screens),
the word \fB"back"\fP (indicating the current screen minus 1, skipping over
@@ -1183,7 +1190,6 @@ selected window is refreshed.
This function is similar to the \fBf.fullzoom\fP function, except that
the only the height of the selected window is changed.
.SH MENUS
-.PP
Functions may be grouped and interactively selected using pop-up
(when bound to a pointer button) or pull-down (when associated
with a titlebutton) menus. Each menu specification contains the name of the
@@ -1236,7 +1242,7 @@ a small button using the default iconify
left of the name when the window is iconified. By default, clicking on an
entry in the icon manager performs \fBf.iconify\fP.
To change the actions taken in the icon manager, use the
-the \fBiconmgr\fP context when specifying button and keyboard bindings.
+\fBiconmgr\fP context when specifying button and keyboard bindings.
.PP
Moving the pointer into the icon manager also directs keyboard focus to
the indicated window (setting the focus explicitly or else sending synthetic
@@ -1259,7 +1265,6 @@ If \fBIconifyByUnmapping\fP is on and wi
they may be lost if they are iconified and no bindings to
\fBf.menu "TwmWindows"\fP or \fBf.warpto\fP are setup.
.SH FILES
-.PP
.nf
.I $HOME/.twmrc.<screen number>
.I $HOME/.twmrc
@@ -1273,8 +1278,10 @@ during \fBf.exec\fP so that programs com
This variable is used as the prefix for files that begin with a tilde and
for locating the \fItwm\fP startup file.
.SH "SEE ALSO"
-.PP
-X(7), Xserver(1), xdm(1), xrdb(1)
+.BR X (7),
+.BR Xserver (1),
+.BR xdm (1),
+.BR xrdb (1)
.SH AUTHORS
Tom LaStrange, Solbourne Computer; Jim Fulton, MIT X Consortium;
Steve Pitschke, Stardent Computer; Keith Packard, MIT X Consortium;
-- System Information:
Debian Release: bullseye/sid
APT prefers testing
APT policy: (500, 'testing'), (500, 'stable')
Architecture: amd64 (x86_64)
Kernel: Linux 5.4.19-1 (SMP w/2 CPU cores)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1), LANGUAGE=is_IS.iso88591 (charmap=ISO-8859-1)
Shell: /bin/sh linked to /bin/dash
Init: sysvinit (via /sbin/init)
Versions of packages twm depends on:
ii libc6 2.30-4
ii libice6 2:1.0.9-2
ii libsm6 2:1.2.3-1
ii libx11-6 2:1.6.9-2
ii libxext6 2:1.3.3-1+b2
ii libxmu6 2:1.1.2-2+b3
ii libxt6 1:1.1.5-1+b3
ii menu 2.1.47+b1
twm recommends no packages.
twm suggests no packages.
-- no debconf information
--
Bjarni I. Gislason
Reply to: