summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2007-10-29doxygen: preprocess SYMHIDDEN/SYMEXPORT macros so they don't show in docsDan McGee
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-10-19Download delta files if UseDelta is set.Nathan Jones
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-14Updates to fix Doxygen documentation generationDan McGee
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-27document the -Qii option.Chantry Xavier
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-23Allow a normal 'make' to compile without asciidoc installedDan McGee
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 McGee
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-09-17Refine pacman manpage, clarify -S repo/package possibility, remove --testDan McGee
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-09-16Merge branch 'asciidoc' into workingDan McGee
We're getting close to release, so might as well do this now so people can actually update some of our documentation.
2007-09-16Remove the DB consistency check from pacman and libalpm.Chantry Xavier
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 Xavier
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 McGee
.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 McGee
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 McGee
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 McGee
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 McGee
* 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>
2007-07-09Update PKGBUILD example.Andrew Fyfe
Signed-off-by: Andrew Fyfe <andrew@neptune-one.net>
2007-07-09Add Synopsis section to man 5 pages.Andrew Fyfe
Signed-off-by: Andrew Fyfe <andrew@neptune-one.net>
2007-07-09Make manpage generation depend on footer.txtDan McGee
If footer.txt is updated, we need to regenerate the manpages, this little fix should do this. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-07-09doc/Makefile.am: Set pacman version and date when man pages are generated.Andrew Fyfe
Signed-off-by: Andrew Fyfe <andrew@neptune-one.net>
2007-07-09Convert the remaining man pages to asciidoc.Andrew Fyfe
Signed-off-by: Andrew Fyfe <andrew@neptune-one.net>
2007-07-09Move common stuff into footer.txt and some formating tweaks.Andrew Fyfe
Signed-off-by: Andrew Fyfe <andrew@neptune-one.net>
2007-07-09Add two asciidoc manpages to the doc/ dirAndrew Fyfe
Add the pacman.8 and pacman.conf.5 asciidoc manpages to the GIT tree, with the rest to follow. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-07-09Start addition of asciidoc stuffDan McGee
Add some asciidoc generation stuff to the doc/ Makefile.am so we can get some manpages up and working. Add necessary stuff to gitignore, and check in the asciidoc.conf file along with the footer for all of the manpages. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-07-09Remove old 'static' manpages in anticipation of the asciidoc switchDan McGee
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-07-01Move Doxygen manpage generation to doc/ directoryDan McGee
Instead of doing the doxygen work in the libalpm/ dir, do it with the rest of the docs in the doc/ dir. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-06-09Implement a -Qt operation in frontend to test the databaseDan McGee
After adding a alpm_db_check() operation in the back end, we can call it in the front end and present a user-friendly interface to it. Inspired-by: VMiklos <vmiklos@frugalware.org> Signed-off-by: Dan McGee <dan@archlinux.org>
2007-06-04Autotool clean up.Andrew Fyfe
* Add vim modeline to Makefile.am and configure.ac * Fix white space in Makefile.am and configure.ac * Add contrib/wget-xdelta.sh to EXTRA_DIST in Makefile.am Signed-off-by: Andrew Fyfe <andrew@neptune-one.net> Signed-off-by: Dan McGee <dan@archlinux.org>
2007-06-01Drop --usesudo option and add some checks related to ASROOTDan McGee
Drop the --usesudo option and use it by default if running as a non-root user. Check the usage of the --asroot option and do not allow it to be used as a normal user. A few other small fixes, including a typo in $confdir. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-06-01scripts/makepkg.in: Various clean ups.Andrew Fyfe
* etc/makepkg.conf.in: Add description for xdelta. * doc/makepkg.conf.5: Add description for xdelta. * scripts/makepkg.in: Various clean ups. Signed-off-by: Andrew Fyfe <andrew@neptune-one.net> Signed-off-by: Dan McGee <dan@archlinux.org>
2007-06-01Change -z|--showsize flag to ShowSize pacman.conf optionNathan Jones
Also cleaned up some duplicate printf lines related to the ShowSize option. Signed-off-by: Nathan Jones <nathanj@insightbb.com> Signed-off-by: Dan McGee <dan@archlinux.org>
2007-05-30doc/makepkg.8: document --log optionDan McGee
Signed-off-by: Dan McGee <dan@archlinux.org>
2007-03-27Move .cvsignore -> .gitignoreDan McGee
* Move all .cvsignore files to .gitignore for switch in VCS. In addition, delete ones that were unnecessary because they only contained Makefile and Makefile.am. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-03-27* Remove outdated ProxyServer option from pacman.conf.5.Dan McGee
2007-03-20* NEWS: add quick line about backup files.Dan McGee
* pacman.8: add documentation for -Se option.
2007-03-19* Updated Italian translationDan McGee
Giovanni Scafora <linuxmania@gmail.com> * Many minor issues mentioned by Scott Horowitz <stonecrest@gmail.com>. - extra 'done' text in --noprogressbar output - missing flags in the pacman.8 manpage - unclear text in --noconfirm help description
2007-03-11* Added Russian language translation. Thanks!Dan McGee
Вам Зачем <4rayven@gmail.com> * Updated manpage to document --cachedir and --dbpath options.
2007-03-01* Slight documentation update.Dan McGee
2007-02-28* Added another test as suggested by Nagy on the ML- a package both providesDan McGee
for and is a dependency of another package. (upgrade057) * Removed man2html stuff from doc/Makefile.am. * Patch: improved depends checking in _alpm_checkdeps Nagy Gabor <ngaba@petra.hos.u-szeged.hu> * Slight revisions to pmrule.py to allow for a PKG_PROVIDES test. * Very quick updates to the pactest README. * Added rules to some of the newer upgrade tests. Note: upgrade055 now fails due to requiredby entries not being written packages that are dependencies in a provides role.
2007-02-24* Added some undocumented options to the manpage.Dan McGee
2007-02-23Implementing feature request: <http://bugs.archlinux.org/task/4706>Dan McGee
* Added these three possible options (or !options, more likely), to the PKGBUILD possibilities: - ccache - distcc - makeflags * Removed the --noccache and -j flags from makepkg as their functionality is better used by adding the above options to a PKGBUILD- keep the functionality where it is needed. Testing would be appreciated, I didn't do much of that yet.
2007-02-23* Removed man2html stuff from configure. It is now available in the doc/Dan McGee
directory by running the target man2html, e.g. 'make man2html'. * Slightly fixed up the bottom of the manpages.
2007-02-22Big commit here, I'll try to cover all the bases.Dan McGee
* Updated all of the language files, as the POT file was updated. NOTE FOR TRANSLATORS, try to base your next contribution off of these, notice how some msgids and messages have been wrapped to the next line- it makes it easier to read anyway. * More Makefile.am/configure.ac updates. 'make dist' and 'make distclean' now work properly, with only one caveat- the automatic testing in distclean doesn't do so hot as it is compiled with a default configure, which includes the fakeroot-proof code (which does not cooperate with pactest). * Added a Makefile.am for the pactest directory.
2007-02-22* A lot of Makefile.am updates to try to get 'make dist' and 'make distcheck'Dan McGee
to work as expected.
2007-02-14* Updated makepkg.8 manpage to reflect shift of -S to --usesudo.Dan McGee
2007-02-12* Unified description of arch variable. Recommend using single quotes inDan McGee
the array, e.g. arch=('i686'). * Updated my TODO. * Changed the email address in rankmirrors script.
2007-02-11A few more slight changes to the pacman man pageDan McGee
2007-02-09* Fix compile errors/warnings.Dan McGee
* Update .cvsignore files a bit.
2007-02-09New manpages were going nowhere without an updated makefileDan McGee
2007-02-09Man pages, man pages, man pages. Just a few more additions and clarifications,Dan McGee
ensured force option was still documented in PKGBUILD.5.
2007-02-09Cleaned up the PKGBUILD man a bit.Dan McGee