summaryrefslogtreecommitdiffstats
path: root/share/man/man7/environ.7
diff options
context:
space:
mode:
authoraaron <aaron@openbsd.org>1998-11-28 03:38:01 +0000
committeraaron <aaron@openbsd.org>1998-11-28 03:38:01 +0000
commit230f84bae9cb430380b72311124b45e167697abc (patch)
tree2052f63dffddd6e75744884518d4cc534e540c40 /share/man/man7/environ.7
parentstart killing redundant .Nm macro arguments (mandoc ``remembers'' the first one (diff)
downloadwireguard-openbsd-230f84bae9cb430380b72311124b45e167697abc.tar.xz
wireguard-openbsd-230f84bae9cb430380b72311124b45e167697abc.zip
share/man/man7/ man page repairs
Diffstat (limited to 'share/man/man7/environ.7')
-rw-r--r--share/man/man7/environ.793
1 files changed, 55 insertions, 38 deletions
diff --git a/share/man/man7/environ.7 b/share/man/man7/environ.7
index 38cae40a7ee..97d12602b24 100644
--- a/share/man/man7/environ.7
+++ b/share/man/man7/environ.7
@@ -1,3 +1,4 @@
+.\" $OpenBSD: environ.7,v 1.4 1998/11/28 03:38:01 aaron Exp $
.\" $NetBSD: environ.7,v 1.4 1995/07/03 19:45:07 jtc Exp $
.\"
.\" Copyright (c) 1983, 1990, 1993
@@ -43,11 +44,11 @@
.Ar extern char **environ ;
.Sh DESCRIPTION
An array of strings called the
-.Ar environment
+.Dq environment
is made available by
-.Xr execve 2
+.Xr execve 2
when a process begins. By convention these strings have the form
-.Dq Ar name=value .
+.Dq Ar name Ns No = Ns Ar value .
The following names are used by various commands:
.Bl -tag -width BLOCKSIZE
.It Ev BLOCKSIZE
@@ -56,44 +57,58 @@ The size of the block units used by several commands, most notably
.Xr du 1
and
.Xr ls 1 .
-BLOCKSIZE may be specified in units of a byte by specifying a number,
-in units of a kilobyte by specifying a number followed by ``K'' or
-``k'', in units of a megabyte by specifying a number followed by ``M''
-or ``m'' and in units of a gigabyte by specifying a number followed
-by ``G'' or ``g''.
+.Ev BLOCKSIZE
+may be specified in units of a byte by specifying a number,
+in units of a kilobyte by specifying a number followed by
+.Dq K
+or
+.Dq k ,
+in units of a megabyte by specifying a number followed by
+.Dq M
+or
+.Dq m
+and in units of a gigabyte by specifying a number followed
+by
+.Dq G
+or
+.Dq g .
Sizes less than 512 bytes or greater than a gigabyte are ignored.
.It Ev EXINIT
A startup list of commands read by
-.Xr ex 1 ,
-.Xr edit 1 ,
+.Xr ex 1 ,
+.Xr edit 1 ,
and
-.Xr vi 1 .
+.Xr vi 1 .
.It Ev HOME
A user's login directory, set by
-.Xr login 1
+.Xr login 1
from the password file
-.Xr passwd 5 .
+.Xr passwd 5 .
.It Ev PATH
The sequence of directories, separated by colons, searched by
-.Xr csh 1 ,
-.Xr sh 1 ,
-.Xr system 3 ,
-.Xr execvp 3 ,
-etc, when looking for an executable file.
-PATH is set to ``/usr/bin:/bin'' initially by
-.Xr login 1 .
+.Xr csh 1 ,
+.Xr sh 1 ,
+.Xr system 3 ,
+.Xr execvp 3 ,
+etc. when looking for an executable file.
+Initially,
+.Ev PATH
+is set to
+.Dq /usr/bin:/bin
+by
+.Xr login 1 .
.It Ev PRINTER
The name of the default printer to be used by
-.Xr lpr 1 ,
-.Xr lpq 1 ,
+.Xr lpq 1 ,
+.Xr lpr 1 ,
and
-.Xr lprm 1 .
+.Xr lprm 1 .
.It Ev SHELL
The full pathname of the user's login shell.
.It Ev TERM
The kind of terminal for which output is to be prepared.
-This information is used by commands, such as
-.Xr nroff 1
+This information is used by commands such as
+.Xr nroff 1
or
.Xr plot 1
which may exploit special terminal capabilities. See
@@ -102,13 +117,15 @@ which may exploit special terminal capabilities. See
for a list of terminal types.
.It Ev TERMCAP
The string describing the terminal in TERM, or, if
-it begins with a '/', the name of the termcap file.
+it begins with a
+.Dq / ,
+the name of the termcap file.
See
.Ev TERMPATH
below,
-.Xr termcap 5 ,
+.Xr termcap 5 ,
and
-.Xr termcap .
+.Xr termcap .
.It Ev TERMPATH
A sequence of pathnames of termcap files, separated by colons or spaces,
which are searched for terminal descriptions in the order listed. Having
@@ -117,7 +134,7 @@ no
is equivalent to a
.Ev TERMPATH
of
-.Dq Pa $HOME/.termcap:/etc/termcap .
+.Dq $HOME/.termcap:/etc/termcap .
.Ev TERMPATH
is ignored if
.Ev TERMCAP
@@ -125,16 +142,16 @@ contains a full pathname.
.It Ev TMPDIR
The directory in which to store temporary files.
Most applications use either
-.Dq /tmp
+.Pa /tmp
or
-.Dq /var/tmp .
+.Pa /var/tmp .
Setting this variable will make them use another directory.
.It Ev TZ
The timezone to use when displaying dates.
The normal format is a pathname relative to
-.Dq /usr/share/zoneinfo .
+.Pa /usr/share/zoneinfo .
For example, the command
-.Dq env TZ=US/Pacific date
+.Ic env TZ=US/Pacific date
displays the current time in California.
See
.Xr tzset 3
@@ -150,15 +167,15 @@ Deprecated synonym of
Further names may be placed in the environment by the
.Xr export
command and
-.Ar name=value
+.Ar name Ns No = Ns Ar value
arguments in
-.Xr sh 1 ,
+.Xr sh 1 ,
or by the
.Xr setenv
command if you use
-.Xr csh 1 .
+.Xr csh 1 .
It is unwise to change certain
-.Xr sh 1
+.Xr sh 1
variables that are frequently exported by
.Pa .profile
files, such as
@@ -180,6 +197,6 @@ unless you know what you are doing.
.Xr termcap 5
.Sh HISTORY
The
-.Nm environ
+.Nm
manual page appeared in
.Bx 4.2 .