[Slapt-get-devel] slapt-get: man page reformatted

[Igor Murzov]

Hi, list

I have reformatted man page. It now looks more standardized and better 
conforms to `man man-pages` specifications.

-- Igor
-------------- next part --------------
.TH slapt-get 8 2011-01-04

.SH NAME
slapt-get \- frontend to pkgtools

.SH SYNOPSIS
.B slapt-get
[\fIOPTION\fR]... [\fITARGET\fR]
.LP
.B options:
\fB--download-only\fR|\fB-d\fR,
\fB--simulate\fR|\fB-s\fR,
\fB--no-prompt\fR|\fB-y\fR,
\fB--prompt\fR|\fB-p\fR,
\fB--reinstall\fR,
\fB--ignore-excludes\fR,
\fB--no-md5\fR,
\fB--ignore-dep\fR,
\fB--no-dep\fR,
\fB--print-uris\fR,
\fB--show-stats\fR|\fB-S\fR,
\fB--config\fR|\fB-c\fR \fIFILE\fR,
\fB--remove-obsolete\fR,
\fB--retry\fR \fIN\fR,
\fB--no-upgrade\fR
.LP
.B targets:
\fB--update\fR|\fB-u\fR,
\fB--upgrade\fR,
\fB--dist-upgrade\fR,
\fB--install\fR|\fB-i\fR,
\fB--install-set\fR,
\fB--remove\fR,
\fB--show\fR,
\fB--filelist\fR,
\fB--search\fR,
\fB--list\fR,
\fB--available\fR,
\fB--installed\fR,
\fB--clean\fR,
\fB--autoclean\fR,
\fB--add-keys\fR,
\fB--help\fR|\fB-h\fR,
\fB--version\fR

.SH DESCRIPTION
.B slapt-get
is an APT like system for Slackware package management.  It
allows one to search for packages, install them, and upgrade the
installed packages all with a few simple commands.  Additional
features include listing all available packages, listing all
installed packages, and removing installed packages.
.B slapt-get
tries to emulate Debian's apt-get as closely as possible.

.SH OPTIONS
.TP
\fB\-\-download\-only\fR, \fB\-d\fR
Download the package only.  Do not install/upgrade.  Packages are downloaded to
.IR /var/slapt-get/ .
.TP
\fB\-\-simulate\fR, \fB\-s\fR
Will not install or download packages.
.TP
\fB\-\-no\-prompt\fR, \fB\-y\fR
Do not prompt for package upgrade/remove confirmation.
.TP
\fB\-\-prompt\fR, \fB\-p\fR
Always prompt for package install confirmation.
.TP
\fB\-\-reinstall\fR
Install the package even if it is already installed.
.TP
\fB\-\-ignore\-excludes\fR
Ignore exclude list and install excluded packages anyway.
.TP
\fB\-\-no\-md5\fR
Do not perform MD5 check sum on package.  This is dangerous!
.TP
\fB\-\-ignore\-dep\fR
Ignore dependency failures on \fB\-\-install\fR, \fB\-\-upgrade\fR, or
\fB\-\-dist\-upgrade\fR.
.TP
\fB\-\-no\-dep\fR
Skip the dependency check.
.TP
\fB\-\-print\-uris\fR
Print URIs of packages to be downloaded to stdout, but do not download.
.TP
\fB\-\-show\-stats\fR, \fB\-S\fR
Show the download statistics
.TP
\fB\-\-config\fR, \fB\-c\fR \fIFILE\fR
Specify file location of slapt-get configuration.
This overrides the default location, \fI/etc/slapt-get/slapt-getrc\fR.
.TP
\fB\-\-remove\-obsolete\fR
Remove installed packages that are no longer available.  This works for
\fB\-\-dist\-upgrade\fR and \fB\-\-remove\fR only.  This removes packages
that are no longer available from any current package sources, but are
currently installed.  Be careful as this will also remove custom built packages.
.TP
\fB\-\-retry\fR \fIN\fR
Specify the number of retries to attempt if the package download fails.
.TP
\fB\-\-no\-upgrade\fR
Install the package rather than attempting to detect if a previous version is
installed and upgrading it.  This is useful for installing kernel packages.
This option is only valid for \fB\-\-install\fR targets.

