lix-project/lix
19
42
Fork 18
Code Issues 295 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

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
\--arg
name
value
\--argstr
name
value
\--attr
\-A
attrPath
\--no-out-link
\--dry-run
\--out-link
\-o
outlink
paths
`nix-build` [*paths…*]
[`--arg` *name* *value*]
[`--argstr` *name* *value*]
[{`--attr` | `-A`} *attrPath*]
[`--no-out-link`]
[`--dry-run`]
[{`--out-link` | `-o`} *outlink*]
# 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

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

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

@ -6,7 +6,13 @@ Title: nix-copy-closure
# 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
@ -75,4 +81,3 @@ environment:
$ nix-copy-closure --from alice@itchy.labs \
/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

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
\--arg
name
value
\--argstr
name
value
\--file
\-f
path
\--profile
\-p
path
\--system-filter
system
\--dry-run
operation
options
arguments
`nix-env`
[`--option` *name* *value*]
[`--arg` *name* *value*]
[`--argstr` *name* *value*]
[{`--file` | `-f`} *path*]
[{`--profile` | `-p`} *path(]
[`--system-filter` *system*]
[`--dry-run`]
*operation* [*options…*] [*arguments…*]
# Description
@ -135,10 +105,10 @@ have an effect. See also [???](#sec-common-options).
# Files
- `~/.nix-defexpr`
The source for the default Nix expressions used by the `--install`,
`--upgrade`, and `--query
--available` operations to obtain derivations. The `--file` option
may be used to override this default.
The source for the default Nix expressions used by the
`--install`, `--upgrade`, and `--query --available` operations to
obtain derivations. The `--file` option may be used to override
this default.
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.
@ -180,21 +150,13 @@ have an effect. See also [???](#sec-common-options).
## Synopsis
nix-env
\--install
\-i
\--preserve-installed
\-P
\--remove-all
\-r
args
`nix-env` {`--install` | `-i`} *args…*
[{`--prebuilt-only` | `-b`}]
[{`--attr` | `-A`}]
[`--from-expression`] [`-E`]
[`--from-profile` *path*]
[`--preserve-installed` | `-P`]
[`--remove-all` | `-r`]
## Description
@ -339,21 +301,13 @@ channel:
## Synopsis
nix-env
\--upgrade
\-u
\--lt
\--leq
\--eq
\--always
args
`nix-env` {`--upgrade` | `-u`} *args*
[`--lt` | `--leq` | `--eq` | `--always`]
[{`--prebuilt-only` | `-b`}]
[{`--attr` | `-A`}]
[`--from-expression`] [`-E`]
[`--from-profile` *path*]
[`--preserve-installed` | `-P`]
## Description
@ -451,19 +405,13 @@ This is illustrated by the following examples:
## Synopsis
nix-env
\--uninstall
\-e
drvnames
`nix-env` {`--uninstall` | `-e`} *drvnames…*
## Description
The uninstall operation creates a new user environment, based on the
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
@ -474,11 +422,7 @@ designated by the symbolic names *names* are removed.
## Synopsis
nix-env
\--set
drvname
`nix-env` `--set` *drvname*
## Description
@ -496,15 +440,7 @@ contain just Firefox:
## Synopsis
nix-env
\--set-flag
name
value
drvnames
`nix-env` `--set-flag` *name* *value* *drvnames*
## Description
@ -572,57 +508,21 @@ To make files from `binutils` take precedence over files from `gcc`:
## Synopsis
nix-env
\--query
\-q
\--installed
\--available
\-a
\--status
\-s
\--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
`nix-env` {`--query` | `-q`} *names…*
[`--installed` | `--available` | `-a`]
[{`--status` | `-s`}]
[{`--attr-path` | `-P`}]
[`--no-name`]
[{`--compare-versions` | `-c`}]
[`--system`]
[`--drv-path`]
[`--out-path`]
[`--description`]
[`--meta`]
[`--xml`]
[`--json`]
[{`--prebuilt-only` | `-b`}]
[{`--attr` | `-A`} *attribute-path*]
## Description
@ -797,13 +697,7 @@ To show all packages in the latest revision of the Nixpkgs repository:
## Synopsis
nix-env
\--switch-profile
\-S
path
`nix-env` {`--switch-profile` | `-S`} *path*
## Description
@ -818,9 +712,7 @@ the symlink `~/.nix-profile` is made to point to *path*.
## Synopsis
nix-env
\--list-generations
`nix-env` `--list-generations`
## Description
@ -841,11 +733,7 @@ generation, and indicates the current generation.
## Synopsis
nix-env
\--delete-generations
generations
`nix-env` `--delete-generations` *generations*
## Description
@ -873,13 +761,7 @@ generations is important to make garbage collection effective.
## Synopsis
nix-env
\--switch-generation
\-G
generation
`nix-env` {`--switch-generation` | `-G`} *generation*
## Description
@ -900,9 +782,7 @@ Switching will fail if the specified generation does not exist.
## Synopsis
nix-env
\--rollback
`nix-env` `--rollback`
## 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
\--base32
\--truncate
\--type
hashAlgo
path
nix-hash
\--to-base16
hash
nix-hash
\--to-base32
hash
`nix-hash` `--to-base32` *hash…*
# 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
\--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
`nix-instantiate` `--find-file` *files…*
# Description
@ -179,5 +145,3 @@ attempt to show non-normal forms).
<string value="foo" />
</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
\--version
\--type
hashAlgo
\--print-path
\--unpack
\--name
name
url
hash
`nix-prefetch-url` *url* [*hash*]
[`--type` *hashAlgo*]
[`--print-path`]
[`--unpack`]
[`--name` *name*]
# 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
\--argstr
name
value
\--attr
\-A
attrPath
\--command
cmd
\--run
cmd
\--exclude
regexp
\--pure
\--keep
name
\--packages
\-p
packages
expressions
path
`nix-shell`
[`--arg` *name* *value*]
[`--argstr` *name* *value*]
[{`--attr` | `-A`} *attrPath*]
[`--command` *cmd*]
[`--run` *cmd*]
[`--exclude` *regexp*]
[--pure]
[--keep *name*]
{{`--packages` | `-p`} {*packages* | *expressions*} … | [*path*]}
# 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
use a non-interactive shell instead.) However, a call to `exit` is
implicitly added to the command, so the shell will exit after
running the command. To prevent this, add `return` at the end; e.g.
`--command
"echo Hello; return"` will print `Hello` and then drop you into the
interactive shell. This can be useful for doing any additional
initialisation.
running the command. To prevent this, add `return` at the end;
e.g. `--command "echo Hello; return"` will print `Hello` and then
drop you into the interactive shell. This can be useful for doing
any additional initialisation.
- `--run` *cmd*
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*
The chained script interpreter to be invoked by `nix-shell`. Only
applicable in `#!`-scripts (described
[below](#ssec-nix-shell-shebang)).
applicable in `#!`-scripts (described below).
- `--keep` *name*
When a `--pure` shell is started, keep the listed environment
@ -287,5 +246,3 @@ contains:
with import <nixpkgs> {};
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
\--add-root
path
\--indirect
operation
options
arguments
`nix-store` *operation* [*options…*] [*arguments…*]
[`--option` *name* *value*]
[`--add-root` *path*]
[`--indirect`]
# Description
@ -83,15 +72,7 @@ options.
## Synopsis
nix-store
\--realise
\-r
paths
\--dry-run
`nix-store` {`--realise` | `-r`} *paths…* [`--dry-run`]
## Description
@ -188,11 +169,7 @@ To test whether a previously-built derivation is deterministic:
## Synopsis
nix-store
\--serve
\--write
`nix-store` `--serve` [`--write`]
## Description
@ -220,19 +197,7 @@ used to provide build access to a given SSH public key:
## Synopsis
nix-store
\--gc
\--print-roots
\--print-live
\--print-dead
\--max-freed
bytes
`nix-store` `--gc` [`--print-roots` | `--print-live` | `--print-dead`] [`--max-freed` *bytes*]
## Description
@ -294,13 +259,7 @@ To delete at least 100 MiBs of unreachable paths:
## Synopsis
nix-store
\--delete
\--ignore-liveness
paths
`nix-store` `--delete` [`--ignore-liveness`] *paths…*
## Description
@ -324,55 +283,13 @@ paths in the store that refer to it (i.e., depend on it).
## Synopsis
nix-store
\--query
\-q
\--outputs
\--requisites
\-R
\--references
\--referrers
\--referrers-closure
\--deriver
\-d
\--graph
\--tree
\--binding
name
\-b
name
\--hash
\--size
\--roots
\--use-output
\-u
\--force-realise
\-f
paths
`nix-store` {`--query` | `-q`}
{`--outputs` | `--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
@ -555,11 +472,7 @@ depends on `svn`:
## Synopsis
nix-store
\--add
paths
`nix-store` `--add` *paths…*
## Description
@ -575,15 +488,7 @@ prints the resulting paths in the Nix store on standard output.
## Synopsis
nix-store
\--recursive
\--add-fixed
algorithm
paths
`nix-store` `--add-fixed` [`--recursive`] *algorithm* *paths…*
## Description
@ -608,13 +513,7 @@ This operation has the following options:
## Synopsis
nix-store
\--verify
\--check-contents
\--repair
`nix-store` `--verify` [`--check-contents`] [`--repair`]
## Description
@ -643,11 +542,7 @@ This operation has the following options:
## Synopsis
nix-store
\--verify-path
paths
`nix-store` `--verify-path` *paths…*
## Description
@ -666,11 +561,7 @@ To verify the integrity of the `svn` command and all its dependencies:
## Synopsis
nix-store
\--repair-path
paths
`nix-store` `--repair-path` *paths…*
## Description
@ -701,11 +592,7 @@ substitutes are available, then repair is not possible.
## Synopsis
nix-store
\--dump
path
`nix-store` `--dump` *path*
## Description
@ -739,11 +626,7 @@ A Nix archive can be unpacked using `nix-store
## Synopsis
nix-store
\--restore
path
`nix-store` `--restore` *path*
## Description
@ -754,11 +637,7 @@ not already exist. The archive is read from standard input.
## Synopsis
nix-store
\--export
paths
`nix-store` `--export` *paths…*
## Description
@ -784,9 +663,7 @@ To import the whole closure again, run:
## Synopsis
nix-store
\--import
`nix-store` `--import`
## Description
@ -800,9 +677,7 @@ Nix store, the import fails.
## Synopsis
nix-store
\--optimise
`nix-store` `--optimise`
## Description
@ -832,13 +707,7 @@ Use `-vv` or `-vvv` to get some progress indication.
## Synopsis
nix-store
\--read-log
\-l
paths
`nix-store` {`--read-log` | `-l`} *paths…*
## Description
@ -866,11 +735,7 @@ substitute, then the log is unavailable.
## Synopsis
nix-store
\--dump-db
paths
`nix-store` `--dump-db` [*paths…*]
## Description
@ -889,9 +754,7 @@ example.
## Synopsis
nix-store
\--load-db
`nix-store` `--load-db`
## Description
@ -902,11 +765,7 @@ The operation `--load-db` reads a dump of the Nix database created by
## Synopsis
nix-store
\--print-env
drvpath
`nix-store` `--print-env` *drvpath*
## Description
@ -927,15 +786,7 @@ of the builder are placed in the variable `_args`.
## Synopsis
nix-store
\--generate-binary-cache-key
key-name
secret-key-file
public-key-file
`nix-store` `--generate-binary-cache-key` *key-name* *secret-key-file* *public-key-file*
## Description
@ -952,5 +803,3 @@ mandatory parameters:
2. The file name where the secret key is to be stored.
3. The file name where the public key is to be stored.
# Environment variables