xref: /netbsd-src/share/man/man1/cd.1 (revision 3b01aba77a7a698587faaae455bbfe740923c1f5)
1.\"	$NetBSD: cd.1,v 1.3 1999/03/15 08:22:21 garbled 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. All advertising materials mentioning features or use of this software
18.\"    must display the following acknowledgement:
19.\"	This product includes software developed by the University of
20.\"	California, Berkeley and its contributors.
21.\" 4. Neither the name of the University nor the names of its contributors
22.\"    may be used to endorse or promote products derived from this software
23.\"    without specific prior written permission.
24.\"
25.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35.\" SUCH DAMAGE.
36.\"
37.\"     @(#)cd.1	8.1 (Berkeley) 6/5/93
38.\"
39.Dd June 5, 1993
40.Dt CD 1
41.Os
42.Sh NAME
43.Nm cd
44.Nd change working directory
45.Sh SYNOPSIS
46.Nm cd
47.Ar directory
48.Sh DESCRIPTION
49.Ar Directory
50is an absolute or relative pathname which becomes the new working
51directory.
52The interpretation of a relative pathname by cd depends on the CDPATH
53environment variable (see below).
54.Sh ENVIRONMENT
55The following environment variables affect the execution of cd:
56.Pp
57.Bl -tag -width indent
58.It Ev CDPATH
59If the
60.Ar directory
61operand does not begin with a slash (/) character, and the first
62component is not dot (.) or dot-dot (..),
63.Nm cd
64searches for the directory relative to each directory named in the
65.Ev CDPATH
66variable, in the order listed.
67The new working directory is set to the first matching directory found.
68An empty string in place of a directory pathname represents the current
69directory.
70If the new working directory was derived from
71.Ev CDPATH ,
72it will be printed to the standard output.
73.It Ev HOME
74If
75.Nm cd
76is invoked without arguments and the
77.Ev HOME
78environment variable exists and contains a directory name, that directory
79becomes the new working directory.
80.El
81.Pp
82See
83.Xr csh 1
84for more information on environment variables.
85.Pp
86The
87.Nm cd
88utility exits 0 on success, and >0 if an error occurs.
89.Sh SEE ALSO
90.Xr csh 1 ,
91.Xr pwd 1 ,
92.Xr sh 1 ,
93.Xr chdir 2
94.Sh STANDARDS
95The
96.Nm cd
97command is expected to be
98.St -p1003.2
99compatible.
100