Skip to content

docs: add more book content #310

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kxxt wants to merge 10 commits into
base: main
Choose a base branch
from
Open

docs: add more book content #310

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
0ee65e0
docs: eBPF is no longer experimental
kxxt Aug 9, 2026
ef59921
docs: update dev docs
kxxt Aug 9, 2026
6e3a3b7
docs: built-in and external term for TUI
kxxt Aug 14, 2026
6e5db02
docs: TUI backtrace
kxxt Aug 14, 2026
ce30bd9
docs: copy dialog
kxxt Aug 15, 2026
4603d1e
docs: TUI theme
kxxt Aug 16, 2026
6e1ec3c
docs: TUI key bindings
kxxt Aug 16, 2026
3c56290
docs: export frontend
kxxt Aug 16, 2026
d616a56
docs: fix version in elevation.md
kxxt Aug 16, 2026
cc89429
docs: init json exporter
kxxt Aug 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions book/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@
- [Log Frontend](./features/log.md)
- [TUI Frontend](./features/tui.md)
- [Basics](./features/tui/basic.md)
- [Builtin Terminal v.s. External Terminal](./features/tui/term.md)
- [Built-in Terminal and External Terminal](./features/tui/term.md)
- [Backtrace](./features/tui/backtrace.md)
- [Breakpoints](./features/tui/debugger.md)
- [Copy to Clipboard](./features/tui/copy.md)
- [Theme](./features/tui/theme.md)
- [Key Bindings](./features/tui/keys.md)
- [Export Frontend](./features/collect.md)
- [Perfetto Trace Export](./features/collect/perfetto.md)
- [JSON Export](./features/collect/json.md)
- [Perfetto Trace Export](./features/collect/perfetto.md)
- [Filtering](./features/filter.md)
- [Convenient Privilege Elevation](./features/elevation.md)
- [Experimental Features](./features/experimental.md)
Expand All @@ -36,8 +36,8 @@
- [FAQ](./faq.md)
- [Developer Guide](./dev.md)
- [Internal Architecture](./dev/architecture.md)
- [Backend Differences]()
- [Event System]()
- [Backend Differences](./dev/backend-differences.md)
- [Event System](./dev/event-system.md)
- [Tests](./dev/tests.md)
- [Checklist for Cutting a Release](./dev/release.md)
- [Maintaining this Book](./dev/book.md)
- [Maintaining this Book](./dev/book.md)
Binary file added book/assets/external-term.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 1 addition & 2 deletions book/build-from-src.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ To control whether or not to dynamically link to libbpf, libelf and zlib, consul
## Feature Flags

- `recommended`: This enables the recommended functionalities of tracexec
- `ebpf`(experimental): eBPF backend that doesn't use ptrace and could be used for system wide tracing
- `ebpf`: eBPF backend that doesn't use ptrace and can be used for system-wide tracing
- `ebpf-debug`: Not meant for end users. This flag enables debug logging to `/sys/kernel/debug/tracing/trace_pipe` and some debug checks.
- `static`: Statically link libelf, zlib and libbpf.
- `vendored`: Vendoring libelf, zlib and libbpf, implies `static`.
Expand All @@ -43,4 +43,3 @@ To dynamically link to libbpf, turn off default features and enable `recommended
```bash
cargo build --release --no-default-features -F recommended
```

Loading