[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-cmd-options-head.txt[]


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


include::common-cmd-footer.txt[]


SEE ALSO
--------
man:lttng(1)
Commit	Line	Data
	1	lttng-help(1)
	2	=============
	3	:revdate: 21 April 2021
	4
	5
	6	NAME
	7	----
	8	lttng-help - Show the help of an LTTng command
	9
	10
	11	SYNOPSIS
	12	--------
	13	[verse]
	14	lttng ['linkgenoptions:(GENERAL OPTIONS)'] help ['COMMAND']
	15
	16
	17	DESCRIPTION
	18	-----------
	19	The `lttng help` command shows the help of:
	20
	21	With the 'COMMAND' argument::
	22	The ++lttng{nbsp}++__COMMAND__ command.
	23
	24	Without the 'COMMAND' argument::
	25	The man:lttng(1) command itself.
	26
	27	The `help` command is equivalent to:
	28
	29	[verse]
	30	lttng ['linkgenoptions:(GENERAL OPTIONS)'] ['COMMAND'] nloption:--help
	31
	32	The `help` command attempts to launch `/usr/bin/man` to view this the
	33	manual page of the command. Override the manual pager path with the
	34	`LTTNG_MAN_BIN_PATH` environment variable.
	35
	36
	37	include::common-cmd-options-head.txt[]
	38
	39
	40	include::common-cmd-help-options.txt[]
	41
	42
	43	include::common-cmd-footer.txt[]
	44
	45
	46	SEE ALSO
	47	--------
	48	man:lttng(1)