Fix: lttng-ctl: lttng_list_sessions: initialize out_sessions to NULL when returning 0

[lttng-tools.git] / doc / man / lttng-help.1.txt

lttng-help(1)
=============
:revdate: 21 April 2021


NAME
----
lttng-help - Show the help of an LTTng command


SYNOPSIS
--------
[verse]
*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *help* ['COMMAND']


DESCRIPTION
-----------
The `lttng help` command shows the help of:

With the 'COMMAND' argument::
    The ++lttng{nbsp}++__COMMAND__ command.

Without the 'COMMAND' argument::
    The man:lttng(1) command itself.

The `help` command is equivalent to:

[verse]
*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] ['COMMAND'] nloption:--help

The `help` command attempts to launch `/usr/bin/man` to view this the
manual page of the command. Override the manual pager path with the
`LTTNG_MAN_BIN_PATH` environment variable.


include::common-lttng-cmd-options-head.txt[]


include::common-lttng-cmd-help-options.txt[]


include::common-lttng-cmd-after-options.txt[]


include::common-footer.txt[]


SEE ALSO
--------
man:lttng(1)