foodogsquared/nix-module-wrapper-manager-fds
1
0
Fork 0
mirror of https://github.com/foo-dogsquared/nix-module-wrapper-manager-fds.git synced 2025-01-30 22:57:58 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

wrapper-manager-fds/docs: add notes in manpage

Browse Source
This commit is contained in:
Gabriel Arazas 2024-08-31 11:34:40 +08:00
parent ea4b45597a
commit d28a4c305d
2 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/default.nix
View File

@ -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 \

16
docs/manpages/header.adoc
View File

@ -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