summaryrefslogtreecommitdiffstats
path: root/games/xroar/README_SBo.txt
diff options
context:
space:
mode:
Diffstat (limited to 'games/xroar/README_SBo.txt')
-rw-r--r--games/xroar/README_SBo.txt19
1 files changed, 15 insertions, 4 deletions
diff --git a/games/xroar/README_SBo.txt b/games/xroar/README_SBo.txt
index ec19bf5505..0f685f6196 100644
--- a/games/xroar/README_SBo.txt
+++ b/games/xroar/README_SBo.txt
@@ -1,20 +1,31 @@
+xroar supports multiple audio systems and has two user interfaces,
+gtk2 (using gtkglext) and sdl2 (very bare-bones; no menus). By
+default, both UIs are built, as is support for PulseAudio and plain
+ALSA audio. For most users, these defaults are just fine. If you have
+different needs, read on.
+
Optional Dependencies
=====================
-jack - if you want to use JACK for audio output, install jack and set
+jack - If you want to use JACK for audio output, install jack and set
JACK=yes in the environment before building xroar. If JACK audio has
x-runs, try 'setcap cap_ipc_lock,cap_sys_nice=ep /usr/games/xroar'.
+ If you don't know what jack is, or why you might want to use it, then
+ you don't want it.
Environment Variables
=====================
+JACK - see above. Default: no.
+
GTKGLEXT - If you have gtkglext installed, but don't want to build
- xroar with it, export GTKGLEXT=no [1] [2].
+ xroar with it, export GTKGLEXT=no [1] [2]. Default: yes.
SDL2 - If you don't want to build xroar with SDL2, export SDL2=no [2].
- This will remove the "-ui sdl" option, which is probably of no
- consequence since the SDL user interface isn't very featureful.
+ This will remove the "-ui sdl" option, which is probably
+ of no consequence since the SDL user interface isn't very
+ featureful. Default: yes.
OSS - use OSS for audio? Default is "no", export OSS="yes" to enable.
Most users won't need this.