From e8c8485097e04134e46d94efb5a951d4a0bbb14d Mon Sep 17 00:00:00 2001 From: Sanel Zukan Date: Mon, 30 Mar 2009 15:17:00 +0000 Subject: [PATCH] Very tiny documentation revision. Fixed code so it can be compiled on SunStudio without errors. --- Jamconfig.in | 5 ++ Jamfile | 10 +-- README.alpha | 73 ++++--------------- doc/dbus-usage.txt | 14 ++-- doc/index.txt.in | 6 +- doc/introduction.txt | 25 +++---- ede-about/ede-about.cpp | 2 +- ede-crasher/CrashDialog.cpp | 2 +- ede-crasher/CrashDialog.h | 2 +- ede-crasher/ede-crasher.cpp | 4 +- ede-launch/ede-launch.cpp | 2 +- ede-screensaver-conf/ede-screensaver-conf.cpp | 2 +- ede-timedate/ede-timedate.cpp | 2 +- ede-tip/ede-tip.cpp | 2 +- evoke/Autostart.cpp | 2 +- 15 files changed, 54 insertions(+), 99 deletions(-) diff --git a/Jamconfig.in b/Jamconfig.in index 8928cdf..b66e984 100644 --- a/Jamconfig.in +++ b/Jamconfig.in @@ -21,6 +21,11 @@ mandir ?= "@mandir@" ; srcdir ?= "@abs_srcdir@" ; sysconfdir ?= "@sysconfdir@" ; +# compiler +CC = @CC@ ; +C++ = @CXX@ ; +LINK = $(CC) ; + # tools used by jam rules XGETTEXT ?= @XGETTEXT@ ; MSGFMT ?= @MSGFMT@ ; diff --git a/Jamfile b/Jamfile index 197158c..343e837 100644 --- a/Jamfile +++ b/Jamfile @@ -28,16 +28,16 @@ SubInclude TOP ede-image-view ; SubInclude TOP elma ; SubInclude TOP ede-launch ; SubInclude TOP emountd ; -SubInclude TOP ede-panel ; +#SubInclude TOP ede-panel ; SubInclude TOP ede-timedate ; SubInclude TOP ede-tip ; -SubInclude TOP edewm ; +#SubInclude TOP edewm ; SubInclude TOP evoke ; SubInclude TOP doc ; SubInclude TOP data ; SubInclude TOP services ; # efile is not compileable on FreeBSD -if $(OS) != FREEBSD { - SubInclude TOP efiler ; -} +#if $(OS) != FREEBSD { +# SubInclude TOP efiler ; +#} diff --git a/README.alpha b/README.alpha index 5501878..40ba9ed 100644 --- a/README.alpha +++ b/README.alpha @@ -15,44 +15,40 @@ Build requirements ------------------ 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 -recommend using the latest daily snapshot - they are extremely stable and -that's what we use internally - although 1.1.7 should work too. +of this writing, latest stable version is 1.1.9. -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 -library is also required for compiling EDE 2.0 and should be released together -with EDE. +library is also required for compiling EDE 2.0 and should be released together with EDE. 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 -same time. +edelib (e.g. released at the same time) or that you do SVN checkout at the same time due +their frequent changes. 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 -of its limitations and you can find it on our repository. +Also you will need a Jam tool. Jam is a make replacement and you can find it on our repository. Downloading the code -------------------- -The best way to download latest code is checking it out from our repository. Make sure -you checkout jam (if you already don't have it installed), edelib, ede2 and efltk modules. - -Here are the commands: +The best way to download latest code is checking it out from our repository. These modules +you should checkout (with their paths): - jam : 'svn co https://ede.svn.sourceforge.net/svnroot/ede/trunk/jam' - edelib : 'svn co https://ede.svn.sourceforge.net/svnroot/ede/trunk/edelib' - ede : 'svn co https://ede.svn.sourceforge.net/svnroot/ede/trunk/ede2' - 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 ------------------------ 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 - 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 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' 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' @@ -68,47 +64,10 @@ In order to build and install EDE do the following steps: 7. jam install -Important stuff that isn't updated (requires efltk) ---------------------------------------------------- +Used programs that requires eFLTK +--------------------------------- - edewm -- eworkpanel +- ede-panel -We are in the process of rewriting these modules from scratch so older versions -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. +These programs are planned to be replaced with the new ones. diff --git a/doc/dbus-usage.txt b/doc/dbus-usage.txt index 5b4993f..cda81bc 100644 --- a/doc/dbus-usage.txt +++ b/doc/dbus-usage.txt @@ -4,8 +4,8 @@ D-BUS usage in EDE Introduction ------------ 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 -to document and explain what programs listen or send data via D-BUS protocol. +It is not meant to describe D-BUS protocol nor how to use it via libdbus nor edelib, but to document and +explain what programs listen or what data are send via D-BUS protocol. 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 ----------------------------------------------------------- -rest of the name will be application name and 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 -with application functionality (e.g. 'org.equinoxproject.Desktop' sounds much better than -'org.equinoxproject.Ede_Desktop'). +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 +with applications functionality ('org.equinoxproject.Desktop' sounds much better than 'org.equinoxproject.Ede_Desktop'). Sample: ----------------------------------------------------------- @@ -31,8 +30,7 @@ Interfaces org.equinoxproject.Desktop ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Used by ede-destkop and access object is '/org/eqiunoxproject/Desktop'. Provided -signals are: +Used by ede-desktop and access object is '/org/eqiunoxproject/Desktop'. Provided signals are: DesktopChanged(int32 n, string name) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/index.txt.in b/doc/index.txt.in index 0b1b5fe..40722af 100644 --- a/doc/index.txt.in +++ b/doc/index.txt.in @@ -17,12 +17,12 @@ =================== :Revision: 0.1 -Introduction +*Introduction* - link:README.html[Readme First] - link:introduction.html[Introduction] -Programs +*Programs* - link:ede-calc.html[ede-calc] - link:ede-help.html[ede-help] @@ -30,7 +30,7 @@ Programs - link:evoke.html[Evoke] - link:emountd.html[Emountd] -Development +*Development* - link:hacking.html[Contributing (in your spare time ;-)] - link:jambuild.html[Jam build] diff --git a/doc/introduction.txt b/doc/introduction.txt index fce7196..b0e2b67 100644 --- a/doc/introduction.txt +++ b/doc/introduction.txt @@ -1,24 +1,17 @@ Introduction ============ -Equinox Desktop Environment or EDE is small desktop environment, -built to be simple and fast. +Equinox Desktop Environment or EDE is small desktop environment, built to be simple and fast. -It is based on concept of separated components, so each of them can -be built, installed and used independently. Of course, full power -of each component comes when they are combined together due many reasons -like communication protocol between each of them. +EDE has a separated components, so each of them can be built, installed and used independently. +Of course, the full power comes when they are combined together. -One of the main goals for EDE is to make desktop environment simple -for usage and as much as possible productive. So, when you start it, -it is already assumed you know 'where things are'. This is accomplished -with familliar look and feel, without needs to learn 'how to start some application' +One of the main goals for EDE is to make desktop environment simple for usage and as much as +possible productive. So, when you start it, it is already assumed you know where the things are. +This is accomplished with familliar look and feel without needs to learn how to start some application or how to shutdown environment or computer. -It is based on http://www.fltk.org[FLTK] GUI library with addition of our -'edelib' library. +It is based on http://www.fltk.org[FLTK] GUI library with addition of our 'edelib' library. -EDE also tries to be http://freedesktop.org[freedesktop.org] friendly -following proposed standards; this allows easier integration with other -desktop environments, or their components (counting those that follows -freedesktop.org specifications). +EDE strives to be http://freedesktop.org[freedesktop.org] friendly following proposed standards. This +allows easier integration with other desktop environments, their components or data. diff --git a/ede-about/ede-about.cpp b/ede-about/ede-about.cpp index d4fa4c4..16b3c9b 100644 --- a/ede-about/ede-about.cpp +++ b/ede-about/ede-about.cpp @@ -28,7 +28,7 @@ #include #include "icons/ede.xpm" -static Fl_Pixmap image_ede(ede_xpm); +static Fl_Pixmap image_ede((const char**)ede_xpm); Fl_Window* win; Fl_Text_Buffer* stylebuff; diff --git a/ede-crasher/CrashDialog.cpp b/ede-crasher/CrashDialog.cpp index 20218d2..9066cb7 100644 --- a/ede-crasher/CrashDialog.cpp +++ b/ede-crasher/CrashDialog.cpp @@ -113,7 +113,7 @@ CrashDialog::CrashDialog() : Fl_Window(DIALOG_W, DIALOG_H, _("EDE crash handler" details_shown = false; 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->image(pix); diff --git a/ede-crasher/CrashDialog.h b/ede-crasher/CrashDialog.h index 4ae1134..c6041a3 100644 --- a/ede-crasher/CrashDialog.h +++ b/ede-crasher/CrashDialog.h @@ -13,12 +13,12 @@ #ifndef __CRASHDIALOG_H__ #define __CRASHDIALOG_H__ -#include #include #include #include #include #include +#include #include diff --git a/ede-crasher/ede-crasher.cpp b/ede-crasher/ede-crasher.cpp index e526d7d..f04f875 100644 --- a/ede-crasher/ede-crasher.cpp +++ b/ede-crasher/ede-crasher.cpp @@ -16,7 +16,7 @@ #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; if(j >= argc) return NULL; @@ -25,7 +25,7 @@ const char* next_param(int curr, char** argv, int argc) { return argv[j]; } -void help(void) { +static void help(void) { puts("Usage: ede-crasher [OPTIONS]"); puts("EDE crash handler\n"); puts("Options:"); diff --git a/ede-launch/ede-launch.cpp b/ede-launch/ede-launch.cpp index 9953767..299c3cf 100644 --- a/ede-launch/ede-launch.cpp +++ b/ede-launch/ede-launch.cpp @@ -38,7 +38,7 @@ EDELIB_NS_USING(run_sync) EDELIB_NS_USING(run_async) 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_Check_Button* in_term; diff --git a/ede-screensaver-conf/ede-screensaver-conf.cpp b/ede-screensaver-conf/ede-screensaver-conf.cpp index cc2c663..3d8697b 100644 --- a/ede-screensaver-conf/ede-screensaver-conf.cpp +++ b/ede-screensaver-conf/ede-screensaver-conf.cpp @@ -27,7 +27,7 @@ #include "XScreenSaver.h" #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* suspend_val; diff --git a/ede-timedate/ede-timedate.cpp b/ede-timedate/ede-timedate.cpp index 38c1136..63070d6 100644 --- a/ede-timedate/ede-timedate.cpp +++ b/ede-timedate/ede-timedate.cpp @@ -44,7 +44,7 @@ Fl_Menu_Item menu_timeFormat[] = { {0} }; -static Fl_Pixmap image_world(world2_xpm); +static Fl_Pixmap image_world((const char**)world2_xpm); Fl_Choice* timeZonesList=(Fl_Choice *)0; Fl_Button* applyButton; diff --git a/ede-tip/ede-tip.cpp b/ede-tip/ede-tip.cpp index 0977f04..c168fb0 100644 --- a/ede-tip/ede-tip.cpp +++ b/ede-tip/ede-tip.cpp @@ -42,7 +42,7 @@ EDELIB_NS_USING(user_config_dir) EDELIB_NS_USING(alert) 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_Check_Button* check_button; diff --git a/evoke/Autostart.cpp b/evoke/Autostart.cpp index 7912a67..7a57052 100644 --- a/evoke/Autostart.cpp +++ b/evoke/Autostart.cpp @@ -60,7 +60,7 @@ typedef list::iterator DialogEntryListIter; static Fl_Window* dialog_win; 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) { char* p = strrchr(path, '/');