Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/qmonnet/bpftool-docs

Extended documentation for bpftool
https://github.com/qmonnet/bpftool-docs

bpf bpftool ebpf

Last synced: about 2 months ago
JSON representation

Extended documentation for bpftool

Awesome Lists containing this project

README

        



bpftool logo: Hannah the Honeyguide

# Documentation for bpftool

[![Netlify Status](https://api.netlify.com/api/v1/badges/b82f47fc-4225-4304-9b60-5effadbd0c1b/deploy-status)](https://app.netlify.com/sites/bpftool-docs/deploys)

This repository contains extended documentation for [bpftool].

Status: Work in progress, not officially deployed yet.

[bpftool]: https://github.com/libbpf/bpftool

## Build locally

### Requirements

The website relies on [Hugo] and [Docsy]. If necessary, install Go. [Install
Hugo's extended version][hugo-install], for example:

```console
$ CGO_ENABLED=1 go install -v -tags extended github.com/gohugoio/hugo@latest
```

[hugo]: https://gohugo.io/
[hugo-install]: https://gohugo.io/installation/
[docsy]: https://www.docsy.dev/

### Development

Simply use Hugo to serve the website locally:

```console
$ hugo server
```

## License

The logos for bpftool are released under the [Creative Commons Attribution 4.0
International][ccby] license (`CC-BY-4.0`).

Manual pages for bpftool originate from the Linux kernel repository and are
dual-licensed under the [GNU GPL v2.0 (only)][gpl] license and the [BSD
2-clause][bsd] license (`GPL-2.0-only OR BSD-2-Clause`). To avoid adding
additional licenses to the mix, the rest of the documentation, unless otherwise
specified, is released under the same dual-licensing terms.

[gpl]: https://spdx.org/licenses/GPL-2.0-only.html
[bsd]: https://spdx.org/licenses/BSD-2-Clause.html
[ccby]: https://spdx.org/licenses/CC-BY-4.0.html