diff --git a/docs/default.nix b/docs/default.nix index 187131d..f66da68 100644 --- a/docs/default.nix +++ b/docs/default.nix @@ -161,7 +161,8 @@ in } '' mkdir -p $out/share/man/man5 - asciidoctor --backend manpage ${./manpages/header.adoc} --out-file header.5 + asciidoctor --attribute is-wider-scoped --backend manpage \ + ${./manpages/header.adoc} --out-file header.5 nixos-render-docs options manpage --revision ${releaseConfig.version} \ --header ./header.5 --footer ${./manpages/footer.5} \ ${wmOptionsDoc.optionsJSON}/share/doc/nixos/options.json \ diff --git a/docs/manpages/header.adoc b/docs/manpages/header.adoc index e2abab9..f6fa3bc 100644 --- a/docs/manpages/header.adoc +++ b/docs/manpages/header.adoc @@ -10,5 +10,21 @@ wrapper-manager-configuration.nix - wrapper-manager configuration specification +ifdef::is-wider-scoped[] +== Additional notes + +If you've included env-specific integration wrapper-manager modules (e.g., NixOS, home-manager), there are additional things that are included. + +* The wider-scoped environment configuration is included as a module argument in each wrapper-manager package (i.e., `wrapper-manager.packages`). +This is mainly useful to create a dynamic wrapper-manager package with different parameters when in NixOS, home-manager, or as standalone package. ++ +-- +* For NixOS integration, the NixOS configuration is available as `nixosConfig`. +* For home-manager integration, `hmConfig` stores the home-manager configuration. +-- + +* Additional wrapper-manager documentation can be deployed with the wider environment. +So far, there should be a manpage or an HTML document that can be enabled with `wrapper-manager.documentation.{manpage,html}.enable`. +endif::[] == Options