home-manager: Document options, update readme

This commit is contained in:
talyz 2021-01-24 23:34:16 +01:00
parent 43095936d4
commit 77302d9381
No known key found for this signature in database
GPG key ID: 2DED2151F4671A2B
2 changed files with 37 additions and 5 deletions

View file

@ -92,17 +92,14 @@
"Documents"
"Videos"
"VirtualBox VMs"
".gnupg/private-keys-v1.d"
".gnupg"
".ssh"
".nixops"
".local/share/keyrings"
".local/share/direnv"
];
files = [
".gnupg/pubring.kbx"
".gnupg/sshcontrol"
".gnupg/trustdb.gpg"
".gnupg/random_seed"
".screenrc"
];
};
}

View file

@ -20,16 +20,51 @@ in
directories = mkOption {
type = with types; listOf str;
default = [ ];
example = [
"Downloads"
"Music"
"Pictures"
"Documents"
"Videos"
"VirtualBox VMs"
".gnupg"
".ssh"
".local/share/keyrings"
".local/share/direnv"
];
description = ''
A list of directories in your home directory that
you want to link to persistent storage.
'';
};
files = mkOption {
type = with types; listOf str;
default = [ ];
example = [
".screenrc"
];
description = ''
A list of files in your home directory you want to
link to persistent storage.
'';
};
removePrefixDirectory = mkOption {
type = types.bool;
default = false;
example = true;
description = ''
Note: This is mainly useful if you have a dotfiles
repo structured for use with GNU Stow; if you don't,
you can likely ignore it.
Whether to remove the first directory when linking
or mounting; e.g. for the path
<literal>"screen/.screenrc"</literal>, the
<literal>screen/</literal> is ignored for the path
linked to in your home directory.
'';
};
};
}