Bug 9522

Summary: Markup problems on the xtrap.1x page
Product: xorg Reporter: Eric S. Raymond <esr>
Component: App/otherAssignee: Jeremy Huddleston Sequoia <jeremyhu>
Status: RESOLVED FIXED QA Contact: Xorg Project Team <xorg-team>
Severity: normal    
Priority: high Keywords: patch
Version: unspecified   
Hardware: x86 (IA32)   
OS: Linux (All)   
Whiteboard: 2011BRB_Reviewed
i915 platform: i915 features:

Description Eric S. Raymond 2007-01-02 10:16:16 UTC
See http://catb.org/~esr/doclifter/problems.html for details on how and
why these patches were generated.  Feel free to email me with any questions.

Problems with xtrap.1x:

1. Unknown or invalid macro.  That is, one that does not fit in the
macro set that the man page seems to be using.  This is a serious
error; it often means part of your text is being lost or rendered
incorrectly.

2. SYNTAX section is actually a Unix SYNOPSIS and should be so marked.

3. .EX/.EE macros are missing or misplaced.

--- xtrap.1x-orig	2006-12-19 16:06:46.000000000 -0500
+++ xtrap.1x	2006-12-19 16:08:24.000000000 -0500
@@ -3,8 +3,7 @@
 .SH NAME
 xtrapreset, xtrapinfo, xtrapstats, xtrapout, xtrapin, xtrapchar, xtrapproto  
 - XTrap sample clients
-.SH SYNTAX
-.NXR "XTrap X Server Extension Sample Clients"
+.SH SYNOPSIS
 .B xtrapreset
 [
 .B \-d[isplay]
@@ -172,15 +171,14 @@
 server.
 .SH SOURCES
 .LP
-.EX
 Sources have been posted on UseNet systems via anonymous ftp.
 They are:
+.EX
 East Coast (USA):   export@lcs.mit.edu:contrib/XTrap_v32*.tar.Z
 West Coast (USA):   gatekeeper@pa.dec.com:X11/contrib/XTrap_v32*.tar.Z
-
+.EE
 .SH IMPORTANT NOTE
 .LP
-.EX
 Digital participated in the X Consortium's xtest working group which 
 chose to evolve XTrap functionality into a new extension for X11/R6
 known as the RECORD extension (XTrap input synthesis functionality is
@@ -196,21 +194,23 @@
 If you encounter problems, have questions, etc. with XTrap, please contact 
 via mail, phone, etc. at:
 
+.EX
         Ken Miller
 	miller@zk3.dec.com
 	(VOICE) 603-881-6221
         (FAX)   603 881-2257
+.EE
 
 or paper mail at:
 
+.EX
         Digital Equipment Corp.
         Ken Miller @ ZKO3-3/Y25
         110 Spitbrook Rd.
         Nashua, NH 03062
+.EE
 
 Naturally email is preferred and will get the fastest response.
-.EE
 .SH SEE ALSO
 X(1)
-.NXE "X"
Comment 1 Daniel Stone 2007-02-27 01:35:27 UTC
Sorry about the phenomenal bug spam, guys.  Adding xorg-team@ to the QA contact so bugs don't get lost in future.
Comment 2 Alan Coopersmith 2013-07-13 21:43:00 UTC
Fix pushed to git, though xtrap is no longer widely used/shipped, having
been superseded by the XTest & XRecord protocols.

http://cgit.freedesktop.org/xorg/app/xtrap/commit/?id=8577e3b4b89a6667c4d6c6f3d2485b9352b1e3a0

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.