File: phat-docs.sgml

package info (click to toggle)
phat 0.2.3-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 1,952 kB
  • ctags: 371
  • sloc: sh: 8,477; ansic: 3,234; makefile: 190
file content (100 lines) | stat: -rw-r--r-- 2,824 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
<!ENTITY PhatFanSlider SYSTEM "sgml/phatfanslider.sgml">
<!ENTITY PhatHFanSlider SYSTEM "sgml/phathfanslider.sgml">
<!ENTITY PhatVFanSlider SYSTEM "sgml/phatvfanslider.sgml">
<!ENTITY PhatSliderButton SYSTEM "sgml/phatsliderbutton.sgml">
]>

<book id="index">
  <bookinfo>
    <title>PHAT Reference Manual</title>
  </bookinfo>

  <part id="phat">
    <title>PHAT Overview</title>

    <partintro>

      <para>PHAT is a library of <ulink
      url="http://www.gtk.org">GTK+</ulink> widgets which are useful
      for pro-audio apps.  The name is a backronym which stands for
      "the PHat Audio Toolkit."</para>

    </partintro>

    <refentry id="install">
      <refnamediv>
	<refname>Installation</refname>
	<refpurpose>How to build and install PHAT on your system</refpurpose>
      </refnamediv>
      <refsect1>
	<title>Linux Systems</title>

	<para>If you're familiar with standard tarball compilation and
	installation procedures, then PHAT won't pose a problem for
	you.  If you're not used to the tarball dance, you'll still
	probably do just fine if you follow these instructions.</para>

	<para>Apart from having a generally sane Linux distribution
	and build environment, you need to have <ulink
	url="http://www.gtk.org">GTK+-2.0</ulink> or greater
	installed, along with it's development files.</para>

	<para>The magic incantantations to build and install PHAT are
	as follows:</para>

	<programlisting>
        tar -xzvpf phat.tar.gz
        cd phat.tar.gz
        ./configure
        make
        su
        &lt;enter root password&gt;
        make install
        /sbin/ldconfig
        </programlisting>

	<para>Replace "phat.tar.gz" above with the actual name of the
	package you downloaded and you should be golden.</para>

      </refsect1>

      <refsect1>
	<title>Other Systems</title> 

        <para>I don't see why PHAT should fail to build on other POSIX
	systems such as the BSDs, but I'm not supporting it either.
	If and when that "I" becomes a "we," that policy may
	change.</para>

	<para>If you're using Windows you're probably S.O.L., but that
	too could change in the future (see above).</para>

      </refsect1>
    </refentry>

    <refentry id="use">
      <refnamediv>
	<refname>Usage</refname> <refpurpose>How to compile programs
	which use PHAT</refpurpose>
      </refnamediv>
      <refsect1>
	<title>Compiling PHAT apps</title>

	<para>PHAT comes with a pkg-config .pc file, so using it is a
	snap. Run "man pkg-config" to learn how to make all your
	compilation dependcy woes disappear.</para>

      </refsect1>
    </refentry>
  </part>

  <part id="phatwidgets">
    <title>PHAT Widgets</title>
      &PhatFanSlider;
      &PhatHFanSlider;
      &PhatVFanSlider;
      &PhatSliderButton;
  </part>

</book>