Skip to content

Commit

Permalink
docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
Kwpolska committed Aug 13, 2012
1 parent 2875f36 commit b08ba91
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 12 deletions.
9 changes: 6 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ PKGBUILDer. An AUR helper (and library) in Python 3.
The current version on your system can be checked by running
`pkgbuilder -v`.

Most of the documentation is likely compatible with previous
releases of the |version| series.

PKGBUILDer is an AUR helper, i.e. an application which builds AUR
packages. It can be used in conjunction with pacman (with a special
script). It uses various techniques to automatize the process as
Expand All @@ -17,8 +20,8 @@ Since version 2.1.0, PKGBUILDer provides modules that can be used in
other scripts.

For standalone use, see the :doc:`PKGBUILDer man page <pkgbuilder>`.
Reading the appendices (:doc:`README` and
:doc:`Message codes <messagecodes>`) is also a good idea.
Reading the :doc:`README <README>` and
the :doc:`Message codes list <messagecodes>` is also a good idea.

For python module usage, see the respective class documents.

Expand All @@ -35,7 +38,7 @@ Table of Contents
pbds
upgrade
utils
README
README for PKGBUILDer <README>
messagecodes
LICENSE
CHANGELOG
Expand Down
15 changes: 7 additions & 8 deletions docs/pkgbuilder.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,6 @@ much as possible.
Since version 2.1.0, PKGBUILDer provides modules that can be used in
other scripts.

Development of the PKGBUILDer is stalled. However, patches are welcome
all the time at GitHub.

OPERATIONS
==========

Expand Down Expand Up @@ -64,16 +61,18 @@ OPTIONS
EXAMPLES
========

pkgbuilder dropbox
Installs the package "dropbox" from the AUR. It is being built in
pkgbuilder trashman
Installs the package "trashman" from the AUR. It is being built in
the CWD.

pkgbuilder -S dropbox
Installs "dropbox", but builds thhe package in /tmp-pkgbuilder-UID.
pkgbuilder -S trashman
Installs "trashman", but builds the package in /tmp-pkgbuilder-UID.

pkgbuilder -Syu
Checks for updates and offers installing them.

(Trashman is an XDG trash manager by Kwpolska.)

SEE ALSO
========
**pacman(8)**, **makepkg(8)**
Expand All @@ -83,6 +82,6 @@ for more info.

BUGS
====
Bugs shall be reported at the GitHub page
Bugs should be reported at the GitHub page
(<https://github.com/Kwpolska/pkgbuilder/issues>). You can also
send mail to <[email protected]>.
2 changes: 1 addition & 1 deletion release
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ cp docs/README.rst README.rst
cp docs/README.rst README

rm docs/pkgbuilder.8.gz | true
rst2man2 docs/pkgbuilder.rst > docs/pkgbuilder.8
rst2man docs/pkgbuilder.rst > docs/pkgbuilder.8
gzip docs/pkgbuilder.8

xgettext -c ./pkgbuilder/* INSTALL.py -o ./messages.pot
Expand Down

0 comments on commit b08ba91

Please sign in to comment.