summaryrefslogtreecommitdiffabout
path: root/README
authorSergey Poznyakoff <gray@gnu.org>2017-12-01 06:46:15 (GMT)
committer Sergey Poznyakoff <gray@gnu.org>2017-12-01 06:47:56 (GMT)
commit048800a78f64808116bb9b943837062a67f586ae (patch) (side-by-side diff)
treeec97848673a9ebfe6cb5fe8c7ef4e96d943db004 /README
parent0145de1db25c3840346b9cd9ea44e571812e5516 (diff)
downloadruncap-048800a78f64808116bb9b943837062a67f586ae.tar.gz
runcap-048800a78f64808116bb9b943837062a67f586ae.tar.bz2
Bugfixes
* runcap.3: Update docs. * runcap.c (stream_capture_get,stream_capture_put) (runcap_loop): Handle EINTR. * README: New file.
Diffstat (limited to 'README') (more/less context) (ignore whitespace changes)
-rw-r--r--README68
1 files changed, 68 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..91f5b16
--- a/dev/null
+++ b/README
@@ -0,0 +1,68 @@
+#+TITLE: runcap
+
+* Overview
+
+The function *runcap* runs an external command, and waits for its
+termination, optionally capturing its standard output and standard
+error streams, and piping data to its standard input.
+
+* Building as a standalone library
+
+The following steps will build the project as a standalone installable
+library:
+
+1. Configure the package
+ #+BEGIN_SRC shell-script
+ ./configure
+ #+END_SRC
+2. Build the project.
+ #+BEGIN_SRC shell-script
+ make
+ #+END_SRC
+3. Install the files (normally run as root).
+ #+BEGIN_SRC shell-script
+ make install
+ #+END_SRC
+
+ This will install the files *libruncap.so* and *libruncap.a* to the
+ system library directory, and the header file *runcap.h* to the
+ system include directory.
+
+* Incorporating as a submodule
+
+To incorporate *runcap* as a submodule to your project, follow these
+steps:
+
+1. Change to your project's toplevel directory.
+2. Clone the project.
+ #+BEGIN_SRC shell-script
+ git submodule add git://git.gnu.org.ua/runcap.git
+ git submodule init
+ #+END_SRC
+3. Add it to *git* index:
+ #+BEGIN_SRC shell-script
+ git add runcap
+ #+END_SRC
+4. Add it to your toplevel *Makefile.am*.
+ #+BEGIN_SRC make
+ ACLOCAL_AMFLAGS = -I grecs/am
+
+ SUBDIRS = runcap
+ #+END_SRC
+5. Edit your *configure.ac*
+ #+BEGIN_SRC automake
+ RUNCAP_SETUP
+ #+END_SRC
+6.
+ #+BEGIN_SRC make
+ AM_CPPFLAGS = @RUNCAP_INC@
+ AM_LDADD = @RUNCAP_LDADD@
+ #+END_SRC
+
+
+# Local Variables:
+# mode: org
+# paragraph-separate: "[ ^L]*$"
+# version-control: never
+# End:
+

Return to:

Send suggestions and report system problems to the System administrator.