From 21449c23cbbaadfcc0066d5dc320b4bd3f06bc14 Mon Sep 17 00:00:00 2001
From: Marti Serra <marti.serra.coscollano@gmail.com>
Date: Sun, 11 Dec 2016 12:47:48 +0100
Subject: [PATCH] steam: added java and steam-run to documentation, removed
 patchelf info

---
 doc/package-notes.xml | 28 ++++++++++++++++++++++++----
 1 file changed, 24 insertions(+), 4 deletions(-)

diff --git a/doc/package-notes.xml b/doc/package-notes.xml
index de148ec5739f..0a4c746c3715 100644
--- a/doc/package-notes.xml
+++ b/doc/package-notes.xml
@@ -418,7 +418,7 @@ it. Place the resulting <filename>package.nix</filename> file into
   chroot environment, as documented
   <link xlink:href="http://sandervanderburg.blogspot.nl/2013/09/composing-fhs-compatible-chroot.html">here</link>.
   This allows us to have binaries in the expected paths without disrupting the system,
-  and to avoid patching them.
+  and to avoid patching them to work in a non FHS environment.
 </para>
 
 </section>
@@ -464,7 +464,6 @@ it. Place the resulting <filename>package.nix</filename> file into
     or because they cannot be patched.The steps to launch a game 
     directly are: 
     <orderedlist>
-    <listitem><para>Patch the script/binary if you can.</para></listitem>
     <listitem><para>Add a file named <filename>steam_appid.txt</filename> in 
     the binary folder, with the appid as contents (it can be found in the 
     stdout from steam).</para></listitem>
@@ -501,14 +500,18 @@ libGL error: failed to load driver: swrast</programlisting></para></listitem>
   <programlisting>steam.sh: line 713: 7842 Segmentation fault (core dumped)</programlisting>
   have a look at <link xlink:href="https://github.com/NixOS/nixpkgs/pull/20269">this pull request</link>.
   </para></listitem>
+
   </itemizedlist></listitem></varlistentry>
 
   <varlistentry>
-  <term>Known issues</term>
+  <term>Java</term>
   <listitem><orderedlist>
   <listitem><para>
-  No java in steam chrootenv. Games affected: Towns:
+  There is no java in steam chrootenv by default. If you get a message like
   <programlisting>/home/foo/.local/share/Steam/SteamApps/common/towns/towns.sh: line 1: java: command not found</programlisting>
+  You need to add  
+  <programlisting> steam.override { withJava = true; };</programlisting>
+  to your configuration.
   </para></listitem>
   </orderedlist></listitem></varlistentry>
 
@@ -517,6 +520,23 @@ libGL error: failed to load driver: swrast</programlisting></para></listitem>
 
 </section>
 
+<section xml:id="sec-steam-run">
+
+<title>steam-run</title>
+<para>
+The FHS-compatible chroot used for steam can also be used to run 
+other linux games that expect a FHS environment.
+To do it, add 
+<programlisting>pkgs.(steam.override {
+          nativeOnly = true;
+          newStdcpp = true;
+        }).run</programlisting>
+to your configuration, rebuild, and run the game with 
+<programlisting>steam-run ./foo</programlisting>
+</para>
+
+</section>
+
 </section>
 
 </chapter>