nix-on-droid/docs/manual.xml
Sergey Volkov 4d20bfc846 update inputs and copyrights to 24.05
Co-authored-by: Alexander Sosedkin <monk@unboiled.info>
2024-07-08 01:14:32 +02:00

59 lines
1.6 KiB
XML

<!-- Copyright (c) 2019-2024, see AUTHORS. Licensed under MIT License, see LICENSE. -->
<book xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
version="5.0"
xml:id="book-manual">
<info>
<title>Nix-on-Droid manual</title>
</info>
<preface>
<title>Preface</title>
<para>
Some basic documentation of Nix-on-Droid.
</para>
<para>
If you encounter problems or bugs then please report them on the
<link xlink:href="https://github.com/nix-community/nix-on-droid/issues">issue tracker</link>.
</para>
</preface>
<appendix xml:id="ch-options">
<title>nix-on-droid configuration options</title>
<section xml:id="sec-usage">
<title>Usage</title>
<para>
To use these options, edit the config file in
<filename>~/.config/nixpkgs/nix-on-droid.nix</filename> or in case of a flake setup,
set the <replaceable>modules</replaceable> value in the <varname>nixOnDroidConfiguration</varname>
call:
<programlisting language="nix">
{
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixos-24.05";
nix-on-droid = {
url = "github:nix-community/nix-on-droid/release-24.05";
inputs.nixpkgs.follows = "nixpkgs";
};
};
outputs = { self, nixpkgs, nix-on-droid }: {
nixOnDroidConfigurations.deviceName = nix-on-droid.lib.nixOnDroidConfiguration {
<replaceable>modules</replaceable> = [ ./nix-on-droid.nix ];
};
};
}
</programlisting>
</para>
</section>
<section xml:id="sec-options">
<title>Options</title>
<xi:include href="./nmd-result/nix-on-droid-options.xml" />
</section>
</appendix>
</book>