xref: /netbsd-src/share/man/man3/paths.3 (revision 5b56473c8414d498c5a294a31434b6f3c5fbea57)
1*5b56473cSjruoho.\" $NetBSD: paths.3,v 1.3 2011/04/08 08:12:51 jruoho Exp $
22fefc936Sjruoho.\"
32fefc936Sjruoho.\" Copyright (c) 2011 The NetBSD Foundation, Inc.
42fefc936Sjruoho.\" All rights reserved.
52fefc936Sjruoho.\"
62fefc936Sjruoho.\" This code is derived from software contributed to The NetBSD Foundation
72fefc936Sjruoho.\" by Jukka Ruohonen.
82fefc936Sjruoho.\"
92fefc936Sjruoho.\" Redistribution and use in source and binary forms, with or without
102fefc936Sjruoho.\" modification, are permitted provided that the following conditions
112fefc936Sjruoho.\" are met:
122fefc936Sjruoho.\" 1. Redistributions of source code must retain the above copyright
132fefc936Sjruoho.\"    notice, this list of conditions and the following disclaimer.
142fefc936Sjruoho.\" 2. Redistributions in binary form must reproduce the above copyright
152fefc936Sjruoho.\"    notice, this list of conditions and the following disclaimer in the
162fefc936Sjruoho.\"    documentation and/or other materials provided with the distribution.
172fefc936Sjruoho.\"
182fefc936Sjruoho.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
192fefc936Sjruoho.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
202fefc936Sjruoho.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
212fefc936Sjruoho.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
222fefc936Sjruoho.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
232fefc936Sjruoho.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
242fefc936Sjruoho.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
252fefc936Sjruoho.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
262fefc936Sjruoho.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
272fefc936Sjruoho.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
282fefc936Sjruoho.\" POSSIBILITY OF SUCH DAMAGE.
292fefc936Sjruoho.\"
30*5b56473cSjruoho.Dd April 8, 2011
312fefc936Sjruoho.Dt PATHS 3
32fb7cdbe0Snjoly.Os
332fefc936Sjruoho.Sh NAME
342fefc936Sjruoho.Nm paths
352fefc936Sjruoho.Nd default system paths
362fefc936Sjruoho.Sh SYNOPSIS
372fefc936Sjruoho.In paths.h
382fefc936Sjruoho.Sh DESCRIPTION
392fefc936SjruohoThe
402fefc936Sjruoho.In paths.h
412fefc936Sjruohoheader defines some default paths used in
422fefc936Sjruoho.Nx .
432fefc936SjruohoAll defined constants are prefixed with
442fefc936Sjruoho.Dv _PATH .
452fefc936SjruohoThe constants include:
46*5b56473cSjruoho.Bl -bullet -offset indent
472fefc936Sjruoho.It
482fefc936SjruohoThe default user search path set by
492fefc936Sjruoho.Xr login 1
502fefc936Sjruohoand associated utilities such as
512fefc936Sjruoho.Xr rshd 8 .
522fefc936SjruohoThis is defined by
532fefc936Sjruoho.Dv _PATH_DEFPATH
542fefc936Sjruohoand includes directories such as
552fefc936Sjruoho.Pa /usr/bin
562fefc936Sjruohoand
572fefc936Sjruoho.Pa /usr/local/bin .
582fefc936Sjruoho.It
592fefc936SjruohoDefault paths for some utilities and device nodes.
602fefc936SjruohoExamples include such paths as
612fefc936Sjruoho.Pa /dev/null
622fefc936Sjruoho.Pq Dv _PATH_DEVNULL ,
632fefc936Sjruoho.Pa /dev/mem
642fefc936Sjruoho.Pq Dv _PATH_MEM ,
652fefc936Sjruohoand
662fefc936Sjruoho.Pa /etc/nologin
672fefc936Sjruoho.Pq Dv _PATH_NOLOGIN ,
682fefc936Sjruohoamong others.
692fefc936Sjruoho.It
702fefc936SjruohoPaths for some default directories such as
712fefc936Sjruoho.Pa /dev
722fefc936Sjruoho.Pq Dv _PATH_DEV
732fefc936Sjruohoand
742fefc936Sjruoho.Pa /tmp
752fefc936Sjruoho.Pq Dv _PATH_TMP
762fefc936Sjruohoas well as paths for some miscellaneous utilities such as
772fefc936Sjruoho.Xr csh 1 ,
782fefc936Sjruoho.Pa /bin/csh
792fefc936Sjruoho.Pq Dv _PATH_CSHELL .
802fefc936Sjruoho.El
812fefc936Sjruoho.Sh SEE ALSO
822fefc936Sjruoho.Xr whereis 1 ,
832fefc936Sjruoho.Xr sysexits 3 ,
842fefc936Sjruoho.Xr types 3 ,
852fefc936Sjruoho.Xr hier 7
862fefc936Sjruoho.\"
872fefc936Sjruoho.\" XXX: Fill this.
882fefc936Sjruoho.\"
892fefc936Sjruoho.\" .Sh HISTORY
902fefc936Sjruoho.\" The
912fefc936Sjruoho.\" .In paths.h
922fefc936Sjruoho.\" header first appeared in
932fefc936Sjruoho.\" .Bx ????
942fefc936Sjruoho.Sh CAVEATS
952fefc936SjruohoThe
962fefc936Sjruoho.In paths.h
972fefc936Sjruohoheader is specific to
982fefc936Sjruoho.Nx .
99