update
[shellsnippets/shellsnippets.git] / posix / cleanenv.1
1 .ds p. /bin:/usr/bin:/sbin:/usr/sbin:/usr/X11R6/bin
2 .Dd October 3, 2014
3 .Dt CLEANENV 1
4 .Os
5 .Sh NAME
6 .Nm cleanenv
7 .Nd run programs with cleaned-up environment
8 .Sh SYNOPSIS
9 .Nm
10 .Oo Fl \*(Ba
11 .Pa /
12 .Oc
13 .Op Ev Foo=bar ...
14 .Ic utility
15 .Op Ar ...
16 .Sh DESCRIPTION
17 The
18 .Nm
19 utility cleans the environment pointer, sets a few environment
20 variables as well as those passed, and runs the program passed.
21 With
22 .Pa /
23 as first option, it first changes to the root directory
24 .Pq Pa / ,
25 then operates the same as if
26 .Fl
27 were passed.
28 With
29 .Fl
30 set, it cleans even more, i.e. anonymises: only
31 .Ev HOME Ns = Ns Pa /
32 and
33 .Ev PATH Ns = Ns Pa \*(p.
34 are set then, whereas normal operation keeps the user's
35 .Ev HOME
36 and additionally passes through
37 .Ev LC_CTYPE ,
38 .Ev DISPLAY ,
39 .Ev TERM ,
40 .Ev USER
41 from the current environment; then,
42 .Ev HOME
43 defaults to
44 .Pa /
45 if not set in the current environment,
46 .Ev TERM
47 defaults to
48 .Ic vt100 ,
49 .Ev TZ
50 is forcibly set to
51 .Ic UTC ,
52 and the
53 .Xr locale 1
54 utility is used to determine the value of
55 .Ev LC_CTYPE
56 to set.
57 .Sh SEE ALSO
58 .Xr env 1
59 .Sh AUTHORS
60 .An Thorsten Glaser Aq tg@mirbsd.org