(zilch lang ninja): document
Change-Id: I6a6a6964dcc713504ec57f40981a601696a573af
This commit is contained in:
parent
154ba9be1c
commit
93a1ebba00
11 changed files with 329 additions and 43 deletions
63
docs/modules/ROOT/pages/ninja/man.adoc
Normal file
63
docs/modules/ROOT/pages/ninja/man.adoc
Normal file
|
|
@ -0,0 +1,63 @@
|
|||
= zilch-cli-ninja(1)
|
||||
Puck Meerburg
|
||||
v0.0.1
|
||||
:doctype: manpage
|
||||
:manmanual: ZILCH-CLI-NINJA
|
||||
:mansource: ZILCH
|
||||
:page-pagination: prev
|
||||
|
||||
== Name
|
||||
|
||||
zilch-cli-ninja - builds a Nixpkgs package using Ninja, using Zilch
|
||||
|
||||
== Synopsis
|
||||
|
||||
*zilch-cli-ninja* [_OPTION_]... _COMMAND_ [_ARG_]...
|
||||
|
||||
== Description
|
||||
|
||||
This command uses Zilch to build a Ninja-based project entirely within
|
||||
Nix, using content-addressed derivations.
|
||||
|
||||
This program requires the derivation to build has a configuration file
|
||||
written. See the documentation at https://puck.moe/zilch/docs/.
|
||||
|
||||
== Subcommands
|
||||
*build* [_TARGET_]...::
|
||||
Build the derivation described by the configuration file, or the
|
||||
target nammes from its Ninja file, if any are passed as arguments.
|
||||
|
||||
*source* [_DIR_]::
|
||||
Write the source of the derivation to _DIR_, or to `src` if no
|
||||
directory is provided.
|
||||
|
||||
*diff*::
|
||||
Compare the 'canonical' source of the derivation to that in the
|
||||
source directory (`src`, or the path selected by `--source`.)
|
||||
|
||||
== Options
|
||||
|
||||
*-h*::
|
||||
*--help*::
|
||||
Print a help message.
|
||||
|
||||
*-s* _DIR_::
|
||||
*--source* _DIR_::
|
||||
Override the input source for builds. Doesn't reconfigure the build,
|
||||
so changes to the build system do not apply.
|
||||
|
||||
*-f* _PATH_::
|
||||
*--config-file* _PATH_::
|
||||
The location of the configuration file. Defaults to `zilch.scm`.
|
||||
|
||||
*-j* _COUNT_::
|
||||
*--max-jobs* _COUNT_::
|
||||
The maximum amount of builds to run. Defaults to the amount of cores.
|
||||
|
||||
*-v*::
|
||||
*--verbose*::
|
||||
Increase the verbosity configured in the Nix daemon.
|
||||
|
||||
*-L*::
|
||||
*--print-build-logs*::
|
||||
Print derivation logs as they come in.
|
||||
Loading…
Add table
Add a link
Reference in a new issue