summaryrefslogtreecommitdiffstats
path: root/doc
AgeCommit message (Collapse)AuthorFilesLines
2008-01-14doc: update makepkg optionsDan McGee1-5/+15
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>
2008-01-13Fix cvsmod typo in PKGBUILD man page.Chantry Xavier1-1/+1
Fixes FS#9175. Signed-off-by: Chantry Xavier <shiningxc@gmail.com>
2008-01-11doc: add note to pacman.conf manpage explaining $repoDan McGee1-5/+26
Fixes FS#9142. Signed-off-by: Dan McGee <dan@archlinux.org>
2008-01-11doc: add info about optdependsDan McGee1-0/+9
Signed-off-by: Dan McGee <dan@archlinux.org>
2008-01-11Rename -t --orphans to -t --unrequired (FS#9144).Chantry Xavier1-1/+1
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>
2008-01-08Documentation updatesNathan Jones1-6/+19
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>
2008-01-07Documentation updatesDan McGee2-14/+31
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>
2008-01-06Remove makeworld from pacman packageDan McGee1-3/+0
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>
2008-01-06Remove stuff that was a little too Arch-specific from manpage footerDan McGee1-4/+3
Signed-off-by: Dan McGee <dan@archlinux.org>
2008-01-05doc: remove --ask option from pacman manpageDan McGee1-6/+0
Signed-off-by: Dan McGee <dan@archlinux.org>
2008-01-05doc: add symlink for repo-remove manpage on installDan McGee2-1/+5
Signed-off-by: Dan McGee <dan@archlinux.org>
2008-01-05Remove mentions of ABS from makepkgDan McGee1-5/+5
Kill off some of the $ABSROOT stuff that was still hanging around in there. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-12-29doc: rename manlink macro to linkmanDan McGee9-37/+37
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>
2007-12-29Ensure that manpages are always distributed and installedDan McGee1-10/+7
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>
2007-12-20Update PKGBUILD manpage to give info on scriptlet argumentsDan McGee1-6/+12
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-12-19Add PM_DEP_MOD_GT and PM_DEP_MOD_LT to documentationNagy Gabor1-2/+3
Signed-off-by: Nagy Gabor <ngaba@bibl.u-szeged.hu> Signed-off-by: Dan McGee <dan@archlinux.org>
2007-12-11Updates to PKGBUILD manpageDan McGee1-6/+11
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>
2007-12-06Update pacman manpage with description of --clean optionDan McGee1-7/+12
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-12-02Add new --needed option for -S.Chantry Xavier1-0/+3
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>
2007-11-21Remove -F/--freshen operationDan McGee1-4/+0
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>
2007-11-21doc: use source highlighter on PKGBUILD guide, update wrong example textDan McGee1-4/+5
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>
2007-11-21Update PKGBUILD manpage with versioned conflicts.Chantry Xavier1-1/+1
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>
2007-11-19Versioned provisions.Nagy Gabor1-0/+2
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>
2007-11-14Make it easier to ignore multiple packages.Nathan Jones1-2/+4
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>
2007-11-14Add help for --ignoregroup.Nathan Jones1-0/+4
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>
2007-11-13configure: Doxygen is disabled by default; manpages are included in distDan McGee1-7/+9
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-11-11Add TotalDownload option.Nathan Jones1-0/+5
This will be used in the next commit. Signed-off-by: Nathan Jones <nathanj@insightbb.com> Signed-off-by: Dan McGee <dan@archlinux.org>
2007-11-11Add IgnoreGroup and --ignoregroup option.Nathan Jones1-0/+4
This will be used in the next commit. Signed-off-by: Nathan Jones <nathanj@insightbb.com> Signed-off-by: Dan McGee <dan@archlinux.org>
2007-11-09Small manpage updatesDan McGee2-5/+5
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-11-09Get rid of the footnotes section in generated manpagesDan McGee1-1/+6
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>
2007-11-09doc: update links in footer.txt so they are actual linksDan McGee1-3/+3
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-11-08Update PKGBUILD.5 with missing devel variable descriptionsDan McGee1-0/+7
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>
2007-11-08Sync asciidoc.conf with GIT repository changesDan McGee1-0/+6
We got our file from the GIT repository originally, so keep it up to date. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-11-08Update the PKGBUILD example in the manpagesDan McGee1-24/+12
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>
2007-10-30Small updates to documentation.Scott Horowitz2-13/+81
Signed-off-by: Scott Horowitz <stonecrest@gmail.com> Signed-off-by: Dan McGee <dan@archlinux.org>
2007-10-29doxygen: preprocess SYMHIDDEN/SYMEXPORT macros so they don't show in docsDan McGee1-3/+3
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-10-20Download delta files if UseDelta is set.Nathan Jones1-0/+4
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>
2007-10-15Updates to fix Doxygen documentation generationDan McGee2-4/+4
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>
2007-09-28document the -Qii option.Chantry Xavier1-1/+3
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>
2007-09-24Allow a normal 'make' to compile without asciidoc installedDan McGee1-0/+9
If we don't have asciidoc installed or enabled, we should still have a successful make. However, we want to ensure 'make dist' fails without asciidoc. This commit should ensure this. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-09-18Update NEWS, -S testing/qt example, and mirrorlist changeDan McGee1-1/+1
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-09-18Refine pacman manpage, clarify -S repo/package possibility, remove --testDan McGee1-4/+3
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-09-17Merge branch 'asciidoc' into workingDan McGee18-1083/+1256
We're getting close to release, so might as well do this now so people can actually update some of our documentation.
2007-09-17Remove the DB consistency check from pacman and libalpm.Chantry Xavier1-4/+0
This reverts commit dfc85cb5f516ffbcff557522e9703c5c7d88b047 and b6f3fe6957d0206485eac98fb2120578b75d0058. This DB check is already in testdb (among others). Also testdb now uses the db path set at make time by default, so specifying the db path is optional. Signed-off-by: Chantry Xavier <shiningxc@gmail.com> Signed-off-by: Dan McGee <dan@archlinux.org>
2007-08-16Update manpage with new query options.Chantry Xavier1-9/+22
Dan: did a bit more updating and clarifying. Signed-off-by: Chantry Xavier <shiningxc@gmail.com> Signed-off-by: Dan McGee <dan@archlinux.org>
2007-07-16Remove unnecessary entries from .gitignore filesDan McGee1-2/+0
.gitignore works recursively, so we don't need Makefile and Makefile.in in all of the subdirectory .gitignore files. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-07-16Man page revision timeDan McGee6-240/+281
Spruce up the asciidoc formatting, fix a few issues that we had. Formatting now looks pretty good in both the manpage output and the XHTML output. Also added some options that we have changed since 3.0, and a few wording updates, etc. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-07-09Add asciidoc checking to configure.ac, make manpage generation optionalDan McGee1-13/+16
Include manpages when we ship a package tarball, and allow them to be generated by the end user if they want by using the --enable-asciidoc option to ./configure. This will allow us to maintain manpages in an easier to modify format while still keeping the make dependencies to a minimum. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-07-09Add a manpage for repo-addDan McGee3-0/+55
We still need some work here- we should have a repo-remove manpage link to this one, and we should not have to struggle with asciidoc formatting to get it to work like any other multiple-command manpage works. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-07-09Asciidoc updates- make it pretty, fix build, etc.Dan McGee9-15/+45
* Fix up the target so we rebuild the manpages when we edit the corresponding text file. * Add vim modelines to all of the asciidoc files ensureing the right syntax highlighting is used and we have expandtabs turned off. * Start making a few small changes to PKGBUILD.5 to make it pretty in both HTML and manpage format output. * Fix the manlink macro to include the manpage section in the link. Signed-off-by: Dan McGee <dan@archlinux.org>