diff options
| author | Jakub Kicinski <jakub.kicinski@netronome.com> | 2017-10-04 20:10:05 -0700 |
|---|---|---|
| committer | David S. Miller <davem@davemloft.net> | 2017-10-04 21:46:14 -0700 |
| commit | ff69c21a85a4ed3d8dcf79dd750a0a9eda4fca83 (patch) | |
| tree | 2691dc811e80b5f0ebe611e93c9d9266b936bf3d /tools/bpf/bpftool/Documentation/bpftool.rst | |
| parent | 71bb428fe2c19512ac671d5ee16ef3e73e1b49a8 (diff) | |
tools: bpftool: add documentation
Add documentation for bpftool. Separate files for each subcommand.
Use rst format. Documentation is compiled into man pages using
rst2man.
Signed-off-by: David Beckett <david.beckett@netronome.com>
Signed-off-by: Jakub Kicinski <jakub.kicinski@netronome.com>
Acked-by: Alexei Starovoitov <ast@kernel.org>
Acked-by: Daniel Borkmann <daniel@iogearbox.net>
Signed-off-by: David S. Miller <davem@davemloft.net>
Diffstat (limited to 'tools/bpf/bpftool/Documentation/bpftool.rst')
| -rw-r--r-- | tools/bpf/bpftool/Documentation/bpftool.rst | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/tools/bpf/bpftool/Documentation/bpftool.rst b/tools/bpf/bpftool/Documentation/bpftool.rst new file mode 100644 index 000000000000..f1df1893fb54 --- /dev/null +++ b/tools/bpf/bpftool/Documentation/bpftool.rst @@ -0,0 +1,34 @@ +================ +BPFTOOL +================ +------------------------------------------------------------------------------- +tool for inspection and simple manipulation of eBPF programs and maps +------------------------------------------------------------------------------- + +:Manual section: 8 + +SYNOPSIS +======== + + **bpftool** *OBJECT* { *COMMAND* | help } + + **bpftool** batch file *FILE* + + *OBJECT* := { **map** | **program** } + + *MAP-COMMANDS* := + { show | dump | update | lookup | getnext | delete | pin | help } + + *PROG-COMMANDS* := { show | dump jited | dump xlated | pin | help } + +DESCRIPTION +=========== + *bpftool* allows for inspection and simple modification of BPF objects + on the system. + + Note that format of the output of all tools is not guaranteed to be + stable and should not be depended upon. + +SEE ALSO +======== + **bpftool-map**\ (8), **bpftool-prog**\ (8) |