~ubuntu-branches/ubuntu/utopic/critcl/utopic

« back to all changes in this revision

Viewing changes to embedded/man/files/critcl_sources.n

  • Committer: Package Import Robot
  • Author(s): Andrew Shadura
  • Date: 2013-05-11 00:08:06 UTC
  • Revision ID: package-import@ubuntu.com-20130511000806-7hq1zc3fnn0gat79
Tags: upstream-3.1.9
ImportĀ upstreamĀ versionĀ 3.1.9

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
'\"
 
2
'\" Generated from file '/home/aku/Projects/Packages/Critcl/dev-master/embedded/man/files/critcl_sources\&.n' by tcllib/doctools with format 'nroff'
 
3
'\" Copyright (c) Jean-Claude Wippler
 
4
'\" Copyright (c) Steve Landers
 
5
'\" Copyright (c) 2011-2013 Andreas Kupries
 
6
'\"
 
7
'\" The definitions below are for supplemental macros used in Tcl/Tk
 
8
'\" manual entries.
 
9
'\"
 
10
'\" .AP type name in/out ?indent?
 
11
'\"     Start paragraph describing an argument to a library procedure.
 
12
'\"     type is type of argument (int, etc.), in/out is either "in", "out",
 
13
'\"     or "in/out" to describe whether procedure reads or modifies arg,
 
14
'\"     and indent is equivalent to second arg of .IP (shouldn't ever be
 
15
'\"     needed;  use .AS below instead)
 
16
'\"
 
17
'\" .AS ?type? ?name?
 
18
'\"     Give maximum sizes of arguments for setting tab stops.  Type and
 
19
'\"     name are examples of largest possible arguments that will be passed
 
20
'\"     to .AP later.  If args are omitted, default tab stops are used.
 
21
'\"
 
22
'\" .BS
 
23
'\"     Start box enclosure.  From here until next .BE, everything will be
 
24
'\"     enclosed in one large box.
 
25
'\"
 
26
'\" .BE
 
27
'\"     End of box enclosure.
 
28
'\"
 
29
'\" .CS
 
30
'\"     Begin code excerpt.
 
31
'\"
 
32
'\" .CE
 
33
'\"     End code excerpt.
 
34
'\"
 
35
'\" .VS ?version? ?br?
 
36
'\"     Begin vertical sidebar, for use in marking newly-changed parts
 
37
'\"     of man pages.  The first argument is ignored and used for recording
 
38
'\"     the version when the .VS was added, so that the sidebars can be
 
39
'\"     found and removed when they reach a certain age.  If another argument
 
40
'\"     is present, then a line break is forced before starting the sidebar.
 
41
'\"
 
42
'\" .VE
 
43
'\"     End of vertical sidebar.
 
44
'\"
 
45
'\" .DS
 
46
'\"     Begin an indented unfilled display.
 
47
'\"
 
48
'\" .DE
 
49
'\"     End of indented unfilled display.
 
50
'\"
 
51
'\" .SO
 
52
'\"     Start of list of standard options for a Tk widget.  The
 
53
'\"     options follow on successive lines, in four columns separated
 
54
'\"     by tabs.
 
55
'\"
 
56
'\" .SE
 
57
'\"     End of list of standard options for a Tk widget.
 
58
'\"
 
59
'\" .OP cmdName dbName dbClass
 
60
'\"     Start of description of a specific option.  cmdName gives the
 
61
'\"     option's name as specified in the class command, dbName gives
 
62
'\"     the option's name in the option database, and dbClass gives
 
63
'\"     the option's class in the option database.
 
64
'\"
 
65
'\" .UL arg1 arg2
 
66
'\"     Print arg1 underlined, then print arg2 normally.
 
67
'\"
 
68
'\" RCS: @(#) $Id: man.macros,v 1.1 2009/01/30 04:56:47 andreas_kupries Exp $
 
69
'\"
 
70
'\"     # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
 
71
.if t .wh -1.3i ^B
 
72
.nr ^l \n(.l
 
73
.ad b
 
74
'\"     # Start an argument description
 
75
.de AP
 
76
.ie !"\\$4"" .TP \\$4
 
77
.el \{\
 
78
.   ie !"\\$2"" .TP \\n()Cu
 
79
.   el          .TP 15
 
80
.\}
 
81
.ta \\n()Au \\n()Bu
 
82
.ie !"\\$3"" \{\
 
83
\&\\$1  \\fI\\$2\\fP    (\\$3)
 
84
.\".b
 
85
.\}
 
