'\" t
.\" Title: libtraceevent
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot
.\" Date: 02/15/2021
.\" Manual: libtraceevent Manual
.\" Source: libtraceevent 1.1.2
.\" Language: English
.\"
.TH "LIBTRACEEVENT" "3" "02/15/2021" "libtraceevent 1\&.1\&.2" "libtraceevent Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
tep_set_flag, tep_clear_flag, tep_test_flag \- Manage flags of trace event parser context\&.
.SH "SYNOPSIS"
.sp
.nf
\fB#include \fR
enum \fBtep_flag\fR {
\fITEP_NSEC_OUTPUT\fR,
\fITEP_DISABLE_SYS_PLUGINS\fR,
\fITEP_DISABLE_PLUGINS\fR
};
void \fBtep_set_flag\fR(struct tep_handle *\fItep\fR, enum tep_flag \fIflag\fR);
void \fBtep_clear_flag\fR(struct tep_handle *\fItep\fR, enum tep_flag \fIflag\fR);
bool \fBtep_test_flag\fR(struct tep_handle *\fItep\fR, enum tep_flag \fIflag\fR);
.fi
.SH "DESCRIPTION"
.sp
Trace event parser context flags are defined in \fBenum tep_flag\fR:
.sp
.if n \{\
.RS 4
.\}
.nf
\fITEP_NSEC_OUTPUT\fR \- print event\(cqs timestamp in nano seconds, instead of micro seconds\&.
\fITEP_DISABLE_SYS_PLUGINS\fR \- disable plugins, located in system\(cqs plugin
directory\&. This directory is defined at library compile
time, and usually depends on library installation
prefix: (install_preffix)/lib/traceevent/plugins
\fITEP_DISABLE_PLUGINS\fR \- disable all library plugins:
\- in system\(cqs plugin directory
\- in directory, defined by the environment variable \fITRACEEVENT_PLUGIN_DIR\fR
\- in user\(cqs home directory, \fI~/\&.traceevent/plugins\fR
.fi
.if n \{\
.RE
.\}
.sp
Note: plugin related flags must me set before calling \fItep_load_plugins()\fR API\&.
.sp
The \fItep_set_flag()\fR function sets \fIflag\fR to \fItep\fR context\&.
.sp
The \fItep_clear_flag()\fR function clears \fIflag\fR from \fItep\fR context\&.
.sp
The \fItep_test_flag()\fR function tests if \fIflag\fR is set to \fItep\fR context\&.
.SH "RETURN VALUE"
.sp
\fItep_test_flag()\fR function returns true if \fIflag\fR is set, false otherwise\&.
.SH "EXAMPLE"
.sp
.if n \{\
.RS 4
.\}
.nf
#include
\&.\&.\&.
struct tep_handle *tep = tep_alloc();
\&.\&.\&.
/* Print timestamps in nanoseconds */
tep_set_flag(tep, TEP_NSEC_OUTPUT);
\&.\&.\&.
if (tep_test_flag(tep, TEP_NSEC_OUTPUT)) {
/* print timestamps in nanoseconds */
} else {
/* print timestamps in microseconds */
}
\&.\&.\&.
/* Print timestamps in microseconds */
tep_clear_flag(tep, TEP_NSEC_OUTPUT);
\&.\&.\&.
.fi
.if n \{\
.RE
.\}
.SH "FILES"
.sp
.if n \{\
.RS 4
.\}
.nf
\fBevent\-parse\&.h\fR
Header file to include in order to have access to the library APIs\&.
\fB\-ltraceevent\fR
Linker switch to add when building a program that uses the library\&.
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.sp
\fIlibtraceevent(3)\fR, \fItrace\-cmd(1)\fR
.SH "AUTHOR"
.sp
.if n \{\
.RS 4
.\}
.nf
\fBSteven Rostedt\fR <\m[blue]\fBrostedt@goodmis\&.org\fR\m[]\&\s-2\u[1]\d\s+2>, author of \fBlibtraceevent\fR\&.
\fBTzvetomir Stoyanov\fR <\m[blue]\fBtz\&.stoyanov@gmail\&.com\fR\m[]\&\s-2\u[2]\d\s+2>, author of this man page\&.
.fi
.if n \{\
.RE
.\}
.SH "REPORTING BUGS"
.sp
Report bugs to <\m[blue]\fBlinux\-trace\-devel@vger\&.kernel\&.org\fR\m[]\&\s-2\u[3]\d\s+2>
.SH "LICENSE"
.sp
libtraceevent is Free Software licensed under the GNU LGPL 2\&.1
.SH "RESOURCES"
.sp
\m[blue]\fBhttps://git\&.kernel\&.org/pub/scm/libs/libtrace/libtraceevent\&.git/\fR\m[]
.SH "NOTES"
.IP " 1." 4
rostedt@goodmis.org
.RS 4
\%mailto:rostedt@goodmis.org
.RE
.IP " 2." 4
tz.stoyanov@gmail.com
.RS 4
\%mailto:tz.stoyanov@gmail.com
.RE
.IP " 3." 4
linux-trace-devel@vger.kernel.org
.RS 4
\%mailto:linux-trace-devel@vger.kernel.org
.RE