diff options
Diffstat (limited to 'doc/manual/src/command-ref')
-rw-r--r-- | doc/manual/src/command-ref/command-ref.md | 2 | ||||
-rw-r--r-- | doc/manual/src/command-ref/conf-file.md | 6 | ||||
-rw-r--r-- | doc/manual/src/command-ref/env-common.md | 30 | ||||
-rw-r--r-- | doc/manual/src/command-ref/files.md | 2 | ||||
-rw-r--r-- | doc/manual/src/command-ref/files/profiles.md | 2 | ||||
-rw-r--r-- | doc/manual/src/command-ref/main-commands.md | 2 | ||||
-rw-r--r-- | doc/manual/src/command-ref/nix-collect-garbage.md | 4 | ||||
-rw-r--r-- | doc/manual/src/command-ref/nix-daemon.md | 4 | ||||
-rw-r--r-- | doc/manual/src/command-ref/opt-common.md | 36 | ||||
-rw-r--r-- | doc/manual/src/command-ref/utilities.md | 2 |
10 files changed, 49 insertions, 41 deletions
diff --git a/doc/manual/src/command-ref/command-ref.md b/doc/manual/src/command-ref/command-ref.md index 6a78075db..c79f8e0ba 100644 --- a/doc/manual/src/command-ref/command-ref.md +++ b/doc/manual/src/command-ref/command-ref.md @@ -1,2 +1,2 @@ This section lists commands and options that you can use when you work -with Nix. +with Lix. diff --git a/doc/manual/src/command-ref/conf-file.md b/doc/manual/src/command-ref/conf-file.md index 980cf8c14..fda6ebde7 100644 --- a/doc/manual/src/command-ref/conf-file.md +++ b/doc/manual/src/command-ref/conf-file.md @@ -1,14 +1,14 @@ # Name -`nix.conf` - Nix configuration file +`nix.conf` - Lix configuration file # Description -Nix supports a variety of configuration settings, which are read from configuration files or taken as command line flags. +Lix supports a variety of configuration settings, which are read from configuration files or taken as command line flags. ## Configuration file -By default Nix reads settings from the following places, in that order: +By default Lix reads settings from the following places, in that order: 1. The system-wide configuration file `sysconfdir/nix/nix.conf` (i.e. `/etc/nix/nix.conf` on most systems), or `$NIX_CONF_DIR/nix.conf` if [`NIX_CONF_DIR`](./env-common.md#env-NIX_CONF_DIR) is set. diff --git a/doc/manual/src/command-ref/env-common.md b/doc/manual/src/command-ref/env-common.md index 3de8ba9eb..ea8420c72 100644 --- a/doc/manual/src/command-ref/env-common.md +++ b/doc/manual/src/command-ref/env-common.md @@ -1,6 +1,6 @@ # Common Environment Variables -Most Nix commands interpret the following environment variables: +Most commands in Lix interpret the following environment variables: - <span id="env-IN_NIX_SHELL">[`IN_NIX_SHELL`](#env-IN_NIX_SHELL)</span>\ Indicator that tells if the current environment was set up by @@ -13,7 +13,7 @@ Most Nix commands interpret the following environment variables: e.g. `/home/eelco/Dev:/etc/nixos`. It can be extended using the [`-I` option](@docroot@/command-ref/opt-common.md#opt-I). - If `NIX_PATH` is not set at all, Nix will fall back to the following list in [impure](@docroot@/command-ref/conf-file.md#conf-pure-eval) and [unrestricted](@docroot@/command-ref/conf-file.md#conf-restrict-eval) evaluation mode: + If `NIX_PATH` is not set at all, Lix will fall back to the following list in [impure](@docroot@/command-ref/conf-file.md#conf-pure-eval) and [unrestricted](@docroot@/command-ref/conf-file.md#conf-restrict-eval) evaluation mode: 1. `$HOME/.nix-defexpr/channels` 2. `nixpkgs=/nix/var/nix/profiles/per-user/root/channels/nixpkgs` @@ -50,28 +50,28 @@ Most Nix commands interpret the following environment variables: Overrides the location of the Nix store (default `prefix/store`). - <span id="env-NIX_DATA_DIR">[`NIX_DATA_DIR`](#env-NIX_DATA_DIR)</span>\ - Overrides the location of the Nix static data directory (default + Overrides the location of the Lix static data directory (default `prefix/share`). - <span id="env-NIX_LOG_DIR">[`NIX_LOG_DIR`](#env-NIX_LOG_DIR)</span>\ - Overrides the location of the Nix log directory (default + Overrides the location of the Lix log directory (default `prefix/var/log/nix`). - <span id="env-NIX_STATE_DIR">[`NIX_STATE_DIR`](#env-NIX_STATE_DIR)</span>\ - Overrides the location of the Nix state directory (default + Overrides the location of the Lix state directory (default `prefix/var/nix`). - <span id="env-NIX_CONF_DIR">[`NIX_CONF_DIR`](#env-NIX_CONF_DIR)</span>\ - Overrides the location of the system Nix configuration directory + Overrides the location of the system Lix configuration directory (default `prefix/etc/nix`). - <span id="env-NIX_CONFIG">[`NIX_CONFIG`](#env-NIX_CONFIG)</span>\ - Applies settings from Nix configuration from the environment. - The content is treated as if it was read from a Nix configuration file. + Applies settings from Lix configuration from the environment. + The content is treated as if it was read from a Lix configuration file. Settings are separated by the newline character. - <span id="env-NIX_USER_CONF_FILES">[`NIX_USER_CONF_FILES`](#env-NIX_USER_CONF_FILES)</span>\ - Overrides the location of the Nix user configuration files to load from. + Overrides the location of the Lix user configuration files to load from. The default are the locations according to the [XDG Base Directory Specification]. See the [XDG Base Directories](#xdg-base-directories) sub-section for details. @@ -84,19 +84,19 @@ Most Nix commands interpret the following environment variables: substantial amounts of disk space. The default is `/tmp`. - <span id="env-NIX_REMOTE">[`NIX_REMOTE`](#env-NIX_REMOTE)</span>\ - This variable should be set to `daemon` if you want to use the Nix + This variable should be set to `daemon` if you want to use the Lix daemon to execute Nix operations. This is necessary in [multi-user - Nix installations](@docroot@/installation/multi-user.md). If the Nix + Nix installations](@docroot@/installation/multi-user.md). If the Lix daemon's Unix socket is at some non-standard path, this variable should be set to `unix://path/to/socket`. Otherwise, it should be left unset. - <span id="env-NIX_SHOW_STATS">[`NIX_SHOW_STATS`](#env-NIX_SHOW_STATS)</span>\ - If set to `1`, Nix will print some evaluation statistics, such as + If set to `1`, Lix will print some evaluation statistics, such as the number of values allocated. - <span id="env-NIX_COUNT_CALLS">[`NIX_COUNT_CALLS`](#env-NIX_COUNT_CALLS)</span>\ - If set to `1`, Nix will print how often functions were called during + If set to `1`, Lix will print how often functions were called during Nix expression evaluation. This is useful for profiling your Nix expressions. @@ -108,9 +108,9 @@ Most Nix commands interpret the following environment variables: ## XDG Base Directories -Nix follows the [XDG Base Directory Specification]. +Lix follows the [XDG Base Directory Specification]. -For backwards compatibility, Nix commands will follow the standard only when [`use-xdg-base-directories`] is enabled. +For backwards compatibility, commands in Lix will follow the standard only when [`use-xdg-base-directories`] is enabled. [New Nix commands](@docroot@/command-ref/new-cli/nix.md) (experimental) conform to the standard by default. The following environment variables are used to determine locations of various state and configuration files: diff --git a/doc/manual/src/command-ref/files.md b/doc/manual/src/command-ref/files.md index df5646c05..e2d08923b 100644 --- a/doc/manual/src/command-ref/files.md +++ b/doc/manual/src/command-ref/files.md @@ -1,4 +1,4 @@ # Files This section lists configuration files that you can use when you work -with Nix. +with Lix. diff --git a/doc/manual/src/command-ref/files/profiles.md b/doc/manual/src/command-ref/files/profiles.md index b5c737880..a6b679e34 100644 --- a/doc/manual/src/command-ref/files/profiles.md +++ b/doc/manual/src/command-ref/files/profiles.md @@ -21,7 +21,7 @@ lrwxrwxrwx 1 alice users 51 Oct 29 13:20 /home/alice/.local/state/nix/profiles/p lrwxrwxrwx 1 alice users 51 Nov 25 14:35 /home/alice/.local/state/nix/profiles/profile-7-link -> /nix/store/mp0x6xnsg0b8qhswy6riqvimai4gm677-profile ``` -Each of these symlinks is a root for the Nix garbage collector. +Each of these symlinks is a root for the Lix garbage collector. The contents of the store path corresponding to each version of the profile is a tree of symlinks to the files of the installed packages, diff --git a/doc/manual/src/command-ref/main-commands.md b/doc/manual/src/command-ref/main-commands.md index e4f1f1d0e..0c1ca4fa1 100644 --- a/doc/manual/src/command-ref/main-commands.md +++ b/doc/manual/src/command-ref/main-commands.md @@ -1,4 +1,4 @@ # Main Commands This section lists commands and options that you can use when you work -with Nix. +with Lix. diff --git a/doc/manual/src/command-ref/nix-collect-garbage.md b/doc/manual/src/command-ref/nix-collect-garbage.md index 3cab79f0e..f9a3f1940 100644 --- a/doc/manual/src/command-ref/nix-collect-garbage.md +++ b/doc/manual/src/command-ref/nix-collect-garbage.md @@ -37,7 +37,9 @@ Instead, it looks in a few locations, and acts on all profiles it finds there: > Not stable; subject to change > > Do not rely on this functionality; it just exists for migration purposes and is may change in the future. - > These deprecated paths remain a private implementation detail of Nix. + > These deprecated paths remain a private implementation detail of Lix. + + <!-- FIXME(Qyriad): this is inconsistent with https://git.lix.systems/lix-project/lix/issues/215, needs updating when that happens --> `$NIX_STATE_DIR/profiles` and `$NIX_STATE_DIR/profiles/per-user`. diff --git a/doc/manual/src/command-ref/nix-daemon.md b/doc/manual/src/command-ref/nix-daemon.md index 04b483be3..268bbc558 100644 --- a/doc/manual/src/command-ref/nix-daemon.md +++ b/doc/manual/src/command-ref/nix-daemon.md @@ -1,6 +1,6 @@ # Name -`nix-daemon` - Nix multi-user support daemon +`nix-daemon` - Lix multi-user support daemon # Synopsis @@ -8,6 +8,6 @@ # Description -The Nix daemon is necessary in multi-user Nix installations. It runs +The Lix daemon is necessary in multi-user Lix installations. It runs build tasks and other operations on the Nix store on behalf of unprivileged users. diff --git a/doc/manual/src/command-ref/opt-common.md b/doc/manual/src/command-ref/opt-common.md index 67772cac8..cd289b7ea 100644 --- a/doc/manual/src/command-ref/opt-common.md +++ b/doc/manual/src/command-ref/opt-common.md @@ -1,6 +1,6 @@ # Common Options -Most Nix commands accept the following command-line options: +Most commands in Lix accept the following command-line options: - <span id="opt-help">[`--help`](#opt-help)</span> @@ -8,12 +8,12 @@ Most Nix commands accept the following command-line options: - <span id="opt-version">[`--version`](#opt-version)</span> - Prints out the Nix version number on standard output and exits. + Prints out the Lix version number on standard output and exits. - <span id="opt-verbose">[`--verbose`](#opt-verbose)</span> / `-v` Increases the level of verbosity of diagnostic messages printed on standard error. - For each Nix operation, the information printed on standard output is well-defined; + For each Lix operation, the information printed on standard output is well-defined; any diagnostic information is printed on standard error, never on standard output. This option may be specified repeatedly. @@ -21,11 +21,11 @@ Most Nix commands accept the following command-line options: - `0` “Errors only” - Only print messages explaining why the Nix invocation failed. + Only print messages explaining why the Lix invocation failed. - `1` “Informational” - Print *useful* messages about what Nix is doing. + Print *useful* messages about what Lix is doing. This is the default. - `2` “Talkative” @@ -80,13 +80,13 @@ Most Nix commands accept the following command-line options: - <span id="opt-no-build-output">[`--no-build-output`](#opt-no-build-output)</span> / `-Q` - By default, output written by builders to standard output and standard error is echoed to the Nix command's standard error. + By default, output written by builders to standard output and standard error is echoed to the Lix command's standard error. This option suppresses this behaviour. Note that the builder's standard output and error are always written to a log file in `prefix/nix/var/log/nix`. - <span id="opt-max-jobs">[`--max-jobs`](#opt-max-jobs)</span> / `-j` *number* - Sets the maximum number of build jobs that Nix will perform in parallel to the specified number. + Sets the maximum number of build jobs that Lix will perform in parallel to the specified number. Specify `auto` to use the number of CPUs in the system. The default is specified by the `max-jobs` configuration setting, which itself defaults to `1`. A higher value is useful on SMP systems or to exploit I/O latency. @@ -116,8 +116,8 @@ Most Nix commands accept the following command-line options: - <span id="opt-keep-going">[`--keep-going`](#opt-keep-going)</span> / `-k` Keep going in case of failed builds, to the greatest extent possible. - That is, if building an input of some derivation fails, Nix will still build the other inputs, but not the derivation itself. - Without this option, Nix stops if any build fails (except for builds of substitutes), possibly killing builds in progress (in case of parallel or distributed builds). + That is, if building an input of some derivation fails, Lix will still build the other inputs, but not the derivation itself. + Without this option, Lix stops if any build fails (except for builds of substitutes), possibly killing builds in progress (in case of parallel or distributed builds). - <span id="opt-keep-failed">[`--keep-failed`](#opt-keep-failed)</span> / `-K` @@ -126,18 +126,24 @@ Most Nix commands accept the following command-line options: - <span id="opt-fallback">[`--fallback`](#opt-fallback)</span> - Whenever Nix attempts to build a derivation for which substitutes are known for each output path, but realising the output paths through the substitutes fails, fall back on building the derivation. + Whenever Lix attempts to build a derivation for which substitutes are known for each output path, but realising the output paths through the substitutes fails, fall back on building the derivation. The most common scenario in which this is useful is when we have registered substitutes in order to perform binary distribution from, say, a network repository. If the repository is down, the realisation of the derivation will fail. - When this option is specified, Nix will build the derivation instead. + When this option is specified, Lix will build the derivation instead. Thus, installation from binaries falls back on installation from source. This option is not the default since it is generally not desirable for a transient failure in obtaining the substitutes to lead to a full build from source (with the related consumption of resources). - <span id="opt-readonly-mode">[`--readonly-mode`](#opt-readonly-mode)</span> - When this option is used, no attempt is made to open the Nix database. - Most Nix operations do need database access, so those operations will fail. + When this option is used, no attempt is made to open the Lix database. + Most Lix operations do need database access, so those operations will fail. + + <div class="warning"> + + FIXME(Lix): sometimes you want `--store dummy` instead, because this option sometimes doesn't work. Document why this is. + + </div> - <span id="opt-arg">[`--arg`](#opt-arg)</span> *name* *value* @@ -195,8 +201,8 @@ Most Nix commands accept the following command-line options: - <span id="opt-option">[`--option`](#opt-option)</span> *name* *value* - Set the Nix configuration option *name* to *value*. - This overrides settings in the Nix configuration file (see nix.conf5). + Set the Lix configuration option *name* to *value*. + This overrides settings in the Lix configuration file (see nix.conf(5)). - <span id="opt-repair">[`--repair`](#opt-repair)</span> diff --git a/doc/manual/src/command-ref/utilities.md b/doc/manual/src/command-ref/utilities.md index 5ba8a02a3..3ee09ea6c 100644 --- a/doc/manual/src/command-ref/utilities.md +++ b/doc/manual/src/command-ref/utilities.md @@ -1,3 +1,3 @@ # Utilities -This section lists utilities that you can use when you work with Nix. +This section lists utilities that you can use when you work with Lix. |