Correct BSD License clause numbering from 1-2-4 to 1-2-3.
[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. Neither the name of the University nor the names of its contributors
16 .\"    may be used to endorse or promote products derived from this software
17 .\"    without specific prior written permission.
18 .\"
19 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 .\" SUCH DAMAGE.
30 .\"
31 .\"     @(#)pwd.1       8.2 (Berkeley) 4/28/95
32 .\" $FreeBSD: src/bin/pwd/pwd.1,v 1.10.2.5 2002/06/17 11:04:22 tjr Exp $
33 .\" $DragonFly: src/bin/pwd/pwd.1,v 1.3 2006/02/17 19:33:31 swildner Exp $
34 .\"
35 .Dd February 4, 2002
36 .Dt PWD 1
37 .Os
38 .Sh NAME
39 .Nm pwd
40 .Nd return working directory name
41 .Sh SYNOPSIS
42 .Nm
43 .Op Fl LP
44 .Sh DESCRIPTION
45 The
46 .Nm
47 utility writes the absolute pathname of the current working directory to
48 the standard output.
49 .Pp
50 Some shells may provide a builtin
51 .Nm
52 command which is similar or identical to this utility.
53 Consult the
54 .Xr builtin 1
55 manual page.
56 .Pp
57 The options are as follows:
58 .Bl -tag -width indent
59 .It Fl L
60 Display the logical current working directory.
61 .It Fl P
62 Display the physical current working directory (all symbolic links resolved).
63 .El
64 .Pp
65 If no options are specified, the
66 .Fl P
67 option is assumed.
68 .Sh ENVIRONMENT
69 Environment variables used by
70 .Nm :
71 .Bl -tag -width ".Ev PWD"
72 .It Ev PWD
73 Logical current working directory.
74 .El
75 .Sh EXIT STATUS
76 .Ex -std
77 .Sh SEE ALSO
78 .Xr builtin 1 ,
79 .Xr cd 1 ,
80 .Xr csh 1 ,
81 .Xr sh 1 ,
82 .Xr getcwd 3
83 .Sh STANDARDS
84 The
85 .Nm
86 utility conforms to
87 .St -p1003.1-2001 .
88 .Sh BUGS
89 In
90 .Xr csh  1
91 the command
92 .Ic dirs
93 is always faster because it is built into that shell.
94 However, it can give a different answer in the rare case
95 that the current directory or a containing directory was moved after
96 the shell descended into it.
97 .Pp
98 The
99 .Fl L
100 option does not work unless the
101 .Ev PWD
102 environment variable is exported by the shell.