tools/bpf/bpftool/Documentation/bpftool.rst

   1 ================
   2 BPFTOOL
   3 ================
   4 -------------------------------------------------------------------------------
   5 tool for inspection and simple manipulation of eBPF programs and maps
   6 -------------------------------------------------------------------------------
   7
   8 :Manual section: 8
   9
  10 SYNOPSIS
  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** }
  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 DESCRIPTION
  36 ===========
  37         *bpftool* allows for inspection and simple modification of BPF objects
  38         on the system.
  39
  40         Note that format of the output of all tools is not guaranteed to be
  41         stable and should not be depended upon.
  42
  43 OPTIONS
  44 =======
  45         -h, --help
  46                   Print short help message (similar to **bpftool help**).
  47
  48         -v, --version
  49                   Print version number (similar to **bpftool version**).
  50
  51         -j, --json
  52                   Generate JSON output. For commands that cannot produce JSON, this
  53                   option has no effect.
  54
  55         -p, --pretty
  56                   Generate human-readable JSON output. Implies **-j**.
  57
  58 SEE ALSO
  59 ========
  60         **bpftool-map**\ (8), **bpftool-prog**\ (8), **bpftool-cgroup**\ (8)
  61         **bpftool-perf**\ (8)