diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/makepkg.8.in | 44 | ||||
| -rw-r--r-- | doc/pacman.8.in | 96 |
2 files changed, 75 insertions, 65 deletions
diff --git a/doc/makepkg.8.in b/doc/makepkg.8.in index 8d8f8437..d6a7994f 100644 --- a/doc/makepkg.8.in +++ b/doc/makepkg.8.in @@ -1,4 +1,4 @@ -.TH makepkg 8 "April 19, 2003" "makepkg #VERSION#" "" +.TH makepkg 8 "May 27, 2003" "makepkg #VERSION#" "" .SH NAME makepkg \- package build utility .SH SYNOPSIS @@ -34,6 +34,7 @@ pkgname=modutils pkgver=2.4.13 pkgrel=1 pkgdesc="Utilities for inserting and removing modules from the linux kernel" +url="http://www.kernel.org" backup=(etc/modules.conf) depends=('glibc>=2.2.5' 'bash' 'zlib') source=(ftp://ftp.server.com/$pkgname-$pkgver.tar.gz modules.conf) @@ -187,6 +188,11 @@ This is the release number specific to Arch Linux packages. This should be a brief description of the package and its functionality. .TP +.B url +This field contains an optional URL that is associated with the piece of software +being packaged. This is typically the project's website. + +.TP .B backup A space-delimited array of filenames (without a preceding slash). The \fIbackup\fP line will be propagated to the package meta-info file for @@ -226,21 +232,6 @@ by wget. .SH MAKEPKG OPTIONS .TP -.B "\-c, \-\-clean" -Clean up leftover work files/directories after a successful build. -.TP -.B "\-C, \-\-cleancache" -Removes all source files from the cache directory to free up diskspace. -.TP -.B "\-i, \-\-install" -Install/Upgrade the package after a successful build. -.TP -.B "\-s, \-\-syncdeps" -Install missing dependencies using pacman. When makepkg finds missing -dependencies, it will run pacman to try and resolve them. If successful, -pacman will download the missing packages from a package repository and -install them for you. -.TP .B "\-b, \-\-builddeps" Build missing dependencies from source. When makepkg finds missing dependencies, it will look for the dependencies' PKGBUILD files under @@ -248,6 +239,12 @@ $ABSROOT (set in your /etc/makepkg.conf). If it finds them it will run another copy of makepkg to build and install the missing dependencies. The child makepkg calls will be made with the \fB-b\fP and \fB-i\fP options. .TP +.B "\-c, \-\-clean" +Clean up leftover work files/directories after a successful build. +.TP +.B "\-C, \-\-cleancache" +Removes all source files from the cache directory to free up diskspace. +.TP .B "\-d, \-\-nodeps" Do not perform any dependency checks. This will let you override/ignore any dependencies required. There's a good chance this option will break the build @@ -258,12 +255,21 @@ process if all of the dependencies aren't installed. file already exists in the build directory. You can override this behaviour with the \fB--force\fP switch. .TP -.B "\-w <destdir>" -Write the resulting package file to the directory \fI<destdir>\fP instead of the -current working directory. +.B "\-i, \-\-install" +Install/Upgrade the package after a successful build. .TP .B "\-p <buildscript>" Read the package script \fI<buildscript>\fP instead of the default (\fIPKGBUILD\fP). +.TP +.B "\-s, \-\-syncdeps" +Install missing dependencies using pacman. When makepkg finds missing +dependencies, it will run pacman to try and resolve them. If successful, +pacman will download the missing packages from a package repository and +install them for you. +.TP +.B "\-w <destdir>" +Write the resulting package file to the directory \fI<destdir>\fP instead of the +current working directory. .SH CONFIGURATION Configuration options are stored in \fI/etc/makepkg.conf\fP. This file is parsed diff --git a/doc/pacman.8.in b/doc/pacman.8.in index ce9e699c..2113fc21 100644 --- a/doc/pacman.8.in +++ b/doc/pacman.8.in @@ -1,4 +1,4 @@ -.TH pacman 8 "April 10, 2003" "pacman #VERSION#" "" +.TH pacman 8 "May 27, 2003" "pacman #VERSION#" "" .SH NAME pacman \- package manager utility .SH SYNOPSIS @@ -14,18 +14,6 @@ the local system. pacman package are \fIgzipped tar\fP format. Add a package to the system. Package will be uncompressed into the installation root and the database will be updated. .TP -.B "\-R, \-\-remove" -Remove a package from the system. Files belonging to the -specified package will be deleted, and the database will -be updated. Most configuration files will be saved with a -\fI.pacsave\fP extension unless the \fB--nosave\fP option was -used. -.TP -.B "\-U, \-\-upgrade" -Upgrade a package. This is essentially a "remove-then-add" -process. See \fBHANDLING CONFIG FILES\fP for an explanation -on how pacman takes care of config files. -.TP .B "\-F, \-\-freshen" This is like --upgrade except that, unlike --upgrade, this will only upgrade packages that are already installed on your system. @@ -38,6 +26,13 @@ build date, size). This can be run against the local package database or can be used on individual .tar.gz packages. See \fBQUERY OPTIONS\fP below. .TP +.B "\-R, \-\-remove" +Remove a package from the system. Files belonging to the +specified package will be deleted, and the database will +be updated. Most configuration files will be saved with a +\fI.pacsave\fP extension unless the \fB--nosave\fP option was +used. +.TP .B "\-S, \-\-sync" Synchronize packages. With this function you can install packages directly from the ftp servers, complete with all dependencies required @@ -45,6 +40,11 @@ to run the packages. For example, \fBpacman -S qt\fP will download qt and all the packages it depends on and install them. You could also use \fBpacman -Su\fP to upgrade all packages that are out of date (see below). .TP +.B "\-U, \-\-upgrade" +Upgrade a package. This is essentially a "remove-then-add" +process. See \fBHANDLING CONFIG FILES\fP for an explanation +on how pacman takes care of config files. +.TP .B "\-V, \-\-version" Display version and exit. .TP @@ -53,14 +53,10 @@ Display syntax for the given operation. If no operation was supplied then the general syntax is shown. .SH OPTIONS .TP -.B "\-v, \-\-verbose" -Output more status and error messages. -.TP -.B "\-f, \-\-force" -Bypass file conflict checks,, overwriting conflicting files. If the -package that is about to be installed contains files that are already -installed, this option will cause all those files to be overwritten. -This option should be used with care, ideally not at all. +.B "\-c, \-\-cascade" +(only used with \fB--remove\fP) +Remove all target packages, as well as all packages that depend on one +or more target packages. This operation is recursive. .TP .B "\-d, \-\-nodeps" Skips all dependency checks. Normally, pacman will always check @@ -68,6 +64,12 @@ a package's dependency fields to ensure that all dependencies are installed and there are no package conflicts in the system. This switch disables these checks. .TP +.B "\-f, \-\-force" +Bypass file conflict checks,, overwriting conflicting files. If the +package that is about to be installed contains files that are already +installed, this option will cause all those files to be overwritten. +This option should be used with care, ideally not at all. +.TP .B "\-n, \-\-nosave" (only used with \fB--remove\fP) Instructs pacman to ignore file backup designations. Normally, when @@ -76,11 +78,6 @@ checked to see if the file should be renamed to a .pacsave extension. If \fB--nosave\fP is used, these designations are ignored and the files are removed. .TP -.B "\-c, \-\-cascade" -(only used with \fB--remove\fP) -Remove all target packages, as well as all packages that depend on one -or more target packages. This operation is recursive. -.TP .B "\-r, \-\-root <path>" Specify alternative installation root (default is "/"). This should \fInot\fP be used as a way to install software into @@ -89,12 +86,19 @@ if you want to install a package on a temporary mounted partition, which is "owned" by another system. By using this option you not only specify where the software should be installed, but you also specify which package database to use. +.TP +.B "\-v, \-\-verbose" +Output more status and error messages. .SH SYNC OPTIONS .TP -.B "\-y, \-\-refresh" -Download a fresh copy of the master package list from the ftp server -defined in \fI/etc/pacman.conf\fP. This should typically be used each -time you use \fB--sysupgrade\fP. +.B "\-c, \-\-clean" +Remove packages from the cache. When pacman downloads packages, +it saves them in \fI/var/cache/pacman/pkg\fP. If you need to free up +diskspace, you can remove these packages by using the --clean option. +.TP +.B "\-s, \-\-search <string>" +This will search each package in the package list for names or descriptions +that contains <string>. .TP .B "\-u, \-\-sysupgrade" Upgrades all packages that are out of date. pacman will examine every @@ -104,29 +108,25 @@ it wants to upgrade and will not proceed without user confirmation. Dependencies are automatically resolved at this level and will be installed/upgraded if necessary. .TP -.B "\-s, \-\-search <string>" -This will search each package in the package list for names or descriptions -that contains <string>. -.TP .B "\-w, \-\-downloadonly" Retrieve all packages from the server, but do not install/upgrade anything. .TP -.B "\-c, \-\-clean" -Remove packages from the cache. When pacman downloads packages, -it saves them in \fI/var/cache/pacman/pkg\fP. If you need to free up -diskspace, you can remove these packages by using the --clean option. +.B "\-y, \-\-refresh" +Download a fresh copy of the master package list from the ftp server +defined in \fI/etc/pacman.conf\fP. This should typically be used each +time you use \fB--sysupgrade\fP. .SH QUERY OPTIONS .TP -.B "\-o, \-\-owns <file>" -Search for the package that owns <file>. +.B "\-i, \-\-info" +Display information on a given package. If it is used with the \fB-p\fP +option then the .PKGINFO file will be printed. .TP .B "\-l, \-\-list" List all files owned by <package>. Multiple packages can be specified on the command line. .TP -.B "\-i, \-\-info" -Display information on a given package. If it is used with the \fB-p\fP -option then the .PKGINFO file will be printed. +.B "\-o, \-\-owns <file>" +Search for the package that owns <file>. .TP .B "\-p, \-\-file" Tells pacman that the package supplied on the command line is a @@ -185,9 +185,9 @@ Server = local:///home/pkgs .RE .SH CONFIG: OPTIONS .TP -.B "NoUpgrade = <file> [file] ..." -All files listed with a \fBNoUpgrade\fP directive will never be touched during a package -install/upgrade. \fINote:\fP do not include the leading slash when specifying files. +.B "DBPath = /path/to/db/dir" +Overrides the default location of the toplevel database directory. The default is +\fI/var/lib/pacman\fP. .TP .B "IgnorePkg = <package> [package] ..." Instructs pacman to ignore any upgrades for this package when performing a @@ -195,6 +195,10 @@ Instructs pacman to ignore any upgrades for this package when performing a .TP .B "NoPassiveFtp" Disables passive ftp connections when downloading packages. (aka Active Mode) +.TP +.B "NoUpgrade = <file> [file] ..." +All files listed with a \fBNoUpgrade\fP directive will never be touched during a package +install/upgrade. \fINote:\fP do not include the leading slash when specifying files. .SH CONFIG: REPOSITORIES Each repository section defines a section name and at least one location where the packages |