c8caa0bb4b
Bring minor improvements to bpftool documentation. Fix or harmonise
formatting, update map types (including in interactive help), improve
description for "map create", fix a build warning due to a missing line
after the double-colon for the "bpftool prog profile" example,
complete/harmonise/sort the list of related bpftool man pages in
footers.
v2:
- Remove (instead of changing) mark-up on "value" in bpftool-map.rst,
when it does not refer to something passed on the command line.
- Fix an additional typo ("hexadeximal") in the same file.
Signed-off-by: Quentin Monnet <quentin@isovalent.com>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
Link: https://lore.kernel.org/bpf/20200511161536.29853-3-quentin@isovalent.com
89 lines
2.4 KiB
ReStructuredText
89 lines
2.4 KiB
ReStructuredText
================
|
|
BPFTOOL
|
|
================
|
|
-------------------------------------------------------------------------------
|
|
tool for inspection and simple manipulation of eBPF programs and maps
|
|
-------------------------------------------------------------------------------
|
|
|
|
:Manual section: 8
|
|
|
|
SYNOPSIS
|
|
========
|
|
|
|
**bpftool** [*OPTIONS*] *OBJECT* { *COMMAND* | **help** }
|
|
|
|
**bpftool** **batch file** *FILE*
|
|
|
|
**bpftool** **version**
|
|
|
|
*OBJECT* := { **map** | **program** | **cgroup** | **perf** | **net** | **feature** }
|
|
|
|
*OPTIONS* := { { **-V** | **--version** } | { **-h** | **--help** }
|
|
| { **-j** | **--json** } [{ **-p** | **--pretty** }] }
|
|
|
|
*MAP-COMMANDS* :=
|
|
{ **show** | **list** | **create** | **dump** | **update** | **lookup** | **getnext**
|
|
| **delete** | **pin** | **event_pipe** | **help** }
|
|
|
|
*PROG-COMMANDS* := { **show** | **list** | **dump jited** | **dump xlated** | **pin**
|
|
| **load** | **attach** | **detach** | **help** }
|
|
|
|
*CGROUP-COMMANDS* := { **show** | **list** | **attach** | **detach** | **help** }
|
|
|
|
*PERF-COMMANDS* := { **show** | **list** | **help** }
|
|
|
|
*NET-COMMANDS* := { **show** | **list** | **help** }
|
|
|
|
*FEATURE-COMMANDS* := { **probe** | **help** }
|
|
|
|
DESCRIPTION
|
|
===========
|
|
*bpftool* allows for inspection and simple modification of BPF objects
|
|
on the system.
|
|
|
|
Note that format of the output of all tools is not guaranteed to be
|
|
stable and should not be depended upon.
|
|
|
|
OPTIONS
|
|
=======
|
|
-h, --help
|
|
Print short help message (similar to **bpftool help**).
|
|
|
|
-V, --version
|
|
Print version number (similar to **bpftool version**).
|
|
|
|
-j, --json
|
|
Generate JSON output. For commands that cannot produce JSON, this
|
|
option has no effect.
|
|
|
|
-p, --pretty
|
|
Generate human-readable JSON output. Implies **-j**.
|
|
|
|
-m, --mapcompat
|
|
Allow loading maps with unknown map definitions.
|
|
|
|
-n, --nomount
|
|
Do not automatically attempt to mount any virtual file system
|
|
(such as tracefs or BPF virtual file system) when necessary.
|
|
|
|
-d, --debug
|
|
Print all logs available, even debug-level information. This
|
|
includes logs from libbpf as well as from the verifier, when
|
|
attempting to load programs.
|
|
|
|
SEE ALSO
|
|
========
|
|
**bpf**\ (2),
|
|
**bpf-helpers**\ (7),
|
|
**bpftool-btf**\ (8),
|
|
**bpftool-cgroup**\ (8),
|
|
**bpftool-feature**\ (8),
|
|
**bpftool-gen**\ (8),
|
|
**bpftool-iter**\ (8),
|
|
**bpftool-link**\ (8),
|
|
**bpftool-map**\ (8),
|
|
**bpftool-net**\ (8),
|
|
**bpftool-perf**\ (8),
|
|
**bpftool-prog**\ (8),
|
|
**bpftool-struct_ops**\ (8)
|