NetBSD/bin/pwd/pwd.1

.\"	$NetBSD: pwd.1,v 1.27 2017/07/04 06:50:37 wiz Exp $
.\"
.\" Copyright (c) 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.
.\"
.\"     @(#)pwd.1	8.2 (Berkeley) 4/28/95
.\"
.Dd August 12, 2016
.Dt PWD 1
.Os
.Sh NAME
.Nm pwd
.Nd return working directory name
.Sh SYNOPSIS
.Nm
.Op Fl LP
.Sh DESCRIPTION
.Nm
writes the absolute pathname of the current working directory to
the standard output.
.Pp
The following options are available:
.Bl -tag -width indent
.It Fl L
If the
.Ev PWD
environment variable is an absolute pathname that contains
neither "/./" nor "/../" and references the current directory, then
.Ev PWD
is assumed to be the name of the current directory.
.It Fl P
Print the physical path to the current working directory, with symbolic
links in the path resolved.
.El
.Pp
The default for the
.Nm
command is
.Fl P .
.Pp
.Nm
is usually provided as a shell builtin (which may have a different
default).
.Sh EXIT STATUS
.Ex -std pwd
.Sh SEE ALSO
.Xr cd 1 ,
.Xr csh 1 ,
.Xr ksh 1 ,
.Xr sh 1 ,
.Xr getcwd 3
.Sh STANDARDS
The
.Nm
utility is expected to be conforming to
.St -p1003.1 ,
except that the default is
.Fl P
not
.Fl L .
.Sh HISTORY
A
.Nm
utility appeared in
.At v5 .
.Sh BUGS
In
.Xr csh 1
the command
.Ic dirs
is always faster (although it can give a different answer in the rare case
that the current directory or a containing directory was moved after
the shell descended into it).
.Pp
.Nm
.Fl L
relies on the file system having unique inode numbers.
If this is not true (e.g., on FAT file systems) then
.Nm
.Fl L
may fail to detect that
.Ev PWD
is incorrect.
Use Ex. 2017-07-04 09:50:04 +03:00			`.\" $NetBSD: pwd.1,v 1.27 2017/07/04 06:50:37 wiz Exp $`
convert to new RCS id conventions. 1995-03-21 12:01:59 +03:00			`.\"`
Merge 4.4-Lite version. 1994-09-22 13:24:46 +04:00			`.\" Copyright (c) 1990, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\"`
			`.\" 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.`
Move UCB-licensed code from 4-clause to 3-clause licence. Patches provided by Joel Baker in PR 22249, verified by myself. 2003-08-07 13:05:01 +04:00			`.\" 3. Neither the name of the University nor the names of its contributors`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\" 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.`
			`.\"`
Sync with 4.4lite2 1995-09-07 10:42:58 +04:00			`.\" @(#)pwd.1 8.2 (Berkeley) 4/28/95`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\"`
Document the version pwd first appeared. Bump date. 2016-08-12 05:03:26 +03:00			`.Dd August 12, 2016`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Dt PWD 1`
More and more .Os cleanups. .Os is defined in the tmac.doc-common file, so we shouldn't override it with versions in the manpages. Many more to come. 1999-03-22 21:25:43 +03:00			`.Os`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh NAME`
			`.Nm pwd`
			`.Nd return working directory name`
			`.Sh SYNOPSIS`
