mirror of
https://github.com/nix-community/home-manager
synced 2024-11-16 16:19:44 +01:00
9f9e277b60
These (and the `*MD` functions apart from `literalMD`) are now no-ops
in nixpkgs and serve no purpose other than to add additional noise and
potentially mislead people into thinking unmarked DocBook documentation
will still be accepted.
Note that if backporting changes including documentation to 23.05,
the `mdDoc` calls will need to be re-added.
To reproduce this commit, run:
$ NIX_PATH=nixpkgs=flake:nixpkgs/e7e69199f0372364a6106a1e735f68604f4c5a25 \
nix shell nixpkgs#coreutils \
-c find . -name '*.nix' \
-exec nix run -- github:emilazy/nix-doc-munge/98dadf1f77351c2ba5dcb709a2a171d655f15099 \
--strip {} +
$ ./format
74 lines
2.2 KiB
Nix
74 lines
2.2 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
|
|
with lib;
|
|
|
|
let cfg = config.programs.man;
|
|
in {
|
|
options = {
|
|
programs.man = {
|
|
enable = mkOption {
|
|
type = types.bool;
|
|
default = true;
|
|
description = ''
|
|
Whether to enable manual pages and the {command}`man`
|
|
command. This also includes "man" outputs of all
|
|
`home.packages`.
|
|
'';
|
|
};
|
|
|
|
package = mkOption {
|
|
type = types.package;
|
|
default = pkgs.man;
|
|
defaultText = literalExpression "pkgs.man";
|
|
description = "The man package to use.";
|
|
};
|
|
|
|
generateCaches = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = ''
|
|
Whether to generate the manual page index caches using
|
|
{manpage}`mandb(8)`. This allows searching for a page or
|
|
keyword using utilities like {manpage}`apropos(1)`.
|
|
|
|
This feature is disabled by default because it slows down
|
|
building. If you don't mind waiting a few more seconds when
|
|
Home Manager builds a new generation, you may safely enable
|
|
this option.
|
|
'';
|
|
};
|
|
};
|
|
};
|
|
|
|
config = mkIf cfg.enable {
|
|
home.packages = [ cfg.package ];
|
|
home.extraOutputsToInstall = [ "man" ];
|
|
|
|
# This is mostly copy/pasted/adapted from NixOS' documentation.nix.
|
|
home.file = mkIf cfg.generateCaches {
|
|
".manpath".text = let
|
|
# Generate a directory containing installed packages' manpages.
|
|
manualPages = pkgs.buildEnv {
|
|
name = "man-paths";
|
|
paths = config.home.packages;
|
|
pathsToLink = [ "/share/man" ];
|
|
extraOutputsToInstall = [ "man" ];
|
|
ignoreCollisions = true;
|
|
};
|
|
|
|
# Generate a database of all manpages in ${manualPages}.
|
|
manualCache = pkgs.runCommandLocal "man-cache" { } ''
|
|
# Generate a temporary man.conf so mandb knows where to
|
|
# write cache files.
|
|
echo "MANDB_MAP ${manualPages}/share/man $out" > man.conf
|
|
|
|
# Run mandb to generate cache files:
|
|
${cfg.package}/bin/mandb -C man.conf --no-straycats --create \
|
|
${manualPages}/share/man
|
|
'';
|
|
in ''
|
|
MANDB_MAP ${config.home.profileDirectory}/share/man ${manualCache}
|
|
'';
|
|
};
|
|
};
|
|
}
|