Very tiny documentation revision.

Fixed code so it can be compiled on SunStudio without errors.
This commit is contained in:
Sanel Zukan 2009-03-30 15:17:00 +00:00
parent 43e887c41d
commit e8c8485097
15 changed files with 54 additions and 99 deletions

View File

@ -21,6 +21,11 @@ mandir ?= "@mandir@" ;
srcdir ?= "@abs_srcdir@" ; srcdir ?= "@abs_srcdir@" ;
sysconfdir ?= "@sysconfdir@" ; sysconfdir ?= "@sysconfdir@" ;
# compiler
CC = @CC@ ;
C++ = @CXX@ ;
LINK = $(CC) ;
# tools used by jam rules # tools used by jam rules
XGETTEXT ?= @XGETTEXT@ ; XGETTEXT ?= @XGETTEXT@ ;
MSGFMT ?= @MSGFMT@ ; MSGFMT ?= @MSGFMT@ ;

10
Jamfile
View File

@ -28,16 +28,16 @@ SubInclude TOP ede-image-view ;
SubInclude TOP elma ; SubInclude TOP elma ;
SubInclude TOP ede-launch ; SubInclude TOP ede-launch ;
SubInclude TOP emountd ; SubInclude TOP emountd ;
SubInclude TOP ede-panel ; #SubInclude TOP ede-panel ;
SubInclude TOP ede-timedate ; SubInclude TOP ede-timedate ;
SubInclude TOP ede-tip ; SubInclude TOP ede-tip ;
SubInclude TOP edewm ; #SubInclude TOP edewm ;
SubInclude TOP evoke ; SubInclude TOP evoke ;
SubInclude TOP doc ; SubInclude TOP doc ;
SubInclude TOP data ; SubInclude TOP data ;
SubInclude TOP services ; SubInclude TOP services ;
# efile is not compileable on FreeBSD # efile is not compileable on FreeBSD
if $(OS) != FREEBSD { #if $(OS) != FREEBSD {
SubInclude TOP efiler ; # SubInclude TOP efiler ;
} #}

View File

