xref: /netbsd-src/share/man/man1/cd.1 (revision 30c555fd2c0c0381b0961d52c6e0419c5f61b510)
1.\"	$NetBSD: cd.1,v 1.10 2019/08/31 21:35:50 uwe Exp $
2.\"
3.\" Copyright (c) 1980, 1990, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" This code is derived from software contributed to Berkeley by
7.\" the Institute of Electrical and Electronics Engineers, Inc.
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.\" 3. Neither the name of the University nor the names of its contributors
18.\"    may be used to endorse or promote products derived from this software
19.\"    without specific prior written permission.
20.\"
21.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31.\" SUCH DAMAGE.
32.\"
33.\"     @(#)cd.1	8.1 (Berkeley) 6/5/93
34.\"
35.Dd August 31, 2019
36.Dt CD 1
37.Os
38.Sh NAME
39.Nm cd
40.Nd change working directory
41.Sh SYNOPSIS
42.Nm cd
43.Op Ar directory
44.Sh DESCRIPTION
45Since
46.Nm
47affects the current shell execution environment, it is always provided
48as a shell regular built-in.
49For more information consult the manual page for the shell in use.
50.Pp
51The
52.Ar directory
53operand is an absolute or relative pathname which becomes the new
54working directory.
55The interpretation of a relative pathname by
56.Nm
57depends on the
58.Ev CDPATH
59environment variable (see below).
60.Sh ENVIRONMENT
61The following environment variables affect the execution of
62.Nm :
63.Bl -tag -width Ev
64.It Ev CDPATH
65A colon-separated list of pathnames that refer to directories.
66If the
67.Ar directory
68operand does not begin with a slash
69.Pq Ql \&/
70character, and the first
71component is not dot
72.Pq Ql \&.
73or dot-dot
74.Pq Ql \&.. ,
75.Nm
76searches for the
77.Ar directory
78relative to each directory named in the
79.Ev CDPATH
80variable, in the order listed.
81The new working directory is set to the first matching directory found.
82An empty string in place of a directory pathname represents the current
83directory.
84If the new working directory was derived from
85.Ev CDPATH ,
86it will be printed to the standard output.
87.It Ev HOME
88If
89.Nm cd
90is invoked without arguments and the
91.Ev HOME
92environment variable exists and contains a directory name, that directory
93becomes the new working directory.
94.It Ev OLDPWD
95Set to the previous working directory after a directory change.
96Not supported by
97.Xr csh 1 .
98.It Ev PWD
99Set to the current working directory.
100.El
101.Sh EXIT STATUS
102.Ex -std cd
103.Sh SEE ALSO
104.Xr csh 1 ,
105.Xr ksh 1 ,
106.Xr pwd 1 ,
107.Xr sh 1 ,
108.Xr chdir 2
109.Sh STANDARDS
110The
111.Nm cd
112command is expected to be
113.St -p1003.2
114compatible.
115