.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "dpkg-realpath 1"
.TH dpkg-realpath 1 2024-03-10 1.22.6 "dpkg suite"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
dpkg\-realpath \- print the resolved pathname with DPKG_ROOT support
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBdpkg-realpath\fR [\fIoption\fR...] \fIpathname\fR
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBdpkg-realpath\fR is a tool (since dpkg 1.20.1) to resolve a pathname,
that takes the \fBdpkg\fR\|(1) root directory into account, either implicitly
from the \fBDPKG_ROOT\fR environment variable or from the command-line
\&\fB\-\-root\fR or \fB\-\-instdir\fR options, and returns an absolute \fIpathname\fR
relative to the root directory.
The root directory must not be prefixed to the \fIpathname\fR to be resolved.
.PP
This is intended to be used by other \fBdpkg\fR helpers, or by maintainer
scripts instead of using \fBrealpath\fR\|(1) or \fBreadlink\fR\|(1) to canonicalize
pathnames, as these latter commands do not support canonicalization
relative to a different root than \fI/\fR.
.PP
This program was introduced in dpkg 1.20.1.
.SH OPTIONS
.IX Header "OPTIONS"
.IP "\fB\-z\fR, \fB\-\-zero\fR" 4
.IX Item "-z, --zero"
Use a NUL byte to end output lines instead of a new line character
(since dpkg 1.20.6).
.IP "\fB\-\-instdir\fR \fIdirectory\fR" 4
.IX Item "--instdir directory"
.PD 0
.IP "\fB\-\-root\fR \fIdirectory\fR" 4
.IX Item "--root directory"
.PD
Set the root directory to \fIdirectory\fR, which is the base directory
that pathnames get canonicalized against.
Defaults to \(Fo\fB/\fR\(Fc if \fBDPKG_ROOT\fR has not been set.
.IP "\fB\-?\fR, \fB\-\-help\fR" 4
.IX Item "-?, --help"
Show the usage message and exit.
.IP \fB\-\-version\fR 4
.IX Item "--version"
Show the version and exit.
.SH ENVIRONMENT
.IX Header "ENVIRONMENT"
.IP \fBDPKG_ROOT\fR 4
.IX Item "DPKG_ROOT"
If set and the \fB\-\-instdir\fR or \fB\-\-root\fR options have not been
specified, it will be used as the filesystem root directory.
.IP \fBDPKG_COLORS\fR 4
.IX Item "DPKG_COLORS"
Sets the color mode.
The currently accepted values are: \fBauto\fR (default), \fBalways\fR and \fBnever\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBrealpath\fR\|(1),
\&\fBreadlink\fR\|(1).