c07ba629df
All bpftool commands support the options for JSON output and debug from libbpf. In addition, some commands support additional options corresponding to specific use cases. The list of options described in the man pages for the different commands are not always accurate. The messages for interactive help are mostly limited to HELP_SPEC_OPTIONS, and are even less representative of the actual set of options supported for the commands. Let's update the lists: - HELP_SPEC_OPTIONS is modified to contain the "default" options (JSON and debug), and to be extensible (no ending curly bracket). - All commands use HELP_SPEC_OPTIONS in their help message, and then complete the list with their specific options. - The lists of options in the man pages are updated. - The formatting of the list for bpftool.rst is adjusted to match formatting for the other man pages. This is for consistency, and also because it will be helpful in a future patch to automatically check that the files are synchronised. Signed-off-by: Quentin Monnet <quentin@isovalent.com> Signed-off-by: Andrii Nakryiko <andrii@kernel.org> Link: https://lore.kernel.org/bpf/20210730215435.7095-5-quentin@isovalent.com
57 lines
1.6 KiB
ReStructuredText
57 lines
1.6 KiB
ReStructuredText
================
|
|
BPFTOOL
|
|
================
|
|
-------------------------------------------------------------------------------
|
|
tool for inspection and simple manipulation of eBPF programs and maps
|
|
-------------------------------------------------------------------------------
|
|
|
|
:Manual section: 8
|
|
|
|
SYNOPSIS
|
|
========
|
|
|
|
**bpftool** [*OPTIONS*] *OBJECT* { *COMMAND* | **help** }
|
|
|
|
**bpftool** **batch file** *FILE*
|
|
|
|
**bpftool** **version**
|
|
|
|
*OBJECT* := { **map** | **program** | **cgroup** | **perf** | **net** | **feature** }
|
|
|
|
*OPTIONS* := { { **-V** | **--version** } |
|
|
{ **-j** | **--json** } [{ **-p** | **--pretty** }] | { **-d** | **--debug** } }
|
|
|
|
*MAP-COMMANDS* :=
|
|
{ **show** | **list** | **create** | **dump** | **update** | **lookup** | **getnext** |
|
|
**delete** | **pin** | **event_pipe** | **help** }
|
|
|
|
*PROG-COMMANDS* := { **show** | **list** | **dump jited** | **dump xlated** | **pin** |
|
|
**load** | **attach** | **detach** | **help** }
|
|
|
|
*CGROUP-COMMANDS* := { **show** | **list** | **attach** | **detach** | **help** }
|
|
|
|
*PERF-COMMANDS* := { **show** | **list** | **help** }
|
|
|
|
*NET-COMMANDS* := { **show** | **list** | **help** }
|
|
|
|
*FEATURE-COMMANDS* := { **probe** | **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.
|
|
|
|
OPTIONS
|
|
=======
|
|
.. include:: common_options.rst
|
|
|
|
-m, --mapcompat
|
|
Allow loading maps with unknown map definitions.
|
|
|
|
-n, --nomount
|
|
Do not automatically attempt to mount any virtual file system
|
|
(such as tracefs or BPF virtual file system) when necessary.
|