tools/perf/Documentation/perf-help.txt

File Facts

System

Linux kernel

Corpus path

tools/perf/Documentation/perf-help.txt

Extension

.txt

Size

928 bytes

Lines

39

Domain

Support Tooling And Documentation

Bucket

tools

Inferred role

Support Tooling And Documentation: documentation

Status

atlas-only

Why This File Exists

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

• Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

Dependency Surface

• No C-style include directives detected by the generator.

Detected Declarations

• No top-level syscall, struct, function, initcall, or export declaration detected by the generator.

Annotated Snippet

perf-help(1)
============

NAME
----
perf-help - display help information about perf

SYNOPSIS
--------
'perf help' [-a|--all] [COMMAND]

DESCRIPTION
-----------

With no options and no COMMAND given, the synopsis of the 'perf'
command and a list of the most commonly used perf commands are printed
on the standard output.

If the option '--all' or '-a' is given, then all available commands are
printed on the standard output.

If a perf command is named, a manual page for that command is brought
up. The 'man' program is used by default for this purpose, but this
can be overridden by other options or configuration variables.

Note that `perf --help ...` is identical to `perf help ...` because the
former is internally converted into the latter.

OPTIONS
-------
-a::
--all::
	Prints all the available commands on the standard output. This
	option supersedes any other option.

PERF
----
Part of the linkperf:perf[1] suite

Annotation

• Atlas domain: Support Tooling And Documentation / tools.
• Implementation status: atlas-only.

Implementation Notes

• This generated page is the file-by-file coverage layer; curated subsystem chapters should link here when they synthesize a multi-file control flow.
• Core OS pages should be promoted from atlas-only to deep-reviewed when they explain data structures, invariants, locking, lifecycle, and C implementation snippets.
• Driver-family pages are intentionally pattern-oriented unless they are part of the selected PCIe/NVMe representative device path.