Initial import from FreeBSD RELENG_4:
[dragonfly.git] / bin / pwd / pwd.1
1 .\" Copyright (c) 1990, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" This code is derived from software contributed to Berkeley by
5 .\" the Institute of Electrical and Electronics Engineers, Inc.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\" 3. All advertising materials mentioning features or use of this software
16 .\"    must display the following acknowledgement:
17 .\"     This product includes software developed by the University of
18 .\"     California, Berkeley and its contributors.
19 .\" 4. Neither the name of the University nor the names of its contributors
20 .\"    may be used to endorse or promote products derived from this software
21 .\"    without specific prior written permission.
22 .\"
23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 .\" SUCH DAMAGE.
34 .\"
35 .\"     @(#)pwd.1       8.2 (Berkeley) 4/28/95
36 .\" $FreeBSD: src/bin/pwd/pwd.1,v 1.10.2.5 2002/06/17 11:04:22 tjr Exp $
37 .\"
38 .Dd February 4, 2002
39 .Dt PWD 1
40 .Os
41 .Sh NAME
42 .Nm pwd
43 .Nd return working directory name
44 .Sh SYNOPSIS
45 .Nm
46 .Op Fl LP
47 .Sh DESCRIPTION
48 The
49 .Nm
50 utility writes the absolute pathname of the current working directory to
51 the standard output.
52 .Pp
53 Some shells may provide a builtin
54 .Nm
55 command which is similar or identical to this utility.
56 Consult the
57 .Xr builtin 1
58 manual page.
59 .Pp
60 The options are as follows:
61 .Bl -tag -width indent
62 .It Fl L
63 Display the logical current working directory.
64 .It Fl P
65 Display the physical current working directory (all symbolic links resolved).
66 .El
67 .Pp
68 If no options are specified, the
69 .Fl P
70 option is assumed.
71 .Sh ENVIRONMENT
72 Environment variables used by
73 .Nm :
74 .Bl -tag -width ".Ev PWD"
75 .It Ev PWD
76 Logical current working directory.
77 .El
78 .Sh DIAGNOSTICS
79 .Ex -std
80 .Sh STANDARDS
81 The
82 .Nm
83 utility conforms to
84 .St -p1003.1-2001 .
85 .Sh SEE ALSO
86 .Xr builtin 1 ,
87 .Xr cd 1 ,
88 .Xr csh 1 ,
89 .Xr sh 1 ,
90 .Xr getcwd 3
91 .Sh BUGS
92 In
93 .Xr csh  1
94 the command
95 .Ic dirs
96 is always faster because it is built into that shell.
97 However, it can give a different answer in the rare case
98 that the current directory or a containing directory was moved after
99 the shell descended into it.
100 .Pp
101 The
102 .Fl L
103 option does not work unless the
104 .Ev PWD
105 environment variable is exported by the shell.