www-template/index.html

   1 <!DOCTYPE html>
   2 <html>
   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         Pipeglade is a helper program that displays graphical user
  15         interfaces for other programs.  It renders the GUI definition
  16         found in a GtkBuilder file (created using
  17         the
  18         <a href="http://glade.gnome.org">Glade</a> Interface
  19         Designer), and communicates with the main program solely
  20         via pipes or fifos.
  21       <p>
  22         To have its GUI rendered by pipeglade, a program must be able to
  23         <ul class="list list-dash">
  24           <li class="list list-dash">
  25             send  plain text commands to standard output or a named
  26             pipe and/or
  27           <li class="list list-dash">
  28             receive and parse simple plain text messages from standard
  29             input or a named pipe.
  30         </ul>
  31         Pipeglade strives for simplicity; it provides access to a
  32         subset of the features available in GTK+ v3.2.  Widgets able to
  33         communicate via pipeglade include
  34         <ul class="list list-dash">
  35           <li class="list list-dash">
  36             layout
  37             <a href="https://developer.gnome.org/gtk3/stable/GtkWindow.html">containers</a>:
  38             <a href="https://developer.gnome.org/gtk3/stable/GtkNotebook.html">notebook</a>,
  39             <a href="https://developer.gnome.org/gtk3/stable/GtkExpander.html">expander</a>,
  40             <a href="https://developer.gnome.org/gtk3/stable/GtkFrame.html">frame</a>,
  41             <a href="https://developer.gnome.org/gtk3/stable/GtkScrolledWindow.html">scrolled window</a>;
  42           <li class="list list-dash">
  43             <a href="https://developer.gnome.org/gtk3/stable/GtkButton.html">buttons</a>:
  44             <a href="https://developer.gnome.org/gtk3/stable/GtkCheckButton.html">check
  45               button</a>,
  46             <a href="https://developer.gnome.org/gtk3/stable/GtkToggleButton.html">toggle
  47               button</a>,
  48             <a href="https://developer.gnome.org/gtk3/stable/GtkRadioButton.html">radio
  49               button</a>,
  50             <a href="https://developer.gnome.org/gtk3/stable/GtkSwitch.html">switch</a>;
  51           <li class="list list-dash">
  52             <a href="https://developer.gnome.org/gtk3/stable/GtkSpinButton.html">spin
  53             buttons</a>
  54             and <a href="https://developer.gnome.org/gtk3/stable/GtkScale.html">scales/sliders</a>;
  55           <li class="list list-dash">
  56             text <a href="https://developer.gnome.org/gtk3/stable/GtkLabel.html">labels</a>
  57             and <a href="https://developer.gnome.org/gtk3/stable/GtkImage.html">images</a>;
  58           <li class="list list-dash">
  59             <a href="https://developer.gnome.org/gtk3/stable/GtkTextView.html">text</a>
  60             and <a href="https://developer.gnome.org/gtk3/stable/GtkTreeView.html">tabular</a>
  61             <a href="https://developer.gnome.org/gtk3/stable/GtkEntry.html">inputs</a>;
  62           <li class="list list-dash">
  63             <a href="https://developer.gnome.org/gtk3/stable/GtkComboBoxText.html">combo
  64             boxes</a>
  65             and <a href="https://developer.gnome.org/gtk3/stable/GtkMenuBar.html">menus</a>;
  66           <li class="list list-dash">
  67             various <a href="https://developer.gnome.org/gtk3/stable/GtkDialog.html">dialog</a>
  68             windows: <a href="https://developer.gnome.org/gtk3/stable/GtkFileChooserButton.html">file</a>
  69             <a href="https://developer.gnome.org/gtk3/stable/GtkFileChooserDialog.html">choosers</a>,
  70             <a href="https://developer.gnome.org/gtk3/stable/GtkPrintUnixDialog.html">print
  71             dialog</a>, <a href="https://developer.gnome.org/gtk3/stable/GtkColorButton.html">color
  72             button</a>, <a href="https://developer.gnome.org/gtk3/stable/GtkFontButton.html">font
  73             button</a>,
  74           <li class="list list-dash">
  75             <a href="https://developer.gnome.org/gtk3/stable/GtkCalendar.html">calendars</a>;
  76           <li class="list list-dash">
  77             <a href="https://developer.gnome.org/gtk3/stable/GtkDrawingArea.html">drawing
  78             areas</a> (see example below);
  79           <li class="list list-dash">
  80             <a href="https://developer.gnome.org/gtk3/stable/GtkStatusbar.html">statusbars</a>
  81             and <a href="https://developer.gnome.org/gtk3/stable/GtkProgressBar.html">progress</a>
  82             <a href="https://developer.gnome.org/gtk3/stable/GtkSpinner.html">indicators</a>;
  83           <li class="list list-dash">
  84             <a href="https://developer.gnome.org/gtk3/stable/GtkSocket.html">XEmbed
  85             sockets</a> displaying other processes (Pipeglade can
  86             also embed itself into an XEmbed socket of another process.)
  87         </ul>
  88         Any <a href="https://developer.gnome.org/gtk3/stable/ch03.html">other</a>
  89         widgets can change visibility, sensitivity, style, and size.
  90       <p>
  91         <div class="subsection">
  92           <h2>DOCUMENTATION</h2>
  93           Pipeglade has a manual page:
  94           <a href="pipeglade.1.html">pipeglade(1)[HTML]</a>,
  95           <a href="pipeglade.1.pdf">pipeglade(1)[PDF]</a>
  96         </div>
  97         <div class="subsection">
  98           <h2>SOURCE CODE</h2>
  99           <ul class="list list-dash">
 100             <li class="list list-dash">
 101               Download pipeglade v_PUT_VERSION_HERE_:
 102               <a href="http://github.com/trebb/pipeglade/archive/_PUT_VERSION_HERE_.tar.gz">
 103                 pipeglade-_PUT_VERSION_HERE_.tar.gz</a>
 104             <li class="list list-dash">
 105               <a href="http://github.com/trebb/pipeglade">GitHub</a>
 106           </ul>
 107         </div>
 108         <div class="subsection">
 109           <h2>EXAMPLE</h2>
 110           The shell script <a href="clock.sh.txt">clock.sh</a> uses
 111           pipeglade to display an analog clock on the interface
 112           defined in the GtkBuilder
 113           file <a href="clock.ui.txt">clock.ui</a>.
 114           <p>
 115           <img src="clock.png" width="300">
 116         </div>
 117         <div class="subsection">
 118           <h2>LICENSE</h2>
 119           <!-- replace_with_license_text -->
 120         </div>
 121     </div>
 122   </div>
 123 </body>
 124 </html>