.SH TARGETS
.TP
\fB\-\-update\fR, \fB\-u\fR
Retrieves package data from MIRROR location.
.TP
\fB\-\-upgrade\fR
Upgrade installed packages if newer versions are available.
.TP
\fB\-\-dist\-upgrade\fR
Upgrade to newer Slackware release.  This is the same as \fB\-\-upgrade\fR,
with the addition of checking to make sure that all the base packages,
from the base disk set, are also installed.  Prior to running dist-upgrade,
make sure that the package cache is updated and the crucial packages
(glibc-solibs, sed, and pkgtools) are upgraded.  See \fIUPGRADE.TXT\fR
on your local Slackware mirror.
.TP
\fB\-\-install\fR, \fB\-i\fR \fIpackage\fR...
Install specified packages.  Packages can be package names or package names
with version, e.g., \fIpkg\-1.0\-i386\-1\fR.
.TP
\fB\-\-install\-set \fIdisk\_set\fR...
Install specified disk sets, e.g., \fB\-\-install\-set\fR \fIxap n l\fR.
.TP
\fB\-\-remove\fR \fIpackage\fR...
Remove specified packages.  Packages can be package names or package names
with version, e.g., \fIpkg\-1.0\-i386\-1\fR.
.TP
\fB\-\-show\fR \fIpackage\fR...
Show packages description.  Packages can be a package names or package names
with version, e.g., \fIpkg\-1.0\-i386\-1\fR.
.TP
\fB\-\-filelist\fR \fIpackage\fR...
Show packages installed files.  Packages can be a package names or package names
with version, e.g., \fIpkg\-1.0\-i386\-1\fR.
.TP
\fB\-\-search\fR \fIexpression\fR
Search available packages. Applies POSIX and extended regular expression
to the names, versions, locations, and descriptions of packages.
.TP
\fB\-\-list\fR
List all packages, installed and available.
.TP
\fB\-\-available\fR
List available packages only.  This will show you the packages present on your
current sources.
.TP
\fB\-\-installed\fR
List installed packages only.
.TP
\fB\-\-clean\fR
Purge cached/downloaded packages from WORKINGDIR (\fI/var/slapt-get/\fR
by default).
.TP
\fB\-\-autoclean\fR
Like clean, autoclean clears out the local repository of retrieved package files.
The difference is that it only removes package files that can no longer be
downloaded, and are largely useless. This allows a cache to be maintained over
a long period without it growing out of control.
.TP
\fB\-\-add\-keys\fR
Check each package source for a \fIGPG\-KEY\fR file.  Download and import into
the local keychain.
.TP
\fB\-\-help\fR, \fB\-h\fR
Display help and exit.
.TP
\fB\-\-version\fR
Print version and license info.

.SH NOTES
.PP
\fBslapt-get\fR uses \fBpkgtools\fR for installing, upgrading, and removing.
.PP
\fBslapt-get\fR will not make assumptions or do things without you telling it to.
.PP
\fBslapt-get\fR can only attempt to resolve dependencies and conflicts for those
packages that were built with this information.  Vanilla Slackware packages
(i.e. official Slackware packages) do not contain this data, thus \fBslapt-get\fR
performs with \fB\-\-no\-dep\fR on by default.
.PP
Untested updates are risky, whether using official packages or third party packages.
.PP
\fBslapt-get\fR will not change your system such that you can only use
\fBslapt-get\fR or are somehow locked into using \fBslapt-get\fR.  The only
additions to your system are \fI/etc/slapt-get\fR and \fI/var/slapt-get\fR.
You are free to try another solution or go back to manual \fBupgradepkg\fR(8).
.PP
\fIUPGRADE.TXT\fR and \fIChangeLog.txt\fR is still required reading, the latter
is especially true when running -current.

.SH FILES
/etc/slapt-get/slapt-getrc

.SH AUTHOR
Jason Woodward <woodwardj at jaos.org>
.SH "SEE ALSO"
.BR installpkg (8),
.BR makepkg (8),
.BR removepkg (8),
.BR explodepkg (8),
.BR pkgtool (8),
.BR upgradepkg (8),
.BR netrc (5)