From 9b6435afbb89e2345ac7399620549db3e58f3f75 Mon Sep 17 00:00:00 2001 From: Alexandre Montplaisir Date: Fri, 2 Mar 2012 17:35:32 -0500 Subject: [PATCH] Manpage fixes Signed-off-by: Alexandre Montplaisir Signed-off-by: Mathieu Desnoyers --- doc/man/lttng-gen-tp.1 | 4 ++-- doc/man/lttng-ust.3 | 18 +++++++++--------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/doc/man/lttng-gen-tp.1 b/doc/man/lttng-gen-tp.1 index 551f0036..5bfe17de 100644 --- a/doc/man/lttng-gen-tp.1 +++ b/doc/man/lttng-gen-tp.1 @@ -29,7 +29,7 @@ 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" @@ -55,7 +55,7 @@ When no output is specified de default files are generated with the same base fi .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.) diff --git a/doc/man/lttng-ust.3 b/doc/man/lttng-ust.3 index 6bbfc96c..3ba5c7cc 100644 --- a/doc/man/lttng-ust.3 +++ b/doc/man/lttng-ust.3 @@ -251,13 +251,13 @@ carefully: directly or through a static library (.a): - Into exactly one object of your application: define "TRACEPOINT_DEFINE" and include the tracepoint provider. - - Use "-I." for the compilation unit containing the tracepoint + - Use "\-I." for the compilation unit containing the tracepoint provider include (e.g. tp.c). - - Link application with "-ldl". + - Link application with "\-ldl". - If building the provider directly into the application, - link the application with "-llttng-ust". + link the application with "\-llttng-ust". - If building a static library for the provider, link the static - library with "-lllttng-ust". + library with "\-lllttng-ust". - Include the tracepoint provider header into all C files using the provider. - Example: @@ -271,9 +271,9 @@ carefully: provider header. - Include the tracepoint provider header into all instrumented C files that use the provider. - - Compile the tracepoint provider with "-I.". - - Link the tracepoint provider with "-llttng-ust". - - Link application with "-ldl". + - Compile the tracepoint provider with "\-I.". + - Link the tracepoint provider with "\-llttng-ust". + - Link application with "\-ldl". - Set a LD_PRELOAD environment to preload the tracepoint provider shared object before starting the application when tracing is needed. @@ -284,7 +284,7 @@ carefully: way libc lazily resolves Thread-Local Storage (TLS) symbols when a library is dlopen'd, linking the tracepoint probe or liblttng-ust with dlopen() is discouraged. They should be linked with the - application using "-llibname" or loaded with LD_PRELOAD. + application using "\-llibname" or loaded with LD_PRELOAD. - Enable instrumentation and control tracing with the "lttng" command from lttng-tools. See lttng-tools doc/quickstart.txt. @@ -302,7 +302,7 @@ specify how long the applications should wait for sessiond "registration done" command before proceeding to execute the main program. The default is 3000ms (3 seconds). The timeout value is specified in milliseconds. The value 0 means "don't wait". The value --1 means "wait forever". Setting this environment variable to 0 is +\-1 means "wait forever". Setting this environment variable to 0 is recommended for applications with time constraints on the process startup time. .PP -- 2.34.1