[lttng-docs.git] / common / welcome.txt

[[welcome]]
== Welcome!

Welcome to the **LTTng Documentation**!

The _Linux Trace Toolkit: next generation_ is an open source software
toolkit which you can use to trace the Linux kernel, user applications,
and user libraries at the same time.

LTTng consists of:

* Kernel modules to trace the Linux kernel.
* Shared libraries to trace C/$$C++$$ user applications.
* Java packages to trace Java applications which use `java.util.logging`
  or Apache log4j 1.2.
* A Python package to trace Python applications which use the standard
  `logging` package.
* A kernel module to trace shell scripts and other user applications
  without a dedicated instrumentation mechanism.
* Daemons and a command-line tool, cmd:lttng, to control the
  LTTng tracers.

[NOTE]
.Open source documentation
====
This is an **open documentation**: its source is available in a
https://github.com/lttng/lttng-docs[public Git repository].

Should you find any error in the content of this text, any grammatical
mistake, or any dead link, we would be very grateful if you would file a
GitHub issue for it or, even better, contribute a patch to this
documentation by creating a pull request.
====
Commit	Line	Data
f0287ae1 PP	1	[[welcome]]
	2	== Welcome!
	3
	4	Welcome to the LTTng Documentation!
	5
	6	The _Linux Trace Toolkit: next generation_ is an open source software
bd2a0d5c PP	7	toolkit which you can use to trace the Linux kernel, user applications,
bd2a0d5c PP	8	and user libraries at the same time.
f762992f PP	9
	10	LTTng consists of:
	11
	12	* Kernel modules to trace the Linux kernel.
bd2a0d5c	13	* Shared libraries to trace C/$$C++$$ user applications.
f762992f PP	14	* Java packages to trace Java applications which use `java.util.logging`
	15	or Apache log4j 1.2.
	16	* A Python package to trace Python applications which use the standard
	17	`logging` package.
	18	* A kernel module to trace shell scripts and other user applications
	19	without a dedicated instrumentation mechanism.
	20	* Daemons and a command-line tool, cmd:lttng, to control the
	21	LTTng tracers.
f0287ae1 PP	22
	23	[NOTE]
	24	.Open source documentation
	25	====
	26	This is an open documentation: its source is available in a
	27	https://github.com/lttng/lttng-docs[public Git repository].
	28
	29	Should you find any error in the content of this text, any grammatical
	30	mistake, or any dead link, we would be very grateful if you would file a
	31	GitHub issue for it or, even better, contribute a patch to this
	32	documentation by creating a pull request.
	33	====