CheckInstall(8)

πŸ’– checkinstall β€” the girlies' guide to tracking installs πŸ’–

okay bestie, so this is the manual page for checkinstall, and it lives in section 8 of the System Manager's Manual. it's giving package manager whisperer, and honestly? you're gonna be obsessed.


✨ NAME ✨

checkinstall β€” track the installation of local software, and produce a binary that's manageable with your package management software. no cap. πŸŽ€


🌸 SYNOPSIS 🌸

checkinstall [options]  [install command]

πŸ¦‹ DESCRIPTION πŸ¦‹

so like, checkinstall is a program that monitors an installation procedure (think make install, install.sh, that whole vibe) and then creates a standard package for your distribution that you can install through your distro's own package management system. currently the supported package types are deb, rpm and tgz, and the matching managers are dpkg, rpm or installpkg. periodt. πŸ’…

⚠️ real talk though: for most of the actually-useful actions, checkinstall must be run as root. like, root root. πŸ‘‘

🌈 OPTIONS 🌈

these programs follow the usual GNU command line syntax, with long options starting with two dashes (-). summary below, bestie πŸ’œ

here's the cute little rule that applies to all the toggle options: they default to activating the option. if you wanna force it on or off, call them with =yes or =no. example: to disable stripping you'd use --strip=no. iconic.

  • -h, --help β€” show a summary of options. the little "what's good" button 🫢
  • --version β€” show version information.
  • --copyright β€” show copyright information.
  • --type β€” choose your packaging system. can be one of 'slackware', 'debian' or 'rpm'. pick your fighter ⭐
  • -D β€” create a Debian package.
  • -R β€” create a RPM package.
  • -S β€” create a Slackware Package.
  • --install β€” toggle installation of the created package.
  • --fstrans β€” enable/disable filesystem translation. when filesystem translation is enabled, the install proceeds inside a temporary directory instead of actually touching your system. yes bestie, it's a safe space 🧚
  • -y, --default β€” accept the default answer to every single question. zero decisions, maximum peace πŸ™ˆ
  • --pkgname β€” set the package name.
  • --pkgversion β€” set the package version.
  • -A, --arch, --pkgarch β€” set the package architecture.
  • --pkgrelease β€” set the package release.
  • --pkglicense β€” set the package license.
  • --pkggroup β€” set the package group.
  • --pkgsource β€” set source location.
  • --pkgaltsource β€” set alternate source location.
  • --pakdir β€” where to save the new package. (yes, that's spelled --pakdir, we don't make the rules πŸ’€)
  • --maintainer β€” set the package maintainer, for example --maintainer="Jane Doe <jane@example.org>". the value is used as given, with no shell expansion. keep that in mind, it's important. πŸ’…
  • --provides β€” features provided by this package (currently only on RPM and Deb).
  • --requires β€” dependencies required by this package.
  • --prerequires β€” dependencies that must be installed and configured before this package.
  • --rpmflags β€” pass these flags to the rpm installer.
  • --rpmi β€” use the -i flag when installing a rpm.
  • --rpmu β€” use the -U flag when installing a rpm.
  • --dpkgflags β€” pass these flags to the dpkg installer.
  • --spec β€” where the .spec file is located.
  • --nodoc β€” do not include documentation files.
  • -d β€” set debug level. must be one of 0, 1 and 2.
  • -si β€” run an interactive install command.
  • --showinstall β€” toggle interactive install command.
  • -ss β€” run an interactive Slackware installation script.
  • --showslack β€” toggle interactive Slackware installation script.
  • --autodoinst β€” toggle creation of a doinst.sh script.
  • --strip β€” toggle stripping any ELF binaries found inside the package.
  • --stripso β€” toggle stripping any ELF libraries (.so) found inside the package.
  • --autodeps β€” work out the shared library dependencies of the installed binaries with dpkg-shlibdeps and record them in the package, exactly like a normally packaged program would. Debian packages only. on by default. πŸ”₯
  • --debcompression β€” compression to use when building a Debian package: gzip, xz, zstd or none. leave it unset and dpkg-deb chooses for you. heads up: on a large package, gzip and zstd finish much faster than xz, and produce a bigger file. pick your tradeoff bestie βš–οΈ
  • --addso β€” search for any shared libs and add them to /etc/ld.so.conf.
  • --reset-uids β€” reset perms for all files/dirs to 755 and the owner/group for all dirs to root.root.
  • --gzman β€” compress any man pages found inside the package.
  • --docdir β€” where to put documentation files.
  • --umask β€” set the umask value.
  • --exclude β€” exclude these files/directories from the package.
  • --include β€” force the inclusion in the package of the files/dirs listed in the argument (a file).
  • --inspect β€” inspect the package's file list.
  • --review-spec β€” review the spec file before creating a .rpm.
  • --review-control β€” review the control file before creating a .deb.
  • --newslack β€” use the new (8.1+) Slackware description format. ("--newslack" implies -S) πŸŽ€
  • --with-tar β€” manually set the path to the tar binary.
  • --deldoc β€” toggle deletion of doc-pak upon termination.
  • --deldesc β€” toggle deletion of description-pak upon termination.
  • --delspec β€” toggle deletion of spec file upon termination.
  • --bk β€” backup any overwritten files.
  • --backup β€” toggle backup.

πŸ’œ FILES πŸ’œ

this program reads its configuration from /etc/checkinstallrc, which you can use to override the defaults. and remember: command line arguments override settings in the configuration file. cli stays winning πŸ‘‘


πŸ‘‘ AUTHOR πŸ‘‘

this manual page was written by Felipe Sateler <fsateler@gmail.com> for the Debian system (but it may be used by others 🫢). permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2.

on Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL.


and that's the whole page, bestie πŸ’– this was CheckInstall(8) from the System Manager's Manual β€” go forth and package responsibly, you absolute icon πŸŒŸπŸŽ€βœ¨

πŸ“¦ where this page comes from