xref: /netbsd-src/share/man/man3/paths.3 (revision 5b56473c8414d498c5a294a31434b6f3c5fbea57)
1.\" $NetBSD: paths.3,v 1.3 2011/04/08 08:12:51 jruoho Exp $
2.\"
3.\" Copyright (c) 2011 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Jukka Ruohonen.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.Dd April 8, 2011
31.Dt PATHS 3
32.Os
33.Sh NAME
34.Nm paths
35.Nd default system paths
36.Sh SYNOPSIS
37.In paths.h
38.Sh DESCRIPTION
39The
40.In paths.h
41header defines some default paths used in
42.Nx .
43All defined constants are prefixed with
44.Dv _PATH .
45The constants include:
46.Bl -bullet -offset indent
47.It
48The default user search path set by
49.Xr login 1
50and associated utilities such as
51.Xr rshd 8 .
52This is defined by
53.Dv _PATH_DEFPATH
54and includes directories such as
55.Pa /usr/bin
56and
57.Pa /usr/local/bin .
58.It
59Default paths for some utilities and device nodes.
60Examples include such paths as
61.Pa /dev/null
62.Pq Dv _PATH_DEVNULL ,
63.Pa /dev/mem
64.Pq Dv _PATH_MEM ,
65and
66.Pa /etc/nologin
67.Pq Dv _PATH_NOLOGIN ,
68among others.
69.It
70Paths for some default directories such as
71.Pa /dev
72.Pq Dv _PATH_DEV
73and
74.Pa /tmp
75.Pq Dv _PATH_TMP
76as well as paths for some miscellaneous utilities such as
77.Xr csh 1 ,
78.Pa /bin/csh
79.Pq Dv _PATH_CSHELL .
80.El
81.Sh SEE ALSO
82.Xr whereis 1 ,
83.Xr sysexits 3 ,
84.Xr types 3 ,
85.Xr hier 7
86.\"
87.\" XXX: Fill this.
88.\"
89.\" .Sh HISTORY
90.\" The
91.\" .In paths.h
92.\" header first appeared in
93.\" .Bx ????
94.Sh CAVEATS
95The
96.In paths.h
97header is specific to
98.Nx .
99