bpftool.rst 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  1. ================
  2. BPFTOOL
  3. ================
  4. -------------------------------------------------------------------------------
  5. tool for inspection and simple manipulation of eBPF programs and maps
  6. -------------------------------------------------------------------------------
  7. :Manual section: 8
  8. SYNOPSIS
  9. ========
  10. **bpftool** [*OPTIONS*] *OBJECT* { *COMMAND* | **help** }
  11. **bpftool** **batch file** *FILE*
  12. **bpftool** **version**
  13. *OBJECT* := { **map** | **program** | **cgroup** | **perf** | **net** }
  14. *OPTIONS* := { { **-V** | **--version** } | { **-h** | **--help** }
  15. | { **-j** | **--json** } [{ **-p** | **--pretty** }] }
  16. *MAP-COMMANDS* :=
  17. { **show** | **list** | **create** | **dump** | **update** | **lookup** | **getnext**
  18. | **delete** | **pin** | **event_pipe** | **help** }
  19. *PROG-COMMANDS* := { **show** | **list** | **dump jited** | **dump xlated** | **pin**
  20. | **load** | **attach** | **detach** | **help** }
  21. *CGROUP-COMMANDS* := { **show** | **list** | **attach** | **detach** | **help** }
  22. *PERF-COMMANDS* := { **show** | **list** | **help** }
  23. *NET-COMMANDS* := { **show** | **list** | **help** }
  24. DESCRIPTION
  25. ===========
  26. *bpftool* allows for inspection and simple modification of BPF objects
  27. on the system.
  28. Note that format of the output of all tools is not guaranteed to be
  29. stable and should not be depended upon.
  30. OPTIONS
  31. =======
  32. -h, --help
  33. Print short help message (similar to **bpftool help**).
  34. -v, --version
  35. Print version number (similar to **bpftool version**).
  36. -j, --json
  37. Generate JSON output. For commands that cannot produce JSON, this
  38. option has no effect.
  39. -p, --pretty
  40. Generate human-readable JSON output. Implies **-j**.
  41. -m, --mapcompat
  42. Allow loading maps with unknown map definitions.
  43. SEE ALSO
  44. ========
  45. **bpf**\ (2),
  46. **bpf-helpers**\ (7),
  47. **bpftool-prog**\ (8),
  48. **bpftool-map**\ (8),
  49. **bpftool-cgroup**\ (8),
  50. **bpftool-net**\ (8),
  51. **bpftool-perf**\ (8)