From 3b30ce60e09ad1c1042999219f537ac324c55931 Mon Sep 17 00:00:00 2001 From: Alexander Koenig Date: Fri, 17 Jun 2016 00:03:37 +0200 Subject: [PATCH] Manual updates. --- help/C/terminatorX-manual.xml | 96 +++++++++++++++++++++-------------- 1 file changed, 58 insertions(+), 38 deletions(-) diff --git a/help/C/terminatorX-manual.xml b/help/C/terminatorX-manual.xml index 0754dda..3dd5e0f 100644 --- a/help/C/terminatorX-manual.xml +++ b/help/C/terminatorX-manual.xml @@ -1,7 +1,7 @@ - + + ]>
@@ -14,8 +14,19 @@ AlexanderKönig - 199920002001200220032004200520062014 - Alexander König + + 1999 + 2000 + 2001 + 2002 + 2003 + 2004 + 2005 + 2006 + 2014 + 2016 + Alexander König + terminatorX Manual &version; @@ -337,32 +348,17 @@ - Linux, FreeBSD or the like + a reasonable up-to-date Linux, reported to run on FreeBSD,too - glibc2 (pthreads). - - - - - - XFree86 (with DGA DirectMouse support). Note - that XFree86 Release 4.0 has a bug resulting in - broken DirectMouse support. This has been fixed by - the XFree86-Team with Release 4.0.1 available from - your distribution or the - XFree86 - homepage. - - - The Gimp Toolkit: gtk+ (>= 2.0). If your - distribution doesn't provide a current version of + The Gimp Toolkit: gtk+ (>= 3.0). If your + distribution doesn't provide a current version (which is unlikely) of gtk+ get it from the gtk+ homepage. @@ -379,7 +375,7 @@ - a compiler (gcc) + a C/C++ compiler (gcc) @@ -500,16 +496,19 @@ - An - ALSA or OSS compatible soundcard capable of - stereo output. - + An audiodevice capable of low-latency stereo playback and compatible with either + + ALSA, + OSS, + JACK or + PulseAudio + + - A good clean mouse and pad, a good X-Pointer - setup. + A good clean mouse and pad. @@ -520,9 +519,9 @@ A note on performance: terminatorX is known to run - satisfyingly on pentium-class systems (or above of course). + satisfyingly even on low-end systems. Increasing the number of turntables or plugins will of course - require more performant systems. + require may require more performant hardware. @@ -2135,12 +2134,13 @@ <emphasis>Audio</emphasis> Tab This tab allows to select which audio backend terminatorX - should use. Currently there are three options: the OSS (Open + should use and to set the parameters foor the different backebds. + Currently there are fouroptions: the OSS (Open Sound System) backend, the ALSA (Advanced Linux Sound - Architecture) backend and the JACK (JACK Audio Connection Kit) - backend. Some of these options might not be available, if your - terminatorX binary wasn't compiled to support a certain - backend. + Architecture) backend, the JACK (JACK Audio Connection Kit) + backend and the PulseAudio backend. Some of these options might not + be available, if your terminatorX binary wasn't compiled to support + a certain backend. The OSS and ALSA backends have dedicated configuration tabs, JACK requires no further configuration - for more details @@ -2150,7 +2150,7 @@ - <emphasis>Audio: OSS</emphasis> Tab + <emphasis>Audio</emphasis> Tab - OSS parameters Select the audio device you are going to use from the available options (or simply enter one yourself). terminatorX @@ -2183,7 +2183,7 @@ - <emphasis>Audio: ALSA</emphasis> Tab + <emphasis>Audio</emphasis> Tab - ALSA parameters Using ALSA for audio output allows specifing the buffer sizes in microseconds. ALSA uses a ring-buffer to process audio. @@ -2202,6 +2202,26 @@ + + <emphasis>Audio</emphasis> Tab - PulseAudio parameters + + The PulseAudio backend currently provides only a single + configuration option: PulseAudio Buffer. This + parameter defines the buffer size in samples that terminatorX + requests when connecting to the PulseAudio daemon. Note that + PulseAudio may override this value, you can run pulseaudio manually + (pulseaudio -v) to trace what latency PulseAudio will actually + achieve. + + + The buffer size is configured in samples (the size in bytes will + samples * 4), for optimal latency this value should be as low + as possible. If you experience underruns or other artifacts in + the audio output try increasing the buffer size. + + + + <emphasis>Input</emphasis> Tab -- 2.25.4