Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 47ff7ac6 authored by Quentin Monnet's avatar Quentin Monnet Committed by David S. Miller
Browse files

tools: bpftool: add cosmetic changes for the manual pages 



Make the look-and-feel of the manual pages somewhat closer to other
manual pages, such as the ones from the utilities from iproute2, by
highlighting more keywords.

Signed-off-by: default avatarQuentin Monnet <quentin.monnet@netronome.com>
Acked-by: default avatarJakub Kicinski <jakub.kicinski@netronome.com>
Acked-by: default avatarDaniel Borkmann <daniel@iogearbox.net>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 004b45c0

tools/bpf/bpftool/Documentation/bpftool-map.rst

+13 −12
Original line number Diff line number Diff line
@@ -13,23 +13,24 @@ SYNOPSIS 
	**bpftool** **map** *COMMAND*



	*COMMANDS* :=

	{ show | dump | update | lookup | getnext | delete | pin | help }

	{ **show** | **dump** | **update** | **lookup** | **getnext** | **delete**

	| **pin** | **help** }



MAP COMMANDS

=============



|	**bpftool** map show   [*MAP*]

|	**bpftool** map dump    *MAP*

|	**bpftool** map update  *MAP*  key *BYTES*   value *VALUE* [*UPDATE_FLAGS*]

|	**bpftool** map lookup  *MAP*  key *BYTES*

|	**bpftool** map getnext *MAP* [key *BYTES*]

|	**bpftool** map delete  *MAP*  key *BYTES*

|	**bpftool** map pin     *MAP*  *FILE*

|	**bpftool** map help

|	**bpftool** **map show**   [*MAP*]

|	**bpftool** **map dump**    *MAP*

|	**bpftool** **map update**  *MAP*  **key** *BYTES*   **value** *VALUE* [*UPDATE_FLAGS*]

|	**bpftool** **map lookup**  *MAP*  **key** *BYTES*

|	**bpftool** **map getnext** *MAP* [**key** *BYTES*]

|	**bpftool** **map delete**  *MAP*  **key** *BYTES*

|	**bpftool** **map pin**     *MAP*  *FILE*

|	**bpftool** **map help**

|

|	*MAP* := { id MAP_ID | pinned FILE }

|	*VALUE* := { BYTES | MAP | PROGRAM }

|	*UPDATE_FLAGS* := { any | exist | noexist }

|	*MAP* := { **id** *MAP_ID* | **pinned** *FILE* }

|	*VALUE* := { *BYTES* | *MAP* | *PROGRAM* }

|	*UPDATE_FLAGS* := { **any** | **exist** | **noexist** }



DESCRIPTION

===========

tools/bpf/bpftool/Documentation/bpftool-prog.rst

+6 −6
Original line number Diff line number Diff line
@@ -10,13 +10,13 @@ tool for inspection and simple manipulation of eBPF progs 
SYNOPSIS

========



|	**bpftool** prog show [*PROG*]

|	**bpftool** prog dump xlated *PROG* [{file *FILE* | opcodes }]

|	**bpftool** prog dump jited  *PROG* [{file *FILE* | opcodes }]

|	**bpftool** prog pin *PROG* *FILE*

|	**bpftool** prog help

|	**bpftool** **prog show** [*PROG*]

|	**bpftool** **prog dump xlated** *PROG* [{**file** *FILE* | **opcodes**}]

|	**bpftool** **prog dump jited**  *PROG* [{**file** *FILE* | **opcodes**}]

|	**bpftool** **prog pin** *PROG* *FILE*

|	**bpftool** **prog help**

|

|	*PROG* := { id *PROG_ID* | pinned *FILE* | tag *PROG_TAG* }

|	*PROG* := { **id** *PROG_ID* | **pinned** *FILE* | **tag** *PROG_TAG* }



DESCRIPTION

===========

tools/bpf/bpftool/Documentation/bpftool.rst

+7 −5
Original line number Diff line number Diff line
@@ -10,18 +10,20 @@ tool for inspection and simple manipulation of eBPF programs and maps 
SYNOPSIS

========



	**bpftool** *OBJECT* { *COMMAND* | help }

	**bpftool** *OBJECT* { *COMMAND* | **help** }



	**bpftool** batch file *FILE*

	**bpftool** **batch file** *FILE*



	**bpftool** version

	**bpftool** **version**



	*OBJECT* := { **map** | **program** }



	*MAP-COMMANDS* :=

	{ show | dump | update | lookup | getnext | delete | pin | help }

	{ **show** | **dump** | **update** | **lookup** | **getnext** | **delete**

	| **pin** | **help** }



	*PROG-COMMANDS* := { show | dump jited | dump xlated | pin | help }

	*PROG-COMMANDS* := { **show** | **dump jited** | **dump xlated** | **pin**

	| **help** }



DESCRIPTION

===========