max/nix-super
1
0
Fork 0
mirror of https://github.com/privatevoid-net/nix-super.git synced 2024-11-25 07:16:17 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

dedent lists

Browse source 
this indentation is unnecessary and probably an artefact from the
migration off XML.
This commit is contained in:
Valentin Gagarin 2024-06-18 11:26:08 +02:00
parent 4f340213bb
commit b975151c09
17 changed files with 523 additions and 524 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/manual/src/command-ref/nix-build.md
View file

@ -55,17 +55,17 @@ All options not listed here are passed to
[`nix-store --realise`](nix-store/realise.md),
except for `--arg` and `--attr` / `-A` which are passed to [`nix-instantiate`](nix-instantiate.md).
- <span id="opt-no-out-link">[`--no-out-link`](#opt-no-out-link)<span>
- <span id="opt-no-out-link">[`--no-out-link`](#opt-no-out-link)<span>
Do not create a symlink to the output path. Note that as a result
the output does not become a root of the garbage collector, and so
might be deleted by `nix-store --gc`.
- <span id="opt-dry-run">[`--dry-run`](#opt-dry-run)</span>
- <span id="opt-dry-run">[`--dry-run`](#opt-dry-run)</span>
Show what store paths would be built or downloaded.
- <span id="opt-out-link">[`--out-link`](#opt-out-link)</span> / `-o` *outlink*
- <span id="opt-out-link">[`--out-link`](#opt-out-link)</span> / `-o` *outlink*
Change the name of the symlink to the output path created from
`result` to *outlink*.

12
doc/manual/src/command-ref/nix-channel.md
View file

@ -27,7 +27,7 @@ The moving parts of channels are:
This command has the following operations:
- `--add` *url* \[*name*\]
- `--add` *url* \[*name*\]
Add a channel *name* located at *url* to the list of subscribed channels.
If *name* is omitted, default to the last component of *url*, with the suffixes `-stable` or `-unstable` removed.
@ -40,20 +40,20 @@ This command has the following operations:
A channel URL must point to a directory containing a file `nixexprs.tar.gz`.
At the top level, that tarball must contain a single directory with a `default.nix` file that serves as the channel’s entry point.
- `--remove` *name*
- `--remove` *name*
Remove the channel *name* from the list of subscribed channels.
- `--list`
- `--list`
Print the names and URLs of all subscribed channels on standard output.
- `--update` \[*names*…\]
- `--update` \[*names*…\]
Download the Nix expressions of subscribed channels and create a new generation.
Update all channels if none is specified, and only those included in *names* otherwise.
- `--list-generations`
- `--list-generations`
Prints a list of all the current existing generations for the
channel profile.
@ -63,7 +63,7 @@ This command has the following operations:
nix-env --profile /nix/var/nix/profiles/per-user/$USER/channels --list-generations
```
- `--rollback` \[*generation*\]
- `--rollback` \[*generation*\]
Revert channels to the state before the last call to `nix-channel --update`.
Optionally, you can specify a specific channel *generation* number to restore.

12
doc/manual/src/command-ref/nix-copy-closure.md
View file

@ -27,26 +27,26 @@ When using public key authentication, you can avoid typing the passphrase with `
# Options
- `--to`
- `--to`
Copy the closure of _paths_ from a Nix store accessible from the local machine to the Nix store on the remote _machine_.
This is the default behavior.
- `--from`
- `--from`
Copy the closure of _paths_ from the Nix store on the remote _machine_ to the local machine's specified Nix store.
- `--gzip`
- `--gzip`
Enable compression of the SSH connection.
- `--include-outputs`
- `--include-outputs`
Also copy the outputs of [store derivation]s included in the closure.
[store derivation]: @docroot@/glossary.md#gloss-store-derivation
- `--use-substitutes` / `-s`
- `--use-substitutes` / `-s`
Attempt to download missing store objects on the target from [substituters](@docroot@/command-ref/conf-file.md#conf-substituters).
Any store objects that cannot be substituted on the target are still copied normally from the source.
@ -56,7 +56,7 @@ When using public key authentication, you can avoid typing the passphrase with `
# Environment variables
- `NIX_SSHOPTS`
- `NIX_SSHOPTS`
Additional options to be passed to `ssh` on the command line.

20
doc/manual/src/command-ref/nix-env/install.md
View file

@ -21,7 +21,7 @@ It is based on the current generation of the active [profile](@docroot@/command-
The arguments *args* map to store paths in a number of possible ways:
- By default, *args* is a set of [derivation] names denoting derivations in the [default Nix expression].
- By default, *args* is a set of [derivation] names denoting derivations in the [default Nix expression].
These are [realised], and the resulting output paths are installed.
Currently installed derivations with a name equal to the name of a derivation being added are removed unless the option `--preserve-installed` is specified.
@ -44,7 +44,7 @@ The arguments *args* map to store paths in a number of possible ways:
gcc-3.3.6 gcc-4.1.1` will install both version of GCC (and will
probably cause a user environment conflict\!).
- If [`--attr`](#opt-attr) / `-A` is specified, the arguments are *attribute paths* that select attributes from the [default Nix expression].
- If [`--attr`](#opt-attr) / `-A` is specified, the arguments are *attribute paths* that select attributes from the [default Nix expression].
This is faster than using derivation names and unambiguous.
Show the attribute paths of available packages with [`nix-env --query`](./query.md):
@ -52,20 +52,20 @@ The arguments *args* map to store paths in a number of possible ways:
nix-env --query --available --attr-path
```
- If `--from-profile` *path* is given, *args* is a set of names
- If `--from-profile` *path* is given, *args* is a set of names
denoting installed [store paths] in the profile *path*. This is an
easy way to copy user environment elements from one profile to
another.
- If `--from-expression` is given, *args* are [Nix language functions](@docroot@/language/constructs.md#functions) that are called with the [default Nix expression] as their single argument.
- If `--from-expression` is given, *args* are [Nix language functions](@docroot@/language/constructs.md#functions) that are called with the [default Nix expression] as their single argument.
The derivations returned by those function calls are installed.
This allows derivations to be specified in an unambiguous way, which is necessary if there are multiple derivations with the same name.
- If *args* are [store derivations](@docroot@/glossary.md#gloss-store-derivation), then these are [realised], and the resulting output paths are installed.
- If *args* are [store derivations](@docroot@/glossary.md#gloss-store-derivation), then these are [realised], and the resulting output paths are installed.
- If *args* are [store paths] that are not store derivations, then these are [realised] and installed.
- If *args* are [store paths] that are not store derivations, then these are [realised] and installed.
- By default all [outputs](@docroot@/language/derivations.md#attr-outputs) are installed for each [derivation].
- By default all [outputs](@docroot@/language/derivations.md#attr-outputs) are installed for each [derivation].
This can be overridden by adding a `meta.outputsToInstall` attribute on the derivation listing a subset of the output names.
Example:
@ -119,14 +119,14 @@ The arguments *args* map to store paths in a number of possible ways:
# Options
- `--prebuilt-only` / `-b`
- `--prebuilt-only` / `-b`
Use only derivations for which a substitute is registered, i.e.,
there is a pre-built binary available that can be downloaded in lieu
of building the derivation. Thus, no packages will be built from
source.
- `--preserve-installed` / `-P`
- `--preserve-installed` / `-P`
Do not remove derivations with a name matching one of the
derivations being installed. Usually, trying to have two versions of
@ -135,7 +135,7 @@ The arguments *args* map to store paths in a number of possible ways:
clashes between the two versions. However, this is not the case for
all packages.
- `--remove-all` / `-r`
- `--remove-all` / `-r`
Remove all previously installed packages first. This is equivalent
to running `nix-env --uninstall '.*'` first, except that everything happens

11
doc/manual/src/command-ref/nix-env/opt-common.md
View file

@ -2,7 +2,7 @@
The following options are allowed for all `nix-env` operations, but may not always have an effect.
- `--file` / `-f` *path*
- `--file` / `-f` *path*
Specifies the Nix expression (designated below as the *active Nix
expression*) used by the `--install`, `--upgrade`, and `--query
@ -14,14 +14,14 @@ The following options are allowed for all `nix-env` operations, but may not alwa
unpacked to a temporary location. The tarball must include a single
top-level directory containing at least a file named `default.nix`.
- `--profile` / `-p` *path*
- `--profile` / `-p` *path*
Specifies the profile to be used by those operations that operate on
a profile (designated below as the *active profile*). A profile is a
sequence of user environments called *generations*, one of which is
the *current generation*.
- `--dry-run`
- `--dry-run`
For the `--install`, `--upgrade`, `--uninstall`,
`--switch-generation`, `--delete-generations` and `--rollback`
@ -32,8 +32,7 @@ The following options are allowed for all `nix-env` operations, but may not alwa
[substituted](@docroot@/glossary.md) (i.e., downloaded) and which paths
will be built from source (because no substitute is available).
- `--system-filter` *system*
- `--system-filter` *system*
By default, operations such as `--query
--available` show derivations matching any platform. This option
By default, operations such as `--query --available` show derivations matching any platform. This option
allows you to use derivations for the specified platform *system*.

6
doc/manual/src/command-ref/nix-env/set-flag.md
View file

@ -13,7 +13,7 @@ to be modified. There are several attributes that can be usefully
modified, because they affect the behaviour of `nix-env` or the user
environment build script:
- `priority` can be changed to resolve filename clashes. The user
- `priority` can be changed to resolve filename clashes. The user
environment build script uses the `meta.priority` attribute of
derivations to resolve filename collisions between packages. Lower
priority values denote a higher priority. For instance, the GCC
@ -23,11 +23,11 @@ environment build script:
priority than Binutils, so the former’s `bin/ld` is symlinked in the
user environment.
- `keep` can be set to `true` to prevent the package from being
- `keep` can be set to `true` to prevent the package from being
upgraded or replaced. This is useful if you want to hang on to an
older version of a package.
- `active` can be set to `false` to “disable” the package. That is, no
- `active` can be set to `false` to “disable” the package. That is, no
symlinks will be generated to the files of the package, but it
remains part of the profile (so it won’t be garbage-collected). It
can be set back to `true` to re-enable the package.

12
doc/manual/src/command-ref/nix-env/upgrade.md
View file

@ -28,11 +28,11 @@ version is installed.
# Flags
- `--lt`
- `--lt`
Only upgrade a derivation to newer versions. This is the default.
- `--leq`
- `--leq`
In addition to upgrading to newer versions, also “upgrade” to
derivations that have the same version. Version are not a unique
@ -40,7 +40,7 @@ version is installed.
that have the same version. This flag may be useful to force
“synchronisation” between the installed and available derivations.
- `--eq`
- `--eq`
*Only* “upgrade” to derivations that have the same version. This may
not seem very useful, but it actually is, e.g., when there is a new
@ -48,21 +48,21 @@ version is installed.
with the same versions built against newer dependencies (to reduce
the number of dependencies floating around on your system).
- `--always`
- `--always`
In addition to upgrading to newer versions, also “upgrade” to
derivations that have the same or a lower version. I.e., derivations
may actually be downgraded depending on what is available in the
active Nix expression.
- `--prebuilt-only` / `-b`
- `--prebuilt-only` / `-b`
Use only derivations for which a substitute is registered, i.e.,
there is a pre-built binary available that can be downloaded in lieu
of building the derivation. Thus, no packages will be built from
source.
- `--preserve-installed` / `-P`
- `--preserve-installed` / `-P`
Do not remove derivations with a name matching one of the
derivations being installed. Usually, trying to have two versions of

22
doc/manual/src/command-ref/nix-hash.md
View file

@ -29,7 +29,7 @@ md5sum`.
# Options
- `--flat`
- `--flat`
Print the cryptographic hash of the contents of each regular file *path*.
That is, instead of computing
@ -39,52 +39,52 @@ md5sum`.
The result is identical to that produced by the GNU commands
`md5sum` and `sha1sum`.
- `--base16`
- `--base16`
Print the hash in a hexadecimal representation (default).
- `--base32`
- `--base32`
Print the hash in a base-32 representation rather than hexadecimal.
This base-32 representation is more compact and can be used in Nix
expressions (such as in calls to `fetchurl`).
- `--base64`
- `--base64`
Similar to --base32, but print the hash in a base-64 representation,
which is more compact than the base-32 one.
- `--sri`
- `--sri`
Print the hash in SRI format with base-64 encoding.
The type of hash algorithm will be prepended to the hash string,
followed by a hyphen (-) and the base-64 hash body.
- `--truncate`
- `--truncate`
Truncate hashes longer than 160 bits (such as SHA-256) to 160 bits.
- `--type` *hashAlgo*
- `--type` *hashAlgo*
Use the specified cryptographic hash algorithm, which can be one of
`md5`, `sha1`, `sha256`, and `sha512`.
- `--to-base16`
- `--to-base16`
Don’t hash anything, but convert the base-32 hash representation
*hash* to hexadecimal.
- `--to-base32`
- `--to-base32`
Don’t hash anything, but convert the hexadecimal hash representation
*hash* to base-32.
- `--to-base64`
- `--to-base64`
Don’t hash anything, but convert the hexadecimal hash representation
*hash* to base-64.
- `--to-sri`
- `--to-sri`
Don’t hash anything, but convert the hexadecimal hash representation
*hash* to SRI.

16
doc/manual/src/command-ref/nix-instantiate.md
View file

@ -30,16 +30,16 @@ standard input.
# Options
- `--add-root` *path*
- `--add-root` *path*
See the [corresponding option](nix-store.md) in `nix-store`.
- `--parse`
- `--parse`
Just parse the input files, and print their abstract syntax trees on
standard output as a Nix expression.
- `--eval`
- `--eval`
Just parse and evaluate the input files, and print the resulting
values on standard output. No instantiation of store derivations
@ -83,7 +83,7 @@ standard input.
> </expr>
> ```
- `--find-file`
- `--find-file`
Look up the given files in Nix’s search path (as specified by the
`NIX_PATH` environment variable). If found, print the corresponding
@ -91,7 +91,7 @@ standard input.
`nixpkgs=/home/alice/nixpkgs`, then `nix-instantiate --find-file
nixpkgs/default.nix` will print `/home/alice/nixpkgs/default.nix`.
- `--strict`
- `--strict`
When used with `--eval`, recursively evaluate list elements and
attributes. Normally, such sub-expressions are left unevaluated
@ -102,19 +102,19 @@ standard input.
> This option can cause non-termination, because lazy data
> structures can be infinitely large.
- `--json`
- `--json`
When used with `--eval`, print the resulting value as an JSON
representation of the abstract syntax tree rather than as a Nix expression.
- `--xml`
- `--xml`
When used with `--eval`, print the resulting value as an XML
representation of the abstract syntax tree rather than as a Nix expression.
The schema is the same as that used by the [`toXML`
built-in](../language/builtins.md).
- `--read-write-mode`
- `--read-write-mode`
When used with `--eval`, perform evaluation in read/write mode so
nix language features that require it will still work (at the cost

10
doc/manual/src/command-ref/nix-prefetch-url.md
View file

@ -39,27 +39,27 @@ the path of the downloaded file in the Nix store is also printed.
# Options
- `--type` *hashAlgo*
- `--type` *hashAlgo*
Use the specified cryptographic hash algorithm,
which can be one of `md5`, `sha1`, `sha256`, and `sha512`.
The default is `sha256`.
- `--print-path`
- `--print-path`
Print the store path of the downloaded file on standard output.
- `--unpack`
- `--unpack`
Unpack the archive (which must be a tarball or zip file) and add the
result to the Nix store. The resulting hash can be used with
functions such as Nixpkgs’s `fetchzip` or `fetchFromGitHub`.
- `--executable`
- `--executable`
Set the executable bit on the downloaded file.
- `--name` *name*
- `--name` *name*
Override the name of the file in the Nix store. By default, this is
`hash-basename`, where *basename* is the last component of *url*.

16
doc/manual/src/command-ref/nix-shell.md
View file

@ -60,7 +60,7 @@ All options not listed here are passed to `nix-store
--realise`, except for `--arg` and `--attr` / `-A` which are passed to
`nix-instantiate`.
- `--command` *cmd*
- `--command` *cmd*
In the environment of the derivation, run the shell command *cmd*.
This command is executed in an interactive shell. (Use `--run` to
@ -71,18 +71,18 @@ All options not listed here are passed to `nix-store
drop you into the interactive shell. This can be useful for doing
any additional initialisation.
- `--run` *cmd*
- `--run` *cmd*
Like `--command`, but executes the command in a non-interactive
shell. This means (among other things) that if you hit Ctrl-C while
the command is running, the shell exits.
- `--exclude` *regexp*
- `--exclude` *regexp*
Do not build any dependencies whose store path matches the regular
expression *regexp*. This option may be specified multiple times.
- `--pure`
- `--pure`
If this flag is specified, the environment is almost entirely
cleared before the interactive shell is started, so you get an
@ -90,7 +90,7 @@ All options not listed here are passed to `nix-store
few variables, in particular `HOME`, `USER` and `DISPLAY`, are
retained.
- `--packages` / `-p` *packages*…
- `--packages` / `-p` *packages*…
Set up an environment in which the specified packages are present.
The command line arguments are interpreted as attribute names inside
@ -98,12 +98,12 @@ All options not listed here are passed to `nix-store
will start a shell in which the packages denoted by the attribute
names `libjpeg` and `openjdk` are present.
- `-i` *interpreter*
- `-i` *interpreter*
The chained script interpreter to be invoked by `nix-shell`. Only
applicable in `#!`-scripts (described below).
- `--keep` *name*
- `--keep` *name*
When a `--pure` shell is started, keep the listed environment
variables.
@ -112,7 +112,7 @@ All options not listed here are passed to `nix-store
# Environment variables
- `NIX_BUILD_SHELL`
- `NIX_BUILD_SHELL`
Shell used to start the interactive environment. Defaults to the
`bash` found in `<nixpkgs>`, falling back to the `bash` found in

2
doc/manual/src/command-ref/nix-store/add-fixed.md
View file

@ -16,7 +16,7 @@ public url or broke since the download expression was written.
This operation has the following options:
- `--recursive`
- `--recursive`
Use recursive instead of flat hashing mode, used when adding
directories to the store.

8
doc/manual/src/command-ref/nix-store/gc.md
View file

@ -14,12 +14,12 @@ reachable via file system references from a set of “roots”, are deleted.
The following suboperations may be specified:
- `--print-roots`
- `--print-roots`
This operation prints on standard output the set of roots used by
the garbage collector.
- `--print-live`
- `--print-live`
This operation prints on standard output the set of “live” store
paths, which are all the store paths reachable from the roots. Live
@ -27,7 +27,7 @@ The following suboperations may be specified:
it would become possible that applications are installed that
reference things that are no longer present in the store.
- `--print-dead`
- `--print-dead`
This operation prints out on standard output the set of “dead” store
paths, which is just the opposite of the set of live paths: any path
@ -36,7 +36,7 @@ The following suboperations may be specified:
By default, all unreachable paths are deleted. The following options
control what gets deleted and in what order:
- `--max-freed` *bytes*
- `--max-freed` *bytes*
Keep deleting paths until at least *bytes* bytes have been deleted,
then stop. The argument *bytes* can be followed by the

32
doc/manual/src/command-ref/nix-store/query.md
View file

@ -24,12 +24,12 @@ symlink.
# Common query options
- `--use-output` / `-u`
- `--use-output` / `-u`
For each argument to the query that is a [store derivation], apply the
query to the output path of the derivation instead.
- `--force-realise` / `-f`
- `--force-realise` / `-f`
Realise each argument to the query first (see [`nix-store --realise`](./realise.md)).
@ -37,7 +37,7 @@ symlink.
# Queries
- `--outputs`
- `--outputs`
Prints out the [output paths] of the store
derivations *paths*. These are the paths that will be produced when
@ -45,7 +45,7 @@ symlink.
[output paths]: @docroot@/glossary.md#gloss-output-path
- `--requisites` / `-R`
- `--requisites` / `-R`
Prints out the [closure] of the store path *paths*.
@ -65,7 +65,7 @@ symlink.
dependencies) is obtained by distributing the closure of a store
derivation and specifying the option `--include-outputs`.
- `--references`
- `--references`
Prints the set of [references] of the store paths
*paths*, that is, their immediate dependencies. (For *all*
@ -73,7 +73,7 @@ symlink.
[references]: @docroot@/glossary.md#gloss-reference
- `--referrers`
- `--referrers`
Prints the set of *referrers* of the store paths *paths*, that is,
the store paths currently existing in the Nix store that refer to
@ -81,14 +81,14 @@ symlink.
referrers is not constant; it can change as store paths are added or
removed.
- `--referrers-closure`
- `--referrers-closure`
Prints the closure of the set of store paths *paths* under the
referrers relation; that is, all store paths that directly or
indirectly refer to one of *paths*. These are all the path currently
in the Nix store that are dependent on *paths*.
- `--deriver` / `-d`
- `--deriver` / `-d`
Prints the [deriver] that was used to build the store paths *paths*. If
the path has no deriver (e.g., if it is a source file), or if the
@ -100,13 +100,13 @@ symlink.
[deriver]: @docroot@/glossary.md#gloss-deriver
- `--valid-derivers`
- `--valid-derivers`
Prints a set of derivation files (`.drv`) which are supposed produce
said paths when realized. Might print nothing, for example for source paths
or paths subsituted from a binary cache.
- `--graph`
- `--graph`
Prints the references graph of the store paths *paths* in the format
of the `dot` tool of AT\&T's [Graphviz
@ -115,7 +115,7 @@ symlink.
this to a store derivation. To obtain a runtime dependency graph,
apply it to an output path.
- `--tree`
- `--tree`
Prints the references graph of the store paths *paths* as a nested
ASCII tree. References are ordered by descending closure size; this
@ -123,7 +123,7 @@ symlink.
recurses into a store path when it is first encountered; this
prevents a blowup of the tree representation of the graph.
- `--graphml`
- `--graphml`
Prints the references graph of the store paths *paths* in the
[GraphML](http://graphml.graphdrawing.org/) file format. This can be
@ -131,20 +131,20 @@ symlink.
dependency graph, apply this to a [store derivation]. To obtain a
runtime dependency graph, apply it to an output path.
- `--binding` *name* / `-b` *name*
- `--binding` *name* / `-b` *name*
Prints the value of the attribute *name* (i.e., environment
variable) of the [store derivation]s *paths*. It is an error for a
derivation to not have the specified attribute.
- `--hash`
- `--hash`
Prints the SHA-256 hash of the contents of the store paths *paths*
(that is, the hash of the output of `nix-store --dump` on the given
paths). Since the hash is stored in the Nix database, this is a fast
operation.
- `--size`
- `--size`
Prints the size in bytes of the contents of the store paths *paths*
— to be precise, the size of the output of `nix-store --dump` on
@ -152,7 +152,7 @@ symlink.
store paths may be higher, especially on filesystems with large
cluster sizes.
- `--roots`
- `--roots`
Prints the garbage collector roots that point, directly or
indirectly, at the store paths *paths*.

6
doc/manual/src/command-ref/nix-store/realise.md
View file

@ -42,17 +42,17 @@ For non-derivation arguments, the argument itself is printed.
# Options
- `--dry-run`
- `--dry-run`
Print on standard error a description of what packages would be
built or downloaded, without actually performing the operation.
- `--ignore-unknown`
- `--ignore-unknown`
If a non-derivation path does not have a substitute, then silently
ignore it.
- `--check`
- `--check`
This option allows you to check whether a derivation is
deterministic. It rebuilds the specified derivation and checks

2
doc/manual/src/command-ref/nix-store/serve.md
View file

@ -14,7 +14,7 @@ access to a restricted ssh user.
The following flags are available:
- `--write`
- `--write`
Allow the connected client to request the realization of
derivations. In effect, this can be used to make the host act as a

4
doc/manual/src/command-ref/nix-store/verify.md
View file

@ -16,7 +16,7 @@ being modified by non-Nix tools, or of bugs in Nix itself.
This operation has the following options:
- `--check-contents`
- `--check-contents`
Checks that the contents of every valid store path has not been
altered by computing a SHA-256 hash of the contents and comparing it
@ -24,7 +24,7 @@ This operation has the following options:
have been modified are printed out. For large stores,
`--check-contents` is obviously quite slow.
- `--repair`
- `--repair`
If any valid path is missing from the store, or (if
`--check-contents` is given) the contents of a valid path has been