FreeBSD install - a package for the installation and maintainance
of non-core utilities.
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.
Jordan K. Hubbard
@(#)pkg_create.1
$FreeBSD: head/usr.sbin/pkg_install/create/pkg_create.1 21673 1997-01-14 07:20:47Z jkh $
hacked up by John Kohl for NetBSD--fixed a few bugs, extended keywords,
added dependency tracking, etc.
[jkh] Took John's changes back and made some additional extensions for
better integration with FreeBSD's new ports collection.
.Dd April 21, 1995 .Dt pkg_create 1 .Os FreeBSD 2.0 .Sh NAME .Nm pkg_create .Nd a utility for creating software package distributions. .Sh SYNOPSIS .Nm .Op Fl YNOhv .Op Fl P Ar pkgs .Op Fl p Ar prefix .Op Fl f Ar contents .Op Fl i Ar iscript .Op Fl k Ar dscript .Op Fl r Ar rscript .Op Fl t Ar template .Op Fl X Ar excludefile .Op Fl D Ar displayfile .Op Fl m Ar mtreefile .Fl d Ar description .Fl f Ar packlist .Ar pkg-name .Sh DESCRIPTION The .Nm command is used to create packages that will subsequently be fed to one of the package extraction/info utilities. The input description and command line arguments for the creation of a package are not really meant to be human-generated, though it is easy enough to do so. It is more expected that you will use a front-end tool for the job rather than muddling through it yourself. Nonetheless, a short description of the input syntax is included in this document. .Sh OPTIONS The following command line options are supported. l -tag -width indent t Fl f Ar packinglist Fetch ``packing list'' for package from the file .Ar packinglist or .Cm stdin if .Ar packinglist is a .Cm - (dash). .Em "Mandatory." t Fl c Ar [-]desc Fetch package ``one line description'' from file .Ar desc or, if preceded by .Cm - , the argument itself. This string should also give some idea of which version of the product (if any) the package represents. .Em "Mandatory." t Fl d Ar [-]desc Fetch long description for package from file .Ar desc or, if preceded by .Cm - , the argument itself. .Em "Mandatory." t Fl Y Assume a default answer of `Yes' for any questions asked. .Em "Optional." t Fl N Assume a default answer of `No' for any questions asked. t Fl O Go into a `packing list Only' mode. This is a custom hack for the .Em "FreeBSD Ports Collection" and is used to do `fake pkg_add' operations when a port is installed. In such cases, it is necessary to know what the final, adjusted packing list will look like. .Em "Optional." t Fl v Turns on verbose output. .Em "Optional." t Fl h Forces tar to follow symbolic links, so that the files they point to are dumped, rather than the links themselves. t Fl i Ar iscript Sets .Ar iscript to be the install procedure for the package. This can be any executable program (or shell script). It will be invoked automatically when the package is later installed. .Em "Optional." t Fl P Ar pkgs Sets the initial package dependency list to .Ar pkgs. This is assumed to be a whitespace separated list of package names and is meant as a convenient shorthand for specifying multiple .Cm @pkgdep directives in the packing list (see PACKING LIST DETAILS section below). .Em "Optional." t Fl p Ar prefix Sets .Ar prefix as the initial directory ``base'' to start from in selecting files for the package. .Em "Optional." t Fl k Ar dscript Sets .Ar dscript to be the de-install procedure for the package. This can be any executable program (or shell script). It will be invoked automatically when the package is later (if ever) de-installed. .Em "Optional." t Fl r Ar rscript Sets .Ar rscript to be the ``requirements'' procedure for the package. This can be any executable program (or shell script). It will be invoked automatically at installation/deinstallation time to determine whether or not installation/deinstallation should proceed. .Em "Optional." t Fl t Ar template Use .Ar template as the input to .Xr mktemp 3 . By default, this is the string
a /tmp/instmp.XXXXXX , but it may be necessary to override it in the situation where space in your
a /tmp directory is limited. Be sure to leave some number of `X' characters for .Xr mktemp 3 to fill in with a unique ID. .Em "Optional." t Fl X Ar excludefile Pass .Ar excludefile as a .Fl exclude-from argument to .Cm tar when creating final package. See .Cm tar man page (or run .Cm tar with .Fl -help flag) for further information on using this flag. t Fl D Ar displayfile Display the file (using .Xr more 1 ) after installing the package. Useful for things like legal notices on almost-free software, etc. t Fl m Ar mtreefile Run .Xr mtree 8 with input from mtreefile before the package is installed. Mtree is invoked as .Cm mtree .Fl u .Fl f .Ar mtreefile .Fl d .Fl e .Fl p
a prefix , where
a prefix is the name of the first directory named by a .Cm @cwd directive. .El
p .Sh PACKING LIST DETAILS The ``packing list'' format (see .Fl f ) is fairly simple, being nothing more than a single column of filenames to include in the package. However, since absolute pathnames are generally a bad idea for a package that could be installed potentially anywhere, there is another method of specifying where things are supposed to go and, optionally, what ownership and mode information they should be installed with. This is done by imbeding specialized command sequences in the packing list. Briefly described, these sequences are: l -tag -width indent -compact t Cm @cwd Ar directory Sets the internal directory pointer to point to .Ar directory . All subsequent filenames will be assumed relative to this directory. Note: .Cm @cd is also an alias for this command. t Cm @srcdir Ar directory Sets the internal directory pointer for _creation only_ to .Ar directory . That is to say that it overrides .Cm @cwd for package creation but not extraction. t Cm @exec Ar command Execute .Ar command as part of the unpacking process. If .Ar command contains a any of the following sequences somewhere in it, they will be expanded inline. For the following examples, assume that .Cm @cwd is set to
a /usr/local and the last extracted file was
a bin/emacs . l -tag -width indent -compact t Cm "%F" Expands to the last filename extracted (as specified), in the example case
a bin/emacs t Cm "%D" Expands to the current directory prefix, as set with .Cm @cwd , in the example case
a /usr/local . t Cm "%B" Expands to the ``basename'' of the fully qualified filename, that is the current directory prefix, plus the last filespec, minus the trailing filename. In the example case, that would be
a /usr/local/bin . t Cm "%f" Expands to the ``filename'' part of the fully qualified name, or the converse of .Cm %B , being in the example case,
a emacs . .El t Cm @unexec Ar command Execute .Ar command as part of the deinstallation process. Expansion of special .Cm % sequences is the same as for .Cm @exec . This command is not executed during the package add, as .Cm @exec is, but rather when the package is deleted. This is useful for deleting links and other ancillary files that were created as a result of adding the package, but not directly known to the package's table of contents (and hence not automatically removable). The advantage of using .Cm @unexec over a deinstallation script is that you can use the ``special sequence expansion'' to get at files regardless of where they've been potentially redirected (see .Fl p ) t Cm @mode Ar mode Sets default permission for all subsequently extracted files to .Ar mode . Format is the same as that used by the .Cm chmod command (well, considering that it's later handed off to it, that's no surprise). Use without an arg to set back to default (extraction) permissions. t Cm @owner Ar user Sets default ownership for all subsequently extracted files to .Ar user . Use without an arg to set back to default (extraction) ownership. t Cm @group Ar group Sets default group ownership for all subsequently extracted files to .Ar group . Use without an arg to set back to default (extraction) group ownership. t Cm @comment Ar string Imbed a comment in the packing list. Useful in trying to document some particularly hairy sequence that may trip someone up later. t Cm @ignore Used internally to tell extraction to ignore the next file (don't copy it anywhere), as it's used for some special purpose. t Cm @ignore_inst Similar to .Cm @ignore , but the ignoring of the next file is delayed one evaluation cycle. This makes it possible to use this directive in the .Ar packinglist file, so you can pack a specialized datafile in with a distribution for your install script (or something) yet have the installer ignore it. t Cm @name Ar name Sets the name of the package. This is mandatory and is usually put at the top. This name is potentially different than the name of the file it came in, and is used when keeping track of the package for later deinstallation. Note that .Nm will derive this field from the package name and add it automatically if none is given. t Cm @dirrm Ar name Declare directory
a name to be deleted at deinstall time. By default, directories created by a package installation are not deleted when the package is deinstalled; this provides an explicit directory cleanup method. This directive should appear at the end of the package list. If more than one .Cm @dirrm directives are used, the directories are removed in the order specified. The
a name directory will not be removed unless it is empty. t Cm @mtree Ar name Declare
a name as an .Xr mtree 8 input file to be used at install time (see .Fl m above). Only the first .Cm @mtree directive is honored. t Cm @display Ar name Declare
a name as the file to be displayed at install time (see .Fl D above). t Cm @pkgdep Ar pkgname Declares a dependency on the .Ar pkgname package. The .Ar pkgname package must be installed before this package may be installed, and this package must be deinstalled before the .Ar pkgname package is deinstalled. Multiple .Cm @pkgdep directives may be used if hte package depends on multiple other packages. .El .Sh SEE ALSO .Xr pkg_add 1 , .Xr pkg_delete 1 , .Xr pkg_info 1 , .Xr sysconf 3 . .Sh HISTORY The .Nm command first appeared in FreeBSD. .Sh AUTHORS l -tag -width indent -compact t "Jordan Hubbard" most of the work t "John Kohl" refined it for NetBSD .El .Sh BUGS Hard links between files in a distribution must be bracketed by .Cm @cwd directives in order to be preserved as hard links when the package is extracted. They additionally must not end up being split between .Cm tar invocations due to exec argument-space limitations (this depends on the value returned by .Fn sysconf _SC_ARG_MAX ) .
p Sure to be others.