xref: /netbsd-src/share/man/man1/cd.1 (revision 23c8222edbfb0f0932d88a8351d3a0cf817dfb9e)
1.\"	$NetBSD: cd.1,v 1.5 2003/08/07 10:31:00 agc 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 June 5, 1993
36.Dt CD 1
37.Os
38.Sh NAME
39.Nm cd
40.Nd change working directory
41.Sh SYNOPSIS
42.Nm cd
43.Ar directory
44.Sh DESCRIPTION
45.Ar Directory
46is an absolute or relative pathname which becomes the new working
47directory.
48The interpretation of a relative pathname by cd depends on the CDPATH
49environment variable (see below).
50.Sh ENVIRONMENT
51The following environment variables affect the execution of cd:
52.Pp
53.Bl -tag -width indent
54.It Ev CDPATH
55If the
56.Ar directory
57operand does not begin with a slash (/) character, and the first
58component is not dot (.) or dot-dot (..),
59.Nm cd
60searches for the directory relative to each directory named in the
61.Ev CDPATH
62variable, in the order listed.
63The new working directory is set to the first matching directory found.
64An empty string in place of a directory pathname represents the current
65directory.
66If the new working directory was derived from
67.Ev CDPATH ,
68it will be printed to the standard output.
69.It Ev HOME
70If
71.Nm cd
72is invoked without arguments and the
73.Ev HOME
74environment variable exists and contains a directory name, that directory
75becomes the new working directory.
76.El
77.Pp
78See
79.Xr csh 1
80for more information on environment variables.
81.Pp
82The
83.Nm cd
84utility exits 0 on success, and \*[Gt]0 if an error occurs.
85.Sh SEE ALSO
86.Xr csh 1 ,
87.Xr pwd 1 ,
88.Xr sh 1 ,
89.Xr chdir 2
90.Sh STANDARDS
91The
92.Nm cd
93command is expected to be
94.St -p1003.2
95compatible.
96