merge Creative Commons™ licence deed plaintext files, by following method:
[shellsnippets/shellsnippets.git] / posix / cleanenv.1
1 .\" $Id: cleanenv.1 3351+X11R6 2012-12-17 14:16:11Z tglase $
2 .ds p. /bin:/usr/bin:/sbin:/usr/sbin:/usr/X11R6/bin
3 .Dd September 25, 2012
4 .Dt CLEANENV 1
5 .Os
6 .Sh NAME
7 .Nm cleanenv
8 .Nd run programs with cleaned-up environment
9 .Sh SYNOPSIS
10 .Nm
11 .Op Fl
12 .Op Ev Foo=bar ...
13 .Ic utility
14 .Op Ar ...
15 .Sh DESCRIPTION
16 The
17 .Nm
18 utility cleans the environment pointer, sets a few environment
19 variables as well as those passed, and runs the program passed.
20 With
21 .Fl
22 set, it cleans even more, i.e. anonymises: only
23 .Ev HOME Ns = Ns Pa /
24 and
25 .Ev PATH Ns = Ns Pa \*(p.
26 are set then, whereas normal operation keeps the user's
27 .Ev HOME
28 and additionally passes through
29 .Ev LC_CTYPE ,
30 .Ev DISPLAY ,
31 .Ev TERM ,
32 .Ev USER
33 from the current environment; then,
34 .Ev HOME
35 defaults to
36 .Pa /
37 if not set in the current environment,
38 .Ev TERM
39 defaults to
40 .Ic vt100 ,
41 and the
42 .Xr locale 1
43 utility is used to determine the value of
44 .Ev LC_CTYPE
45 to set.
46 .Sh SEE ALSO
47 .Xr env 1
48 .Sh AUTHORS
49 .An Thorsten Glaser Aq tg@mirbsd.org