summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAge
* Expand PKGBUILD documentationDan McGee2008-06-14
| | | | | | | | Add documentation for $startdir, $srcdir, and $pkgdir variables, as well as general information about the build() function and about custom variables in PKGBUILDs. This addresses FS#10634. Signed-off-by: Dan McGee <dan@archlinux.org>
* Document pacman -q/--quiet operationDan McGee2008-06-14
| | | | | | Fixes FS#10644. Signed-off-by: Dan McGee <dan@archlinux.org>
* Fix manpage typoDan McGee2008-03-30
| | | | | | Noticed in FS#10025. Signed-off-by: Dan McGee <dan@archlinux.org>
* Clarify the NoUpgrade and NoExtract behavior.Chantry Xavier2008-03-10
| | | | Signed-off-by: Chantry Xavier <shiningxc@gmail.com>
* doc/makepkg: document --log, address locale issuesDan McGee2008-02-05
| | | | | | | | Looks like no one ever documented -L/--log, so do that now. In addition, address some of the issues brought up in FS#9156 and add a note about build output and logs being in the current locale. Signed-off-by: Dan McGee <dan@archlinux.org>
* doc/makepkg.8: add missing '-' to manpage optionDan McGee2008-01-24
| | | | Signed-off-by: Dan McGee <dan@archlinux.org>
* Another documentation update for FS#9204Chantry Xavier2008-01-15
| | | | | Signed-off-by: Chantry Xavier <shiningxc@gmail.com> Signed-off-by: Dan McGee <dan@archlinux.org>
* Clarify -Sc documentation.Chantry Xavier2008-01-15
| | | | | | | s/old packages/packages that are no longer installed/g. Signed-off-by: Chantry Xavier <shiningxc@gmail.com> Signed-off-by: Dan McGee <dan@archlinux.org>
* Change the versioned provision format.Chantry Xavier2008-01-14
| | | | | | | | | | | | | | | | | | | | | | Change the 'provname provver' format to 'provname=provver'. In .PKGINFO, the provisions are copied from the PKGBUILD without quotes. So the provision version was actually handled as a different provision... See FS#9171. Dan: Unfortunately we have to change our original specification for versioned provisions with this patch, but it ends up being the simpler and cleaner solution in the long run, and if there is any time to change it the time is now before many packages have been built. Keeping the ' ' based format would have required us to do special parsing in repo-add, as well as being susceptible to users not using quotes in their provides array. Hopefully this will resolve the issues we had with our initial plan. Sorry for the confusion. Acked-by: Nagy Gabor <ngaba@bibl.u-szeged.hu> Signed-off-by: Chantry Xavier <shiningxc@gmail.com> Signed-off-by: Dan McGee <dan@archlinux.org>
* Update cachedir documentation (FS#9204).Chantry Xavier2008-01-14
| | | | | Signed-off-by: Chantry Xavier <shiningxc@gmail.com> Signed-off-by: Dan McGee <dan@archlinux.org>
* doc: update documentation for --recursive and --cascadeChantry Xavier2008-01-13
| | | | | | | | This addresses some of the issues in FS#9192. Attempt to clarify the -Rc and -Rs options in the man page. Signed-off-by: Chantry Xavier <shiningxc@gmail.com> Signed-off-by: Dan McGee <dan@archlinux.org>
* doc: update makepkg optionsDan McGee2008-01-13
| | | | | | | | Add documentation for --holdver (from Scott) and --forcever (saying this is an internal option that should not be used by most end users), and re-alphabetize the --asroot option. Signed-off-by: Dan McGee <dan@archlinux.org>
* Fix cvsmod typo in PKGBUILD man page.Chantry Xavier2008-01-13
| | | | | | Fixes FS#9175. Signed-off-by: Chantry Xavier <shiningxc@gmail.com>
* doc: add note to pacman.conf manpage explaining $repoDan McGee2008-01-10
| | | | | | Fixes FS#9142. Signed-off-by: Dan McGee <dan@archlinux.org>
* doc: add info about optdependsDan McGee2008-01-10
| | | | Signed-off-by: Dan McGee <dan@archlinux.org>
* Rename -t --orphans to -t --unrequired (FS#9144).Chantry Xavier2008-01-10
| | | | | | | | | | It turns out the orphan name was misleading. Real orphans are packages installed as dependency no longer required by any others (-Qtd). The -t option only shows package not required by any others, so --unrequired describes it better. Signed-off-by: Chantry Xavier <shiningxc@gmail.com> Signed-off-by: Dan McGee <dan@archlinux.org>
* Documentation updatesNathan Jones2008-01-08
| | | | | | | | | | | | | | Document the following: * -R can take a group * -S can take a group and provision I also split up the -S description into multiple paragraphs because it was getting too large. Signed-off-by: Nathan Jones <nathanj@insightbb.com> [Dan: added some feedback from the ML, rewrapped lines] Signed-off-by: Dan McGee <dan@archlinux.org>
* Documentation updatesDan McGee2008-01-06
| | | | | | | | Update description of path specifiers for both pacman and pacman.conf in their respective manpages. Ensure it is obvious that they are absolute and not relative paths. Signed-off-by: Dan McGee <dan@archlinux.org>
* Remove makeworld from pacman packageDan McGee2008-01-06
| | | | | | | This is an Arch-specific tool (although others could find use in it), so off to the standalone ABS package it goes. Signed-off-by: Dan McGee <dan@archlinux.org>
* Remove stuff that was a little too Arch-specific from manpage footerDan McGee2008-01-06
| | | | Signed-off-by: Dan McGee <dan@archlinux.org>
* doc: remove --ask option from pacman manpageDan McGee2008-01-05
| | | | Signed-off-by: Dan McGee <dan@archlinux.org>
* doc: add symlink for repo-remove manpage on installDan McGee2008-01-05
| | | | Signed-off-by: Dan McGee <dan@archlinux.org>
* Remove mentions of ABS from makepkgDan McGee2008-01-05
| | | | | | Kill off some of the $ABSROOT stuff that was still hanging around in there. Signed-off-by: Dan McGee <dan@archlinux.org>
* doc: rename manlink macro to linkmanDan McGee2007-12-29
| | | | | | | | | | | | | | | | | | | | | | | | | Between AsciiDoc 8.2.2 and 8.2.3, the following change was made to the stock Asciidoc configuration: @@ -149,7 +153,10 @@ # Inline macros. # Backslash prefix required for escape processing. # (?s) re flag for line spanning. -(?su)[\\]?(?P<name>\w(\w|-)*?):(?P<target>\S*?)(\[(?P<attrlist>.*?)\])= + +# Explicit so they can be nested. +(?su)[\\]?(?P<name>(http|https|ftp|file|mailto|callto|image|link)):(?P<target>\S*?)(\[(?P<attrlist>.*?)\])= + # Anchor: [[[id]]]. Bibliographic anchor. (?su)[\\]?\[\[\[(?P<attrlist>[\w][\w-]*?)\]\]\]=anchor3 # Anchor: [[id,xreflabel]] This default regex now matches explicit values, and unfortunately in this case manlink was being matched by just 'link', causing the wrong inline macro template to be applied. By renaming the macro, we can avoid being matched by the wrong regex. Signed-off-by: Dan McGee <dan@archlinux.org>
* Ensure that manpages are always distributed and installedDan McGee2007-12-28
| | | | | | | | | | | | | Commit 012f7939784358b02726c169543aa99436439335 was a bit misguided in its thinking, and resulted in a package built without asciidoc enabled not installing the manpages to the system on a 'make install' operation. Fix this behavior by making manpages required in a normal build, and in order to disable their existence, the '--disable-doc' option must be used. Hopefully this solves manpage issues for both developers and package builders while allowing as much flexibility as possible. Signed-off-by: Dan McGee <dan@archlinux.org>
* Update PKGBUILD manpage to give info on scriptlet argumentsDan McGee2007-12-19
| | | | Signed-off-by: Dan McGee <dan@archlinux.org>
* Add PM_DEP_MOD_GT and PM_DEP_MOD_LT to documentationNagy Gabor2007-12-19
| | | | | Signed-off-by: Nagy Gabor <ngaba@bibl.u-szeged.hu> Signed-off-by: Dan McGee <dan@archlinux.org>
* Updates to PKGBUILD manpageDan McGee2007-12-10
| | | | | | | | Make the manpage a little more distro agnostic by referring to ABS in the context of Arch Linux, and saying that prototype files are also available with the pacman source. Signed-off-by: Dan McGee <dan@archlinux.org>
* Update pacman manpage with description of --clean optionDan McGee2007-12-05
| | | | Signed-off-by: Dan McGee <dan@archlinux.org>
* Add new --needed option for -S.Chantry Xavier2007-12-02
| | | | | | | | | | | | | | | | | During a pacman operation such as a group install, pacman can ask several questions such as "local version is up to date. Upgrade anyway?". They are usually all answered either by yes or by no: * yes when you want to reinstall all the targets. * no when you only want to install the missing ones (either because you are installing a group, or because you are copying a pacman -S line from wiki or whatever). So instead of asking this question for each target, it is now now configured with a flag. Yes will be the default -S behavior, No will be achieved with the --needed flag. Signed-off-by: Chantry Xavier <shiningxc@gmail.com> Signed-off-by: Dan McGee <dan@archlinux.org>
* Remove -F/--freshen operationDan McGee2007-11-21
| | | | | | | | | | This operation made sense in the days before sync DBs existed, but it no longer has the same usefulness it once did. Signed-off-by: Dan McGee <dan@archlinux.org> Signed-off-by: Chantry Xavier <shiningxc@gmail.com> Signed-off-by: Nagy Gabor <ngaba@bibl.u-szeged.hu> Signed-off-by: Aaron Griffin <aaronmgriffin@gmail.com>
* doc: use source highlighter on PKGBUILD guide, update wrong example textDan McGee2007-11-20
| | | | | | | Note that if you are building manpages with asciidoc now, you must also have source-highlight installed for it to correctly generate everything. Signed-off-by: Dan McGee <dan@archlinux.org>
* Update PKGBUILD manpage with versioned conflicts.Chantry Xavier2007-11-20
| | | | | | | | | As the b96922679e4ed14aa687bf194b766d82a1d10577 commit showed with two pactests (which were renamed to depconflict110/111), versioned conflicts are now possible. Signed-off-by: Chantry Xavier <shiningxc@gmail.com> Signed-off-by: Dan McGee <dan@archlinux.org>
* Versioned provisions.Nagy Gabor2007-11-18
| | | | | | | | | | | | | | | | | | | This patch introduces versioned provisions in "provision 1.0-1" format. _alpm_db_whatprovides was modified accordingly (added sync500.py), alpm_depcmp was modified accordingly (add043.py passes now; added add044.py and add045.py). Notes: alpm_db_search now uses the whole versioned %PROVIDES% string in its search. debug logging was simplified in alpm_depcmp. Signed-off-by: Nagy Gabor <ngaba@bibl.u-szeged.hu> [Xavier: fixed a few typos, duplicate const strings with strdup before modifying them, put some debugging back in alpm_depcmp, minor code cleanups (var/function renaming), added a note in PKGBUILD man page.] Signed-off-by: Chantry Xavier <shiningxc@gmail.com> [Dan: made strcmp checks clearer, added a comment] Signed-off-by: Dan McGee <dan@archlinux.org>
* Make it easier to ignore multiple packages.Nathan Jones2007-11-13
| | | | | | | | | | | | This makes --ignore and --ignoregroup able to accept multiple packages/groups by separating each with a comma. For instance: pacman -Su --ignore kernel26,udev,glibc This was requested in the comments of FS#8054. Signed-off-by: Nathan Jones <nathanj@insightbb.com> Signed-off-by: Dan McGee <dan@archlinux.org>
* Add help for --ignoregroup.Nathan Jones2007-11-13
| | | | | | Signed-off-by: Nathan Jones <nathanj@insightbb.com> [Dan: split usage line into two lines for clarity] Signed-off-by: Dan McGee <dan@archlinux.org>
* configure: Doxygen is disabled by default; manpages are included in distDan McGee2007-11-13
| | | | Signed-off-by: Dan McGee <dan@archlinux.org>
* Add TotalDownload option.Nathan Jones2007-11-11
| | | | | | | This will be used in the next commit. Signed-off-by: Nathan Jones <nathanj@insightbb.com> Signed-off-by: Dan McGee <dan@archlinux.org>
* Add IgnoreGroup and --ignoregroup option.Nathan Jones2007-11-11
| | | | | | | This will be used in the next commit. Signed-off-by: Nathan Jones <nathanj@insightbb.com> Signed-off-by: Dan McGee <dan@archlinux.org>
* Small manpage updatesDan McGee2007-11-08
| | | | Signed-off-by: Dan McGee <dan@archlinux.org>
* Get rid of the footnotes section in generated manpagesDan McGee2007-11-08
| | | | | | | We really don't need it since it is just links. However, we do need to figure out how to get our old links to show up right. Signed-off-by: Dan McGee <dan@archlinux.org>
* doc: update links in footer.txt so they are actual linksDan McGee2007-11-08
| | | | Signed-off-by: Dan McGee <dan@archlinux.org>
* Update PKGBUILD.5 with missing devel variable descriptionsDan McGee2007-11-08
| | | | | | | The lack of descriptions on some of the variables was causing issues with documentation generation. Adding text to them fixes this. Signed-off-by: Dan McGee <dan@archlinux.org>
* Sync asciidoc.conf with GIT repository changesDan McGee2007-11-08
| | | | | | We got our file from the GIT repository originally, so keep it up to date. Signed-off-by: Dan McGee <dan@archlinux.org>
* Update the PKGBUILD example in the manpagesDan McGee2007-11-07
| | | | | | | The old one was old. Use something a bit more recent and a bit simpler as well so it actually looks OK in the manpage. Signed-off-by: Dan McGee <dan@archlinux.org>
* Small updates to documentation.Scott Horowitz2007-10-29
| | | | | Signed-off-by: Scott Horowitz <stonecrest@gmail.com> Signed-off-by: Dan McGee <dan@archlinux.org>
* doxygen: preprocess SYMHIDDEN/SYMEXPORT macros so they don't show in docsDan McGee2007-10-29
| | | | Signed-off-by: Dan McGee <dan@archlinux.org>
* Download delta files if UseDelta is set.Nathan Jones2007-10-19
| | | | | | | | Delta files will be used if the size is smaller than a percent (MAX_DELTA_RATIO) of the package size. Signed-off-by: Nathan Jones <nathanj@insightbb.com> Signed-off-by: Dan McGee <dan@archlinux.org>
* Updates to fix Doxygen documentation generationDan McGee2007-10-14
| | | | | | | | | We had way too much going on with the Doxygen manpage generation. Clean it up quite a bit by removing directory manpages, using relative paths, not having a manpage for every single alpm function, and ensuring internal functions are not documented publicly. Signed-off-by: Dan McGee <dan@archlinux.org>
* document the -Qii option.Chantry Xavier2007-09-27
| | | | | | | | | I suppose -Qii could be used for other things than displaying the list of backup files, but currently, it's the only one, so that's how I documented it.. Signed-off-by: Chantry Xavier <shiningxc@gmail.com> Signed-off-by: Dan McGee <dan@archlinux.org>