~ubuntu-branches/ubuntu/intrepid/libgtkada2/intrepid

« back to all changes in this revision

Viewing changes to debian/patches/01-doc.patch

  • Committer: Bazaar Package Importer
  • Author(s): Luca Falavigna
  • Date: 2008-08-11 09:46:51 UTC
  • mfrom: (6.1.1 squeeze)
  • Revision ID: james.westby@ubuntu.com-20080811094651-9mjd6acwa98ffw5c
Tags: 2.12.0-2ubuntu1
Add lpia to supported architectures.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
Adjust the info and man page files to Debian.
 
2
 
 
3
-- 
 
4
Ludovic Brenta.
 
5
 
 
6
Index: libgtkada2-2.12.0/docs/gate.1
 
7
===================================================================
 
8
--- libgtkada2-2.12.0.orig/docs/gate.1
 
9
+++ libgtkada2-2.12.0/docs/gate.1
 
10
@@ -1,33 +1,34 @@
 
11
-.TH GATE 1 "29 March 1999" "GNU Debian/Linux" "GtkAda programming manual"
 
12
+.TH GATE2 1 "2 July 2003" "Debian GNU/Linux" "GtkAda 2 programming manual"
 
13
 .SH NAME
 
14
-gate \- generate Ada applications from a GLADE XML file
 
15
+gate2 \- generate Ada applications from a GLADE XML file
 
16
 .SH SYNOPSIS
 
17
-.B gate
 
18
+.B gate2
 
19
 .I file
 
20
 .SH DESCRIPTION
 
21
-\fIgate\fP is the static version of the program transforming
 
22
-a file produced by \fIglade(1)\fP, the Gtk GUI builder, into an Ada
 
23
-program.
 
24
-It will generate a set of Ada files that, when compiled, will
 
25
-recreate the interface you just designed in \fIglade(1)\fP.
 
26
-The most important file created by Gate is called
 
27
+\fIgate2\fP is the static version of the program transforming a file
 
28
+produced by \fIglade-2(1)\fP, the Gtk GUI builder, into an Ada
 
29
+program.  It will generate a set of Ada files that, when compiled,
 
30
+will recreate the interface you just designed in \fIglade-2(1)\fP.
 
31
+The most important file created by gate2 is called
 
32
 .\" .IR "callback_<project_name>.adb" .
 
33
 .IB "callback_" "<project_name>" ".adb"
 
34
 and contains stubs for all the callbacks you declared in Glade.
 
35
 .PP
 
36
-Note that you can easily go back to Glade any time, modify your interface,
 
37
-and have \fIgate\fP regenerate a set of files. All your modifications will be
 
38
-kept in the new files. For that, \fIgate\fP creates a directory
 
39
-.B .gate
 
40
-in the current directory. Please do not delete it if you want \fIgate\fP to be able to
 
41
-keep your changes from one version to the next.
 
42
-Also note that to be able to keep track of your modifications, gate relies on
 
43
-patch and diff being available on your system. If you don't have a working set
 
44
-of diff/patch, configure will simply replace them by null operations.
 
45
+Note that you can easily go back to glade-2 any time, modify your
 
46
+interface, and have \fIgate2\fP regenerate a set of files. All your
 
47
+modifications will be kept in the new files. For that, \fIgate2\fP
 
48
+creates a directory
 
49
+.B .gate2
 
50
+in the current directory. Please do not delete it if you want
 
51
+\fIgate2\fP to be able to keep your changes from one version to the
 
52
+next.  Also note that to be able to keep track of your modifications,
 
53
+gate2 relies on patch and diff being available on your system. If you
 
54
+don't have a working set of diff/patch, configure will simply replace
 
55
+them by null operations.
 
56
 .SH "SEE ALSO"
 
57
-.BR gtkada-config (1),
 
58
-.BR dgate (1),
 
59
-.BR glade (1)
 
60
+.BR gtkada2-config (1),
 
61
+.BR dgate2 (1),
 
62
+.BR glade-2 (1)
 
63
 .SH "COPYRIGHT FOR THIS MAN PAGE"
 
64
 This man page has been written by Samuel Tardieu
 
65
 for the Debian GNU/Linux distribution, from informations given
 
66
Index: libgtkada2-2.12.0/docs/gtkada-config.1
 
67
===================================================================
 
68
--- libgtkada2-2.12.0.orig/docs/gtkada-config.1
 
