xref: /linux/tools/bpf/bpftool/Documentation/bpftool.rst (revision f6f3bac08ff9855d803081a353a1fafaa8845739)
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
13	**bpftool** [*OPTIONS*] *OBJECT* { *COMMAND* | **help** }
14
15	**bpftool** **batch file** *FILE*
16
17	**bpftool** **version**
18
19	*OBJECT* := { **map** | **program** | **cgroup** | **perf** | **net** }
20
21	*OPTIONS* := { { **-V** | **--version** } | { **-h** | **--help** }
22	| { **-j** | **--json** } [{ **-p** | **--pretty** }] }
23
24	*MAP-COMMANDS* :=
25	{ **show** | **list** | **dump** | **update** | **lookup** | **getnext** | **delete**
26	| **pin** | **event_pipe** | **help** }
27
28	*PROG-COMMANDS* := { **show** | **list** | **dump jited** | **dump xlated** | **pin**
29	| **load** | **help** }
30
31	*CGROUP-COMMANDS* := { **show** | **list** | **attach** | **detach** | **help** }
32
33	*PERF-COMMANDS* := { **show** | **list** | **help** }
34
35	*NET-COMMANDS* := { **show** | **list** | **help** }
36
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
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
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
60SEE ALSO
61========
62	**bpftool-map**\ (8), **bpftool-prog**\ (8), **bpftool-cgroup**\ (8)
63        **bpftool-perf**\ (8), **bpftool-net**\ (8)
64