First commit

Signed-off-by: Mattias Andrée <m@maandree.se>

1 files changed, 197 insertions, 0 deletions

diff --git a/enum_libenv_class.3 b/enum_libenv_class.3
new file mode 100644
index 0000000..25edd60
--- /dev/null
+++ b/enum_libenv_class.3
@@ -0,0 +1,197 @@
+.TH ENUM_LIBENV_CLASS 3 libenv
+.SH NAME
+enum libenv_class - Environment variables classes
+
+.SH SYNOPSIS
+.nf
+#include <libenv.h>
+
+enum libenv_class {
+	LIBENV_END = 0,
+	/* ... members omitted, see listing below ...  */
+};
+.fi
+
+.SH DESCRIPTION
+The
+.B enum libenv_class
+contains one dummy value,
+.IR LIBENV_END ,
+used to mark the end of a class list for variadic functions.
+In addition to this dummy value, it also contains the following
+values used to describe a class of environment variables:
+.TP
+.B LIBENV_DISPLAY
+Environment variables necessary for the
+graphical environment.
+.TP
+.B LIBENV_DISPLAY_CONFIG
+Environment variables that configure
+the graphical environment.
+.TP
+.B LIBENV_DESKTOP
+Environment variables that describe
+the desktop environment.
+.TP
+.B LIBENV_TERMINAL_CAPS
+Environment variables that describe
+the terminals capabilities.
+.TP
+.B LIBENV_LOCAL_TERMINAL
+Environment variables that describe
+the terminals but is only meaningful
+for the local host.
+.TP
+.B LIBENV_LOCALE
+Environment variables that configure
+the locale.
+.TP
+.B LIBENV_TIMEZONE
+Environment variables that configure
+the timezone.
+.TP
+.B LIBENV_SESSION
+Environment variables that describe
+the current session.
+
+This for example includes variables
+added by
+.BR sshd (8)
+to describe the remote connection.
+
+This does not include display, desktop,
+or terminal information, nor does
+include information to identify the
+user.
+.TP
+.B LIBENV_THEME_CONFIG
+Environment variables that configure
+the user's theme.
+
+This is excludes variables listed for
+.I LIBENV_THEME_PLUGIN
+except in the
+hypothetical scenario where it names
+a plugin and additional configurations.
+.TP
+.B LIBENV_THEME_PLUGIN
+Environment variables that describe
+the plugins the user's theme requires.
+.TP
+.B LIBENV_INTERNET
+Environment variables that configures
+the user's internet configurations,
+including mainly proxies.
+.TP
+.B LIBENV_AUDIO
+Environment variables that configures
+the user's audio.
+.TP
+.B LIBENV_USER
+Environment variables that describe
+any information gathered about the
+user from
+.BR passwd (5)
+or login parameters.
+.TP
+.B LIBENV_APPLICATIONS
+Environment variables that default
+applications configured for the user.
+.TP
+.B LIBENV_PREFERENCES
+Environment variables that configure
+preferences, for the user, for various
+applications.
+.TP
+.B LIBENV_SYSTEM_PATHS
+Environment variables that list directories
+configured system wide (but could be
+overwritten for the user).
+
+Environment variables with this classification
+has at least also
+.IR LIBENV_PATH .
+.TP
+.B LIBENV_USER_PATHS
+Environment variables that list directories
+configured for the user.
+
+Environment variables with this classification
+has at least also
+.IR LIBENV_PATH .
+.TP
+.B LIBENV_PWD
+Environment variables that contain
+current and past working directories.
+
+Environment variables with this classification
+has at least also
+.IR LIBENV_PATH .
+.TP
+.B LIBENV_EXEC
+Environment variables that contain
+information about the executed utility.
+.TP
+.B LIBENV_PATH
+Environment variables that contain
+filesystem paths.
+
+Any environment variable with this
+classification has at least one other
+classification.
+.TP
+.B LIBENV_REMOTE_UNSAFE
+Environment variables that should be removed
+when entering a remote session.
+
+Any environment variable with this
+classification has at least one other
+classification.
+.TP
+.B LIBENV_REMOTE_SAFE
+Environment variables that should be can
+safely be kepted when entering a remote
+session.
+
+Any environment variable with this
+classification has at least one other
+classification.
+.TP
+.B LIBENV_LOGIN_UNSAFE
+Environment variables that should be removed
+when entering a logging into a new user.
+
+Any environment variable with this
+classification has at least one other
+classification.
+.TP
+.B LIBENV_LOGIN_SAFE
+Environment variables that should be can
+safely be kepted when entering a logging
+into a new user.
+
+Any environment variable with this
+classification has at least one other
+classification.
+.TP
+.B LIBENV_SU_UNSAFE
+Environment variables that should be removed
+when escalating privileges.
+
+Any environment variable with this
+classification has at least one other
+classification.
+.TP
+.B LIBENV_SU_SAFE
+Environment variables that should be can
+safely be kepted when escalating privileges.
+
+Any environment variable with this
+classification has at least one other
+classification.
+
+.SH SEE ALSO
+.BR libenv (7),
+.BR libenv_get_chosen_list (3),
+.BR libenv_filter_variable_list (3),
+.BR libenv_select_variable_list (3).