SPK
Section: User Commands (1)
Index
Return to Main Contents
NAME
spk - An application to interface with the local spk package management system.
SYNOPSIS
spk
[OPTION]... [PACKAGE] [EXEC ARGUMENTS]
DESCRIPTION
spk interfaces with the local spk package management system. It is used to install packages, list packages, list the files contained in a package, and perform other similar functions. It is primarily aimed at package management for source-based package installations.
spk will execute EXEC ARGUMENTS (e.g., make install), recording which files are added/modified/deleted. It will place these records in its repository, associating them with PACKAGE. PACKAGE can then be queried for information or uninstalled from the system.
By default spk will back up files that are removed or changed and archive them with the information for PACKAGE. These files can later be restored when PACKAGE is uninstalled.
spk has a number of other functions. It can be told about dependencies and warn if a package about to be uninstalled is needed by other packages. It can scan the filesystem for files which are not under package management.
If PACKAGE is specified in reference to an existing package, only enough characters need be specified so that PACKAGE is unambiguous ("some_package" will match against "some_package-1.0" if no other packages begin with "some_package").
OPTIONS
- -a, --append-install
-
Process existing records by adding them to the existing package PACKAGE.
- --archive
-
Archive removed or changed files during an installation. This option is only valid when either --execute, --complete-install, or --install-execute is specified. This is the default behavior, but the behavior can also be set in spk.conf. This option will override whatever is in spk.conf.
- -c, --complete-install
-
Complete the install of PACKAGE. This means that any records that were made with the --execute option will now be placed in the repository and associated with PACKAGE.
- --depends-on=PACK
-
Mark a dependency on PACK with PACKAGE.
- --delete-archive
-
Delete the archived files associated with PACKAGE from the repository.
- -d, --drop-records
-
Discard any records (and backed up files) that have not already been placed in the repository (by installing a package).
- -e, --execute
-
Execute EXEC ARGUMENTS, making records of files that are added, changed, or removed. This is implied if no options are specified and EXEC ARGUMENTS are made up of at least two arguments (e.g., spk make install). Changed or removed files will be backed up unless --no-archive is specified or archiving is turned off in spk.conf and --archive is not specified.
- -f, --force
-
Force an uninstall of PACKAGE even if other packages depend on PACKAGE and even if there are archived files associated with PACKAGE (--uninstall does not restore archived files, --uninstall-full does). This option only makes sense with --uninstall and --uninstall-full. If used with --uninstall-full archived files will still be restored.
- -h, --help
-
Display a usage summary for spk and exit.
- -i, --install-execute
-
Execute EXEC ARGUMENTS, making records of files that are added, changed, or removed. Then complete the install of PACKAGE. Changed or removed files will be backed up unless --no-archive is specified or archiving is turned off in spk.conf and --archive is not specified. --install-execute is the same as performing an --execute followed by a --complete-install.
- -l, --list
-
List all packages in the repository, or list those that start with PACKAGE ("spk --list gnome" will list all packages whose name starts with "gnome").
- -n, --no-archive
-
Do not archive removed or changed files during an installation. This option is only valid when either --execute, --complete-install, or --install-execute is specified. This option will override whatever is specified in spk.conf.
- --no-dep=PACK
-
Remove a dependency on PACK from PACKAGE.
- --no-support=PACK
-
Remove support for PACK from PACKAGE.
- -Q, --quiet
-
Display the minimal amount of output.
- -q, --query
-
Retrieve information about the package managment system if PACKAGE is not specified. Otherwise retrieve information about PACAKGE. If the --verbose option is specified information about the package management system will contain a list of files that are not under package management.
- -r, --rename=NEW_NAME
-
Rename PACKAGE to NEW_NAME.
- --show-archive
-
Display the archived files associated with PACKAGE.
- -s, --show-files
-
Display the files associated with PACKAGE.
- --show-state
-
Tell whether or not there any records exist which have not yet been placed in the repository. This is implied if no other options are specified and no arguments are given.
- --support-for=PACK
-
Mark support for PACK with PACKAGE.
- -u, --uninstall
-
Uninstall PACKAGE from the system, deleteing files that were added when PACKAGE was installed. If other packages depend on PACKAGE --force must be specified. If there are archived files associated with PACKAGE --force must be specified or --uninstall-full should be used instead.
- -U, --uninstall-full
-
Uninstall PACKAGE from the system, deleteing files that were added when PACKAGE was installed and restoring files that were archived when PACKAGE was installed. If other packages depend on PACKAGE --force must be specified.
- -V, --verbose
-
Display the maximum amount of output.
- -v, --version
-
Display version information and exit.
- -w, --where-is=FILE
-
Check all packages for records containing the string FILE and display results.
FILES
spk.conf
AUTHOR
Written by Christopher Carroll.
REPORTING BUGS
Report bugs to <spk@christophercarroll.org>.
COPYRIGHT
Copyright (C) 2004 Christopher Carroll
This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
Index
- NAME
-
- SYNOPSIS
-
- DESCRIPTION
-
- OPTIONS
-
- FILES
-
- AUTHOR
-
- REPORTING BUGS
-
- COPYRIGHT
-
This document was created by
man2html,
using the manual pages.
Time: 12:55:55 GMT, April 10, 2004