Small fix in documentation regarding pkg-config argument specification for Jack API.

[rtaudio-cdist.git] / doc / doxygen / compiling.txt

diff --git a/doc/doxygen/compiling.txt b/doc/doxygen/compiling.txt
index d9884d009ea2ac32857e870976c79a53a0245d30..15f45b0a2b5efd9999d2acfb20729fac34d15685 100644 (file)
--- a/doc/doxygen/compiling.txt
+++ b/doc/doxygen/compiling.txt
@@ -32,7 +32,7 @@ In order to compile RtAudio for a specific OS and audio API, it is necessary to
   <TD>RtApiPulse</TD>
   <TD>__LINUX_PULSE__</TD>
   <TD><TT>pthread</TT></TD>
-  <TD><TT>g++ -Wall -D__LINUX_PULSE__ -o audioprobe audioprobe.cpp RtAudio.cpp -lpthread</TT></TD>
+  <TD><TT>g++ -Wall -D__LINUX_PULSE__ -o audioprobe audioprobe.cpp RtAudio.cpp -lpthread -lpulse-simple -lpulse</TT></TD>
 </TR>
 <TR>
   <TD>Linux</TD>
@@ -48,7 +48,7 @@ In order to compile RtAudio for a specific OS and audio API, it is necessary to
   <TD>RtApiJack</TD>
   <TD>__UNIX_JACK__</TD>
   <TD><TT>jack, pthread</TT></TD>
-  <TD><TT>g++ -Wall -D__UNIX_JACK__ -o audioprobe audioprobe.cpp RtAudio.cpp `pkg-config --cflags --libs jack` -lpthread</TT></TD>
+  <TD><TT>g++ -Wall -D__UNIX_JACK__ -o audioprobe audioprobe.cpp RtAudio.cpp $(pkg-config --cflags --libs jack) -lpthread</TT></TD>
 </TR>
 
 <TR>
@@ -65,7 +65,7 @@ In order to compile RtAudio for a specific OS and audio API, it is necessary to
   <TD>RtApiDs</TD>
   <TD>__WINDOWS_DS__</TD>
   <TD><TT>dsound.lib (ver. 5.0 or higher), multithreaded</TT></TD>
-  <TD><I>compiler specific</I></TD>
+  <TD>MinGW: <TT>g++ -Wall -D__WINDOWS_DS__ -o audioprobe audioprobe.cpp RtAudio.cpp -lole32 -lwinmm -ldsound</TT></TD>
 </TR>
 <TR>
   <TD>Windows</TD>
@@ -73,12 +73,20 @@ In order to compile RtAudio for a specific OS and audio API, it is necessary to
   <TD>RtApiAsio</TD>
   <TD>__WINDOWS_ASIO__</TD>
   <TD><I>various ASIO header and source files</I></TD>
-  <TD><I>compiler specific</I></TD>
+  <TD>MinGW: <TT>g++ -Wall -D__WINDOWS_ASIO__ -Iinclude -o audioprobe audioprobe.cpp RtAudio.cpp asio.cpp asiolist.cpp asiodrivers.cpp iasiothiscallresolver.cpp -lole32</TT></TD>
+</TR>
+<TR>
+  <TD>Windows</TD>
+  <TD>WASAPI</TD>
+  <TD>RtApiWasapi</TD>
+  <TD>__WINDOWS_WASAPI__</TD>
+  <TD>MinGW: <TT>FunctionDiscoveryKeys_devpkey.h, lksuser, luuid, lwinmm, lole32</TT></TD>
+  <TD>MinGW: <TT>g++ -Wall -D__WINDOWS_WASAPI__ -Iinclude -o audioprobe audioprobe.cpp RtAudio.cpp -lole32 -lwinmm -lksuser -luuid</TT></TD>
 </TR>
 </TABLE>
 <P>
 
-The example compiler statements above could be used to compile the <TT>audioprobe.cpp</TT> example file, assuming that <TT>audioprobe.cpp</TT>, <TT>RtAudio.h</TT>, <tt>RtError.h</tt>, and <TT>RtAudio.cpp</TT> all exist in the same directory.
+The example compiler statements above could be used to compile the <TT>audioprobe.cpp</TT> example file, assuming that <TT>audioprobe.cpp</TT>, <TT>RtAudio.h</TT>, <TT>RtAudio.cpp</TT> and any other necessary files all exist in the same directory or the include directory.
 
 
 */