mirror of
https://github.com/LnL7/nix-darwin.git
synced 2024-12-14 11:57:34 +00:00
e65131e69c
This process was automated by [my fork of `nix-doc-munge`]; thanks
to @pennae for writing this tool! It automatically checks that the
resulting documentation doesn't change, although my fork loosens
this a little to ignore some irrelevant whitespace and typographical
differences.
As of this commit there is no DocBook remaining in the options
documentation.
You can play along at home if you want to reproduce this commit:
$ NIX_PATH=nixpkgs=flake:nixpkgs/c1bca7fe84c646cfd4ebf3482c0e6317a0b13f22 \
nix shell nixpkgs#coreutils \
-c find . -name '*.nix' \
-exec nix run github:emilazy/nix-doc-munge/0a7190f600027bf7baf6cb7139e4d69ac2f51062 \
{} +
[my fork of `nix-doc-munge`]: https://github.com/emilazy/nix-doc-munge
84 lines
2 KiB
Nix
84 lines
2 KiB
Nix
{ name, lib, ... }:
|
|
|
|
with lib;
|
|
|
|
{
|
|
options = {
|
|
name = mkOption {
|
|
type = types.str;
|
|
description = lib.mdDoc ''
|
|
The name of the user account. If undefined, the name of the
|
|
attribute set will be used.
|
|
'';
|
|
};
|
|
|
|
description = mkOption {
|
|
type = types.str;
|
|
default = "";
|
|
example = "Alice Q. User";
|
|
description = lib.mdDoc ''
|
|
A short description of the user account, typically the
|
|
user's full name.
|
|
'';
|
|
};
|
|
|
|
uid = mkOption {
|
|
type = types.int;
|
|
description = lib.mdDoc "The user's UID.";
|
|
};
|
|
|
|
gid = mkOption {
|
|
type = types.int;
|
|
default = 20;
|
|
description = lib.mdDoc "The user's primary group.";
|
|
};
|
|
|
|
isHidden = mkOption {
|
|
type = types.bool;
|
|
default = true;
|
|
description = lib.mdDoc "Whether to make the user account hidden.";
|
|
};
|
|
|
|
# extraGroups = mkOption {
|
|
# type = types.listOf types.str;
|
|
# default = [];
|
|
# description = "The user's auxiliary groups.";
|
|
# };
|
|
|
|
home = mkOption {
|
|
type = types.path;
|
|
default = "/var/empty";
|
|
description = lib.mdDoc "The user's home directory.";
|
|
};
|
|
|
|
createHome = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = lib.mdDoc "Create the home directory when creating the user.";
|
|
};
|
|
|
|
shell = mkOption {
|
|
type = types.either types.shellPackage types.path;
|
|
default = "/sbin/nologin";
|
|
example = literalExpression "pkgs.bashInteractive";
|
|
description = lib.mdDoc "The user's shell.";
|
|
};
|
|
|
|
packages = mkOption {
|
|
type = types.listOf types.package;
|
|
default = [];
|
|
example = literalExpression "[ pkgs.firefox pkgs.thunderbird ]";
|
|
description = lib.mdDoc ''
|
|
The set of packages that should be made availabe to the user.
|
|
This is in contrast to {option}`environment.systemPackages`,
|
|
which adds packages to all users.
|
|
'';
|
|
};
|
|
};
|
|
|
|
config = {
|
|
|
|
name = mkDefault name;
|
|
|
|
};
|
|
}
|