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** | **net** | **feature** }
  20
  21         *OPTIONS* := { { **-V** | **--version** } | { **-h** | **--help** }
  22         | { **-j** | **--json** } [{ **-p** | **--pretty** }] }
  23
  24         *MAP-COMMANDS* :=
  25         { **show** | **list** | **create** | **dump** | **update** | **lookup** | **getnext**
  26         | **delete** | **pin** | **event_pipe** | **help** }
  27
  28         *PROG-COMMANDS* := { **show** | **list** | **dump jited** | **dump xlated** | **pin**
  29         | **load** | **attach** | **detach** | **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
  37         *FEATURE-COMMANDS* := { **probe** | **help** }
  38
  39 DESCRIPTION
  40 ===========
  41         *bpftool* allows for inspection and simple modification of BPF objects
  42         on the system.
  43
  44         Note that format of the output of all tools is not guaranteed to be
  45         stable and should not be depended upon.
  46
  47 OPTIONS
  48 =======
  49         .. include:: common_options.rst
  50
  51         -m, --mapcompat
  52                   Allow loading maps with unknown map definitions.
  53
  54         -n, --nomount
  55                   Do not automatically attempt to mount any virtual file system
  56                   (such as tracefs or BPF virtual file system) when necessary.