- getopt returns -1 not EOF - use .Nm correctly in man page 1997-09-14 12:51:38 +04:00			`.Nm`
Add -L flag. 1998-11-04 00:38:19 +03:00			`.Op Fl LP`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh DESCRIPTION`
- getopt returns -1 not EOF - use .Nm correctly in man page 1997-09-14 12:51:38 +04:00			`.Nm`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`writes the absolute pathname of the current working directory to`
			`the standard output.`
			`.Pp`
Add -L flag. 1998-11-04 00:38:19 +03:00			`The following options are available:`
			`.Bl -tag -width indent`
			`.It Fl L`
Make /bin/pwd almost conform to IEEE 1003.1 - Make 'pwd -L' fall back to 'pwd -P' if PWD is incorrect. - Ignore PWD if it contains "/./" or "/../". - Garbage collect some redundant code. It is still non-conformant because posix mandates that the default be 'pwd -L' (aka ksh), not 'pwd -P' (historic practise everywhere else). Changing the default will break too much... 2003-10-30 16:52:23 +03:00			`If the`
			`.Ev PWD`
			`environment variable is an absolute pathname that contains`
			`neither "/./" nor "/../" and references the current directory, then`
			`.Ev PWD`
			`is assumed to be the name of the current directory.`
Add -L flag. 1998-11-04 00:38:19 +03:00			`.It Fl P`
			`Print the physical path to the current working directory, with symbolic`
New policy: New sentences start on a new line. Patches by Robert Elz <kre at munnari oz au>, with minimal changes by me. 2002-09-25 19:18:36 +04:00			`links in the path resolved.`
Add -L flag. 1998-11-04 00:38:19 +03:00			`.El`
Make /bin/pwd almost conform to IEEE 1003.1 - Make 'pwd -L' fall back to 'pwd -P' if PWD is incorrect. - Ignore PWD if it contains "/./" or "/../". - Garbage collect some redundant code. It is still non-conformant because posix mandates that the default be 'pwd -L' (aka ksh), not 'pwd -P' (historic practise everywhere else). Changing the default will break too much... 2003-10-30 16:52:23 +03:00			`.Pp`
			`The default for the`
			`.Nm`
			`command is`
			`.Fl P .`
			`.Pp`
			`.Nm`
			`is usually provided as a shell builtin (which may have a different`
			`default).`
For commands and utilities, use EXIT STATUS rather than RETURN VALUES as appropriate (and documented in mdoc(7)). 2000-09-04 11:30:07 +04:00			`.Sh EXIT STATUS`
Use Ex. 2017-07-04 09:50:04 +03:00			`.Ex -std pwd`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh SEE ALSO`
			`.Xr cd 1 ,`
			`.Xr csh 1 ,`
Make /bin/pwd almost conform to IEEE 1003.1 - Make 'pwd -L' fall back to 'pwd -P' if PWD is incorrect. - Ignore PWD if it contains "/./" or "/../". - Garbage collect some redundant code. It is still non-conformant because posix mandates that the default be 'pwd -L' (aka ksh), not 'pwd -P' (historic practise everywhere else). Changing the default will break too much... 2003-10-30 16:52:23 +03:00			`.Xr ksh 1 ,`
			`.Xr sh 1 ,`
Document the fact that the pwd utility is POSIX.2 compliant. 1993-08-28 07:57:20 +04:00			`.Xr getcwd 3`
Make it clearer that -L does not necessarily do the job, and, following conventions, move exit status information into its own section. 1999-05-31 18:37:20 +04:00			`.Sh STANDARDS`
			`The`
			`.Nm`
			`utility is expected to be conforming to`
Make /bin/pwd almost conform to IEEE 1003.1 - Make 'pwd -L' fall back to 'pwd -P' if PWD is incorrect. - Ignore PWD if it contains "/./" or "/../". - Garbage collect some redundant code. It is still non-conformant because posix mandates that the default be 'pwd -L' (aka ksh), not 'pwd -P' (historic practise everywhere else). Changing the default will break too much... 2003-10-30 16:52:23 +03:00			`.St -p1003.1 ,`
			`except that the default is`
			`.Fl P`
			`not`
			`.Fl L .`
Document the version pwd first appeared. Bump date. 2016-08-12 05:03:26 +03:00			`.Sh HISTORY`
			`A`
			`.Nm`
			`utility appeared in`
			`.At v5 .`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh BUGS`
			`In`
- getopt returns -1 not EOF - use .Nm correctly in man page 1997-09-14 12:51:38 +04:00			`.Xr csh 1`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`the command`
			`.Ic dirs`
			`is always faster (although it can give a different answer in the rare case`
			`that the current directory or a containing directory was moved after`
			`the shell descended into it).`
Make /bin/pwd almost conform to IEEE 1003.1 - Make 'pwd -L' fall back to 'pwd -P' if PWD is incorrect. - Ignore PWD if it contains "/./" or "/../". - Garbage collect some redundant code. It is still non-conformant because posix mandates that the default be 'pwd -L' (aka ksh), not 'pwd -P' (historic practise everywhere else). Changing the default will break too much... 2003-10-30 16:52:23 +03:00			`.Pp`
			`.Nm`
			`.Fl L`
file system, not filesystem; e.g. is an abbreviation; use FAT instead of msdos when describing the file system. 2003-10-30 17:58:23 +03:00			`relies on the file system having unique inode numbers.`
			`If this is not true (e.g., on FAT file systems) then`
Make /bin/pwd almost conform to IEEE 1003.1 - Make 'pwd -L' fall back to 'pwd -P' if PWD is incorrect. - Ignore PWD if it contains "/./" or "/../". - Garbage collect some redundant code. It is still non-conformant because posix mandates that the default be 'pwd -L' (aka ksh), not 'pwd -P' (historic practise everywhere else). Changing the default will break too much... 2003-10-30 16:52:23 +03:00			`.Nm`
			`.Fl L`
			`may fail to detect that`
			`.Ev PWD`
			`is incorrect.`