diff options
| author | Alexander Bantyev <balsoft@balsoft.ru> | 2023-03-23 19:27:41 +0400 |
|---|---|---|
| committer | Valentin Gagarin <valentin.gagarin@tweag.io> | 2023-03-30 09:46:28 +0200 |
| commit | 36b059748d06e39fb3e588463bbc4ddcd2255f27 (patch) | |
| tree | c56ec5afaa12e37ababda1132c189f9334338974 /doc/manual/src/command-ref/nix-copy-closure.md | |
| parent | 84c2c09ec2889d3caf1841140cc2bcb4ab34228b (diff) | |
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>
Diffstat (limited to 'doc/manual/src/command-ref/nix-copy-closure.md')
| -rw-r--r-- | doc/manual/src/command-ref/nix-copy-closure.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/manual/src/command-ref/nix-copy-closure.md b/doc/manual/src/command-ref/nix-copy-closure.md index cd8e351bb..0801e8246 100644 --- a/doc/manual/src/command-ref/nix-copy-closure.md +++ b/doc/manual/src/command-ref/nix-copy-closure.md @@ -63,12 +63,16 @@ authentication, you can avoid typing the passphrase with `ssh-agent`. - `-v`\ Show verbose output. +{{#include ./opt-common.md}} + # Environment variables - `NIX_SSHOPTS`\ Additional options to be passed to `ssh` on the command line. +{{#include ./env-common.md}} + # Examples Copy Firefox with all its dependencies to a remote machine: |