nix-super/src/nix
Valentin Gagarin 4781e7fa70 Document each store type on its own page
This makes for more useful manual table of contents, that displays the
information at a glance.

The `nix help-stores` command is kept as-is, even though it will show up
in the manual with the same information as these pages due to the way it
is written as a "`--help`-style" command. Deciding what to do with that
command is left for a later PR.

This change also lists all store types at the top of the respective overview page.

Co-authored-by: John Ericson <John.Ericson@Obsidian.Systems
2023-12-01 01:27:52 +01:00
..
realisation fix spelling mistakes reported by Debian's lintian tool 2022-01-30 10:51:39 +02:00
add-to-store.cc Add a new nix store add command 2023-11-15 19:21:17 +01:00
add.md Add a new nix store add command 2023-11-15 19:21:17 +01:00
app.cc Clean up app.cc (#9201) 2023-10-22 22:56:46 +00:00
build.cc Make the Derived Path family of types inductive for dynamic derivations 2023-08-10 00:08:32 -04:00
build.md Also use long options in src/nix/*.md 2023-05-17 08:10:30 +01:00
bundle.cc Merge FSAccessor into SourceAccessor 2023-11-01 17:09:28 +01:00
bundle.md clarify definition of "installable" 2023-03-05 01:46:17 +01:00
cat.cc key and cat: no need for progressBar 2023-11-12 15:40:44 -05:00
config.cc Rename nix show-config to nix config show 2023-11-28 14:28:19 +01:00
copy.cc Make command infra less stateful and more regular 2023-03-15 16:29:07 -04:00
copy.md Also use long options in src/nix/*.md 2023-05-17 08:10:30 +01:00
daemon.cc Add --process-ops flag to nix-daemon 2023-11-21 13:18:19 -05:00
daemon.md Port the flags of nix-daemon to nix daemon (#8788) 2023-08-28 13:43:34 +00:00
derivation-add.cc Create nix derivation add command 2023-04-07 08:34:58 -04:00
derivation-add.md Create nix derivation add command 2023-04-07 08:34:58 -04:00
derivation-show.cc Rename files to reflect new nix derivation show name 2023-04-07 08:34:58 -04:00
derivation-show.md Create nix derivation add command 2023-04-07 08:34:58 -04:00
derivation.cc nix show-derivation -> nix derivation show 2023-04-07 08:34:58 -04:00
develop.cc Split up util.{hh,cc} 2023-11-05 12:20:02 -05:00
develop.md docs: make the nix develop --command example unambiguous (#8952) 2023-09-12 17:15:36 +02:00
diff-closures.cc Get rid of some unchecked calls to std::cout 2023-03-02 15:02:24 +01:00
diff-closures.md Add 'nix store diff-closures' manpage 2020-12-21 13:32:29 +01:00
doctor.cc Split up util.{hh,cc} 2023-11-05 12:20:02 -05:00
dump-path.cc nar dump-path command renamed to nar pack 2023-11-14 19:59:48 +05:30
edit.cc Split up util.{hh,cc} 2023-11-05 12:20:02 -05:00
edit.md nix edit: support kakoune 2022-03-22 23:18:02 +09:00
eval.cc refactor: use string accessors 2023-09-27 00:33:01 -04:00
eval.md Also use long options in src/nix/*.md 2023-05-17 08:10:30 +01:00
flake-archive.md Add 'nix flake' manpages 2020-12-23 18:26:40 +01:00
flake-check.md Also use long options in src/nix/*.md 2023-05-17 08:10:30 +01:00
flake-clone.md Add 'nix flake' manpages 2020-12-23 18:26:40 +01:00
flake-init.md doc: fix number of template attributes 2023-11-21 16:52:25 +01:00
flake-lock.md Overhaul nix flake update and lock commands 2023-10-31 15:33:57 +01:00
flake-metadata.md Merge 'nix flake {info,list-inputs}' into 'nix flake metadata' 2021-03-16 17:19:04 +01:00
flake-new.md Add 'nix flake' manpages 2020-12-23 18:26:40 +01:00
flake-prefetch.md nix store prefetch-tarball -> nix flake prefetch 2021-01-11 12:36:39 +01:00
flake-show.md Update docs 2022-02-22 14:32:56 +01:00
flake-update.md Overhaul nix flake update and lock commands 2023-10-31 15:33:57 +01:00
flake.cc nix flake update add deprecation warnings. 2023-11-27 09:08:15 +01:00
flake.md docs: clarify flake types and implied defaults 2023-10-25 15:10:35 +02:00
fmt.cc Move value-only methods to InstallableValue 2023-03-16 20:06:46 -04:00
fmt.md nix-fmt: add command 2022-03-11 10:00:19 -05:00
get-env.sh structured attrs: improve support / usage of NIX_ATTRS_{SH,JSON}_FILE 2023-10-01 13:22:48 +01:00
hash.cc treewide: Reference HashFormat members with scope 2023-10-19 00:56:41 +08:00
help.md Add 'nix help' manpage 2020-12-21 13:32:29 +01:00
key-convert-secret-to-public.md Add commands for generating secret/public keys 2021-01-06 17:49:31 +01:00
key-generate-secret.md Fix missing ` in key manual 2022-06-08 11:46:50 +02:00
local.mk keep generated documentation in a separate directory 2023-11-30 20:39:24 +01:00
log.cc Make the Derived Path family of types inductive for dynamic derivations 2023-08-10 00:08:32 -04:00
log.md clarify definition of "installable" 2023-03-05 01:46:17 +01:00
ls.cc Merge FSAccessor into SourceAccessor 2023-11-01 17:09:28 +01:00
main.cc keep generated documentation in a separate directory 2023-11-30 20:39:24 +01:00
make-content-addressed.cc Make command infra less stateful and more regular 2023-03-15 16:29:07 -04:00
make-content-addressed.md clarify definition of "installable" 2023-03-05 01:46:17 +01:00
nar-cat.md Add 'nix nar' manpages 2020-12-21 13:32:28 +01:00
nar-dump-path.md code cleanup 2023-11-14 20:02:33 +05:30
nar-ls.md Also use long options in src/nix/*.md 2023-05-17 08:10:30 +01:00
nar.cc Make command infra less stateful and more regular 2023-03-15 16:29:07 -04:00
nar.md Add 'nix nar' manpages 2020-12-21 13:32:28 +01:00
nix.md Document each store type on its own page 2023-12-01 01:27:52 +01:00
optimise-store.cc Add 'nix store optimise' manpage 2020-12-21 13:32:28 +01:00
optimise-store.md Add 'nix store optimise' manpage 2020-12-21 13:32:28 +01:00
path-from-hash-part.cc Add command 'nix store path-from-hash-part' 2022-10-18 16:51:12 +02:00
path-from-hash-part.md Add command 'nix store path-from-hash-part' 2022-10-18 16:51:12 +02:00
path-info.cc Fix compile warning due to unused variable binding. 2023-11-22 11:34:53 +01:00
path-info.md Make nix path-info --json return an object not array 2023-11-06 11:06:31 -05:00
prefetch.cc treewide: Reference HashFormat members with scope 2023-10-19 00:56:41 +08:00
print-dev-env.md clarify definition of "installable" 2023-03-05 01:46:17 +01:00
profile-diff-closures.md Add 'nix profile' manpage 2020-12-21 13:32:29 +01:00
profile-history.md nix profile history: Show profile date 2021-09-14 20:47:33 +02:00
profile-install.md clarify definition of "installable" 2023-03-05 01:46:17 +01:00
profile-list.md nix profile list: Improve readability of the output 2023-07-02 16:17:09 +02:00
profile-remove.md man: fix formatting of nix3-profile-remove 2021-06-28 16:27:03 +02:00
profile-rollback.md Generations -> profile versions 2021-09-14 19:57:45 +02:00
profile-upgrade.md Trivial changes from the lazy-trees branch 2022-12-07 14:06:34 +01:00
profile-wipe-history.md Add 'nix profile wipe-history' command 2021-09-14 20:35:41 +02:00
profile.cc Simplify ContentAddress 2023-07-07 07:30:01 -04:00
profile.md keep generated documentation in a separate directory 2023-11-30 20:39:24 +01:00
realisation.cc Move enabled experimental feature to libutil struct 2023-03-20 11:05:22 -04:00
registry-add.md nix registry: add --registry flag 2021-06-30 22:13:32 +03:00
registry-list.md Add 'nix registry' manpages 2020-12-21 13:32:27 +01:00
registry-pin.md Style tweaks 2021-07-07 10:02:55 +02:00
registry-remove.md nix registry: add --registry flag 2021-06-30 22:13:32 +03:00
registry.cc Overhaul completions, redo #6693 (#8131) 2023-10-23 15:03:11 +02:00
registry.md doc: Fix typo 2022-06-28 22:43:37 -04:00
repl.cc flakes: adopt repl-flake behavior as default 2023-09-27 20:47:10 -04:00
repl.md flakes: adopt repl-flake behavior as default 2023-09-27 20:47:10 -04:00
run.cc Split up util.{hh,cc} 2023-11-05 12:20:02 -05:00
run.hh Ensure all headers have #pragma once and are in API docs 2023-03-31 23:19:44 -04:00
run.md clarify definition of "installable" 2023-03-05 01:46:17 +01:00
search.cc Move evaluator settings (type and global) to separate file/header 2023-07-31 10:14:15 -04:00
search.md Also use long options in src/nix/*.md 2023-05-17 08:10:30 +01:00
shell.md nix: Reserve shebang line syntax and only parse double backtick quotes 2023-11-07 13:24:01 -05:00
sigs.cc key and cat: no need for progressBar 2023-11-12 15:40:44 -05:00
store-cat.md Add 'nix store' NAR-related manpages 2020-12-21 13:32:28 +01:00
store-copy-log.cc Fix misrendering of 'nix store --help' 2023-03-21 12:02:19 +01:00
store-copy-log.md link "store derivation" to glossary definition 2022-12-21 11:42:50 +01:00
store-delete.cc Make command infra less stateful and more regular 2023-03-15 16:29:07 -04:00
store-delete.md clarify definition of "installable" 2023-03-05 01:46:17 +01:00
store-dump-path.md clarify definition of "installable" 2023-03-05 01:46:17 +01:00
store-gc.cc Deduplicate the Store downcasting with a template 2022-03-11 13:32:33 +00:00
store-gc.md Add 'nix store gc' command 2021-01-10 23:29:14 +01:00
store-info.cc Store info command help updates 2023-10-17 09:39:59 +05:30
store-info.md Store info command help updates 2023-10-17 09:39:59 +05:30
store-ls.md Also use long options in src/nix/*.md 2023-05-17 08:10:30 +01:00
store-prefetch-file.md Fix some typos 2021-03-26 16:14:38 +01:00
store-repair.cc Make command infra less stateful and more regular 2023-03-15 16:29:07 -04:00
store-repair.md clarify definition of "installable" 2023-03-05 01:46:17 +01:00
store.cc Move store docs to 'nix help-stores' 2023-03-21 14:37:09 +01:00
upgrade-nix.cc nix upgrade-nix: make the source URL an option 2023-11-10 12:12:28 -05:00
upgrade-nix.md nix upgrade-nix: make the source URL an option 2023-11-10 12:12:28 -05:00
verify.cc Split up util.{hh,cc} 2023-11-05 12:20:02 -05:00
verify.md Also use long options in src/nix/*.md 2023-05-17 08:10:30 +01:00
why-depends.cc Merge FSAccessor into SourceAccessor 2023-11-01 17:09:28 +01:00
why-depends.md Add 'nix why-depends' manpage 2020-12-21 13:32:28 +01:00