X-Git-Url: http://git.lttng.org./?a=blobdiff_plain;ds=sidebyside;f=doc%2Fman%2Flttng-add-context.1.txt;h=f995a7fbe2fd629f1091c68427edc30fc3410db8;hb=d06773cf79bd49a8385b8e38b1d3b2633271feed;hp=4f133b80e03a478f838d6f36b845d55e1f9f7b92;hpb=09693c6dc50260ad67e0b8d50510bbc0be9ecb1c;p=lttng-tools.git diff --git a/doc/man/lttng-add-context.1.txt b/doc/man/lttng-add-context.1.txt index 4f133b80e..f995a7fbe 100644 --- a/doc/man/lttng-add-context.1.txt +++ b/doc/man/lttng-add-context.1.txt @@ -20,7 +20,7 @@ Add context fields to a channel: List the available context fields: [verse] -*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *add-context* --list +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *add-context* option:--list DESCRIPTION @@ -28,7 +28,7 @@ DESCRIPTION The `lttng add-context` command adds one or more context fields to a channel. -Channels are created with the linklttng:lttng-enable-channel(1) command. +Channels are created with the man:lttng-enable-channel(1) command. When context fields are added to a channel, all the events emitted within this channel contain the dynamic values of those context fields. @@ -59,6 +59,10 @@ with: 'TYPE':: Context type name. +NOTE: Make sure to **single-quote** the type when running the command +from a shell, as `$` is a special character for variable substitution in +most shells. + Use the option:--list option without other arguments to list the available context field names. @@ -112,4 +116,4 @@ include::common-cmd-footer.txt[] SEE ALSO -------- -linklttng:lttng(1) +man:lttng(1)