From edd48c7a89669e9f82727de47e4ef62fd8cc1a58 Mon Sep 17 00:00:00 2001 From: dianed-square <73617011+dianed-square@users.noreply.github.com> Date: Mon, 23 Feb 2026 14:14:27 -0800 Subject: [PATCH] docs: generate manpages (#7443) --- documentation/docs/getting-started/installation.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/documentation/docs/getting-started/installation.md b/documentation/docs/getting-started/installation.md index 19ad75dc98..615f3302cc 100644 --- a/documentation/docs/getting-started/installation.md +++ b/documentation/docs/getting-started/installation.md @@ -407,6 +407,18 @@ In CI/CD (and other automated, non-interactive environments), pin a specific ver See [CI/CD Environments](/docs/tutorials/cicd) for a complete example and usage details. +## Generate manpages for Linux distributions + +If you're packaging goose for a Linux distribution or creating a custom build, you can generate Unix manpages from the CLI command definitions: + +```bash +just generate-manpages +``` + +This creates ROFF-formatted manpages in `target/man/` (e.g., `goose.1`, `goose-session.1`) that can be installed to `/usr/share/man/man1/` to provide offline documentation via the `man` command. + +Manpage generation requires the goose source repository and is intended for distribution packagers preparing packages for Fedora, Debian, and other Linux distributions. See the [generate_manpages.rs source](https://github.com/block/goose/blob/main/crates/goose-cli/src/bin/generate_manpages.rs) for implementation details. + ## Additional Resources You can also configure Extensions to extend goose's functionality, including adding new ones or toggling them on and off. For detailed instructions, visit the [Using Extensions Guide][using-extensions].