[BACK]Return to cd.1 CVS log [TXT][DIR] Up to [cvs.NetBSD.org] / src / share / man / man1

File: [cvs.NetBSD.org] / src / share / man / man1 / cd.1 (download)

Revision 1.10, Sat Aug 31 21:35:50 2019 UTC (19 months, 3 weeks ago) by uwe
Branch: MAIN
CVS Tags: phil-wifi-20200421, phil-wifi-20200411, phil-wifi-20200406, phil-wifi-20191119, is-mlppp-base, is-mlppp, HEAD
Changes since 1.9: +31 -15 lines

Move the text that explains that cd(1) is a shell built-in to the very
beginning of the description where it can be seen prominently.
Improve formatting.

.\"	$NetBSD: cd.1,v 1.10 2019/08/31 21:35:50 uwe Exp $
.\"
.\" Copyright (c) 1980, 1990, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" the Institute of Electrical and Electronics Engineers, Inc.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)cd.1	8.1 (Berkeley) 6/5/93
.\"
.Dd August 31, 2019
.Dt CD 1
.Os
.Sh NAME
.Nm cd
.Nd change working directory
.Sh SYNOPSIS
.Nm cd
.Op Ar directory
.Sh DESCRIPTION
Since
.Nm
affects the current shell execution environment, it is always provided
as a shell regular built-in.
For more information consult the manual page for the shell in use.
.Pp
The
.Ar directory
operand is an absolute or relative pathname which becomes the new
working directory.
The interpretation of a relative pathname by
.Nm
depends on the
.Ev CDPATH
environment variable (see below).
.Sh ENVIRONMENT
The following environment variables affect the execution of
.Nm :
.Bl -tag -width Ev
.It Ev CDPATH
A colon-separated list of pathnames that refer to directories.
If the
.Ar directory
operand does not begin with a slash
.Pq Ql \&/
character, and the first
component is not dot
.Pq Ql \&.
or dot-dot
.Pq Ql \&.. ,
.Nm
searches for the
.Ar directory
relative to each directory named in the
.Ev CDPATH
variable, in the order listed.
The new working directory is set to the first matching directory found.
An empty string in place of a directory pathname represents the current
directory.
If the new working directory was derived from
.Ev CDPATH ,
it will be printed to the standard output.
.It Ev HOME
If
.Nm cd
is invoked without arguments and the
.Ev HOME
environment variable exists and contains a directory name, that directory
becomes the new working directory.
.It Ev OLDPWD
Set to the previous working directory after a directory change.
Not supported by
.Xr csh 1 .
.It Ev PWD
Set to the current working directory.
.El
.Sh EXIT STATUS
.Ex -std cd
.Sh SEE ALSO
.Xr csh 1 ,
.Xr ksh 1 ,
.Xr pwd 1 ,
.Xr sh 1 ,
.Xr chdir 2
.Sh STANDARDS
The
.Nm cd
command is expected to be
.St -p1003.2
compatible.