mirror of
https://github.com/LnL7/nix-darwin.git
synced 2024-12-14 11:57:34 +00:00
readme: update Documentation
section
This commit is contained in:
parent
60ed03d0b1
commit
3c27b08740
1 changed files with 2 additions and 24 deletions
26
README.md
26
README.md
|
@ -153,31 +153,9 @@ nix-channel --update darwin
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
Reference documentation of all the options is available [here](https://daiderd.com/nix-darwin/manual/index.html).
|
`darwin-help` will open up a local copy of the reference documentation, it can also be found online [here](https://daiderd.com/nix-darwin/manual/index.html).
|
||||||
This can also be accessed locally using `man 5 configuration.nix`.
|
|
||||||
|
|
||||||
`darwin-help` will open a HTML version of the manpage in the default browser.
|
The documentation is also available as manpages by running `man 5 configuration.nix`.
|
||||||
|
|
||||||
Furthermore there's `darwin-option` to introspect the settings of a system and its available options.
|
|
||||||
> NOTE: `darwin-option` is only available to non-flake installations.
|
|
||||||
|
|
||||||
```
|
|
||||||
$ darwin-option nix.linux-builder.enable
|
|
||||||
Value:
|
|
||||||
true
|
|
||||||
|
|
||||||
Default:
|
|
||||||
false
|
|
||||||
|
|
||||||
Example:
|
|
||||||
true
|
|
||||||
|
|
||||||
Description:
|
|
||||||
Whether to enable Linux builder.
|
|
||||||
```
|
|
||||||
|
|
||||||
There's also a small wiki https://github.com/LnL7/nix-darwin/wiki about
|
|
||||||
specific topics, like macOS upgrades.
|
|
||||||
|
|
||||||
## Uninstalling
|
## Uninstalling
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue