summaryrefslogtreecommitdiff
path: root/man/deb-preinst.man
diff options
context:
space:
mode:
authorGuillem Jover <guillem@debian.org>2016-10-05 04:30:17 +0200
committerGuillem Jover <guillem@debian.org>2016-10-30 04:43:27 +0100
commit75439a326729192b9ceeee0021956bda7e89158d (patch)
treef9d868bbe27d166519ae5c323d702ab6e81bc758 /man/deb-preinst.man
parent6db5b664cd164a553c6c7d2960cc93e83a5ef689 (diff)
downloaddpkg-75439a326729192b9ceeee0021956bda7e89158d.tar.gz
man: Generate the man pages at build time
This makes it possible to filter them and update several variable strings such as system and package pathnames, the release date and the dpkg suite version. And will make it possible to use UTF-8 in the source and convert to the more conservative groff escape sequences on the output.
Diffstat (limited to 'man/deb-preinst.man')
-rw-r--r--man/deb-preinst.man45
1 files changed, 45 insertions, 0 deletions
diff --git a/man/deb-preinst.man b/man/deb-preinst.man
new file mode 100644
index 000000000..1ab99d886
--- /dev/null
+++ b/man/deb-preinst.man
@@ -0,0 +1,45 @@
+.\" dpkg manual page - deb-preinst(5)
+.\"
+.\" Copyright © 2016 Guillem Jover <guillem@debian.org>
+.\"
+.\" This is free software; you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation; either version 2 of the License, or
+.\" (at your option) any later version.
+.\"
+.\" This is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+.\" GNU General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public License
+.\" along with this program. If not, see <https://www.gnu.org/licenses/>.
+.
+.TH deb\-preinst 5 "%RELEASE_DATE%" "%VERSION%" "dpkg utilities"
+.SH NAME
+deb\-preinst \- package pre-installation maintainer script
+.
+.SH SYNOPSIS
+preinst
+.
+.SH DESCRIPTION
+A package can perform several pre-installation actions via maintainer
+scripts, by including an executable \fIpreinst\fP file in its control
+archive (i.e. \fIDEBIAN/preinst\fP during package creation).
+.PP
+The script can be called in the following ways:
+.TP
+\fInew-preinst\fP \fBinstall\fP
+Before the package is installed.
+.TP
+\fInew-preinst\fP \fBinstall\fP \fIold-version new-version\fP
+Before removed package is upgraded.
+.TP
+\fInew-preinst\fP \fBupgrade\fP \fIold-version new-version\fP
+Before the package is upgraded.
+.TP
+\fIold-preinst\fP \fBabort-upgrade\fP \fInew-version\fP
+If \fIpostrm\fP fails during upgrade or fails on failed upgrade.
+.
+.SH SEE ALSO
+.BR dpkg (1).