Improve and document previously undocumented ping command
[pipeglade.git] / www-template / index.html
blob1e40a0e934b1ce95913bbc8f8c1a586b33db84ef
1 <!DOCTYPE html>
2 <html lang="en">
3 <head>
4 <link rel="stylesheet" href="style.css" type="text/css" media="all">
5 <title>PIPEGLADE</title>
6 <meta name="author" content="Bert Burgemeister">
7 </head>
8 <body>
9 <div class="mandoc">
10 <div class="section">
11 <h1>PIPEGLADE<br />
12 Graphical User Interfaces, The UNIX Way</h1>
13 <p>
14 <div class="toc">
15 <!-- replace_with_toc -->
16 </div>
17 <p>
18 Pipeglade is a helper program that displays graphical user
19 interfaces for other programs. It renders the GUI definition
20 found in a GtkBuilder file (created using
21 the
22 <a class="link-ext" href="https://glade.gnome.org">Glade</a> Interface
23 Designer), and communicates with the main program solely
24 via pipes or fifos.
25 <p>
26 To have its GUI rendered by pipeglade, a program must be able to
27 <ul class="list list-dash">
28 <li class="list list-dash">
29 send plain text commands to standard output or a named
30 pipe and/or
31 <li class="list list-dash">
32 receive and parse simple plain text messages from standard
33 input or a named pipe.
34 </ul>
35 Pipeglade strives for simplicity; it provides access to a
36 subset of the features available in GTK+ v3.2.
37 <p>
38 See below for the set of widgets accessible via pipeglade.
39 (<a class="link-ext" href="https://developer.gnome.org/gtk3/stable/ch03.html">Widgets
40 of any kind</a> can grab focus and change visibility,
41 sensitivity, <a class="link-ext" href="https://developer.gnome.org/gtk3/stable/chap-css-properties.html">style</a>,
42 size, and tooltip.)
43 <p>
44 <div class="subsection">
45 <h2>DOCUMENTATION</h2>
46 Pipeglade has a manual page:
47 <a class="link-ext" href="pipeglade.1.html">pipeglade(1)[HTML]</a>,
48 <a class="link-ext" href="pipeglade.1.pdf">pipeglade(1)[PDF]</a>
49 </div>
50 <div class="subsection">
51 <h2>WIDGET GALLERY</h2>
52 <!-- replace_with_widget_gallery -->
53 </div>
54 <div class="subsection">
55 <h2>EXAMPLE</h2>
56 The shell script <a class="link-ext" href="clock.sh.txt">clock.sh</a> uses
57 pipeglade to display an analog clock on the interface
58 defined in the GtkBuilder
59 file <a class="link-ext" href="clock.ui.txt">clock.ui</a>. The script was
60 also used to generate the image below.
61 <p>
62 <img src="clock.jpg" width="200">
63 </div>
64 <div class="subsection">
65 <h2>SOURCE CODE</h2>
66 <ul class="list list-dash">
67 <li class="list list-dash">
68 Download pipeglade v_PUT_VERSION_HERE_:
69 <a class="link-ext" href="http://github.com/trebb/pipeglade/archive/_PUT_VERSION_HERE_.tar.gz">
70 pipeglade-_PUT_VERSION_HERE_.tar.gz</a>
71 <li class="list list-dash">
72 <a class="link-ext" href="http://github.com/trebb/pipeglade">GitHub</a>
73 </ul>
74 </div>
75 <div class="subsection">
76 <h2>LICENSE</h2>
77 <!-- replace_with_license_text -->
78 </div>
79 </div>
80 </div>
81 </body>
82 </html>