diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile.am | 4 | ||||
| -rw-r--r-- | doc/PKGBUILD.5.txt | 81 | ||||
| -rw-r--r-- | doc/asciidoc.conf | 4 | ||||
| -rw-r--r-- | doc/makepkg.8.txt | 2 | ||||
| -rw-r--r-- | doc/makepkg.conf.5.txt | 2 | ||||
| -rw-r--r-- | doc/pacman-key.8.txt | 4 | ||||
| -rw-r--r-- | doc/pacman.8.txt | 15 | ||||
| -rw-r--r-- | doc/pacman.conf.5.txt | 14 |
8 files changed, 65 insertions, 61 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index def58c4e..bc0244c2 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -92,9 +92,9 @@ html: $(HTML_DOCS) website: html bsdtar czf website.tar.gz $(HTML_DOCS) \ -C /etc/asciidoc/stylesheets/ \ - xhtml11.css xhtml11-manpage.css xhtml11-quirks.css \ + asciidoc.css asciidoc-manpage.css \ -C /etc/asciidoc/javascripts/ \ - asciidoc-xhtml11.js \ + asciidoc.js \ -C /etc/asciidoc/ \ images diff --git a/doc/PKGBUILD.5.txt b/doc/PKGBUILD.5.txt index b9b7855b..015db5fe 100644 --- a/doc/PKGBUILD.5.txt +++ b/doc/PKGBUILD.5.txt @@ -16,12 +16,12 @@ PKGBUILD Description ----------- -This manual page is meant to describe general rules about PKGBUILDs. Once a +This manual page describes general rules about PKGBUILDs. Once a PKGBUILD is written, the actual package is built using makepkg and installed with pacman. -NOTE: An example PKGBUILD, useful for reference, is located in '{pkgdatadir}'. -Also located there are other example files such as a ChangeLog and an install +NOTE: An example PKGBUILD, useful for reference, is located in '{pkgdatadir}' +along with other example files such as a ChangeLog and an install script. You can copy the provided PKGBUILD.proto file to a new package build directory and make customizations to suit your needs. @@ -30,18 +30,18 @@ Options and Directives ---------------------- The following is a list of standard options and directives available for use in a PKGBUILD. These are all understood and interpreted by makepkg, and most -will be directly transferred to the built package. +of them will be directly transferred to the built package. If you need to create any custom variables for use in your build process, it is -recommended to name your custom variables with an '_' (underscore) prefix. +recommended to prefix their name with an '_' (underscore). This will prevent any possible name clashes with internal makepkg variables. For example, to store the base kernel version in a variable, use something similar to `$_basekernver`. *pkgname (array)*:: - The name of the package. This has be a unix-friendly name as it will be - used in the package filename. Members of the array are not allowed to start - with hyphens. + The name of the package or an array of names for split packages. + Because it will be used in the package filename, this has to be unix-friendly. + Members of the array are not allowed to start with hyphens. *pkgver*:: The version of the software as released from the author (e.g. '2.7.1'). @@ -50,13 +50,13 @@ similar to `$_basekernver`. *pkgrel*:: This is the release number specific to the Arch Linux release. This allows package maintainers to make updates to the package's configure - flags, for example. A pkgrel of '1' is typically used for each upstream - software release and is incremented for intermediate PKGBUILD updates. The + flags, for example. This is typically (re)set to '1' for each new upstream + software release and incremented for intermediate PKGBUILD updates. The variable is not allowed to contain hyphens. *pkgdesc*:: This should be a brief description of the package and its functionality. - Try to keep the description to one line of text. + Try to keep the description to one line of text and not use the package's name. *epoch*:: Used to force the package to be seen as newer than any previous versions @@ -69,18 +69,18 @@ similar to `$_basekernver`. *url*:: This field contains a URL that is associated with the software being - packaged. This is typically the project's website. + packaged. Typically the project's website. *license (array)*:: This field specifies the license(s) that apply to the package. - Commonly-used licenses are found in '/usr/share/licenses/common'. If you + Commonly used licenses can be found in '/usr/share/licenses/common'. If you see the package's license there, simply reference it in the license field (e.g. `license=('GPL')`). If the package provides a license not - found in '/usr/share/licenses/common', then you should include the license + available in '/usr/share/licenses/common', then you should include it in the package itself and set `license=('custom')` or `license=('custom:LicenseName')`. The license should be placed in - '$pkgdir/usr/share/licenses/$pkgname' when building the package. If - multiple licenses are applicable for a package, list all of them: + '$pkgdir/usr/share/licenses/$pkgname/' when building the package. If + multiple licenses are applicable, list all of them: `license=('GPL' 'FDL')`. *install*:: @@ -97,22 +97,21 @@ similar to `$_basekernver`. *source (array)*:: An array of source files required to build the package. Source files - must either reside in the same directory as the PKGBUILD file, or be a - fully-qualified URL that makepkg will use to download the file. In order - to make the PKGBUILD as useful as possible, use the $pkgname and $pkgver - variables if possible when specifying the download location. Any files - that are compressed will automatically be extracted, unless found in - the noextract array listed below. + must either reside in the same directory as the PKGBUILD, or be a + fully-qualified URL that makepkg can use to download the file. + To make the PKGBUILD as useful as possible, use the $pkgname and $pkgver + variables if possible when specifying the download location. Compressed files + will be extracted automatically unless found in + the noextract array described below. + -It is also possible to specify an optional filename, which is helpful +It is also possible to overwrite the filename, which is helpful with weird URLs and for handling multiple source files with the same name. The syntax is: `source=('filename::url')`. *noextract (array)*:: An array of filenames corresponding to those from the source array. Files listed here will not be extracted with the rest of the source files. This - is useful for packages which use compressed data which is downloaded but - not necessary to uncompress. + is useful for packages that use compressed data directly. *md5sums (array)*:: This array contains an MD5 hash for every source file specified in the @@ -135,16 +134,16 @@ name. The syntax is: `source=('filename::url')`. *arch (array)*:: Defines on which architectures the given package is available (e.g. `arch=('i686' 'x86_64')`). Packages that contain no architecture specific - files may use arch=('any'). + files should use arch=('any'). *backup (array)*:: - A space-delimited array of filenames, without preceding slashes, that + An array of filenames, without preceding slashes, that should be backed up if the package is removed or upgraded. This is commonly used for packages placing configuration files in /etc. See Handling Config Files in linkman:pacman[8] for more information. *depends (array)*:: - An array of packages that this package depends on to run. Packages in + An array of packages this package depends on to run. Entries in this list should be surrounded with single quotes and contain at least the package name. Entries can also include a version requirement of the form 'name<>version', where <> is one of five comparisons: >= (greater @@ -157,12 +156,12 @@ append the version needed by the binary. Appending the version yourself disables auto detection. *makedepends (array)*:: - An array of packages that this package depends on to build, but are not + An array of packages this package depends on to build but are not needed at runtime. Packages in this list follow the same format as depends. *checkdepends (array)*:: - An array of packages that this package depends on to run its test suite, + An array of packages this package depends on to run its test suite but are not needed at runtime. Packages in this list follow the same format as depends. These dependencies are only considered when the check() function is present and is to be run by makepkg. @@ -182,7 +181,7 @@ disables auto detection. same format as depends. Versioned conflicts are also supported. *provides (array)*:: - An array of ``virtual provisions'' that this package provides. This allows + An array of ``virtual provisions'' this package provides. This allows a package to provide dependencies other than its own package name. For example, the dcron package can provide 'cron', which allows packages to depend on 'cron' rather than 'dcron OR fcron'. @@ -197,7 +196,7 @@ try to find the library in the built package and append the correct version. Appending the version yourself disables auto detection. *replaces (array)*:: - An array of packages that this package should replace, and can be used + An array of packages this package should replace. This can be used to handle renamed/combined packages. For example, if the 'j2re' package is renamed to 'jre', this directive allows future upgrades to continue as expected even though the package has moved. Sysupgrade is currently @@ -257,7 +256,7 @@ version. Appending the version yourself disables auto detection. build() Function ---------------- -In addition to the above directives, the optional build() bash function usually +In addition to the above directives, the optional build() function usually comprises the remainder of the PKGBUILD. This is directly sourced and executed by makepkg, so anything that bash or the system has available is available for use here. The function is run in `bash -e` mode, meaning any command that exits @@ -265,22 +264,22 @@ with a non-zero status will cause the function to exit. Be sure any exotic commands used are covered by `makedepends`. All of the above variables such as `pkgname` and `pkgver` are available for use -in the build function. In addition, makepkg defines three variables for your -use during the build and install process. These three variables are as follows: +in the build function. In addition, makepkg defines the following three +variables for use during the build and install process: *startdir*:: - This contains the absolute path to the directory where the PKGBUILD was + This contains the absolute path to the directory where the PKGBUILD is located, which is usually the output of `$(pwd)` when makepkg is started. *srcdir*:: - This points to the directory where makepkg extracts or copies all source + This points to the directory where makepkg extracts to or copies to all source files. *pkgdir*:: This points to the directory where makepkg bundles the installed package (this directory will become the root directory of your built package). -If you create any variables of your own in the build function, it is +If you create any variables on your own in the build function, it is recommended to use the bash `local` keyword to scope the variable to inside the build function. @@ -310,8 +309,8 @@ Each split package uses a corresponding packaging function with name `package_foo()`, where `foo` is the name of the split package. All options and directives for the split packages default to the global values -given within the PKGBUILD. However, some of these can be overridden within each -split package's packaging function. The following variables can be overridden: +given in the PKGBUILD. Nevertheless, the following ones can be overridden within +each split package's packaging function: `pkgver`, `pkgrel`, `pkgdesc`, `arch`, `license`, `groups`, `depends`, `optdepends`, `provides`, `conflicts`, `replaces`, `backup`, `options`, `install` and `changelog`. @@ -372,7 +371,7 @@ makepkg supports building development versions of packages without having to manually update the pkgver in the PKGBUILD. This was formerly done using the separate utility 'versionpkg'. In order to utilize this functionality, your PKGBUILD must use correct variable names depending on the SCM being fetched -from. +from (e.g., "makepkg-git", "mplayer-svn"). *CVS*:: The generated pkgver will be the date the package is built. diff --git a/doc/asciidoc.conf b/doc/asciidoc.conf index 3ea510d8..e2e72672 100644 --- a/doc/asciidoc.conf +++ b/doc/asciidoc.conf @@ -17,7 +17,11 @@ plus=+ caret=^ startsb=[ endsb=] +backslash=\ tilde=~ +apostrophe=' +backtick=` +litdd=-- ifdef::backend-docbook[] [linkman-inlinemacro] diff --git a/doc/makepkg.8.txt b/doc/makepkg.8.txt index 1a2dcd04..e61f7ab3 100644 --- a/doc/makepkg.8.txt +++ b/doc/makepkg.8.txt @@ -53,7 +53,7 @@ Options in linkman:makepkg.conf[5]. *\--config* <file>:: - Use an alternate config file instead of the `{sysconfdir}/makepkg.conf` + Use an alternate config file instead of the +{sysconfdir}/makepkg.conf+ default. *-d, \--nodeps*:: diff --git a/doc/makepkg.conf.5.txt b/doc/makepkg.conf.5.txt index 9d3ad0a1..3ce4759f 100644 --- a/doc/makepkg.conf.5.txt +++ b/doc/makepkg.conf.5.txt @@ -70,7 +70,7 @@ Options This is often used to set the number of jobs used, for example, `-j2`. Other flags that make accepts can also be passed. -**BUILDENV=(**fakeroot !distcc color !ccache !sign**)**:: +**BUILDENV=(**fakeroot !distcc color !ccache check !sign**)**:: This array contains options that affect the build environment, the defaults are shown here. All options should always be left in the array; to enable or disable an option simply remove or place an ``!'' at the front of the diff --git a/doc/pacman-key.8.txt b/doc/pacman-key.8.txt index 8a08480f..892f14df 100644 --- a/doc/pacman-key.8.txt +++ b/doc/pacman-key.8.txt @@ -25,12 +25,12 @@ and export keys, fetch keys from keyservers and update the key trust database. Options ------- *\--config* <file>:: - Use an alternate config file instead of the `{sysconfdir}/pacman.conf` + Use an alternate config file instead of the +{sysconfdir}/pacman.conf+ default. *\--gpgdir* <dir>:: Set an alternate home directory for GnuPG. If unspecified, the value is - read from `{sysconfdir}/pacman.conf`. + read from +{sysconfdir}/pacman.conf+. Commands diff --git a/doc/pacman.8.txt b/doc/pacman.8.txt index 6270dbd8..531c992a 100644 --- a/doc/pacman.8.txt +++ b/doc/pacman.8.txt @@ -117,7 +117,7 @@ Options ------- *-b, \--dbpath* <path>:: Specify an alternative database location (a typical default is - `{localstatedir}/lib/pacman`). This should not be used unless you know what you are + +{localstatedir}/lib/pacman+). This should not be used unless you know what you are doing. *NOTE*: if specified, this is an absolute path and the root path is not automatically prepended. @@ -138,7 +138,7 @@ Options *\--cachedir* <dir>:: Specify an alternative package cache location (a typical default is - `{localstatedir}/cache/pacman/pkg`). Multiple cache directories can be specified, + +{localstatedir}/cache/pacman/pkg+). Multiple cache directories can be specified, and they are tried in the order they are passed to pacman. *NOTE*: this is an absolute path, the root path is not automatically prepended. @@ -150,11 +150,12 @@ Options to be used. *\--gpgdir* <dir>:: - Specify a directory of files used by GnuPG to verify package signatures. - This directory should contain two files: `pubring.gpg` and `trustdb.gpg`. - `pubring.gpg` holds the public keys of all packagers. `trustdb.gpg` - contains a so-called trust database, which specifies that the keys are - authentic and trusted. + Specify a directory of files used by GnuPG to verify package signatures (a + typical default is +{sysconfdir}/pacman.d/gnupg+). This directory should contain + two files: `pubring.gpg` and `trustdb.gpg`. `pubring.gpg` holds the public keys + of all packagers. `trustdb.gpg` contains a so-called trust database, which + specifies that the keys are authentic and trusted. *NOTE*: this is an absolute + path, the root path is not automatically prepended. *\--logfile* <file>:: Specify an alternate log file. This is an absolute path, regardless of diff --git a/doc/pacman.conf.5.txt b/doc/pacman.conf.5.txt index 99fb0fa4..bdf0bc83 100644 --- a/doc/pacman.conf.5.txt +++ b/doc/pacman.conf.5.txt @@ -35,7 +35,7 @@ NoUpgrade = etc/passwd etc/group etc/shadow NoUpgrade = etc/fstab [core] -Include = {sysconfdir}/pacman.d/core +Include = /etc/pacman.d/core [custom] Server = file:///home/pkgs @@ -57,13 +57,13 @@ Options *DBPath =* path/to/db/dir:: Overrides the default location of the toplevel database directory. A - typical default is `{localstatedir}/lib/pacman/`. Most users will not need to set + typical default is +{localstatedir}/lib/pacman/+. Most users will not need to set this option. *NOTE*: if specified, this is an absolute path and the root path is not automatically prepended. *CacheDir =* path/to/cache/dir:: Overrides the default location of the package cache directory. A typical - default is `{localstatedir}/cache/pacman/pkg/`. Multiple cache directories can be + default is +{localstatedir}/cache/pacman/pkg/+. Multiple cache directories can be specified, and they are tried in the order they are listed in the config file. If a file is not found in any cache directory, it will be downloaded to the first cache directory with write access. *NOTE*: this is an absolute @@ -71,7 +71,7 @@ Options *GPGDir =* path/to/gpg/dir:: Overrides the default location of the directory containing configuration - files for GnuPG. A typical default is `{sysconfdir}/pacman.d/gnupg/`. + files for GnuPG. A typical default is +{sysconfdir}/pacman.d/gnupg/+. This directory should contain two files: `pubring.gpg` and `trustdb.gpg`. `pubring.gpg` holds the public keys of all packagers. `trustdb.gpg` contains a so-called trust database, which specifies that the keys are @@ -81,7 +81,7 @@ Options *LogFile =* '/path/to/file':: Overrides the default location of the pacman log file. A typical default - is `{localstatedir}/log/pacman.log`. This is an absolute path and the root directory + is +{localstatedir}/log/pacman.log+. This is an absolute path and the root directory is not prepended. *HoldPkg =* package ...:: @@ -158,7 +158,7 @@ Options *UseSyslog*:: Log action messages through syslog(). This will insert log entries into - `{localstatedir}/log/messages` or equivalent. + +{localstatedir}/log/messages+ or equivalent. *UseDelta*:: Download delta files instead of complete packages if possible. Requires @@ -225,7 +225,7 @@ directory with these packages so pacman can find it when run with '\--refresh'. The above command will generate a compressed database named '/home/pkgs/custom.db.tar.gz'. Note that the database must be of the form -'{treename}.db.tar.gz', where '{treename}' is the name of the section defined in +'\{treename\}.db.tar.gz', where '\{treename\}' is the name of the section defined in the configuration file. That's it! Now configure your custom section in the configuration file as shown in the config example above. Pacman will now use your package repository. If you add new packages to the repository, remember to |