diff options
Diffstat (limited to 'nixpkgs/doc/functions/fhs-environments.xml')
| -rw-r--r-- | nixpkgs/doc/functions/fhs-environments.xml | 38 |
1 files changed, 9 insertions, 29 deletions
diff --git a/nixpkgs/doc/functions/fhs-environments.xml b/nixpkgs/doc/functions/fhs-environments.xml index 79682080be31..e7b81e97a23f 100644 --- a/nixpkgs/doc/functions/fhs-environments.xml +++ b/nixpkgs/doc/functions/fhs-environments.xml @@ -5,15 +5,7 @@ <title>buildFHSUserEnv</title> <para> - <function>buildFHSUserEnv</function> provides a way to build and run - FHS-compatible lightweight sandboxes. It creates an isolated root with bound - <filename>/nix/store</filename>, so its footprint in terms of disk space - needed is quite small. This allows one to run software which is hard or - unfeasible to patch for NixOS -- 3rd-party source trees with FHS assumptions, - games distributed as tarballs, software with integrity checking and/or - external self-updated binaries. It uses Linux namespaces feature to create - temporary lightweight environments which are destroyed after all child - processes exit, without root user rights requirement. Accepted arguments are: + <function>buildFHSUserEnv</function> provides a way to build and run FHS-compatible lightweight sandboxes. It creates an isolated root with bound <filename>/nix/store</filename>, so its footprint in terms of disk space needed is quite small. This allows one to run software which is hard or unfeasible to patch for NixOS -- 3rd-party source trees with FHS assumptions, games distributed as tarballs, software with integrity checking and/or external self-updated binaries. It uses Linux namespaces feature to create temporary lightweight environments which are destroyed after all child processes exit, without root user rights requirement. Accepted arguments are: </para> <variablelist> @@ -33,8 +25,7 @@ </term> <listitem> <para> - Packages to be installed for the main host's architecture (i.e. x86_64 on - x86_64 installations). Along with libraries binaries are also installed. + Packages to be installed for the main host's architecture (i.e. x86_64 on x86_64 installations). Along with libraries binaries are also installed. </para> </listitem> </varlistentry> @@ -44,9 +35,7 @@ </term> <listitem> <para> - Packages to be installed for all architectures supported by a host (i.e. - i686 and x86_64 on x86_64 installations). Only libraries are installed by - default. + Packages to be installed for all architectures supported by a host (i.e. i686 and x86_64 on x86_64 installations). Only libraries are installed by default. </para> </listitem> </varlistentry> @@ -66,8 +55,7 @@ </term> <listitem> <para> - Like <literal>extraBuildCommands</literal>, but executed only on multilib - architectures. + Like <literal>extraBuildCommands</literal>, but executed only on multilib architectures. </para> </listitem> </varlistentry> @@ -77,8 +65,7 @@ </term> <listitem> <para> - Additional derivation outputs to be linked for both target and - multi-architecture packages. + Additional derivation outputs to be linked for both target and multi-architecture packages. </para> </listitem> </varlistentry> @@ -88,8 +75,7 @@ </term> <listitem> <para> - Additional commands to be executed for finalizing the derivation with - runner script. + Additional commands to be executed for finalizing the derivation with runner script. </para> </listitem> </varlistentry> @@ -99,16 +85,14 @@ </term> <listitem> <para> - A command that would be executed inside the sandbox and passed all the - command line arguments. It defaults to <literal>bash</literal>. + A command that would be executed inside the sandbox and passed all the command line arguments. It defaults to <literal>bash</literal>. </para> </listitem> </varlistentry> </variablelist> <para> - One can create a simple environment using a <literal>shell.nix</literal> like - that: + One can create a simple environment using a <literal>shell.nix</literal> like that: </para> <programlisting><![CDATA[ @@ -133,10 +117,6 @@ ]]></programlisting> <para> - Running <literal>nix-shell</literal> would then drop you into a shell with - these libraries and binaries available. You can use this to run closed-source - applications which expect FHS structure without hassles: simply change - <literal>runScript</literal> to the application path, e.g. - <filename>./bin/start.sh</filename> -- relative paths are supported. + Running <literal>nix-shell</literal> would then drop you into a shell with these libraries and binaries available. You can use this to run closed-source applications which expect FHS structure without hassles: simply change <literal>runScript</literal> to the application path, e.g. <filename>./bin/start.sh</filename> -- relative paths are supported. </para> </section> |