steven/beansprout-custom
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add man pages

Browse source 
beansprout(1) is basically just the README and beansprout(5) is basically
just docs/CONFIGURATION.md.

By default, the man pages are generated if scdoc is availabled, but they
can also be explicitly disabled with -Dman-pages.
This commit is contained in:
Ben Buhse 2026-02-25 16:02:58 -06:00
commit 09f43674b5
No known key found for this signature in database
GPG key ID: 7916ACFCD38FD0B4
5 changed files with 451 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

23
build.zig
View file

@ -11,6 +11,15 @@ pub fn build(b: *std.Build) void {
const strip = b.option(bool, "strip", "Omit debug information") orelse false;
const pie = b.option(bool, "pie", "Build a Position Independent Executable") orelse false;
const man_pages = b.option(
bool,
"man-pages",
"Set to true to build man pages. Requires scdoc. Defaults to true if scdoc is found.",
) orelse scdoc_found: {
// Default to true if scdoc is available; else false.
_ = b.findProgram(&.{"scdoc"}, &.{}) catch break :scdoc_found false;
break :scdoc_found true;
};
// Wayland
const scanner = Scanner.create(b, .{});
@ -75,6 +84,20 @@ pub fn build(b: *std.Build) void {
b.installArtifact(beansprout);
const man_step = b.step("man", "Build man pages");
if (man_pages) {
inline for (.{ .{ "beansprout", "1" }, .{ "beansprout", "5" } }) |page| {
const scdoc = b.addSystemCommand(&.{ "/bin/sh", "-c", "scdoc < man/" ++ page[0] ++ "." ++ page[1] ++ ".scd" });
scdoc.addFileArg(b.path("man/" ++ page[0] ++ "." ++ page[1] ++ ".scd"));
const stdout = scdoc.captureStdOut();
const install = b.addInstallFile(stdout, "share/man/man" ++ page[1] ++ "/" ++ page[0] ++ "." ++ page[1]);
b.getInstallStep().dependOn(&install.step);
man_step.dependOn(&install.step);
}
} else {
man_step.dependOn(&b.addFail("man pages disabled; scdoc not found or -Dman-pages=false was set").step);
}
const exe_unit_tests = b.addTest(.{
.root_module = beansprout.root_module,
});