diff options
author | John Ericson <John.Ericson@Obsidian.Systems> | 2023-05-15 07:11:47 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-05-15 07:11:47 -0400 |
commit | 914672dc4f955afc3478c256145e7f6098b7da63 (patch) | |
tree | 9a68fca94fa52226916a25885999b707cb8ed2bb /doc/manual/src/command-ref/files/channels.md | |
parent | b15cba03c394962f274852d08f9274249afe0f49 (diff) | |
parent | 992be330ab31be4fe226b09fb602ced18fda788c (diff) |
Merge pull request #8141 from tweag/user-files-doc
Document user files of nix
Diffstat (limited to 'doc/manual/src/command-ref/files/channels.md')
-rw-r--r-- | doc/manual/src/command-ref/files/channels.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/manual/src/command-ref/files/channels.md b/doc/manual/src/command-ref/files/channels.md new file mode 100644 index 000000000..7b1f27128 --- /dev/null +++ b/doc/manual/src/command-ref/files/channels.md @@ -0,0 +1,26 @@ +## Channels + +A directory containing symlinks to Nix channels, managed by [`nix-channel`]: + +- `$XDG_STATE_HOME/nix/profiles/channels` for regular users +- `$NIX_STATE_DIR/profiles/per-user/root/channels` for `root` + +[`nix-channel`] uses a [profile](@docroot@/command-ref/files/profiles.md) to store channels. +This profile contains symlinks to the contents of those channels. + +## Subscribed channels + +The list of subscribed channels is stored in + +- `~/.nix-channels` +- `$XDG_STATE_HOME/nix/channels` if [`use-xdg-base-directories`] is set to `true` + +in the following format: + +``` +<url> <name> +... +``` + +[`nix-channel`]: @docroot@/command-ref/nix-channel.md +[`use-xdg-base-directories`]: @docroot@/command-ref/conf-file.md#conf-use-xdg-base-directories |