69
+++ libgtkada2-2.12.0/docs/gtkada-config.1
 
70
@@ -1,48 +1,55 @@
 
71
-.TH GTKADA-CONFIG 1 "29 March 1999" "GNU Debian/Linux" "GtkAda programming manual"
 
72
+.TH GTKADA2-CONFIG 1 "2 July 2003" "Debian GNU/Linux" "GtkAda 2 programming manual"
 
73
 .SH NAME
 
74
-gtkada-config - script to get information about the installed version of GTKADA
 
75
+gtkada2-config - script to get information about the installed version of GTKADA
 
76
 .SH SYNOPSIS
 
77
-.B gtkada-config
 
78
+.B gtkada2-config
 
79
 [\-\-prefix\fI[=DIR]\fP] [\-\-version] [\-\-libs] [\-\-cflags] [\-\-static]
 
80
 .SH DESCRIPTION
 
81
 .PP
 
82
-\fIgtkada-config\fP is a tool that is used to configure to determine
 
83
-the compiler and linker flags that should be used to compile
 
84
-and link programs that use \fIGTKADA\fP.
 
85
-.
 
86
+\fIgtkada2-config\fR is a tool that is used to configure to determine
 
87
+the compiler and linker flags that should be used to compile and link
 
88
+programs that use GtkAda.  To compile, bind and link a program against
 
89
+GtkAda, you invoke \fBgnatmake\fR like this:
 
90
+
 
91
+  gnatmake my_prog `gtkada2-config`
 
92
+
 
93
 .SH OPTIONS
 
94
-.l
 
95
-\fIgtkada-config\fP accepts the following options:
 
96
+\fBgtkada2-config\fR accepts the following options:
 
97
 .TP 8
 
98
 .B  \-\-version
 
99
-Print the currently installed version of \fIGTKADA\fP on the standard output.
 
100
+Print the currently installed version of \fIGTKADA\fR on the standard output.
 
101
 .TP 8
 
102
 .B  \-\-libs
 
103
-Print the linker flags that are necessary to link a \fIGTKADA\fP program.
 
104
+Print the linker flags that are necessary to link a \fIGTKADA\fR program.
 
105
 .TP 8
 
106
 .B  \-\-cflags
 
107
-Print the compiler flags that are necessary to compile a \fIGTKADA\fP program.
 
108
+Print the compiler flags that are necessary to compile a \fIGTKADA\fR program.
 
109
 .TP 8
 
110
 .B  \-\-static
 
111
-Print the flags that are necessary to statically build a \fIGTKADA\fP program.
 
112
+Print the flags that are necessary to statically build a \fIGTKADA\fR program.
 
113
 .TP 8
 
114
 .B  \-\-prefix=PREFIX
 
115
-If specified, use PREFIX instead of the installation prefix that \fIGTKADA\fP
 
116
-was built with when computing the output for the \-\-cflags and
 
117
-\-\-libs options. This option must be specified
 
118
-before any \-\-libs or \-\-cflags options.
 
119
+Use PREFIX instead of the installation prefix that \fIGTKADA\fR was
 
120
+built with when computing the output for the \-\-cflags and \-\-libs
 
121
+options. This option must be specified before any \-\-libs or
 
122
+\-\-cflags options.
 
123
+
 
124
+.SH NOTES
 
125
+In Debian GNU/Linux, a GNAT project file is available as an
 
126
+alternative; see \fB/usr/share/ada/adainclude/gtkada2.gpr\fR.
 
127
+
 
128
 .SH "SEE ALSO"
 
129
-.BR gate (1),
 
130
-.BR dgate (1),
 
131
-.BR glade (1)
 
132
+.BR gate2 (1),
 
133
+.BR dgate2 (1),
 
134
+.BR glade-2 (1)
 
135
 .SH "COPYRIGHT FOR THIS MAN PAGE"
 
136
-This man page has been written by Samuel Tardieu
 
137
-for the Debian GNU/Linux distribution, from informations given
 
138
-by the GtkAda authors Emmanuel Briot, Joel Brobecker and Arnaud Charlet.
 
139
-
 
140
-Permission to use, copy, modify, and distribute this documentation
 
141
-for any purpose and without fee is hereby granted,
 
142
-provided that the above copyright notice appear in all copies and that
 
143
-both that copyright notice and this permission notice appear in
 
144
-supporting documentation.
 
