doc/autoinclude/Mainpage.doc

   1 /** \mainpage Welcome to libzypp
   2
   3 \section intro Introduction
   4
   5 Welcome to the libzypp documentation.
   6
   7 libzypp is the package management library that powers applications like YaST, zypper and the openSUSE/SLE implementation of PackageKit.
   8
   9 \section whatis What is libzypp?
  10
  11 libzypp provides all the functionality for a package manager:
  12
  13 - An API for package repository management, supporting most common repository metadata formats and signed repositories.
  14 - An API for solving packages, products, patterns and patches (installation, removal, update and distribution upgrade operations) dependencies, with additional features like locking.
  15 - An API for commiting the transaction to the system over a rpm target. Supporting deltarpm calculation, media changing and installation order calculation.
  16 - An API for browsing available and installed software, with some facilities for programs with an user interface.
  17 - A suite of maintained solving testcases representing common and uncommon operations on Linux software management
  18
  19 \section impl Implementation
  20
  21 libzypp is implemented as a C++ library with experimental bindings available for python and ruby.
  22
  23 \section otherfunc Other functionality offered by libzypp
  24
  25 Most of libzypp functionality is implemented over components provided also by libzypp:
  26
  27 - Media abstraction library offering a common interface over local files, http,ftp,iso,nfs and other protocols.
  28
  29 \section thirdpfunc 3rd party software libzypp is based on
  30
  31 Additionally, some functionality libzypp uses is based on 3rd party libraries:
  32
  33 - SAT solver library, for dependency solving and repository data storage and querying
  34 - curl, that powers some protocols of the media abstraction component
  35 - boost, for misc. utilities like shared pointers, functors and algorithms.
  36
  37 \section join Join the community
  38
  39 Visit our web site at : http://en.opensuse.org/Libzypp or #zypp on irc.freenode.net
  40
  41 \section license License
  42
  43 \code
  44 /*---------------------------------------------------------------------\
  45 |                          ____ _   __ __ ___                          |
  46 |                         |__  / \ / / . \ . \                         |
  47 |                           / / \ V /|  _/  _/                         |
  48 |                          / /__ | | | | | |                           |
  49 |                         /_____||_| |_| |_|                           |
  50 |                                                                      |
  51 \---------------------------------------------------------------------*/
  52
  53 Copyright (C) 2000-2002 Ximian, Inc.
  54 Copyright (C) 2005 SUSE Linux Products GmbH
  55
  56 ZYpp is licensed under the GNU General Public License version 2
  57 or later. The text of the GNU General Public License can be viewed at
  58 http://www.gnu.org/licenses/gpl.html
  59
  60 As a special exception, you have permission to link this program
  61 with the following libraries and distribute executables, as long as you
  62 follow the requirements of the GNU GPL in regard to all of the
  63 software in the executable aside from the following libraries:
  64 - OpenSSL (http://www.openssl.org)
  65 \endcode
  66
  67 */