OSDN Git Service

tools: bpftool: add cosmetic changes for the manual pages
[uclinux-h8/linux.git] / 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** *OBJECT* { *COMMAND* | **help** }
14
15         **bpftool** **batch file** *FILE*
16
17         **bpftool** **version**
18
19         *OBJECT* := { **map** | **program** }
20
21         *MAP-COMMANDS* :=
22         { **show** | **dump** | **update** | **lookup** | **getnext** | **delete**
23         | **pin** | **help** }
24
25         *PROG-COMMANDS* := { **show** | **dump jited** | **dump xlated** | **pin**
26         | **help** }
27
28 DESCRIPTION
29 ===========
30         *bpftool* allows for inspection and simple modification of BPF objects
31         on the system.
32
33         Note that format of the output of all tools is not guaranteed to be
34         stable and should not be depended upon.
35
36 OPTIONS
37 =======
38         -h, --help
39                   Print short help message (similar to **bpftool help**).
40
41         -v, --version
42                   Print version number (similar to **bpftool version**).
43
44 SEE ALSO
45 ========
46         **bpftool-map**\ (8), **bpftool-prog**\ (8)