path: root/README
diff options
Diffstat (limited to 'README')
1 files changed, 84 insertions, 0 deletions
diff --git a/README b/README
index e69de29..6b86aea 100644
--- a/README
+++ b/README
@@ -0,0 +1,84 @@
+Copyright (C) 2009 Sergey Poznyakoff
+See the end of file for copying conditions.
+* Introduction
+This file contains brief information about configuring, testing
+and running Pies. It is *not* intended as a replacement
+for the documentation, it is provided as a brief reference only.
+The complete documentation for Pies is available in
+doc/ subdirectory. To read it without installing the package
+run `info -f doc/pies.info'. After the package is installed
+the documentation can be accessed running `info Pies'. Invoking
+`info pies' (with lower-case `p') will show you a concise
+description of the command line syntax (similar to a man-page style).
+* Overview
+Pies (pronounced ``p-yes'') stands for the Program Invocation and
+Execution Supervisor. This utility starts and controls execution of
+external programs, called ``components''. Each component is a stand-alone
+program, designed to be executed in the foreground. Upon startup pies
+reads the list of components from its configuration file, starts them,
+and remains in the background, controlling their execution. When a
+component terminates, pies tries to restarts it. Its configuration allows
+to specify actions other than simple restart, depending on the exit code
+of the component.
+Pies supports a wide variety of component types. For example, it can
+bind the standard input and output of a component to a network socket,
+which makes pies a replacement for the inetd utility. Pies implements
+powerful access control lists, which are especially useful with such
+inetd-style components.
+Pies can also be used to manage MeTA1 (http://meta1.org) components.
+Moreover, it is able to use MeTA1 configuration file directly, so that
+migration from the native mcp utility to pies does not require any
+Pies gives you complete control over the execution environment of
+each component. This includes modifying shell environment, running
+components with the given user privileges, etc. The standard error
+and/or output of any component may be redirected either to a disk
+file or to syslog.
+* Building
+A usual three-state procedure:
+ ./configure
+ make
+ make install
+See INSTALL for a generic options to ./configure.
+* Configuring and Running
+Please, see the Pies documentation.
+* Bug reporting.
+Send bug reports to <bug-pies@gnu.org.ua>.
+* Copyright information:
+Copyright (C) 2009 Sergey Poznyakoff
+ Permission is granted to anyone to make or distribute verbatim copies
+ of this document as received, in any medium, provided that the
+ copyright notice and this permission notice are preserved,
+ thus giving the recipient permission to redistribute in turn.
+ Permission is granted to distribute modified versions
+ of this document, or of portions of it,
+ under the above conditions, provided also that they
+ carry prominent notices stating who last changed them.
+Local Variables:
+mode: outline
+paragraph-separate: "[ ]*$"
+version-control: never

Return to:

Send suggestions and report system problems to the System administrator.