doc/e.dox.in

   1 /**
   2
   3 @mainpage Enlightenment
   4
   5 @image html  e.png
   6
   7 @version @PACKAGE_VERSION@
   8 @date 2000-2012
   9
  10 Please see the @ref authors page for contact details.
  11
  12 @section intro Introduction
  13
  14 The Enlightenment Window Manager is a lean, fast, modular and very
  15 extensible window manager for X11 and Linux. It is classed as a
  16 "desktop shell" providing the things you need to operate your desktop
  17 (or laptop), but is not a whole application suite. This covered
  18 launching applications, managing their windows and doing other system
  19 tasks like suspending, reboots, managing files etc.
  20
  21
  22 @section compiling How to compile modules?
  23
  24 pkgconfig (.pc) files are installed for enlightenment. To compile a
  25 module you can use something like the following:
  26
  27 @verbatim
  28 gcc module.c $(pkg-config enlightenment --cflags --libs)
  29 @endverbatim
  30
  31 Note that modules are installed to $HOME (~/.e/e/modules) or
  32 system. One can know the system directory with the command:
  33
  34 @verbatim
  35 pkg-config --variable=modules enlightenment
  36 @endverbatim
  37
  38 @section install How is it installed?
  39
  40 Just use the traditional autotools steps, the options will be
  41 autodetected. Note that it depend on EFL (Enlightenment Foundation
  42 Libraries): eina, eet, evas, ecore, e_dbus, embryo, edje, efreet and
  43 eeze.
  44
  45 @verbatim
  46 ./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var
  47 make
  48 sudo make install
  49 @endverbatim
  50
  51 @todo (0.17) Document API
  52
  53 */
  54
  55 /**
  56
  57 @page authors Authors
  58
  59 @author The Rasterman (Carsten Haitzler) <raster@rasterman.com>
  60 @author Ibukun Olumuyiwa <ibukun@computer.org>
  61 @author Sebastian Dransfeld <sd@tango.flipp.net>
  62 @author HandyAndE (Andrew Williams) <andy@handyande.co.uk>
  63 @author CodeWarrior (Hisham Mardam Bey) <hisham@hisham.cc>
  64 @author dj2 (Dan Sinclair) <dj2@everburning.com>
  65 @author Tilman Sauerbeck <tilman@@code-monkey.de>
  66 @author Aleksej Struk <astruk@gmail.com>
  67 @author Brian Mattern <rephorm@rephorm.com>
  68 @author devilhorns (Christopher Michael) <devilhorns@comcast.net>
  69 @author /dev/urandom (Viktor Kojouharov) <vkojouharov@gmail.com>
  70 @author ilLogict (Chidambar Zinnoury) <illogict@online.fr>
  71 @author Stafford Horne <shorne@softhome.net>
  72 @author Cedric Bail <cedric.bail@free.fr>
  73 @author onefang (David Seikel) <onefang@gmail.com>
  74 @author okra (Stephen Houston) <smhouston88@gmail.com>
  75 @author Byron Hillis <metrics@score5.org>
  76 @author Ravenlock (Eric Schuele) <e.schuele@computer.org>
  77 @author ManoWarrior (Luchezar Petkov) <luchezar.petkov@gmail.com>
  78 @author morlenxus (Brian Miculcy) <morlenxus@gmx.net>
  79 @author Toma- (Tom Haste) <tomhaste@gmail.com>
  80 @author k-s (Gustavo Sverzut Barbieri) <barbieri@profusion.mobi>
  81 @author Peter van de Werken <pwerken-e@a-eskwadraat.nl>
  82 @author Florian Hackenberger <florian@hackenberger.at>
  83 @author Hannes Janetzek <hannes.janetzek@gmail.com>
  84 @author Mike Blumenkrantz (discomfitor/zmike) <michael.blumenkrantz@gmail.com>
  85 @author Leif Middelschulte <leif.middelschulte@gmail.com>
  86 @author yoz (Michael Bouchaud) <michael.bouchaud@gmail.com>
  87 @author billiob (Boris Faure) <billiob@gmail.com>
  88 @author Jihoon Kim <jihoon48.kim@samsung.com>
  89 @author Sthitha <iamsthitha@gmail>
  90 @author Doyoun Kang <doyoun.kang@samsung.com>
  91 @author Gwanglim Lee <gl77.lee@samsung.com>
  92 @author Thomas Gstädtner <thomas@gstaedtner.net>
  93 @author q66 <quaker66@gmail.com>
  94 @author Tom Hacohen <tom@stosb.com>
  95
  96 */