da996583ee
there is only one currently: configuration.nix(5), which contains a list of all the options. svn path=/nixos/branches/modular-nixos/; revision=16360
89 lines
2.0 KiB
Nix
89 lines
2.0 KiB
Nix
# This module includes the NixOS man-pages in the system environment,
|
|
# and optionally starts a browser that shows the NixOS manual on one
|
|
# of the virtual consoles. The latter is useful for the installation
|
|
# CD.
|
|
|
|
{pkgs, config, ...}:
|
|
|
|
let
|
|
|
|
inherit (pkgs.lib) mkOption mkIf;
|
|
|
|
cfg = config.services.nixosManual;
|
|
|
|
manual =
|
|
# We could speed up the evaluation of the manual expression by
|
|
# providing it the optionDeclarations of the current
|
|
# configuration.
|
|
import ../../../doc/manual {inherit pkgs;};
|
|
|
|
in
|
|
|
|
{
|
|
|
|
options = {
|
|
|
|
services.nixosManual.enable = mkOption {
|
|
default = true;
|
|
description = ''
|
|
Whether to build the NixOS manual pages.
|
|
'';
|
|
};
|
|
|
|
services.nixosManual.showManual = mkOption {
|
|
default = false;
|
|
description = ''
|
|
Whether to show the NixOS manual on one of the virtual
|
|
consoles.
|
|
'';
|
|
};
|
|
|
|
services.nixosManual.ttyNumber = mkOption {
|
|
default = "8";
|
|
description = ''
|
|
Virtual console on which to show the manual.
|
|
'';
|
|
};
|
|
|
|
services.nixosManual.browser = mkOption {
|
|
default = "${pkgs.w3m}/bin/w3m";
|
|
description = ''
|
|
Browser used to show the manual.
|
|
'';
|
|
};
|
|
|
|
};
|
|
|
|
|
|
config = mkIf cfg.enable {
|
|
|
|
environment.systemPackages = [manual];
|
|
|
|
boot.extraTTYs = mkIf cfg.showManual [cfg.ttyNumber];
|
|
|
|
services.extraJobs = mkIf cfg.showManual (pkgs.lib.singleton
|
|
{ name = "nixos-manual";
|
|
|
|
job = ''
|
|
description "NixOS manual"
|
|
|
|
start on udev
|
|
stop on shutdown
|
|
respawn ${cfg.browser} ${manual}/share/doc/nixos/manual.html \
|
|
< /dev/tty${toString cfg.ttyNumber} > /dev/tty${toString cfg.ttyNumber} 2>&1
|
|
'';
|
|
});
|
|
|
|
services.ttyBackgrounds.specificThemes = mkIf cfg.showManual
|
|
[ { tty = cfg.ttyNumber;
|
|
theme = pkgs.themes "green";
|
|
}
|
|
];
|
|
|
|
services.mingetty.helpLine = mkIf cfg.showManual
|
|
"\nPress <Alt-F${toString cfg.ttyNumber}> for the NixOS manual.";
|
|
|
|
};
|
|
|
|
}
|