mirror of
https://github.com/foo-dogsquared/nixos-config.git
synced 2025-02-07 12:19:07 +00:00
wrapper-manager-fds/docs: add notes in manpage
This commit is contained in:
parent
8f6c4a7a46
commit
126cd15234
@ -161,7 +161,8 @@ in
|
|||||||
}
|
}
|
||||||
''
|
''
|
||||||
mkdir -p $out/share/man/man5
|
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} \
|
nixos-render-docs options manpage --revision ${releaseConfig.version} \
|
||||||
--header ./header.5 --footer ${./manpages/footer.5} \
|
--header ./header.5 --footer ${./manpages/footer.5} \
|
||||||
${wmOptionsDoc.optionsJSON}/share/doc/nixos/options.json \
|
${wmOptionsDoc.optionsJSON}/share/doc/nixos/options.json \
|
||||||
|
@ -10,5 +10,21 @@
|
|||||||
|
|
||||||
wrapper-manager-configuration.nix - wrapper-manager configuration specification
|
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
|
== Options
|
||||||
|
Loading…
Reference in New Issue
Block a user