aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README25
1 files changed, 25 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..109984f
--- /dev/null
+++ b/README
@@ -0,0 +1,25 @@
+NAME
+ libenv - Environment sanitation library
+
+SYNOPSIS
+ #include <libenv.h>
+
+ Link with -lenv.
+
+DESCRIPTION
+ The libenv software library is C library designed to help
+ utilities perform sanitation of environment variables.
+
+ Some utilities need to remove environment variables that are
+ not appropriate for the new context that the utility entires.
+ Likewise some utilities may meed to remove all except some
+ special environment variables. libenv provides a database of
+ environment variable variables that could be interesting and
+ provides functionality to describe the new context the is is
+ entered and filter out environment variables accordingly.
+
+SEE ALSO
+ libenv_filter_variable_list(3),
+ libenv_select_variable_list(3),
+ libenv_get_chosen_list(3),
+ libenv_get_complete_list(3)