f98e46a251
Update references to other bpftool man pages at the bottom of each manual page. Also reference the "bpf(2)" and "bpf-helpers(7)" man pages. References are sorted by number of man section, then by "prog-and-map-go-first", the other pages in alphabetical order. Signed-off-by: Quentin Monnet <quentin.monnet@netronome.com> Reviewed-by: Jakub Kicinski <jakub.kicinski@netronome.com> Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
73 lines
1.9 KiB
ReStructuredText
73 lines
1.9 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** }
|
|
|
|
*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** }
|
|
|
|
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.
|
|
|
|
|
|
SEE ALSO
|
|
========
|
|
**bpf**\ (2),
|
|
**bpf-helpers**\ (7),
|
|
**bpftool-prog**\ (8),
|
|
**bpftool-map**\ (8),
|
|
**bpftool-cgroup**\ (8),
|
|
**bpftool-net**\ (8),
|
|
**bpftool-perf**\ (8)
|