[TCLCORE] problems in one or more man pages you maintain

[<es...@th...>]

This is automatically generated email about problems in a man page for which
you appear to be responsible.  If you are not the right person or list, tell
me and I will attempt to correct my database.

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.

Note: This patch does not change the mod date of the manual page.  You
may wish to do that by hand.

Problems with CrtImgType.3:

1. Garbled C code in a function synopsis.

--- CrtImgType.3-orig	2003-11-30 14:07:32.000000000 -0500
+++ CrtImgType.3	2003-11-30 14:11:51.000000000 -0500
@@ -252,7 +252,6 @@
 \fB#include <tk.h>\fR
 .sp
 \fBTk_CreateImageType\fR(\fItypePtr\fR)
-ClientData
 .sp
 .VS
 \fBTk_GetImageMasterData\fR(\fIinterp, name, typePtrPtr\fR)
Problems with Tk_InitImageArgs.3:

1. Garbled C code in a function synopsis.

--- Tk_InitImageArgs.3-orig	2003-12-01 01:49:02.000000000 -0500
+++ Tk_InitImageArgs.3	2003-12-01 01:49:24.000000000 -0500
@@ -252,7 +252,6 @@
 \fB#include <tk.h>\fR
 .sp
 \fBTk_CreateImageType\fR(\fItypePtr\fR)
-ClientData
 .sp
 .VS
 \fBTk_GetImageMasterData\fR(\fIinterp, name, typePtrPtr\fR)
Problems with GetUid.3:

1. C syntax error.

--- GetUid.3-orig	2003-12-03 15:26:34.000000000 -0500
+++ GetUid.3	2003-12-03 15:26:53.000000000 -0500
@@ -251,10 +251,10 @@
 .nf
 \fB#include <tk.h>\fR
 .sp
-\fB#typedef char *Tk_Uid\fR
+\fBtypedef char *Tk_Uid\fR
 .sp
 Tk_Uid
-\fBTk_GetUid\fR(\fIstring\fR)
+\fBTk_GetUid\fR(\fIstring\fR);
 .SH ARGUMENTS
 .AP char *string in
 String for which the corresponding unique identifier is
Problems with Tk_Uid.3:

1. C syntax error.

--- Tk_Uid.3-orig	2003-12-03 17:17:51.000000000 -0500
+++ Tk_Uid.3	2003-12-03 17:18:08.000000000 -0500
@@ -251,10 +251,10 @@
 .nf
 \fB#include <tk.h>\fR
 .sp
-\fB#typedef char *Tk_Uid\fR
+\fBtypedef char *Tk_Uid\fR
 .sp
 Tk_Uid
-\fBTk_GetUid\fR(\fIstring\fR)
+\fBTk_GetUid\fR(\fIstring\fR);
 .SH ARGUMENTS
 .AP char *string in
 String for which the corresponding unique identifier is
Problems with Tclx_Init.3:

1. Broken command synopsis syntax.  This may mean you're using a
construction in the command synopsis other than the standard
[ ] | { }, or it may mean you have running text in the command synopsis
section (the latter is not technically an error, but it's impossible
to translate into DocBook markup).

--- Tclx_Init.3-orig	2003-11-30 17:27:12.000000000 -0500
+++ Tclx_Init.3	2003-11-30 17:30:05.000000000 -0500
@@ -23,8 +23,6 @@
 .SH SYNOPSIS
 .nf
 .ft CW
--ltclx -ltcl
-
 #include "tclExtend.h"
 
 int
@@ -53,6 +51,9 @@
                  char *appLongName,
                  char *appVersion,
                  int   appPatchlevel);
+.PP
+To use these functions, you must include -ltclx -ltcl in the command 
+that links your C application.
 
 .ft R
 .fi
Problems with TclX_Main.3:

1. Broken command synopsis syntax.  This may mean you're using a
construction in the command synopsis other than the standard
[ ] | { }, or it may mean you have running text in the command synopsis
section (the latter is not technically an error, but it's impossible
to translate into DocBook markup).

--- TclX_Main.3-orig	2003-12-03 17:25:48.000000000 -0500
+++ TclX_Main.3	2003-12-03 17:27:44.000000000 -0500
@@ -23,8 +23,6 @@
 .SH SYNOPSIS
 .nf
 .ft CW
--ltclx -ltcl
-
 #include "tclExtend.h"
 
 int
@@ -55,6 +53,8 @@
                  int   appPatchlevel);
 
 .ft R
+Link your program with the Tcl libraries, using the
+options -ltclx -ltcl, to get access to these functions.
 .fi
 .SH DESCRIPTION
 These functions are used to initialize Extended Tcl and applications based
Problems with Tclxcmd_Init.3:

1. Broken command synopsis syntax.  This may mean you're using a
construction in the command synopsis other than the standard
[ ] | { }, or it may mean you have running text in the command synopsis
section (the latter is not technically an error, but it's impossible
to translate into DocBook markup).

--- Tclxcmd_Init.3-orig	2003-12-04 11:57:50.000000000 -0500
+++ Tclxcmd_Init.3	2003-12-04 11:58:35.000000000 -0500
@@ -23,8 +23,6 @@
 .SH SYNOPSIS
 .nf
 .ft CW
--ltclx -ltcl
-
 #include "tclExtend.h"
 
 int
@@ -55,6 +53,8 @@
                  int   appPatchlevel);
 
 .ft R
+Link your program with the Tcl libraries, using the
+options -ltclx -ltcl, to get access to these functions.
 .fi
 .SH DESCRIPTION
 These functions are used to initialize Extended Tcl and applications based

--
                             Eric S. Raymond