Minor manual page edit
[pipeglade.git] / README
blob66f62a39302f73f3bb36503216ad326b6d1b2be6
1 Graphical User Interfaces, The UNIX Way
2 =======================================
4 Pipeglade is a helper program that displays graphical user interfaces
5 for other programs. It renders the GUI definition found in a
6 GtkBuilder file (created using the Glade Interface Designer), and
7 communicates with the main program solely via pipes or fifos.
9 Visit http://pipeglade.boundp.org
12 INSTALLATION
13 ============
15 GTK+ v3.2 or newer and libxml2 are required.
17   make
19 should build a usable binary.
21   make prefix=/some/dir mandir=/another/dir install
23 installs the pipeglade binary in /some/dir/bin/ and its manual page in
24 /another/dir/man1/.  Default prefix is /usr/local/.  Default mandir is
25 $(prefix)/man.
27 To get rid of the installation, call
29   make uninstall
33   make prefix=/some/dir mandir=/another/dir uninstall
35 respectively.
38 TESTS AND FIRST STEPS
39 =====================
41   ./pipegladetest.sh
43 runs pipeglade's tests (which require some human assistance).  The
44 GtkBuilder file for the test GUI, pipeglade.ui, is also used in the
45 demonstration script
47   ./echo.sh,
49 which redirects the messages initiated by user activity on the GUI
50 back into a text area of the same GUI.  Another example,
52   ./clock.sh,
54 uses the GtkBuilder file clock.ui and displays an analog clock.
56 There are three other example GtkBuilder files.  To see how they look
57 like, call
59   ./pipeglade -u simple_dialog.ui
63   ./pipeglade -u simple_open.ui.
65 The third one, bad_window.ui, is for testing, and is intentionally
66 broken.
69 SUCCESSFUL BUILDS
70 =================
72 Debian wheezy, GTK+ 3.4.2
73 Debian Jessie, GTK+ 3.14.5
74 FreeBSD 10.1, GTK+ 3.14.5
75 FreeBSD 10.2, GTK+ 3.16.6
76 Arch Linux, GTK+ 3.18.5