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