.TH "LTTNG-GEN-TP" "1" "February 16, 2012" "" ""
.SH "NAME"
-lttng-gen-tp \(em LTTng UST 2.0 tracepoint code generator
+lttng-gen-tp \(em LTTng UST 2.x tracepoint code generator
.SH "SYNOPSIS"
.PP
The LTTng project aims at providing highly efficient tracing tools for Linux.
-It's tracers help tracking down performance issues and debugging problems
+Its tracers help in tracking down performance issues and debugging problems
involving multiple concurrent processes and threads. Tracing across multiple
systems is also possible.
-The \fBlttng\-gen\-tp\fP tool simplify the generation of the UST tracepoint
-files. It takes a simple template file and generate the necessary code to use the defined tracepoints in your application.
-The section TEMPLATE FILE FORMAT describe the content of the template file.
+The \fBlttng\-gen\-tp\fP tool simplifies the generation of the UST tracepoint
+files. It takes a simple template file and generates the necessary code to use the defined tracepoints in your application.
+The section TEMPLATE FILE FORMAT describes the content of the template file.
-Currently, the tool can generate the .h and .c associated to your
+Currently, the tool can generate the .h, .c and .o associated with your
tracepoint. The generated .h can be directly included in your application.
-You need to compile the .c into a .o, .a or .so at your choice and
-link it with your application. Refer to the UST documentation for the
+You can let the tool generate the .o or compile the .c yourself.
+You can compile the .c into a .o, .a or .so at your choice and
+link it with your application.
+Refer to the UST documentation for the
advantages and disadvantage of each form.
To compile the resulting .c file, you need to add the options
-"-llttng-ust -I."
+"\-llttng-ust \-I.".
.SH "OPTIONS"
.PP
-This program follow the usual GNU command line syntax with long options starting with
+This program follows the usual GNU command line syntax with long options starting with
two dashes. Below is a summary of the available options.
.PP
.TP
.BR "\-o, \-\-output"
Specify the generated file. The type of the generated file depend on the file
-extension (.h, .c).
-This option can be specfied multiple times to generate different file type.
+extension (.h, .c, .o).
+This option can be specified multiple times to generate different file type.
.PP
-When no output is specified de default files are generated with the same base filename as the template file. The default files are: .h, .c.
+When no output is specified the default files are generated with the same base filename as the template file. The default files are: .h, .c, .o.
.SH "TEMPLATE FILE FORMAT"
-The template file, which has the usual extention \fB.tp\fP, contains a list of
+The template file, which has the usual extension \fB.tp\fP, contains a list of
TRACEPOINT_EVENT definitions and other optional definition entries like
TRACEPOINT_LOGLEVEL.
(See lttng-ust(3) for the complete list of available definition.)
ctf_string(message, text)
)
)
+.SH "ENVIRONMENT VARIABLES"
+.PP
+When the tool generates a .o file, it will look for the following environment variables
+.PP
+
+.PP
+.IP "CC"
+Specify which C compiler to use. If the variable is not specified, the
+tool will try "cc" and "gcc"
+
+.IP "CFLAGS"
+Flags directly passed to the compiler
.SH "SEE ALSO"
.PP