Skip to content
README.rst 1.57 KiB
Newer Older
Seblu's avatar
Seblu committed
===========
ArchVersion
===========

INTRODUCTION
============
*archversion* is an upstream version controller against current *Archlinux* [#]_
or *AUR* [#]_ version.
It can be used by Dev and TUs to check if new release of their package are available.

Seblu's avatar
Seblu committed
HOW TO USE IT
=============
The first thing to do is to define a list of package to track by creating a file
~/.config/archversion.conf. This file look like an old fashioned INI file.
Seblu's avatar
Seblu committed

Seblu's avatar
Seblu committed
You can find a nice example of this file in misc directory.

Then you can run:
*archversion check -d* to only display version which differ with cache.
*archversion check -n* to only display new verions.
*archversion check -nd* to display new versions not in cache.

Of course you can add the last one in a cron job to get a daily report of which
packages need updates.


COMPARING MODES
===============
*archversion* allow you to compare version against differents things, not only
official Archlinux repository.
You can compare upstream version against:
- An Archlinux package
- An AUR package
- A stored value
Seblu's avatar
Seblu committed


DEPENDENCIES
============
- Python 3.x [#]_
- PyXDG [#]_


SOURCES
=======
*archversion* sources are available on github [#]_.


LICENSE
=======
*archversion* is licensied under the term of GPL v2 [#]_.


AUTHOR
======
*archversion* was started by Sébastien Luttringer in July 2012.


LINKS
=====
.. [#] http://www.archlinux.org/
.. [#] http://aur.archlinux.org/
.. [#] http://python.org/download/releases/
.. [#] http://freedesktop.org/wiki/Software/pyxdg
.. [#] https://github.com/seblu/archversion/
.. [#] http://www.gnu.org/licenses/gpl-2.0.html