@ -15,44 +15,40 @@ Build requirements
------------------ ------------------
EDE 2.0 is using FLTK toolkit from http://www.fltk.org[www.fltk.org]. At the time EDE 2.0 is using FLTK toolkit from http://www.fltk.org[www.fltk.org]. At the time
of this writing, last released version was 1.1.7 and 1.1.8 was coming really soon. We of this writing, latest stable version is 1.1.9.
recommend using the latest daily snapshot - they are extremely stable and
that's what we use internally - although 1.1.7 should work too.
Since fltk lacks many things needed for developing a full *nix desktop Since FLTK lacks many things needed for developing a full *nix desktop
environment, we have developed a small add-on library called 'edelib'. This environment, we have developed a small add-on library called 'edelib'. This
library is also required for compiling EDE 2.0 and should be released together library is also required for compiling EDE 2.0 and should be released together with EDE.
with EDE.
We *strongly* recommend that you use matching versions of ede and We *strongly* recommend that you use matching versions of ede and
edelib (e.g. released at the same time) or that you do SVN checkout at the edelib (e.g. released at the same time) or that you do SVN checkout at the same time due
same time. their frequent changes.
Make sure you have eFLTK installed too, because some packages still requires it. Make sure you have eFLTK installed too, because some packages still requires it.
Also you will need a Jam tool. Jam is a make replacement and removes a lot Also you will need a Jam tool. Jam is a make replacement and you can find it on our repository.
of its limitations and you can find it on our repository.
Downloading the code Downloading the code
-------------------- --------------------
The best way to download latest code is checking it out from our repository. Make sure The best way to download latest code is checking it out from our repository. These modules
you checkout jam (if you already don't have it installed), edelib, ede2 and efltk modules. you should checkout (with their paths):
Here are the commands:
- jam : 'svn co https://ede.svn.sourceforge.net/svnroot/ede/trunk/jam' - jam : 'svn co https://ede.svn.sourceforge.net/svnroot/ede/trunk/jam'
- edelib : 'svn co https://ede.svn.sourceforge.net/svnroot/ede/trunk/edelib' - edelib : 'svn co https://ede.svn.sourceforge.net/svnroot/ede/trunk/edelib'
- ede : 'svn co https://ede.svn.sourceforge.net/svnroot/ede/trunk/ede2' - ede : 'svn co https://ede.svn.sourceforge.net/svnroot/ede/trunk/ede2'
- efltk : 'svn co https://ede.svn.sourceforge.net/svnroot/ede/trunk/efltk' - efltk : 'svn co https://ede.svn.sourceforge.net/svnroot/ede/trunk/efltk'
If you already have Jam installed, there is no need to download it.
Compiling and installing Compiling and installing
------------------------ ------------------------
In order to build and install EDE do the following steps: In order to build and install EDE do the following steps:
1. compile and install jam first; going to jam source directory and runnig 'make' will do 1. compile and install jam first; going to jam source directory and runnig 'make' will do
the job; after that you should get 'bin.YOUR_PLATFORM' directory (on linux it will be the job; after that you should get 'bin.YOUR_PLATFORM' directory (on Linux it will be
bin.linux) and copy 'jam' executable in your $PATH, e.g. /usr/local/bin bin.linux) and copy 'jam' executable in your $PATH, e.g. /usr/local/bin
2. compile and install edelib; please read README file in edelib directory 2. compile and install edelib; please read README file in edelib directory
@ -60,7 +56,7 @@ In order to build and install EDE do the following steps:
3. compile and install efltk; './configure --disable-mysql --disable-unixODBC && make && make install' 3. compile and install efltk; './configure --disable-mysql --disable-unixODBC && make && make install'
will do the job will do the job
4. then go in ede2 directory and run './autogen.sh' 4. go in ede2 directory and run './autogen.sh'
5. after that, goes './configure --enable-debug' 5. after that, goes './configure --enable-debug'
@ -68,47 +64,10 @@ In order to build and install EDE do the following steps:
7. jam install 7. jam install
Important stuff that isn't updated (requires efltk) Used programs that requires eFLTK
--------------------------------------------------- ---------------------------------
- edewm - edewm
- eworkpanel - ede-panel
We are in the process of rewriting these modules from scratch so older versions These programs are planned to be replaced with the new ones.
will be provided
- efinder
It will be ported to fltk1 as soon as we finish efiler (see below) cause we
would like to use same widgets for displaying file list.
- emenueditor
It will either be completely rewritten or removed, because EDE 2 will use XDG menus
(FreeDesktop.org).
New modules in EDE 2.0
----------------------
- edialog
Command line utility for displaying dialogs (useful for scripting). It is very
UNFINISHED.
- efiler
Simple and lightweight file manager. Currently it's fully functional, but we
plan some more features.
- eimage
Small image viewer. Likewise, functional but a few features will be added.
- ede-calc
Scientific calculator.
TODO: to be filled
Contributors wanted
-------------------
As usualy, every help is very appreciated :)
Also, EDE code is sparkled with comments starting with TODO and FIXME -
please see what of that you can do (just type e.g. "grep TODO . -R" or "grep FIXME . -R").
EDE coding standards and EDE HIG documents are being prepared.

View File

@ -4,8 +4,8 @@ D-BUS usage in EDE
Introduction Introduction
------------ ------------
This document describes link:http://freedesktop.org/wiki/Software/dbus/[D-BUS] usage in EDE applications. This document describes link:http://freedesktop.org/wiki/Software/dbus/[D-BUS] usage in EDE applications.
It is not meant to describe D-BUS protocol nor how to use it either via libdbus nor edelib, but It is not meant to describe D-BUS protocol nor how to use it via libdbus nor edelib, but to document and
to document and explain what programs listen or send data via D-BUS protocol. explain what programs listen or what data are send via D-BUS protocol.
Naming convention Naming convention
----------------- -----------------
@ -16,10 +16,9 @@ EDE uses 'org.equinoxproject' as main namespace for interfaces and object paths,
/org/equinoxproject/Desktop # ede-desktop object path /org/equinoxproject/Desktop # ede-desktop object path
----------------------------------------------------------- -----------------------------------------------------------
rest of the name will be application name and method or signal name. If application name Rest of the name will be application name with method or signal name. If application name
is not suitable or could not be represented as D-BUS name or could be ambiguous, it can be replaced is not suitable or could not be represented as D-BUS name (or could be ambiguous), it can be replaced
with application functionality (e.g. 'org.equinoxproject.Desktop' sounds much better than with applications functionality ('org.equinoxproject.Desktop' sounds much better than 'org.equinoxproject.Ede_Desktop').
'org.equinoxproject.Ede_Desktop').
Sample: Sample:
----------------------------------------------------------- -----------------------------------------------------------
@ -31,8 +30,7 @@ Interfaces
org.equinoxproject.Desktop org.equinoxproject.Desktop
~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~
Used by ede-destkop and access object is '/org/eqiunoxproject/Desktop'. Provided Used by ede-desktop and access object is '/org/eqiunoxproject/Desktop'. Provided signals are:
signals are:
DesktopChanged(int32 n, string name) DesktopChanged(int32 n, string name)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

