diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Doxyfile | 20 | ||||
| -rw-r--r-- | doc/Makefile.am | 10 | ||||
| -rw-r--r-- | doc/PKGBUILD-example.txt | 6 | ||||
| -rw-r--r-- | doc/PKGBUILD.5.txt | 16 | ||||
| -rw-r--r-- | doc/footer.txt | 11 | ||||
| -rw-r--r-- | doc/makepkg.8.txt | 7 | ||||
| -rw-r--r-- | doc/makepkg.conf.5.txt | 10 | ||||
| -rw-r--r-- | doc/pacman.8.txt | 36 | ||||
| -rw-r--r-- | doc/pacman.conf.5.txt | 28 | ||||
| -rw-r--r-- | doc/repo-add.8.txt | 13 |
10 files changed, 101 insertions, 56 deletions
diff --git a/doc/Doxyfile b/doc/Doxyfile index 5174c651..f287bbcd 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -1,4 +1,4 @@ -# Doxyfile 1.5.2 +# Doxyfile 1.5.5 #--------------------------------------------------------------------------- # Project related configuration options @@ -28,7 +28,8 @@ FULL_PATH_NAMES = NO STRIP_FROM_PATH = STRIP_FROM_INC_PATH = SHORT_NAMES = NO -JAVADOC_AUTOBRIEF = NO +JAVADOC_AUTOBRIEF = YES +QT_AUTOBRIEF = NO MULTILINE_CPP_IS_BRIEF = NO DETAILS_AT_TOP = NO INHERIT_DOCS = YES @@ -37,10 +38,14 @@ TAB_SIZE = 4 ALIASES = OPTIMIZE_OUTPUT_FOR_C = YES OPTIMIZE_OUTPUT_JAVA = NO +OPTIMIZE_FOR_FORTRAN = NO +OPTIMIZE_OUTPUT_VHDL = NO BUILTIN_STL_SUPPORT = NO CPP_CLI_SUPPORT = NO +SIP_SUPPORT = NO DISTRIBUTE_GROUP_DOC = NO SUBGROUPING = YES +TYPEDEF_HIDES_STRUCT = NO #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- @@ -49,6 +54,7 @@ EXTRACT_PRIVATE = NO EXTRACT_STATIC = NO EXTRACT_LOCAL_CLASSES = YES EXTRACT_LOCAL_METHODS = NO +EXTRACT_ANON_NSPACES = NO HIDE_UNDOC_MEMBERS = NO HIDE_UNDOC_CLASSES = NO HIDE_FRIEND_COMPOUNDS = NO @@ -60,6 +66,7 @@ SHOW_INCLUDE_FILES = YES INLINE_INFO = YES SORT_MEMBER_DOCS = YES SORT_BRIEF_DOCS = NO +SORT_GROUP_NAMES = NO SORT_BY_SCOPE_NAME = NO GENERATE_TODOLIST = YES GENERATE_TESTLIST = YES @@ -126,6 +133,10 @@ HTML_FOOTER = HTML_STYLESHEET = HTML_ALIGN_MEMBERS = YES GENERATE_HTMLHELP = NO +GENERATE_DOCSET = NO +DOCSET_FEEDNAME = "Doxygen generated docs" +DOCSET_BUNDLE_ID = org.doxygen.Project +HTML_DYNAMIC_SECTIONS = NO CHM_FILE = HHC_LOCATION = GENERATE_CHI = NO @@ -194,7 +205,9 @@ EXPAND_ONLY_PREDEF = YES SEARCH_INCLUDES = YES INCLUDE_PATH = ../.. INCLUDE_FILE_PATTERNS = *.h -PREDEFINED = HAVE_CONFIG_H= SYMHIDDEN= SYMEXPORT= +PREDEFINED = HAVE_CONFIG_H= \ + SYMHIDDEN= \ + SYMEXPORT= EXPAND_AS_DEFINED = SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- @@ -227,6 +240,7 @@ DOT_IMAGE_FORMAT = png DOT_PATH = DOTFILE_DIRS = DOT_GRAPH_MAX_NODES = 50 +MAX_DOT_GRAPH_DEPTH = 3 DOT_TRANSPARENT = NO DOT_MULTI_TARGETS = NO GENERATE_LEGEND = YES diff --git a/doc/Makefile.am b/doc/Makefile.am index eba950e3..476a21c3 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -32,6 +32,14 @@ EXTRA_DIST = \ MOSTLYCLEANFILES = *.xml MAINTAINERCLEANFILES = $(ASCIIDOC_MANS) +if USE_GIT_VERSION +GIT_VERSION := $(shell sh -c 'git describe --abbrev=4 | sed s/^v//')-dirty +REAL_PACKAGE_VERSION = $(GIT_VERSION) +else +REAL_PACKAGE_VERSION = $(PACKAGE_VERSION) +endif + + man_MANS = dist_man_MANS = $(ASCIIDOC_MANS) repo-remove.8 @@ -47,7 +55,7 @@ endif if USE_ASCIIDOC ASCIIDOC_OPTS = \ -f asciidoc.conf \ - -a pacman_version="$(PACKAGE_VERSION)" \ + -a pacman_version="$(REAL_PACKAGE_VERSION)" \ -a pacman_date="`date +%Y-%m-%d`" \ -a sysconfdir=$(sysconfdir) A2X_OPTS = \ diff --git a/doc/PKGBUILD-example.txt b/doc/PKGBUILD-example.txt index 2cc53808..0477cb1a 100644 --- a/doc/PKGBUILD-example.txt +++ b/doc/PKGBUILD-example.txt @@ -1,4 +1,4 @@ -# Maintainer: judd <jvinet@zeroflux.org> +# Maintainer: Joe User <joe.user@example.com> pkgname=patch pkgver=2.5.4 @@ -13,8 +13,8 @@ source=(ftp://ftp.gnu.org/gnu/$pkgname/$pkgname-$pkgver.tar.gz) md5sums=('ee5ae84d115f051d87fcaaef3b4ae782') build() { - cd $startdir/src/$pkgname-$pkgver + cd $srcdir/$pkgname-$pkgver ./configure --prefix=/usr make || return 1 - make prefix=$startdir/pkg/usr install + make prefix=$pkgdir/usr install } diff --git a/doc/PKGBUILD.5.txt b/doc/PKGBUILD.5.txt index f4ddc839..b90d67a7 100644 --- a/doc/PKGBUILD.5.txt +++ b/doc/PKGBUILD.5.txt @@ -99,14 +99,13 @@ similar to `$_basekernver`. source array (in the same order). makepkg will use this to verify source file integrity during subsequent builds. To easily generate md5sums, run ``makepkg -g >> PKGBUILD''. If desired, move the md5sums line to an - appropriate location. *NOTE:* makepkg supports multiple integrity - algorithms and their corresponding arrays (i.e. sha1sums for the SHA1 - algorithm); however, official packages use only md5sums for the time - being. + appropriate location. -*sha1sums, etc.*:: - Alternative integrity checks that makepkg supports, as noted in md5sums - above. +*sha1sums, sha256sums, sha384sums, sha512sums (arrays)*:: + Alternative integrity checks that makepkg supports; these all behave + similar to the md5sums option described above. To enable use and generation + of these checksums, be sure to set up the `INTEGRITY_CHECK` option in + linkman:makepkg.conf[5]. *groups (array)*:: An array of symbolic names that represent groups of packages, allowing @@ -192,6 +191,9 @@ similar to `$_basekernver`. *emptydirs*;; Leave empty directories in packages. + *zipman*;; + Compress man pages with gzip. + *ccache*;; Allow the use of ccache during build. More useful in its negative form `!ccache` with select packages that have problems building diff --git a/doc/footer.txt b/doc/footer.txt index 15bb479b..8290f3c4 100644 --- a/doc/footer.txt +++ b/doc/footer.txt @@ -15,9 +15,16 @@ mailto:pacman-dev@archlinux.org[]. Authors ------- + +Current maintainers: + +* Dan McGee <dan@archlinux.org> +* Xavier Chantry <shiningxc@gmail.com> +* Aaron Griffin <aaron@archlinux.org> + +Past contributors: + * Judd Vinet <jvinet@zeroflux.org> * Aurelien Foret <aurelien@archlinux.org> -* Aaron Griffin <aaron@archlinux.org> -* Dan McGee <dan@archlinux.org> See the 'AUTHORS' file for additional contributors. diff --git a/doc/makepkg.8.txt b/doc/makepkg.8.txt index 59108f1b..068cbcb5 100644 --- a/doc/makepkg.8.txt +++ b/doc/makepkg.8.txt @@ -45,13 +45,6 @@ Options for rebuilding packages from source when the PKGBUILD may be slightly outdated and not updated with an `$$arch=('yourarch')$$` field. -*-b, \--builddeps*:: - Build missing dependencies from source. When makepkg finds missing - build-time or run-time dependencies, it will look for the dependencies' - PKGBUILD files under `SRCROOT` (set in linkman:makepkg.conf[5]). If it - finds them it will call makepkg to build and install the missing - dependencies. The child calls will be made with the `-b` and `-i` options. - *-c, \--clean*:: Clean up leftover work files and directories after a successful build. diff --git a/doc/makepkg.conf.5.txt b/doc/makepkg.conf.5.txt index f6e4b382..b5a49ba8 100644 --- a/doc/makepkg.conf.5.txt +++ b/doc/makepkg.conf.5.txt @@ -37,6 +37,9 @@ Options well; the download URL is placed on the end of the command. This is more flexible than the former `FTPAGENT` variable, as any protocol can have a download agent. Several examples are provided in the default makepkg.conf. + All instances of `%u` will be replaced with the download URL. If present, + instances of `%o` will be replaced with the local filename, plus a ``.part'' + extension, which allows to do file resumes properly. **CARCH=**"carch":: Specifies your computer architecture; possible values include such things @@ -94,8 +97,8 @@ Options running in the DistCC cluster. In addition, you will want to modify your `MAKEFLAGS`. -**OPTIONS=(**strip !docs libtool emptydirs**)**:: - This array contains options that affect the default packaging. All four are +**OPTIONS=(**strip docs libtool emptydirs zipman**)**:: + This array contains options that affect the default packaging. They are equivalent to options that can be placed in the PKGBUILD; 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 @@ -117,6 +120,9 @@ Options *emptydirs*;; Leave empty directories in packages. + *zipman*;; + Compress man pages with gzip. + **INTEGRITY_CHECK=(**check1 ...**)**:: File integrity checks to use. Multiple checks may be specified; this affects both generation and checking. The current valid options are: diff --git a/doc/pacman.8.txt b/doc/pacman.8.txt index 8c37e387..5594ac61 100644 --- a/doc/pacman.8.txt +++ b/doc/pacman.8.txt @@ -28,13 +28,6 @@ ends to be written (for instance, a GUI front end). Operations ---------- -*-A, \--add* (deprecated):: - Add a package to the system. Either a URL or file path can be specified. - The package will be uncompressed into the installation root and the - database will be updated. The package will not be installed if another - version is already installed. *NOTE*: please use '\--upgrade' in place of - this option. - *-Q, \--query*:: Query the package database. This operation allows you to view installed packages and their files, as well as meta-information about individual @@ -86,16 +79,22 @@ You can also use `pacman -Su` to upgrade all packages that are out of date. See Options ------- *\--asdeps*:: - Install packages non-explicitly; in other works, fake their install reason + Install packages non-explicitly; in other words, fake their install reason to be installed as a dependency. This is useful for makepkg and other build from source tools that need to install dependencies before building the package. +*\--asexplicit*:: + Install packages explicitly; in other words, fake their install reason to + be explicitly installed. This is useful if you want to mark a dependency + as explicitly installed so it will not be removed by the '\--recursive' + remove operation. + *-b, \--dbpath* <'path'>:: Specify an alternative database location (a typical default is ``/var/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. This behavior changed in pacman 3.1.0. + not automatically prepended. *-d, \--nodeps*:: Skips all dependency checks. Normally, pacman will always check a @@ -113,7 +112,7 @@ Options not be used as a way to install software into ``/usr/local'' instead of ``/usr''. This option is used if you want to install a package on a temporary mounted partition which is "owned" by another system. - *NOTE*: If database path or logfile are not specified on either the + *NOTE*: if database path or logfile are not specified on either the command line or in linkman:pacman.conf[5], their default location will be inside this root path. @@ -124,8 +123,7 @@ Options Specify an alternative package cache location (a typical default is ``/var/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. This - behavior changed in pacman 3.1.0. + is an absolute path, the root path is not automatically prepended. *\--config* <'file'>:: Specify an alternate configuration file. @@ -231,7 +229,12 @@ Remove Options[[RO]] that (A) they are not required by other packages; and (B) they were not explicitly installed by the user. This operation is recursive and analogous to a backwards '\--sync' operation, and helps keep a clean system without - orphans. + orphans. If you want to omit condition (B), pass this option twice. + +*-u, \--unneeded*:: + Removes the targets that are not required by any other packages. + This is mostly useful when removing a group without using the '-c' option, + to avoid breaking any dependencies. Sync Options[[SO]] @@ -246,10 +249,9 @@ Sync Options[[SO]] packages that are no longer installed; use two to remove all packages from the cache. In both cases, you will have a yes or no option to remove packages and/or unused downloaded databases. - -*-e, \--dependsonly*:: - Install all dependencies of a package, but not the specified package - itself. This is pretty useless and we're not sure why it even exists. ++ +If you use a network shared cache, see the 'CleanMethod' option in +linkman:pacman.conf[5]. *-g, \--groups*:: Display all the members for each package group specified. If no group diff --git a/doc/pacman.conf.5.txt b/doc/pacman.conf.5.txt index cb9d2c55..20a90671 100644 --- a/doc/pacman.conf.5.txt +++ b/doc/pacman.conf.5.txt @@ -40,6 +40,8 @@ Include = /etc/pacman.d/core Server = file:///home/pkgs -------- +*NOTE*: Each directive must be in CamelCase. If the case isn't respected, the directive +won't be recognized. For example. noupgrade or NOUPGRADE will not work. Options ------- @@ -55,7 +57,7 @@ Options Overrides the default location of the toplevel database directory. A typical default is ``/var/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. This behavior changed in pacman 3.1.0. + path is not automatically prepended. *CacheDir =* path/to/cache/dir:: Overrides the default location of the package cache directory. A typical @@ -63,14 +65,13 @@ Options 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 - path, the root path is not automatically prepended. This behavior changed - in pacman 3.1.0. + path, the root path is not automatically prepended. *LogFile =* '/path/to/file':: - Log actions directly to a file. A typical default is - ``/var/log/pacman.log''. As of pacman 3.1.0, this does not need to be - specified by default. This is an absolute path and root is not prepended. + Overrides the default location of the pacman log file. A typical default + is ``/var/log/pacman.log''. This is an absolute path and the root directory + is not prepended. *HoldPkg =* package ...:: If a user tries to '\--remove' a package that's listed in `HoldPkg`, @@ -80,6 +81,12 @@ Options Instructs pacman to ignore any upgrades for this package when performing a '\--sysupgrade'. +*SyncFirst =* package ...:: + Instructs pacman to check for newer version of these packages before any + sync operation. The user will have the choice to either cancel the current + operation and upgrade these packages first or go on with the current operation. + This option is typically used with the 'pacman' package. + *IgnoreGroup =* group ...:: Instructs pacman to ignore any upgrades for all packages in this group when performing a '\--sysupgrade'. @@ -117,6 +124,15 @@ Options These files refer to files in the package archive, so do not include the leading slash (the RootDir) when specifying them. +*CleanMethod =* KeepInstalled | KeepCurrent:: + If set to `KeepInstalled` (the default), the '-Sc' operation will clean + packages that are no longer installed (not present in the local database). + If set to `KeepCurrent`, '-Sc' will clean outdated packages (not present in + any sync database). + The second behavior is useful when the package cache is shared among + multiple machines, where the local databases are usually different, but the + sync databases in use could be the same. + *UseSyslog*:: Log action messages through syslog(). This will insert log entries into ``/var/log/messages'' or equivalent. diff --git a/doc/repo-add.8.txt b/doc/repo-add.8.txt index 5664949f..d3b85762 100644 --- a/doc/repo-add.8.txt +++ b/doc/repo-add.8.txt @@ -16,9 +16,9 @@ repo-add - package database maintenance utility Synopsis -------- -repo-add <path-to-db> [--force] <package> ... +repo-add [-q] <path-to-db> <package> ... -repo-remove <path-to-db> <packagename> ... +repo-remove [-q] <path-to-db> <packagename> ... Description @@ -36,12 +36,9 @@ on the command line. Options ------- -*--force* (repo-add only):: - Add a force entry to the sync database, which tells pacman to skip version - number comparison and update the package regardless. This flag can be - specified in the middle of the command line, with any packages listed - before the flag being added as normal entries, and any specified after - being marked as force upgrades. +*-q, \--quiet*:: + Force this program to keep quiet and run silent except for warning and + error messages. See Also |