manpage -> man pages

[lttng-docs.git] / toc / docs.yml

title: The <span class="reset-text-transform">LTTng</span> Documentation
cats:
  - id: whats-new
    title: What's new in LTTng 2.6?
  - id: nuts-and-bolts
    title: Nuts and bolts
    cats:
      - id: what-is-tracing
        title: What is tracing?
      - id: lttng-alternatives
        title: Alternatives to LTTng
  - id: installing-lttng
    title: Installing <span class="reset-text-transform">LTTng</span>
    cats:
      - id: desktop-distributions
        title: Desktop distributions
        cats:
          - id: ubuntu
            title: Ubuntu
            cats:
              - id: ubuntu-official-repositories
                title: Official repositories
              - id: ubuntu-ppa
                title: PPA
          - id: fedora
            title: Fedora
          - id: debian
            title: Debian
          - id: opensuse
            title: openSUSE/RPM
          - id: archlinux
            title: Arch Linux
      - id: embedded-distributions
        title: Embedded distributions
        cats:
          - id: buildroot
            title: Buildroot
          - id: oe-yocto
            title: OpenEmbedded/Yocto
      - id: enterprise-distributions
        title: "Enterprise distributions (<abbr title=\"Red Hat Enterprise Linux\">RHEL</abbr>, <abbr title=\"SUSE Linux Enterprise Server\">SLES</abbr>)"
      - id: building-from-source
        title: Building from source
  - id: getting-started
    title: Getting started with <span class="reset-text-transform">LTTng</span>
    cats:
      - id: tracing-the-linux-kernel
        title: Tracing the Linux kernel
      - id: tracing-your-own-user-application
        title: Tracing your own user application
      - id: viewing-and-analyzing-your-traces
        title: Viewing and analyzing your traces
  - id: understanding-lttng
    title: Understanding <span class="reset-text-transform">LTTng</span>
    cats:
      - id: core-concepts
        title: Core concepts
        cats:
          - id: tracing-session
            title: Tracing session
          - id: domain
            title: Domain
          - id: channel
            title: Channel
            cats:
              - id: channel-overwrite-mode-vs-discard-mode
                title: Overwrite and discard event loss modes
              - id: channel-subbuf-size-vs-subbuf-count
                title: Sub-buffers count and size
              - id: channel-switch-timer
                title: Switch timer
              - id: channel-buffering-schemes
                title: Buffering schemes
          - id: event
            title: Event
      - id: plumbing
        title: Plumbing
        cats:
          - id: plumbing-overview
            title: Overview
          - id: lttng-sessiond
            title: Session daemon
          - id: lttng-consumerd
            title: Consumer daemon
          - id: lttng-relayd
            title: Relay daemon
          - id: liblttng-ctl-lttng
            title: Control library and command line interface
          - id: lttng-ust
            title: User space tracing library
          - id: lttng-modules
            title: <span class="reset-text-transform">LTTng</span> kernel modules
  - id: using-lttng
    title: Using <span class="reset-text-transform">LTTng</span>
    cats:
      - id: instrumenting
        title: Instrumenting
        cats:
          - id: c-application
            title: C application
            cats:
              - id: tracepoint-provider
                title: Tracepoint provider
              - id: lttng-gen-tp
                title: Using <code>lttng-gen-tp</code>
              - id: defining-tracepoints
                title: Defining tracepoints
              - id: using-tracepoint-classes
                title: Using tracepoint classes
              - id: assigning-log-levels
                title: Assigning log levels to tracepoints
              - id: probing-the-application-source-code
                title: Probing the application's source code
              - id: building-tracepoint-providers-and-user-application
                title: Building/linking tracepoint providers and the user application
                cats:
                  - id: static-linking
                    title: Static linking
                  - id: dynamic-linking
                    title: Dynamic linking
                  - id: using-lttng-ust-with-daemons
                    title: Using <span class="reset-text-transform">LTTng</span>-UST with daemons
                  - id: lttng-ust-pkg-config
                    title: <span class="reset-text-transform">pkg-config</span>
              - id: tracef
                title: Using <code>tracef()</code>
              - id: lttng-ust-environment-variables-compiler-flags
                title: <span class="reset-text-transform">LTTng</span>-UST environment variables and special compilation flags
          - id: cxx-application
            title: C++ application
          - id: prebuilt-ust-helpers
            title: Prebuilt user space tracing helpers
            cats:
              - id: liblttng‑ust‑libc‑pthread-wrapper
                title: C standard library and POSIX threads tracing
              - id: liblttng‑ust‑cyg‑profile
                title: Function tracing
              - id: liblttng‑ust‑dl
                title: Dynamic linker tracing
          - id: java-application
            title: Java application
          - id: instrumenting-linux-kernel
            title: Linux kernel
            cats:
              - id: instrumenting-linux-kernel-itself
                title: Instrumenting the Linux kernel for <span class="reset-text-transform">LTTng</span>
                cats:
                  - id: mainline-trace-event
                    title: Defining/using tracepoints with mainline <code>TRACE_EVENT()</code> infrastructure
                  - id: lttng-adaptation-layer
                    title: Adding the <span class="reset-text-transform">LTTng</span> adaptation layer
                  - id: instrumenting-linux-kernel-tracing
                    title: Tracing
              - id: instrumenting-out-of-tree-linux-kernel
                title: Instrumenting an out-of-tree Linux kernel module for <span class="reset-text-transform">LTTng</span>
          - id: proc-lttng-logger-abi
            title: <span class="reset-text-transform">LTTng</span> logger ABI
          - id: advanced-instrumenting-techniques
            title: Advanced techniques
            cats:
              - id: instrumenting-32-bit-app-on-64-bit-system
                title: Instrumenting a 32-bit application on a 64-bit system
                cats:
                  - id: building-32-bit-userspace-rcu
                    title: Building 32-bit Userspace RCU
                  - id: building-32-bit-lttng-ust
                    title: Building 32-bit <span class="reset-text-transform">LTTng</span>-UST
                  - id: building-32-bit-lttng-tools
                    title: Building 32-bit <span class="reset-text-transform">LTTng</span>-tools
                  - id: building-64-bit-lttng-tools
                    title: Building 64-bit <span class="reset-text-transform">LTTng</span>-tools
                  - id: building-instrumented-32-bit-c-application
                    title: Building an instrumented 32-bit C application
                  - id: running-32-bit-and-64-bit-c-applications
                    title: Running 32-bit and 64-bit versions of an instrumented C application
      - id: controlling-tracing
        title: Controlling tracing
        cats:
          - id: creating-destroying-tracing-sessions
            title: Creating and destroying tracing sessions
          - id: enabling-disabling-events
            title: Enabling and disabling events
          - id: basic-tracing-session-control
            title: Basic tracing session control
          - id: enabling-disabling-channels
            title: Enabling and disabling channels
            cats:
              - id: fine-tuning-channels
                title: Fine-tuning channels
          - id: adding-context
            title: Adding some context to channels
          - id: saving-loading-tracing-session
            title: Saving and loading tracing session configurations
          - id: sending-trace-data-over-the-network
            title: Sending trace data over the network
          - id: lttng-live
            title: Viewing events as they arrive
          - id: taking-a-snapshot
            title: Taking a snapshot
          - id: mi
            title: Machine interface
  - id: reference
    title: Reference
    cats:
      - id: online-lttng-manpages
        title: Online <span class="reset-text-transform">LTTng</span> man pages
      - id: lttng-ust-ref
        title: <span class="reset-text-transform">LTTng</span>-UST
        cats:
          - id: liblttng-ust
            title: <span class="reset-text-transform">LTTng</span>-UST library (<code>liblttng&#8209;ust</code>)
            cats:
              - id: liblttng-ust-tp-fields
                title: Tracepoint fields macros (for <code>TP_FIELDS()</code>)
              - id: liblttng-ust-tracepoint-loglevel
                title: Tracepoint log levels (for <code>TRACEPOINT_LOGLEVEL()</code>)
      - id: lttng-modules-ref
        title: <span class="reset-text-transform">LTTng</span>-modules
        cats:
          - id: lttng-modules-tp-struct-entry
            title: Tracepoint fields macros (for <code>TP_STRUCT__entry()</code>)
          - id: lttng-modules-tp-fast-assign
            title: Tracepoint assignment macros (for <code>TP_fast_assign()</code>)