share/man/man1/cd.1

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