86
.el \{\
 
87
.br
 
88
.ie !"\\$2"" \{\
 
89
\&\\$1  \\fI\\$2\\fP
 
90
.\}
 
91
.el \{\
 
92
\&\\fI\\$1\\fP
 
93
.\}
 
94
.\}
 
95
..
 
96
'\"     # define tabbing values for .AP
 
97
.de AS
 
98
.nr )A 10n
 
99
.if !"\\$1"" .nr )A \\w'\\$1'u+3n
 
100
.nr )B \\n()Au+15n
 
101
.\"
 
102
.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
 
103
.nr )C \\n()Bu+\\w'(in/out)'u+2n
 
104
..
 
105
.AS Tcl_Interp Tcl_CreateInterp in/out
 
106
'\"     # BS - start boxed text
 
107
'\"     # ^y = starting y location
 
108
'\"     # ^b = 1
 
109
.de BS
 
110
.br
 
111
.mk ^y
 
112
.nr ^b 1u
 
113
.if n .nf
 
114
.if n .ti 0
 
115
.if n \l'\\n(.lu\(ul'
 
116
.if n .fi
 
117
..
 
118
'\"     # BE - end boxed text (draw box now)
 
119
.de BE
 
120
.nf
 
121
.ti 0
 
122
.mk ^t
 
123
.ie n \l'\\n(^lu\(ul'
 
124
.el \{\
 
125
.\"     Draw four-sided box normally, but don't draw top of
 
126
.\"     box if the box started on an earlier page.
 
127
.ie !\\n(^b-1 \{\
 
128
\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 
129
.\}
 
130
.el \}\
 
131
\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 
132
.\}
 
133
.\}
 
134
.fi
 
135
.br
 
136
.nr ^b 0
 
137
..
 
138
'\"     # VS - start vertical sidebar
 
139
'\"     # ^Y = starting y location
 
140
'\"     # ^v = 1 (for troff;  for nroff this doesn't matter)
 
141
.de VS
 
142
.if !"\\$2"" .br
 
143
.mk ^Y
 
144
.ie n 'mc \s12\(br\s0
 
145
.el .nr ^v 1u
 
146
..
 
147
'\"     # VE - end of vertical sidebar
 
148
.de VE
 
149
.ie n 'mc
 
150
.el \{\
 
151
.ev 2
 
152
.nf
 
153
.ti 0
 
154
.mk ^t
 
155
\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
 
156
.sp -1
 
157
.fi
 
158
.ev
 
159
.\}
 
160
.nr ^v 0
 
161
..
 
162
'\"     # Special macro to handle page bottom:  finish off current
 
163
'\"     # box/sidebar if in box/sidebar mode, then invoked standard
 
164
'\"     # page bottom macro.
 
165
.de ^B
 
166
.ev 2
 
167
'ti 0
 
168
'nf
 
169
.mk ^t
 
