X-Git-Url: http://git.efficios.com/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2Flttng.1.txt;h=5e949e20d9f8ea2ed1b95d1d714cbc9ae319e826;hp=a737e11f346ed26e4fb8a93f66ad0758dfb6f3ca;hb=980bb5fda2120f8d2a4e82fcf72be7cbbeb85fd2;hpb=5d231d824cb0cfba5c4074cc16f09fae8abc146b diff --git a/doc/man/lttng.1.txt b/doc/man/lttng.1.txt index a737e11f3..5e949e20d 100644 --- a/doc/man/lttng.1.txt +++ b/doc/man/lttng.1.txt @@ -11,7 +11,7 @@ SYNOPSIS -------- [verse] *lttng* [option:--group='GROUP'] [option:--mi='TYPE'] [option:--no-sessiond | option:--sessiond-path='PATH'] - [option:--quiet | option:-v | option:-vv | option:-vvv] 'COMMAND' ['COMMAND OPTIONS'] + [option:--quiet | option:-v | option:-vv | option:-vvv] '<>' ['COMMAND OPTIONS'] DESCRIPTION @@ -23,7 +23,7 @@ user applications, and user libraries. LTTng consists of Linux kernel modules (for Linux kernel tracing) and dynamically loaded libraries (for user application and library tracing). -An LTTng _session daemon_, linklttng:lttng-sessiond(8), receives +An LTTng _session daemon_, man:lttng-sessiond(8), receives commands from the command-line interface `lttng` to control the LTTng tracers. All interactions with the LTTng tracers happen through the `lttng` tool or through the liblttng-ctl library shipped with the @@ -33,27 +33,29 @@ A _tracing domain_ is a tracer category. There are five available domains. For some commands, the domain needs to be specified with a command-line option. The domain options are: -option:-j, option:--jul:: +nloption:-j, nloption:--jul:: Apply command to the `java.util.logging` (JUL) domain. -option:-k, option:--kernel:: +nloption:-k, nloption:--kernel:: Apply command to the Linux kernel domain. -option:-l, option:--log4j:: - Apply command to the Apache log4j 1.2 (Java) domain. +nloption:-l, nloption:--log4j:: + Apply command to the https://logging.apache.org/log4j/1.2/[Apache log4j 1.2] + (Java) domain. -option:-p, option:--python:: - Apply command to the Python domain. +nloption:-p, nloption:--python:: + Apply command to the https://www.python.org/[Python] domain. -option:-u, option:--userspace:: - Apply command to the user space domain. +nloption:-u, nloption:--userspace:: + Apply command to the user space domain (application using + liblttng-ust directly; see man:lttng-ust(3)). The LTTng session daemon is a tracing registry which allows the user to interact with multiple tracers (kernel and user space) within the same container, a _tracing session_. Traces can be gathered from the Linux kernel and/or from instrumented applications (see -linklttng:lttng-ust(3)). You can aggregate and read the events of LTTng -traces using linklttng:babeltrace(1). +man:lttng-ust(3)). You can aggregate and read the events of LTTng +traces using man:babeltrace(1). To trace the Linux kernel, the session daemon needs to be running as `root`. LTTng uses a _tracing group_ to allow specific users to interact @@ -71,19 +73,19 @@ for stable and long-term tracing. User applications instrumented with LTTng automatically register to the root session daemon and to user session daemons. This allows any session daemon to list the available traceable applications and event sources -(see linklttng:lttng-list(1)). +(see man:lttng-list(1)). -By default, the linklttng:lttng-create(1) command automatically spawns a +By default, the man:lttng-create(1) command automatically spawns a user session daemon if none is currently running. The option:--no-sessiond general option can be set to avoid this. OPTIONS ------- -option:-g, option:--group='GROUP':: +option:-g 'GROUP', option:--group='GROUP':: Use 'GROUP' as Unix tracing group (default: `tracing`). -option:-m, option:--mi='TYPE':: +option:-m 'TYPE', option:--mi='TYPE':: Print the command's result using the machine interface type 'TYPE' instead of a human-readable output. + @@ -137,93 +139,107 @@ option:-V, option:--version:: Show version. +[[commands]] COMMANDS -------- -The following commands also have their own option:--help option. +The following commands also have their own nloption:--help option. Tracing sessions ~~~~~~~~~~~~~~~~ -linklttng:lttng-create(1):: - Create a tracing session. +man:lttng-create(1):: + {cmd_descr_create}. -linklttng:lttng-destroy(1):: - Tear down tracing sessions. +man:lttng-destroy(1):: + {cmd_descr_destroy}. -linklttng:lttng-save(1):: - Save tracing session configurations. +man:lttng-load(1):: + {cmd_descr_load}. -linklttng:lttng-set-session(1):: - Set current tracing session. +man:lttng-regenerate(1):: + {cmd_descr_regenerate}. -linklttng:lttng-load(1):: - Load tracing session configurations. +man:lttng-save(1):: + {cmd_descr_save}. + +man:lttng-set-session(1):: + {cmd_descr_set_session}. Channels ~~~~~~~~ -linklttng:lttng-enable-channel(1):: - Create or enable tracing channels. +man:lttng-add-context(1):: + {cmd_descr_add_context}. -linklttng:lttng-disable-channel(1):: - Disable tracing channels. +man:lttng-disable-channel(1):: + {cmd_descr_disable_channel}. -linklttng:lttng-add-context(1):: - Add context fields to a channel. +man:lttng-enable-channel(1):: + {cmd_descr_enable_channel}. Event rules ~~~~~~~~~~~ -linklttng:lttng-enable-event(1):: - Create or enable event rules. +man:lttng-disable-event(1):: + {cmd_descr_disable_event}. -linklttng:lttng-disable-event(1):: - Disable event rules. +man:lttng-enable-event(1):: + {cmd_descr_enable_event}. Status ~~~~~~ -linklttng:lttng-list(1):: - List tracing sessions, domains, channels, and events. +man:lttng-list(1):: + {cmd_descr_list}. -linklttng:lttng-status(1):: - Get the status of the current tracing session. +man:lttng-status(1):: + {cmd_descr_status}. Control ~~~~~~~ -linklttng:lttng-snapshot(1):: - Snapshot buffers of current tracing session. +man:lttng-snapshot(1):: + {cmd_descr_snapshot}. + +man:lttng-start(1):: + {cmd_descr_start}. + +man:lttng-stop(1):: + {cmd_descr_stop}. + -linklttng:lttng-start(1):: - Start tracing. +Tracing session rotation +~~~~~~~~~~~~~~~~~~~~~~~~ +man:lttng-disable-rotation(1):: + {cmd_descr_disable_rotation}. + +man:lttng-enable-rotation(1):: + {cmd_descr_enable_rotation}. + +man:lttng-rotate(1):: + {cmd_descr_rotate}. -linklttng:lttng-stop(1):: - Stop tracing. Resource tracking ~~~~~~~~~~~~~~~~~ -linklttng:lttng-track(1):: - Track specific system resources. +man:lttng-track(1):: + {cmd_descr_track}. -linklttng:lttng-untrack(1):: - Untrack specific system resources. +man:lttng-untrack(1):: + {cmd_descr_untrack}. Miscellaneous ~~~~~~~~~~~~~ -linklttng:lttng-calibrate(1):: - Quantify LTTng overhead. - -linklttng:lttng-help(1):: - Display help information about a command. +man:lttng-help(1):: + {cmd_descr_help}. -linklttng:lttng-version(1):: - Show version information. +man:lttng-version(1):: + {cmd_descr_version}. -linklttng:lttng-view(1):: - Start trace viewer. +man:lttng-view(1):: + {cmd_descr_view}. include::common-cmd-footer.txt[] @@ -231,8 +247,8 @@ include::common-cmd-footer.txt[] SEE ALSO -------- -linklttng:lttng-sessiond(8), -linklttng:lttng-relayd(8), -linklttng:lttng-crash(1), -linklttng:lttng-ust(3), -linklttng:babeltrace(1) +man:lttng-sessiond(8), +man:lttng-relayd(8), +man:lttng-crash(1), +man:lttng-ust(3), +man:babeltrace(1)