145
+This man page has been written by Samuel Tardieu and modified by
 
146
+Ludovic Brenta for the Debian GNU/Linux distribution, from
 
147
+informations given by the GtkAda authors Emmanuel Briot, Joel
 
148
+Brobecker and Arnaud Charlet.
 
149
+
 
150
+Permission to use, copy, modify, and distribute this documentation for
 
151
+any purpose and without fee is hereby granted, provided that the above
 
152
+copyright notice appear in all copies and that both that copyright
 
153
+notice and this permission notice appear in supporting documentation.
 
154
 
 
155
Index: libgtkada2-2.12.0/docs/generate.1
 
156
===================================================================
 
157
--- /dev/null
 
158
+++ libgtkada2-2.12.0/docs/generate.1
 
159
@@ -0,0 +1,84 @@
 
160
+.TH GENERATE2 1 "25 Nov 2003" "Debian GNU/Linux" "GtkAda 2 programming manual"
 
161
+.SH NAME
 
162
+generate2 \- Generate an Ada binding to a GTK+ widget
 
163
+.SH SYNOPSIS
 
164
+generate2 \fIc_file\fR [\fIdefinition-file unit_name\fR]
 
165
+
 
166
+generate2 -l \fIc_file\fR [\fIada_file\fR]
 
167
+.SH DESCRIPTION
 
168
+This script reads \fIc_file\fR, a C header file describing a new GTK+
 
169
+widget, and produces an Ada 95 thick binding to it on standard output.
 
170
+The binding makes it possible to use the widget from within Ada
 
171
+programs, just like other GTK+ widgets.
 
172
+
 
173
+\fBgenerate2\fR does not fully automate the process, although it
 
174
+should really speed things up. You will probably need less than 15 min
 
175
+to create a new binding once you get used to the way GtkAda
 
176
+works. Note that \fIc_file\fR should have the same format as is used
 
177
+by GTK+ itself.
 
178
+
 
179
+Here are the steps to create a new binding :
 
180
+
 