View File

@ -17,12 +17,12 @@
=================== ===================
:Revision: 0.1 :Revision: 0.1
Introduction *Introduction*
- link:README.html[Readme First] - link:README.html[Readme First]
- link:introduction.html[Introduction] - link:introduction.html[Introduction]
Programs *Programs*
- link:ede-calc.html[ede-calc] - link:ede-calc.html[ede-calc]
- link:ede-help.html[ede-help] - link:ede-help.html[ede-help]
@ -30,7 +30,7 @@ Programs
- link:evoke.html[Evoke] - link:evoke.html[Evoke]
- link:emountd.html[Emountd] - link:emountd.html[Emountd]
Development *Development*
- link:hacking.html[Contributing (in your spare time ;-)] - link:hacking.html[Contributing (in your spare time ;-)]
- link:jambuild.html[Jam build] - link:jambuild.html[Jam build]

View File

@ -1,24 +1,17 @@
Introduction Introduction
============ ============
Equinox Desktop Environment or EDE is small desktop environment, Equinox Desktop Environment or EDE is small desktop environment, built to be simple and fast.
built to be simple and fast.
It is based on concept of separated components, so each of them can EDE has a separated components, so each of them can be built, installed and used independently.
be built, installed and used independently. Of course, full power Of course, the full power comes when they are combined together.
of each component comes when they are combined together due many reasons
like communication protocol between each of them.
One of the main goals for EDE is to make desktop environment simple One of the main goals for EDE is to make desktop environment simple for usage and as much as
for usage and as much as possible productive. So, when you start it, possible productive. So, when you start it, it is already assumed you know where the things are.
it is already assumed you know 'where things are'. This is accomplished This is accomplished with familliar look and feel without needs to learn how to start some application
with familliar look and feel, without needs to learn 'how to start some application'
or how to shutdown environment or computer. or how to shutdown environment or computer.
It is based on http://www.fltk.org[FLTK] GUI library with addition of our It is based on http://www.fltk.org[FLTK] GUI library with addition of our 'edelib' library.
'edelib' library.
EDE also tries to be http://freedesktop.org[freedesktop.org] friendly EDE strives to be http://freedesktop.org[freedesktop.org] friendly following proposed standards. This
following proposed standards; this allows easier integration with other allows easier integration with other desktop environments, their components or data.
desktop environments, or their components (counting those that follows
freedesktop.org specifications).

View File

@ -28,7 +28,7 @@
#include <edelib/Nls.h> #include <edelib/Nls.h>
#include "icons/ede.xpm" #include "icons/ede.xpm"
static Fl_Pixmap image_ede(ede_xpm); static Fl_Pixmap image_ede((const char**)ede_xpm);
Fl_Window* win; Fl_Window* win;
Fl_Text_Buffer* stylebuff; Fl_Text_Buffer* stylebuff;

View File

