| Jakub Kicinski | ff69c21 | 2017-10-04 20:10:05 -0700 | [diff] [blame] | 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 | |
| Quentin Monnet | 0641c3c | 2017-10-23 09:24:16 -0700 | [diff] [blame] | 13 | **bpftool** [*OPTIONS*] *OBJECT* { *COMMAND* | **help** } |
| Jakub Kicinski | ff69c21 | 2017-10-04 20:10:05 -0700 | [diff] [blame] | 14 | |
| Quentin Monnet | 47ff7ac | 2017-10-23 09:24:15 -0700 | [diff] [blame] | 15 | **bpftool** **batch file** *FILE* |
| Jakub Kicinski | ff69c21 | 2017-10-04 20:10:05 -0700 | [diff] [blame] | 16 | |
| Quentin Monnet | 47ff7ac | 2017-10-23 09:24:15 -0700 | [diff] [blame] | 17 | **bpftool** **version** |
| Quentin Monnet | 821cfbb | 2017-10-19 15:46:26 -0700 | [diff] [blame] | 18 | |
| Roman Gushchin | 5ccda64 | 2017-12-13 15:18:54 +0000 | [diff] [blame^] | 19 | *OBJECT* := { **map** | **program** | **cgroup** } |
| Jakub Kicinski | ff69c21 | 2017-10-04 20:10:05 -0700 | [diff] [blame] | 20 | |
| Quentin Monnet | 0641c3c | 2017-10-23 09:24:16 -0700 | [diff] [blame] | 21 | *OPTIONS* := { { **-V** | **--version** } | { **-h** | **--help** } |
| 22 | | { **-j** | **--json** } [{ **-p** | **--pretty** }] } |
| 23 | |
| Jakub Kicinski | ff69c21 | 2017-10-04 20:10:05 -0700 | [diff] [blame] | 24 | *MAP-COMMANDS* := |
| Quentin Monnet | 47ff7ac | 2017-10-23 09:24:15 -0700 | [diff] [blame] | 25 | { **show** | **dump** | **update** | **lookup** | **getnext** | **delete** |
| 26 | | **pin** | **help** } |
| Jakub Kicinski | ff69c21 | 2017-10-04 20:10:05 -0700 | [diff] [blame] | 27 | |
| Quentin Monnet | 47ff7ac | 2017-10-23 09:24:15 -0700 | [diff] [blame] | 28 | *PROG-COMMANDS* := { **show** | **dump jited** | **dump xlated** | **pin** |
| Roman Gushchin | 49a086c | 2017-12-13 15:18:53 +0000 | [diff] [blame] | 29 | | **load** | **help** } |
| Jakub Kicinski | ff69c21 | 2017-10-04 20:10:05 -0700 | [diff] [blame] | 30 | |
| Roman Gushchin | 5ccda64 | 2017-12-13 15:18:54 +0000 | [diff] [blame^] | 31 | *CGROUP-COMMANDS* := { **list** | **attach** | **detach** | **help** } |
| 32 | |
| Jakub Kicinski | ff69c21 | 2017-10-04 20:10:05 -0700 | [diff] [blame] | 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 | |
| Quentin Monnet | a2bc2e5 | 2017-10-23 09:24:06 -0700 | [diff] [blame] | 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 | |
| Quentin Monnet | 0641c3c | 2017-10-23 09:24:16 -0700 | [diff] [blame] | 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 | |
| Jakub Kicinski | ff69c21 | 2017-10-04 20:10:05 -0700 | [diff] [blame] | 56 | SEE ALSO |
| 57 | ======== |
| Roman Gushchin | 5ccda64 | 2017-12-13 15:18:54 +0000 | [diff] [blame^] | 58 | **bpftool-map**\ (8), **bpftool-prog**\ (8), **bpftool-cgroup**\ (8) |