diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Doxyfile | 20 | ||||
| -rw-r--r-- | doc/PKGBUILD.5.txt | 3 | ||||
| -rw-r--r-- | doc/makepkg.conf.5.txt | 10 | ||||
| -rw-r--r-- | doc/pacman.8.txt | 29 | ||||
| -rw-r--r-- | doc/pacman.conf.5.txt | 11 | ||||
| -rw-r--r-- | doc/repo-add.8.txt | 13 |
6 files changed, 60 insertions, 26 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/PKGBUILD.5.txt b/doc/PKGBUILD.5.txt index ac394729..aa870097 100644 --- a/doc/PKGBUILD.5.txt +++ b/doc/PKGBUILD.5.txt @@ -182,6 +182,9 @@ Options and Directives *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/makepkg.conf.5.txt b/doc/makepkg.conf.5.txt index f6e4b382..113ad140 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 f6eb69c3..a6bc3d9a 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,11 +79,17 @@ 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 @@ -226,7 +225,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]] @@ -241,10 +245,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..5514e2c0 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 ------- @@ -117,6 +119,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 |