lix-project/lix
18
45
Fork 24
Code Issues 315 Code Review (Gerrit) Projects 1 Releases Wiki Activity

Clean up the manpages

Browse source
This commit is contained in:
Eelco Dolstra 2020-07-24 12:56:19 +02:00
parent 8d0b311a1c
commit 758c9ee1bb
No known key found for this signature in database
GPG key ID: 8170B4726D7198DE
12 changed files with 248 additions and 701 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
doc/manual/src/command-ref/conf-file.md
View file

@ -1,12 +1,8 @@
nix.conf Title: nix.conf
5 # Name
Nix `nix.conf` - Nix configuration file
nix.conf
Nix configuration file
# Description # Description

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

@ -1,44 +1,18 @@
nix-build Title: nix-build
1 # Name
Nix `nix-build` - build a Nix expression
nix-build # Synopsis
build a Nix expression `nix-build` [*paths…*]
[`--arg` *name* *value*]
nix-build [`--argstr` *name* *value*]
[{`--attr` | `-A`} *attrPath*]
\--arg [`--no-out-link`]
[`--dry-run`]
name [{`--out-link` | `-o`} *outlink*]
value
\--argstr
name
value
\--attr
\-A
attrPath
\--no-out-link
\--dry-run
\--out-link
\-o
outlink
paths
# Description # Description

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

@ -1,34 +1,12 @@
nix-channel Title: nix-channel
1 # Name
Nix `nix-channel` - manage Nix channels
nix-channel # Synopsis
manage Nix channels `nix-channel` {`--add` url [*name*] | `--remove` *name* | `--list` | `--update` [*names…*] | `--rollback` [*generation*] }
nix-channel
\--add
url
name
\--remove
name
\--list
\--update
names
\--rollback
generation
# Description # Description

26
doc/manual/src/command-ref/nix-collect-garbage.md
View file

@ -1,28 +1,12 @@
nix-collect-garbage Title: nix-collect-garbage
1 # Name
Nix `nix-collect-garbage` - delete unreachable store paths
nix-collect-garbage # Synopsis
delete unreachable store paths `nix-collect-garbage` [`--delete-old`] [`-d`] [`--delete-older-than` *period*] [`--max-freed` *bytes*] [`--dry-run`]
nix-collect-garbage
\--delete-old
\-d
\--delete-older-than
period
\--max-freed
bytes
\--dry-run
# Description # Description

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

@ -6,7 +6,13 @@ Title: nix-copy-closure
# Synopsis # Synopsis
`nix-copy-closure` [`--to` | `--from`] [`--gzip`] [`--include-outputs`] [`--use-substitutes` | `-s`] [`-v`] _user@machine_ _paths_ `nix-copy-closure`
[`--to` | `--from`]
[`--gzip`]
[`--include-outputs`]
[`--use-substitutes` | `-s`]
[`-v`]
_user@machine_ _paths_
# Description # Description
@ -75,4 +81,3 @@ environment:
$ nix-copy-closure --from alice@itchy.labs \ $ nix-copy-closure --from alice@itchy.labs \
/nix/store/0dj0503hjxy5mbwlafv1rsbdiyx1gkdy-subversion-1.4.4 /nix/store/0dj0503hjxy5mbwlafv1rsbdiyx1gkdy-subversion-1.4.4
$ nix-env -i /nix/store/0dj0503hjxy5mbwlafv1rsbdiyx1gkdy-subversion-1.4.4 $ nix-env -i /nix/store/0dj0503hjxy5mbwlafv1rsbdiyx1gkdy-subversion-1.4.4

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

@ -1,14 +1,12 @@
nix-daemon Title: nix-daemon
8 # Name
Nix `nix-daemon` - Nix multi-user support daemon
nix-daemon # Synopsis
Nix multi-user support daemon `nix-daemon`
nix-daemon
# Description # Description

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

