From: Philippe Proulx Date: Wed, 23 Mar 2016 01:10:27 +0000 (-0400) Subject: Update man pages links to v2.7 X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=e99e591bd54ef26a30b72bc9ae326d85b4a04967;p=lttng-docs.git Update man pages links to v2.7 Signed-off-by: Philippe Proulx --- diff --git a/contents/getting-started/tracing-your-own-user-application.md b/contents/getting-started/tracing-your-own-user-application.md index 9ac0ba5..252edce 100644 --- a/contents/getting-started/tracing-your-own-user-application.md +++ b/contents/getting-started/tracing-your-own-user-application.md @@ -72,7 +72,7 @@ TRACEPOINT_EVENT( The exact syntax is well explained in the [C application](#doc-c-application) instrumentation guide of the [Using LTTng](#doc-using-lttng) chapter, as well as in the -LTTng-UST man page. +LTTng-UST man page. Save the above snippet as `hello-tp.h`. diff --git a/contents/reference/online-manpages.md b/contents/reference/online-manpages.md index b330e57..266aa2a 100644 --- a/contents/reference/online-manpages.md +++ b/contents/reference/online-manpages.md @@ -6,11 +6,11 @@ LTTng packages currently install the following man pages, available online using the links below: * **LTTng-tools** - * `lttng` - * `lttng-sessiond` - * `lttng-relayd` + * `lttng` + * `lttng-sessiond` + * `lttng-relayd` * **LTTng-UST** - * `lttng-gen-tp` - * `lttng-ust` - * `lttng-ust-cyg-profile` - * `lttng-ust-dl` + * `lttng-gen-tp` + * `lttng-ust` + * `lttng-ust-cyg-profile` + * `lttng-ust-dl` diff --git a/contents/understanding-lttng/plumbing/liblttng-ctl-lttng.md b/contents/understanding-lttng/plumbing/liblttng-ctl-lttng.md index 873f3b6..3a97c26 100644 --- a/contents/understanding-lttng/plumbing/liblttng-ctl-lttng.md +++ b/contents/understanding-lttng/plumbing/liblttng-ctl-lttng.md @@ -21,7 +21,7 @@ Every function/structure is thoroughly documented. The `lttng` program is the _de facto_ standard user interface to control LTTng tracing sessions. `lttng` uses `liblttng-ctl` to communicate with session daemons behind the scenes. -Its man page is exhaustive, as +Its man page is exhaustive, as well as its command line help (lttng cmd --help, where cmd is the command name). diff --git a/contents/understanding-lttng/plumbing/lttng-consumerd.md b/contents/understanding-lttng/plumbing/lttng-consumerd.md index 6d99b95..09001c4 100644 --- a/contents/understanding-lttng/plumbing/lttng-consumerd.md +++ b/contents/understanding-lttng/plumbing/lttng-consumerd.md @@ -18,7 +18,7 @@ the consumer daemon is always the child process of a session daemon. Consumer daemons should never be started manually. For this reason, they are not installed in one of the usual locations listed in the `PATH` environment variable. `lttng-sessiond` has, however, a -bunch of options to +bunch of options to specify custom consumer daemon paths if, for some reason, a consumer daemon other than the default installed one is needed. diff --git a/contents/understanding-lttng/plumbing/lttng-sessiond.md b/contents/understanding-lttng/plumbing/lttng-sessiond.md index 4469902..70ac4cd 100644 --- a/contents/understanding-lttng/plumbing/lttng-sessiond.md +++ b/contents/understanding-lttng/plumbing/lttng-sessiond.md @@ -78,5 +78,5 @@ pkill lttng-sessiond The default `SIGTERM` signal terminates it cleanly. Several other options are available and described in -lttng-sessiond's +lttng-sessiond's man page or by running `lttng-sessiond --help`. diff --git a/contents/using-lttng/controlling-tracing/enabling-disabling-channels/fine-tuning-channels.md b/contents/using-lttng/controlling-tracing/enabling-disabling-channels/fine-tuning-channels.md index 791e6ce..d21924b 100644 --- a/contents/using-lttng/controlling-tracing/enabling-disabling-channels/fine-tuning-channels.md +++ b/contents/using-lttng/controlling-tracing/enabling-disabling-channels/fine-tuning-channels.md @@ -4,7 +4,7 @@ id: fine-tuning-channels There are various parameters that may be fine-tuned with the `enable-channel` command. The latter are well documented in -the man page of `lttng` +the man page of `lttng` and in the [Channel](#doc-channel) section of the [Understanding LTTng](#doc-understanding-lttng) chapter. For basic tracing needs, their default values should be just fine, but here are a diff --git a/contents/using-lttng/controlling-tracing/persistent-memory-file-systems.md b/contents/using-lttng/controlling-tracing/persistent-memory-file-systems.md index 8edc13c..2c8a2ec 100644 --- a/contents/using-lttng/controlling-tracing/persistent-memory-file-systems.md +++ b/contents/using-lttng/controlling-tracing/persistent-memory-file-systems.md @@ -45,5 +45,5 @@ viewing the events, use the `--extract` option: lttng-crash --extract /path/to/trace /path/to/shm -See the lttng-crash man page +See the lttng-crash man page for the complete list of options. diff --git a/contents/using-lttng/instrumenting/c-application/lttng-gen-tp.md b/contents/using-lttng/instrumenting/c-application/lttng-gen-tp.md index 1ac4ad0..cc52ec6 100644 --- a/contents/using-lttng/instrumenting/c-application/lttng-gen-tp.md +++ b/contents/using-lttng/instrumenting/c-application/lttng-gen-tp.md @@ -31,4 +31,4 @@ CFLAGS=-I/custom/include/path lttng-gen-tp my-template.tp For more information on `lttng-gen-tp`, see -its man page. +its man page.