]> Git Repo - linux.git/blame - tools/bpf/bpftool/Documentation/bpftool.rst
Merge branch 'x86-urgent-for-linus' of git://git.kernel.org/pub/scm/linux/kernel...
[linux.git] / tools / bpf / bpftool / Documentation / bpftool.rst
CommitLineData
ff69c21a
JK
1================
2BPFTOOL
3================
4-------------------------------------------------------------------------------
5tool for inspection and simple manipulation of eBPF programs and maps
6-------------------------------------------------------------------------------
7
8:Manual section: 8
9
10SYNOPSIS
11========
12
0641c3c8 13 **bpftool** [*OPTIONS*] *OBJECT* { *COMMAND* | **help** }
ff69c21a 14
47ff7ac6 15 **bpftool** **batch file** *FILE*
ff69c21a 16
47ff7ac6 17 **bpftool** **version**
821cfbb0 18
f6f3bac0 19 *OBJECT* := { **map** | **program** | **cgroup** | **perf** | **net** }
ff69c21a 20
0641c3c8
QM
21 *OPTIONS* := { { **-V** | **--version** } | { **-h** | **--help** }
22 | { **-j** | **--json** } [{ **-p** | **--pretty** }] }
23
ff69c21a 24 *MAP-COMMANDS* :=
0b592b5a
JK
25 { **show** | **list** | **create** | **dump** | **update** | **lookup** | **getnext**
26 | **delete** | **pin** | **event_pipe** | **help** }
ff69c21a 27
6ebe6dbd 28 *PROG-COMMANDS* := { **show** | **list** | **dump jited** | **dump xlated** | **pin**
b7d3826c 29 | **load** | **attach** | **detach** | **help** }
ff69c21a 30
6ebe6dbd 31 *CGROUP-COMMANDS* := { **show** | **list** | **attach** | **detach** | **help** }
5ccda64d 32
b04df400
YS
33 *PERF-COMMANDS* := { **show** | **list** | **help** }
34
f6f3bac0
YS
35 *NET-COMMANDS* := { **show** | **list** | **help** }
36
ff69c21a
JK
37DESCRIPTION
38===========
39 *bpftool* allows for inspection and simple modification of BPF objects
40 on the system.
41
42 Note that format of the output of all tools is not guaranteed to be
43 stable and should not be depended upon.
44
a2bc2e5c
QM
45OPTIONS
46=======
47 -h, --help
48 Print short help message (similar to **bpftool help**).
49
50 -v, --version
51 Print version number (similar to **bpftool version**).
52
0641c3c8
QM
53 -j, --json
54 Generate JSON output. For commands that cannot produce JSON, this
55 option has no effect.
56
57 -p, --pretty
58 Generate human-readable JSON output. Implies **-j**.
59
c034a177
JF
60 -m, --mapcompat
61 Allow loading maps with unknown map definitions.
62
63
ff69c21a
JK
64SEE ALSO
65========
f98e46a2
QM
66 **bpf**\ (2),
67 **bpf-helpers**\ (7),
68 **bpftool-prog**\ (8),
69 **bpftool-map**\ (8),
70 **bpftool-cgroup**\ (8),
71 **bpftool-net**\ (8),
72 **bpftool-perf**\ (8)
This page took 0.132451 seconds and 4 git commands to generate.