@ -113,7 +113,7 @@ CrashDialog::CrashDialog() : Fl_Window(DIALOG_W, DIALOG_H, _("EDE crash handler"
details_shown = false; details_shown = false;
begin(); begin();
pix = new Fl_Pixmap(core_xpm); pix = new Fl_Pixmap((const char**)core_xpm);
icon_box = new Fl_Box(10, 10, 70, 75); icon_box = new Fl_Box(10, 10, 70, 75);
icon_box->image(pix); icon_box->image(pix);

View File

@ -13,12 +13,12 @@
#ifndef __CRASHDIALOG_H__ #ifndef __CRASHDIALOG_H__
#define __CRASHDIALOG_H__ #define __CRASHDIALOG_H__
#include <FL/Fl_Window.H>
#include <FL/Fl_Box.H> #include <FL/Fl_Box.H>
#include <FL/Fl_Button.H> #include <FL/Fl_Button.H>
#include <FL/Fl_Pixmap.H> #include <FL/Fl_Pixmap.H>
#include <FL/Fl_Text_Display.H> #include <FL/Fl_Text_Display.H>
#include <FL/Fl_Text_Buffer.H> #include <FL/Fl_Text_Buffer.H>
#include <FL/Fl_Window.H>
#include <edelib/String.h> #include <edelib/String.h>

View File

@ -16,7 +16,7 @@
#define CHECK_ARGV(argv, pshort, plong) ((strcmp(argv, pshort) == 0) || (strcmp(argv, plong) == 0)) #define CHECK_ARGV(argv, pshort, plong) ((strcmp(argv, pshort) == 0) || (strcmp(argv, plong) == 0))
const char* next_param(int curr, char** argv, int argc) { static const char* next_param(int curr, char** argv, int argc) {
int j = curr + 1; int j = curr + 1;
if(j >= argc) if(j >= argc)
return NULL; return NULL;
@ -25,7 +25,7 @@ const char* next_param(int curr, char** argv, int argc) {
return argv[j]; return argv[j];
} }
void help(void) { static void help(void) {
puts("Usage: ede-crasher [OPTIONS]"); puts("Usage: ede-crasher [OPTIONS]");
puts("EDE crash handler\n"); puts("EDE crash handler\n");
puts("Options:"); puts("Options:");

View File

@ -38,7 +38,7 @@ EDELIB_NS_USING(run_sync)
EDELIB_NS_USING(run_async) EDELIB_NS_USING(run_async)
EDELIB_NS_USING(alert) EDELIB_NS_USING(alert)
static Fl_Pixmap image_run(run_xpm); static Fl_Pixmap image_run((const char**)run_xpm);
static Fl_Input* dialog_input; static Fl_Input* dialog_input;
static Fl_Check_Button* in_term; static Fl_Check_Button* in_term;

View File

@ -27,7 +27,7 @@
#include "XScreenSaver.h" #include "XScreenSaver.h"
#include "icons/energy.xpm" #include "icons/energy.xpm"
static Fl_Pixmap image_energy(energy_star_xpm); static Fl_Pixmap image_energy((const char**)energy_star_xpm);
static Fl_Spinner* standby_val; static Fl_Spinner* standby_val;
static Fl_Spinner* suspend_val; static Fl_Spinner* suspend_val;

View File

@ -44,7 +44,7 @@ Fl_Menu_Item menu_timeFormat[] = {
{0} {0}
}; };
static Fl_Pixmap image_world(world2_xpm); static Fl_Pixmap image_world((const char**)world2_xpm);
Fl_Choice* timeZonesList=(Fl_Choice *)0; Fl_Choice* timeZonesList=(Fl_Choice *)0;
Fl_Button* applyButton; Fl_Button* applyButton;

View File

@ -42,7 +42,7 @@ EDELIB_NS_USING(user_config_dir)
EDELIB_NS_USING(alert) EDELIB_NS_USING(alert)
EDELIB_NS_USING(DESK_FILE_TYPE_APPLICATION) EDELIB_NS_USING(DESK_FILE_TYPE_APPLICATION)
static Fl_Pixmap image_hint(hint_xpm); static Fl_Pixmap image_hint((const char**)hint_xpm);
Fl_Window* win; Fl_Window* win;
Fl_Check_Button* check_button; Fl_Check_Button* check_button;

View File

@ -60,7 +60,7 @@ typedef list<DialogEntry*>::iterator DialogEntryListIter;
static Fl_Window* dialog_win; static Fl_Window* dialog_win;
static Fl_Check_Browser* cbrowser; static Fl_Check_Browser* cbrowser;
static Fl_Pixmap warnpix(warning_xpm); static Fl_Pixmap warnpix((const char**)warning_xpm);
static char* get_basename(const char* path) { static char* get_basename(const char* path) {
char* p = strrchr(path, '/'); char* p = strrchr(path, '/');