@ -1,50 +1,20 @@
nix-env Title: nix-env
1 # Name
Nix `nix-env` - manipulate or query Nix user environments
nix-env # Synopsis
manipulate or query Nix user environments `nix-env`
[`--option` *name* *value*]
nix-env [`--arg` *name* *value*]
[`--argstr` *name* *value*]
\--arg [{`--file` | `-f`} *path*]
[{`--profile` | `-p`} *path(]
name [`--system-filter` *system*]
[`--dry-run`]
value *operation* [*options…*] [*arguments…*]
\--argstr
name
value
\--file
\-f
path
\--profile
\-p
path
\--system-filter
system
\--dry-run
operation
options
arguments
# Description # Description
@ -135,10 +105,10 @@ have an effect. See also [???](#sec-common-options).
# Files # Files
- `~/.nix-defexpr` - `~/.nix-defexpr`
The source for the default Nix expressions used by the `--install`, The source for the default Nix expressions used by the
`--upgrade`, and `--query `--install`, `--upgrade`, and `--query --available` operations to
--available` operations to obtain derivations. The `--file` option obtain derivations. The `--file` option may be used to override
may be used to override this default. this default.
If `~/.nix-defexpr` is a file, it is loaded as a Nix expression. If If `~/.nix-defexpr` is a file, it is loaded as a Nix expression. If
the expression is a set, it is used as the default Nix expression. the expression is a set, it is used as the default Nix expression.
@ -180,21 +150,13 @@ have an effect. See also [???](#sec-common-options).
## Synopsis ## Synopsis
nix-env `nix-env` {`--install` | `-i`} *args…*
[{`--prebuilt-only` | `-b`}]
\--install [{`--attr` | `-A`}]
[`--from-expression`] [`-E`]
\-i [`--from-profile` *path*]
[`--preserve-installed` | `-P`]
\--preserve-installed [`--remove-all` | `-r`]
\-P
\--remove-all
\-r
args
## Description ## Description
@ -339,21 +301,13 @@ channel:
## Synopsis ## Synopsis
nix-env `nix-env` {`--upgrade` | `-u`} *args*
[`--lt` | `--leq` | `--eq` | `--always`]
\--upgrade [{`--prebuilt-only` | `-b`}]
[{`--attr` | `-A`}]
\-u [`--from-expression`] [`-E`]
[`--from-profile` *path*]
\--lt [`--preserve-installed` | `-P`]
\--leq
\--eq
\--always
args
## Description ## Description
@ -451,19 +405,13 @@ This is illustrated by the following examples:
## Synopsis ## Synopsis
nix-env `nix-env` {`--uninstall` | `-e`} *drvnames…*
\--uninstall
\-e
drvnames
## Description ## Description
The uninstall operation creates a new user environment, based on the The uninstall operation creates a new user environment, based on the
current generation of the active profile, from which the store paths current generation of the active profile, from which the store paths
designated by the symbolic names *names* are removed. designated by the symbolic names *drvnames* are removed.
## Examples ## Examples
@ -474,11 +422,7 @@ designated by the symbolic names *names* are removed.
## Synopsis ## Synopsis
nix-env `nix-env` `--set` *drvname*
\--set
drvname
## Description ## Description
@ -496,15 +440,7 @@ contain just Firefox:
## Synopsis ## Synopsis
nix-env `nix-env` `--set-flag` *name* *value* *drvnames*
\--set-flag
name
value
drvnames
## Description ## Description
@ -572,57 +508,21 @@ To make files from `binutils` take precedence over files from `gcc`:
## Synopsis ## Synopsis
nix-env `nix-env` {`--query` | `-q`} *names…*
[`--installed` | `--available` | `-a`]
\--query [{`--status` | `-s`}]
[{`--attr-path` | `-P`}]
\-q [`--no-name`]
[{`--compare-versions` | `-c`}]
\--installed [`--system`]
[`--drv-path`]
\--available [`--out-path`]
[`--description`]
\-a [`--meta`]
[`--xml`]
\--status [`--json`]
[{`--prebuilt-only` | `-b`}]
\-s [{`--attr` | `-A`} *attribute-path*]
\--attr-path
\-P
\--no-name
\--compare-versions
\-c
\--system
\--drv-path
\--out-path
\--description
\--meta
\--xml
\--json
\--prebuilt-only
\-b
\--attr
\-A
attribute-path
names
## Description ## Description
@ -797,13 +697,7 @@ To show all packages in the latest revision of the Nixpkgs repository:
## Synopsis ## Synopsis
nix-env `nix-env` {`--switch-profile` | `-S`} *path*
\--switch-profile
\-S
path
## Description ## Description
@ -818,9 +712,7 @@ the symlink `~/.nix-profile` is made to point to *path*.
## Synopsis ## Synopsis
nix-env `nix-env` `--list-generations`
\--list-generations
## Description ## Description
@ -841,11 +733,7 @@ generation, and indicates the current generation.
## Synopsis ## Synopsis
nix-env `nix-env` `--delete-generations` *generations*
\--delete-generations
generations
## Description ## Description
@ -873,13 +761,7 @@ generations is important to make garbage collection effective.
## Synopsis ## Synopsis
nix-env `nix-env` {`--switch-generation` | `-G`} *generation*
\--switch-generation
\-G
generation
## Description ## Description
@ -900,9 +782,7 @@ Switching will fail if the specified generation does not exist.
## Synopsis ## Synopsis
nix-env `nix-env` `--rollback`
\--rollback
## Description ## Description

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

@ -1,38 +1,16 @@
nix-hash Title: nix-hash
1 # Name
Nix `nix-hash` - compute the cryptographic hash of a path
nix-hash # Synopsis
compute the cryptographic hash of a path `nix-hash` [`--flat`] [`--base32`] [`--truncate`] [`--type` *hashAlgo*] *path…*
nix-hash `nix-hash` `--to-base16` *hash…*
\--flat `nix-hash` `--to-base32` *hash…*
\--base32
\--truncate
\--type
hashAlgo
path
nix-hash
\--to-base16
hash
nix-hash
\--to-base32
hash
# Description # Description

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

@ -1,56 +1,22 @@
nix-instantiate Title: nix-instantiate
1 # Name
Nix `nix-instantiate` - instantiate store derivations from Nix expressions
nix-instantiate # Synopsis
instantiate store derivations from Nix expressions `nix-instantiate`
[`--parse` | `--eval` [`--strict`] [`--json`] [`--xml`] ]
[`--read-write-mode`]
[`--arg` *name* *value*]
[{`--attr`| `-A`} *attrPath*]
[`--add-root` *path*]
[`--indirect`]
[`--expr` | `-E`]
*files…*
nix-instantiate `nix-instantiate` `--find-file` *files…*
\--parse
\--eval
\--strict
\--json
\--xml
\--read-write-mode
\--arg
name
value
\--attr
\-A
attrPath
\--add-root
path
\--indirect
\--expr
\-E
files
nix-instantiate
\--find-file
files
# Description # Description
@ -179,5 +145,3 @@ attempt to show non-normal forms).
<string value="foo" /> <string value="foo" />
</attr> </attr>
... ...
# Environment variables

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

@ -1,32 +1,16 @@
nix-prefetch-url Title: nix-prefetch-url
1 # Name
Nix `nix-prefetch-url` - copy a file from a URL into the store and print its hash
nix-prefetch-url # Synopsis
copy a file from a URL into the store and print its hash `nix-prefetch-url` *url* [*hash*]
[`--type` *hashAlgo*]
nix-prefetch-url [`--print-path`]
[`--unpack`]
\--version [`--name` *name*]
\--type
hashAlgo
\--print-path
\--unpack
\--name
name
url
hash
# Description # Description

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

@ -1,60 +1,21 @@
nix-shell Title: nix-shell
1 # Name
Nix `nix-shell` - start an interactive shell based on a Nix expression
nix-shell # Synopsis
start an interactive shell based on a Nix expression `nix-shell`
[`--arg` *name* *value*]
nix-shell [`--argstr` *name* *value*]
[{`--attr` | `-A`} *attrPath*]
\--arg [`--command` *cmd*]
[`--run` *cmd*]
name [`--exclude` *regexp*]
[--pure]
value [--keep *name*]
{{`--packages` | `-p`} {*packages* | *expressions*} … | [*path*]}
\--argstr
name
value
\--attr
\-A
attrPath
\--command
cmd
\--run
cmd
\--exclude
regexp
\--pure
\--keep
name
\--packages
\-p
packages
expressions
path
# Description # Description
@ -96,11 +57,10 @@ All options not listed here are passed to `nix-store
This command is executed in an interactive shell. (Use `--run` to This command is executed in an interactive shell. (Use `--run` to
use a non-interactive shell instead.) However, a call to `exit` is use a non-interactive shell instead.) However, a call to `exit` is
implicitly added to the command, so the shell will exit after implicitly added to the command, so the shell will exit after
running the command. To prevent this, add `return` at the end; e.g. running the command. To prevent this, add `return` at the end;
`--command e.g. `--command "echo Hello; return"` will print `Hello` and then
"echo Hello; return"` will print `Hello` and then drop you into the drop you into the interactive shell. This can be useful for doing
interactive shell. This can be useful for doing any additional any additional initialisation.
initialisation.
- `--run` *cmd* - `--run` *cmd*
Like `--command`, but executes the command in a non-interactive Like `--command`, but executes the command in a non-interactive
@ -129,8 +89,7 @@ All options not listed here are passed to `nix-store
- `-i` *interpreter* - `-i` *interpreter*
The chained script interpreter to be invoked by `nix-shell`. Only The chained script interpreter to be invoked by `nix-shell`. Only
applicable in `#!`-scripts (described applicable in `#!`-scripts (described below).
[below](#ssec-nix-shell-shebang)).
- `--keep` *name* - `--keep` *name*
When a `--pure` shell is started, keep the listed environment When a `--pure` shell is started, keep the listed environment
@ -287,5 +246,3 @@ contains:
with import <nixpkgs> {}; with import <nixpkgs> {};
runCommand "dummy" { buildInputs = [ python pythonPackages.prettytable ]; } "" runCommand "dummy" { buildInputs = [ python pythonPackages.prettytable ]; } ""
# Environment variables

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

@ -1,26 +1,15 @@
nix-store Title: nix-store
1 # Name
Nix `nix-store` - manipulate or query the Nix store
nix-store # Synopsis
manipulate or query the Nix store `nix-store` *operation* [*options…*] [*arguments…*]
[`--option` *name* *value*]
nix-store [`--add-root` *path*]
[`--indirect`]
\--add-root
path
\--indirect
operation
options
arguments
# Description # Description
@ -83,15 +72,7 @@ options.
## Synopsis ## Synopsis
nix-store `nix-store` {`--realise` | `-r`} *paths…* [`--dry-run`]
\--realise
\-r
paths
\--dry-run
## Description ## Description
@ -188,11 +169,7 @@ To test whether a previously-built derivation is deterministic:
## Synopsis ## Synopsis
nix-store `nix-store` `--serve` [`--write`]
\--serve
\--write
## Description ## Description
@ -220,19 +197,7 @@ used to provide build access to a given SSH public key:
## Synopsis ## Synopsis
nix-store `nix-store` `--gc` [`--print-roots` | `--print-live` | `--print-dead`] [`--max-freed` *bytes*]
\--gc
\--print-roots
\--print-live
\--print-dead
\--max-freed
bytes
## Description ## Description
@ -294,13 +259,7 @@ To delete at least 100 MiBs of unreachable paths:
## Synopsis ## Synopsis
nix-store `nix-store` `--delete` [`--ignore-liveness`] *paths…*
\--delete
\--ignore-liveness
paths
## Description ## Description
@ -324,55 +283,13 @@ paths in the store that refer to it (i.e., depend on it).
## Synopsis ## Synopsis
nix-store `nix-store` {`--query` | `-q`}
{`--outputs` | `--requisites` | `-R` | `--references` |
\--query `--referrers` | `--referrers-closure` | `--deriver` | `-d` |
`--graph` | `--tree` | `--binding` *name* | `-b` *name* | `--hash` |
\-q `--size` | `--roots`}
[`--use-output`] [`-u`] [`--force-realise`] [`-f`]
\--outputs *paths…*
\--requisites
\-R
\--references
\--referrers
\--referrers-closure
\--deriver
\-d
\--graph
\--tree
\--binding
name
\-b
name
\--hash
\--size
\--roots
\--use-output
\-u
\--force-realise
\-f
paths
## Description ## Description
@ -555,11 +472,7 @@ depends on `svn`:
## Synopsis ## Synopsis
nix-store `nix-store` `--add` *paths…*
\--add
paths
## Description ## Description
@ -575,15 +488,7 @@ prints the resulting paths in the Nix store on standard output.
## Synopsis ## Synopsis
nix-store `nix-store` `--add-fixed` [`--recursive`] *algorithm* *paths…*
\--recursive
\--add-fixed
algorithm
paths
## Description ## Description
@ -608,13 +513,7 @@ This operation has the following options:
## Synopsis ## Synopsis
nix-store `nix-store` `--verify` [`--check-contents`] [`--repair`]
\--verify
\--check-contents
\--repair
## Description ## Description
@ -643,11 +542,7 @@ This operation has the following options:
## Synopsis ## Synopsis
nix-store `nix-store` `--verify-path` *paths…*
\--verify-path
paths
## Description ## Description
@ -666,11 +561,7 @@ To verify the integrity of the `svn` command and all its dependencies:
## Synopsis ## Synopsis
nix-store `nix-store` `--repair-path` *paths…*
\--repair-path
paths
## Description ## Description
@ -701,11 +592,7 @@ substitutes are available, then repair is not possible.
## Synopsis ## Synopsis
nix-store `nix-store` `--dump` *path*
\--dump
path
## Description ## Description
@ -739,11 +626,7 @@ A Nix archive can be unpacked using `nix-store
## Synopsis ## Synopsis
nix-store `nix-store` `--restore` *path*
\--restore
path
## Description ## Description
@ -754,11 +637,7 @@ not already exist. The archive is read from standard input.
## Synopsis ## Synopsis
nix-store `nix-store` `--export` *paths…*
\--export
paths
## Description ## Description
@ -784,9 +663,7 @@ To import the whole closure again, run:
## Synopsis ## Synopsis
nix-store `nix-store` `--import`
\--import
## Description ## Description
@ -800,9 +677,7 @@ Nix store, the import fails.
## Synopsis ## Synopsis
nix-store `nix-store` `--optimise`
\--optimise
## Description ## Description
@ -832,13 +707,7 @@ Use `-vv` or `-vvv` to get some progress indication.
## Synopsis ## Synopsis
nix-store `nix-store` {`--read-log` | `-l`} *paths…*
\--read-log
\-l
paths
## Description ## Description
@ -866,11 +735,7 @@ substitute, then the log is unavailable.
## Synopsis ## Synopsis
nix-store `nix-store` `--dump-db` [*paths…*]
\--dump-db
paths
## Description ## Description
@ -889,9 +754,7 @@ example.
## Synopsis ## Synopsis
nix-store `nix-store` `--load-db`
\--load-db
## Description ## Description
@ -902,11 +765,7 @@ The operation `--load-db` reads a dump of the Nix database created by
## Synopsis ## Synopsis
nix-store `nix-store` `--print-env` *drvpath*
\--print-env
drvpath
## Description ## Description
@ -927,15 +786,7 @@ of the builder are placed in the variable `_args`.
## Synopsis ## Synopsis
nix-store `nix-store` `--generate-binary-cache-key` *key-name* *secret-key-file* *public-key-file*
\--generate-binary-cache-key
key-name
secret-key-file
public-key-file
## Description ## Description
@ -952,5 +803,3 @@ mandatory parameters:
2. The file name where the secret key is to be stored. 2. The file name where the secret key is to be stored.
3. The file name where the public key is to be stored. 3. The file name where the public key is to be stored.
# Environment variables