xref: /linux/tools/bpf/bpftool/Documentation/bpftool.rst (revision 02f23aa47ae763f0a1ea87192a8d7f7f00facd01)
1.. SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2
3================
4BPFTOOL
5================
6-------------------------------------------------------------------------------
7tool for inspection and simple manipulation of eBPF programs and maps
8-------------------------------------------------------------------------------
9
10:Manual section: 8
11
12.. include:: substitutions.rst
13
14SYNOPSIS
15========
16
17	**bpftool** [*OPTIONS*] *OBJECT* { *COMMAND* | **help** }
18
19	**bpftool** **batch file** *FILE*
20
21	**bpftool** **version**
22
23	*OBJECT* := { **map** | **program** | **cgroup** | **perf** | **net** | **feature** }
24
25	*OPTIONS* := { { **-V** | **--version** } | |COMMON_OPTIONS| }
26
27	*MAP-COMMANDS* :=
28	{ **show** | **list** | **create** | **dump** | **update** | **lookup** | **getnext** |
29	**delete** | **pin** | **event_pipe** | **help** }
30
31	*PROG-COMMANDS* := { **show** | **list** | **dump jited** | **dump xlated** | **pin** |
32	**load** | **attach** | **detach** | **help** }
33
34	*CGROUP-COMMANDS* := { **show** | **list** | **attach** | **detach** | **help** }
35
36	*PERF-COMMANDS* := { **show** | **list** | **help** }
37
38	*NET-COMMANDS* := { **show** | **list** | **help** }
39
40	*FEATURE-COMMANDS* := { **probe** | **help** }
41
42DESCRIPTION
43===========
44	*bpftool* allows for inspection and simple modification of BPF objects
45	on the system.
46
47	Note that format of the output of all tools is not guaranteed to be
48	stable and should not be depended upon.
49
50OPTIONS
51=======
52	.. include:: common_options.rst
53
54	-m, --mapcompat
55		  Allow loading maps with unknown map definitions.
56
57	-n, --nomount
58		  Do not automatically attempt to mount any virtual file system
59		  (such as tracefs or BPF virtual file system) when necessary.
60