Manpage source code cleanup
[pipeglade.git] / README
blob62be1b78622648a8c03a43e9bbdcbedcc87b925f
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 is required.
17   make
19 should build a usable binary.
21   make PREFIX=/some/dir/ install
23 installs the pipeglade binary in /some/dir/bin/ and its manual page in
24 /some/dir/man/man1/.  Default PREFIX is /usr/local/.
26 To get rid of the installation, call
28   make uninstall
32   make PREFIX=/some/dir/ uninstall
34 respectively.
37 TESTS AND FIRST STEPS
38 =====================
40   ./pipegladetest.sh
42 runs pipeglade's tests (which require some human assistance).  The
43 GtkBuilder file for the test GUI, pipeglade.ui, is also used in the
44 demonstration script
46   ./echo.sh,
48 which redirects the messages initiated by user activity on the GUI
49 back into a text area of the same GUI.  Another example,
51   ./clock.sh,
53 uses the GtkBuilder file clock.ui and displays an analog clock.
55 There are three other example GtkBuilder files.  To see how they look
56 like, call
58   ./pipeglade -u simple_dialog.ui
62   ./pipeglade -u simple_open.ui.
64 The third one, bad_window.ui, is for testing, and is intentionally
65 broken.
68 SUCCESSFUL BUILDS
69 =================
71 Debian wheezy, GTK+ 3.4.2
72 Debian Jessie, GTK+ 3.14.5
73 FreeBSD 10.1, GTK+ 3.14.5
74 FreeBSD 10.2, GTK+ 3.16.6