181
+.IP \(bu 3
 
182
+Give the \fBgenerate2\fR script the C header file.
 
183
+
 
184
+.IP \(bu
 
185
+For every field in the C structure, the script asks you whether or
 
186
+not you want to create a function to make it accessible from Ada.
 
187
+Answer y or n (the default value is n, just press ENTER).  Example:
 
188
+
 
189
+   $ generate2 ../include/gtk/gtkbutton.h > temporary
 
190
+   Create a function for the field child (of type GtkWidget*) [n]?
 
191
+   Create a function for the field in_button (of type guint) [n]?
 
192
+   Create a function for the field button_down (of type guint) [n]?
 
193
+
 
194
+.IP \(bu
 
195
+If you answered yes to at least one of the above questions, create a
 
196
+new C file, and move the C part of the temporary file created by
 
197
+generate2 to this C file.
 
198
+
 
199
+.IP \(bu
 
200
+Do a \fBgnatchop\fR on the temporary file created by generate2.
 
201
+This should create two Ada files (spec and body).
 
202
+
 
203
+.IP \(bu
 
204
+Edit these two files as needed (generally to change some parameters
 
205
+from Gint to Boolean for instance).  It can be a little bit tricky
 
206
+when one of your functions returns a GList* or a GSList*. Please have
 
207
+a look at `/usr/share/ada/adainclude/gtkada2/gtk-combo.ads' for
 
208
+examples how to do this.
 
209
+
 
210
+.SH OPTIONS
 
211
+
 
212
+.TP
 
213
+.B -l
 
214
+Simply list the functions defined in the file (C or Ada).  If an
 
215
+\fIada_file\fR argument is present, the output will only show the
 
216
+differences between the two files.
 
217
+.TP
 
218
+.I file_name
 
219
+name of the C file to parse.
 
220
+.TP
 
221
+.I definition_file
 
222
+The file to parse for interface definition.
 
223
+.TP
 
224
+.I unit_name
 
225
+If present, only the functions including this name will be generated.
 
226
+.SH EXAMPLES
 
227
+generate2 ../include/gdk/gdk.h ../include/gdk/gdktypes.h window
 
228
+
 
229
+generate2 ../include/gtk/gtkframe.h
 
230
+.SH SEE ALSO
 
231
+.BR gtkada2-config (1),
 
232
+.BR gate2 (1),
 
233
+.BR glade-2 (1),
 
234
+.BR gnatchop (1)
 
235
+.SH COPYRIGHT FOR THIS MAN PAGE
 
236
+This man page has been written by Ludovic Brenta for the Debian
 
237
+GNU/Linux distribution, from information given by the GtkAda authors
 
238
+Emmanuel Briot, Joel Brobecker and Arnaud Charlet.
 
239
+
 
240
+Permission to use, copy, modify, and distribute this documentation for
 
241
+any purpose and without fee is hereby granted, provided that the above
 
242
+copyright notice appear in all copies and that both that copyright
 
243
+notice and this permission notice appear in supporting documentation.
 
244
Index: libgtkada2-2.12.0/docs/gdialog.1
 
245
===================================================================
 
246
--- /dev/null
 
247
+++ libgtkada2-2.12.0/docs/gdialog.1
 
248
@@ -0,0 +1,49 @@
 
249
+.TH GDIALOG2 1 "25 Nov 2003" "Debian GNU/Linux" "GtkAda 2 programming manual"
 
250
+.SH NAME
 
251
+gdialog2 \- Display a GTK+ dialog box from the command line.
 
252
+.SH SYNOPSIS
 
253
+gdialog2 [\fIdialog_type\fR [\fIjustification\fR]]
 
254
+.SH DESCRIPTION
 
255
+\fBgdialog2\fR displays the contents of its standard input in a GTK+
 
256
+dialog box.  This is the version supplied with GtkAda version 2, and
 
257
+it uses GTK+ 2 widgets.
 
258
+.SH OPTIONS
 
259
+.TP 5
 
260
+.I dialog_type
 
261
+The type of dialog box desired.  Possible values are:
 
262
+.RS
 
263
+.TP 13
 
264
+.BR warning
 
265
+A message box with an exclamation point.
 
266
+.TP
 
267
+.BR error
 
268
+A message box with a red stop sign.
 
269
+.TP
 
270
+.BR information
 
271
+A message box with an "information" sign: white "i" on blue
 
272
+background.
 
273
+.TP
 
274
+.BR confirmation
 
275
+A message box with a question mark.
 
276
+.TP
 
277
+.BR custom
 
278
+A message box with no pixmap and a user-defined caption.
 
279
+.RE
 
280
+
 
281
+The default type is \fBinformation\fR.
 
282
+
 
283
+.TP
 
284
+.I justification
 
285
+The type of justification desired for the text of the message.
 
286
+Possible values are \fBjustify_left\fR, \fBjustify_right\fR,
 
287
+\fBjustify_center\fR and \fBjustify_fill\fR.  The default is
 
288
+\fBjustify_center\fR.
 
289
+.SH COPYRIGHT FOR THIS MAN PAGE
 
290
+This man page has been written by Ludovic Brenta for the Debian
 
291
+GNU/Linux distribution, from information given by the GtkAda authors
 
292
+Emmanuel Briot, Joel Brobecker and Arnaud Charlet.
 
293
+
 
294
+Permission to use, copy, modify, and distribute this documentation for
 
295
+any purpose and without fee is hereby granted, provided that the above
 
296
+copyright notice appear in all copies and that both that copyright
 
297
+notice and this permission notice appear in supporting documentation.
 
298
Index: libgtkada2-2.12.0/docs/gtkada_ug/gtkada_ug.texi
 
299
===================================================================
 
300
--- libgtkada2-2.12.0.orig/docs/gtkada_ug/gtkada_ug.texi
 
301
+++ libgtkada2-2.12.0/docs/gtkada_ug/gtkada_ug.texi
 
302
@@ -1,12 +1,12 @@
 
303
 \input texinfo   @c -*-texinfo-*-
 
304
 @c %**start of header
 
305
-@setfilename gtkada_ug.info
 
306
+@setfilename gtkada2_ug.info
 
307
 @settitle GtkAda User's Guide
 
308
 @syncodeindex fn cp
 
309
 
 
310
 @dircategory User Interface Toolkit
 
311
 @direntry
 
312
-* GtkAda_Ug: (gtkada_ug).           Ada95 graphical tookit based on GTK+ (User's Guide)
 
313
+* GtkAda2 User's Guide: (gtkada2_ug).           Ada95 graphical tookit based on GTK+ (User's Guide)
 
314
 @end direntry 
 
315
 
 
316
 @set GtkAdaVersion 2.12.0