bpftool.rst 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  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** }
  14. *OPTIONS* := { { **-V** | **--version** } | { **-h** | **--help** }
  15. | { **-j** | **--json** } [{ **-p** | **--pretty** }] }
  16. *MAP-COMMANDS* :=
  17. { **show** | **list** | **dump** | **update** | **lookup** | **getnext** | **delete**
  18. | **pin** | **event_pipe** | **help** }
  19. *PROG-COMMANDS* := { **show** | **list** | **dump jited** | **dump xlated** | **pin**
  20. | **load** | **help** }
  21. *CGROUP-COMMANDS* := { **show** | **list** | **attach** | **detach** | **help** }
  22. *PERF-COMMANDS* := { **show** | **list** | **help** }
  23. DESCRIPTION
  24. ===========
  25. *bpftool* allows for inspection and simple modification of BPF objects
  26. on the system.
  27. Note that format of the output of all tools is not guaranteed to be
  28. stable and should not be depended upon.
  29. OPTIONS
  30. =======
  31. -h, --help
  32. Print short help message (similar to **bpftool help**).
  33. -v, --version
  34. Print version number (similar to **bpftool version**).
  35. -j, --json
  36. Generate JSON output. For commands that cannot produce JSON, this
  37. option has no effect.
  38. -p, --pretty
  39. Generate human-readable JSON output. Implies **-j**.
  40. SEE ALSO
  41. ========
  42. **bpftool-map**\ (8), **bpftool-prog**\ (8), **bpftool-cgroup**\ (8)
  43. **bpftool-perf**\ (8)