lix/doc/manual/src/command-ref
Alexander Bantyev 36b059748d Split nix-env and nix-store documentation per-subcommand
Documentation on "classic" commands with many sub-commands are
notoriously hard to discover due to lack of overview and anchor links.
Additionally the information on common options and environment variables
is not accessible offline in man pages, and therefore often overlooked
by readers.

With this change, each sub-command of nix-store and nix-env gets its
own page in the manual (listed in the table of contents), and each own
man page.

Also, man pages for each subcommand now (again) list common options
and environment variables. While this makes each page quite long and
some common parameters don't apply, this should still make it easier
to navigate as that additional information was not accessible on the
command line at all.

It is now possible to run 'nix-store --<subcommand> --help` to display
help pages for the given subcommand.

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-03-30 09:46:28 +02:00
..
nix-env Split nix-env and nix-store documentation per-subcommand 2023-03-30 09:46:28 +02:00
nix-store Split nix-env and nix-store documentation per-subcommand 2023-03-30 09:46:28 +02:00
command-ref.md Convert commands 2020-07-23 18:27:12 +02:00
conf-file-prefix.md Fix XDG_CONFIG_DIRS fallback 2021-11-17 14:31:15 +01:00
env-common.md Split nix-env and nix-store documentation per-subcommand 2023-03-30 09:46:28 +02:00
experimental-commands.md Start generation of the nix.1 manpage 2020-08-17 19:33:18 +02:00
files.md Convert nix.conf manpage 2020-07-23 18:27:11 +02:00
main-commands.md Convert commands 2020-07-23 18:27:12 +02:00
nix-build.md Split nix-env and nix-store documentation per-subcommand 2023-03-30 09:46:28 +02:00
nix-channel.md Split nix-env and nix-store documentation per-subcommand 2023-03-30 09:46:28 +02:00
nix-collect-garbage.md Split nix-env and nix-store documentation per-subcommand 2023-03-30 09:46:28 +02:00
nix-copy-closure.md Split nix-env and nix-store documentation per-subcommand 2023-03-30 09:46:28 +02:00
nix-daemon.md manual: build action -> build task 2022-11-06 13:28:18 +01:00
nix-env.md Split nix-env and nix-store documentation per-subcommand 2023-03-30 09:46:28 +02:00
nix-hash.md Split nix-env and nix-store documentation per-subcommand 2023-03-30 09:46:28 +02:00
nix-instantiate.md Split nix-env and nix-store documentation per-subcommand 2023-03-30 09:46:28 +02:00
nix-prefetch-url.md Replace the trailing markdown spaces by a backslash 2021-04-23 14:37:21 +02:00
nix-shell.md Split nix-env and nix-store documentation per-subcommand 2023-03-30 09:46:28 +02:00
nix-store.md Split nix-env and nix-store documentation per-subcommand 2023-03-30 09:46:28 +02:00
opt-common-syn.md Convert commands 2020-07-23 18:27:12 +02:00
opt-common.md Split nix-env and nix-store documentation per-subcommand 2023-03-30 09:46:28 +02:00
opt-inst-syn.md Convert commands 2020-07-23 18:27:12 +02:00
utilities.md Use mdbook 2020-07-23 18:26:48 +02:00