170
.if \\n(^b \{\
 
171
.\"     Draw three-sided box if this is the box's first page,
 
172
.\"     draw two sides but no top otherwise.
 
173
.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 
174
.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 
175
.\}
 
176
.if \\n(^v \{\
 
177
.nr ^x \\n(^tu+1v-\\n(^Yu
 
178
\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
 
179
.\}
 
180
.bp
 
181
'fi
 
182
.ev
 
183
.if \\n(^b \{\
 
184
.mk ^y
 
185
.nr ^b 2
 
186
.\}
 
187
.if \\n(^v \{\
 
188
.mk ^Y
 
189
.\}
 
190
..
 
191
'\"     # DS - begin display
 
192
.de DS
 
193
.RS
 
194
.nf
 
195
.sp
 
196
..
 
197
'\"     # DE - end display
 
198
.de DE
 
199
.fi
 
200
.RE
 
201
.sp
 
202
..
 
203
'\"     # SO - start of list of standard options
 
204
.de SO
 
205
.SH "STANDARD OPTIONS"
 
206
.LP
 
207
.nf
 
208
.ta 4c 8c 12c
 
209
.ft B
 
210
..
 
211
'\"     # SE - end of list of standard options
 
212
.de SE
 
213
.fi
 
214
.ft R
 
215
.LP
 
216
See the \\fBoptions\\fR manual entry for details on the standard options.
 
217
..
 
218
'\"     # OP - start of full description for a single option
 
219
.de OP
 
220
.LP
 
221
.nf
 
222
.ta 4c
 
223
Command-Line Name:      \\fB\\$1\\fR
 
224
Database Name:  \\fB\\$2\\fR
 
225
Database Class: \\fB\\$3\\fR
 
226
.fi
 
227
.IP
 
228
..
 
229
'\"     # CS - begin code excerpt
 
230
.de CS
 
231
.RS
 
232
.nf
 
233
.ta .25i .5i .75i 1i
 
234
..
 
235
'\"     # CE - end code excerpt
 
236
.de CE
 
237
.fi
 
238
.RE
 
239
..
 
240
.de UL
 
241
\\$1\l'|0\(ul'\\$2
 
242
..
 
243
.TH "critcl_sources" n 3\&.1\&.8 doc "C Runtime In Tcl (CriTcl)"
 
244
.BS
 
245
.SH NAME
 
246
critcl_sources \- Critcl - How To Get The Sources
 
247
.SH DESCRIPTION
 
248
Welcome to the \fIC Runtime In Tcl\fR, \fICriTcl\fR for short, a
 
249
system to build C extension packages for Tcl on the fly, from C code
 
250
embedded within Tcl scripts, for all who wish to make their code go
 
251
faster\&.
 
252
.PP
 
253
The audience of this document is anyone wishing to either have
 
254
just a look at Critcl's source code, or build the packages, or to
 
255
extend and modify them\&.
 
256
.PP
 
257
For builders and developers we additionally provide
 
258
.IP [1]
 
259
\fICritcl - License\fR\&.
 
260
.IP [2]
 
261
\fICritcl - The Installer's Guide\fR\&.
 
262
.IP [3]
 
263
\fICritcl - The Developer's Guide\fR\&.
 
264
.PP
 
265
respectively\&.
 
266
.SH "SOURCE LOCATION"
 
267
The official repository for Critcl can be found at
 
268
\fIhttp://andreas-kupries\&.github\&.com/critcl\fR
 
269
.SH RETRIEVAL
 
270
Assuming that you simply wish to look at the sources, or build a
 
271
specific revision, the easiest way of retrieving it is to:
 
272
.IP [1]
 
273
Go to this site\&.
 
274
.IP [2]
 
275
Follow the 'Fork me on Github' link (top-right corner) to the project sources\&.
 
276
.IP [3]
 
277
Choose the revision under the Commits panel you wish to have and
 
278
.IP [4]
 
279
follow its 'Browse code' link to its detailed information page\&.
 
280
.IP [5]
 
281
On that page, choose either the "ZIP" link to get a copy of this revision as a Zip archive\&.
 
282
.PP
 
283
.SH "SOURCE CODE MANAGEMENT"
 
284
For the curious (or a developer-to-be), the sources are managed by the
 
285
\fIGit SCM\fR [http://www\&.git-scm\&.com]\&.
 
286
Binaries for popular platforms can be found directly at its
 
287
\fIdownload page\fR [http://www\&.fossil-scm\&.org/downloads]\&.
 
288
.PP
 
289
With that tool available the full history can be retrieved via:
 
290
.CS
 
291
 
 
292
 
 
293
    git clone http://github\&.com/andreas-kupries/critcl
 
294
    cd critcl
 
295
 
 
296
.CE
 
297
to get a checkout of the head of the trunk and move into it for browsing, editing, etc\&.
 
298
.SH AUTHORS
 
299
Jean Claude Wippler, Steve Landers, Andreas Kupries
 
300
.SH "BUGS, IDEAS, FEEDBACK"
 
301
This document, and the package it describes, will undoubtedly contain
 
302
bugs and other problems\&.
 
303
Please report them at \fIhttps://github\&.com/andreas-kupries/critcl/issues\fR\&.
 
304
Ideas for enhancements you may have for either package, application,
 
305
and/or the documentation are also very welcome and should be reported
 
306
at \fIhttps://github\&.com/andreas-kupries/critcl/issues\fR as well\&.
 
307
.SH KEYWORDS
 
308
C code, Embedded C Code, code generator, compile & run, compiler, dynamic code generation, dynamic compilation, generate package, linker, on demand compilation, on-the-fly compilation
 
309
.SH CATEGORY
 
310
Glueing/Embedded C code
 
311
.SH COPYRIGHT
 
312
.nf
 
313
Copyright (c) Jean-Claude Wippler
 
314
Copyright (c) Steve Landers
 
315
Copyright (c) 2011-2013 Andreas Kupries
 
316
 
 
317
.fi
 
 
b'\\ No newline at end of file'