Enlightenment CVS committal
Author : atmosphere
Project : e17
Module : apps/entrance
Dir : e17/apps/entrance/doc
Modified Files:
entrance.doxygen
Log Message:
update example3 to reflect a more current taillights, update config stuff explaining
users,sessions, engines, pointers, system, and auth types.
http://www.atmos.org/docs/entrance/index.html
===================================================================
RCS file: /cvsroot/enlightenment/e17/apps/entrance/doc/entrance.doxygen,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -3 -r1.5 -r1.6
--- entrance.doxygen 26 Jan 2004 04:06:57 -0000 1.5
+++ entrance.doxygen 3 Mar 2004 19:01:46 -0000 1.6
@@ -11,7 +11,7 @@
@version 1.0.0
@author Ibukun Olumuyiwa <[EMAIL PROTECTED]>
@author Corey Donohoe <[EMAIL PROTECTED]>
[EMAIL PROTECTED] 2003
[EMAIL PROTECTED] 2003-2004
<OL>
<LI><A HREF="index.html#intro">What is Entrance?</A>
@@ -88,12 +88,24 @@
Most of the visible beauty to the user comes from the theme. You can
download themes in .eet format and copy them to
'/usr/share/entrance/themes'. If the theme you'd like to run has been
-installed, changed the key '<B>/entrance/themes</B>' to reflect the filename
-of the theme you just installed.
+installed, changed the key '<strong>/entrance/themes</strong>' to reflect
+the filename of the theme you just installed. If you'd like to test your
+theme without changing your config you can issues this command to load a
+theme called "mytheme"
[EMAIL PROTECTED]
+$ entrance -T -t mynewtheme
[EMAIL PROTECTED]
@section config_pointer Setting the pointer Image
Entrance allows you to pick an image file as the pointer when using the
-mouse. I don't remember how to change this right now.
+mouse. Open up that wonderful thing we call the entrance system
+configuration editor and set the key.
[EMAIL PROTECTED]
+/entrance/pointer pointer.png
[EMAIL PROTECTED]
+This should be the full path to Image file on disk that you want to load the
+pointer from. Note png is probably the best format here since you'll get
+transparency in the evas.
@section config_datetime Setting up date and time formatting
Entrance allows you to pick date formatting displayed in your theme. Your
@@ -108,16 +120,81 @@
your theme.
@section config_system Enabling/Disabling Shutdown and Reboot
+Entrance gives the themer an option of telling the system when to reboot and
+shutdown. If this isn't acceptable for your system we offer ways to turn it
+off. Load up your system config tool, and edit your db!
[EMAIL PROTECTED]
+/entrance/system/reboot 1
+/entrance/system/halt 1
[EMAIL PROTECTED]
+Simply set those variables to 0, and Entrance won't allow themers to reboot
+your box based on some user interaction. :)
@section config_users Setting up user lists
-TODO
[EMAIL PROTECTED] config_session Setting up XSessions
-TODO
+Entrance will automatically generate your user lists for you as users log in
+and out by default. You can disable this elsewhere in the config. The
+easiest way to setup a user is to log in once.
+First find the file you want to represent you at the login screen, copy it
+to the system user directory. For an eet you might.
[EMAIL PROTECTED]
+$ sudo cp myusername.eet /usr/share/entrance/users/
[EMAIL PROTECTED]
+For a jpg or png it might look like the following
[EMAIL PROTECTED]
+$ sudo cp myusername.jpg /usr/share/entrance/users/
[EMAIL PROTECTED]
+Next Edit your system's config db with edb_gtk_ed. You'll see your username
+somewhere in the list(unless of course you've disabled this feature)
[EMAIL PROTECTED]
+/entrance/users/0/name myusername
+/entrance/users/0/icon default.eet
+/entrance/users/0/session Enlightenment
[EMAIL PROTECTED]
+You can change the /entrance/users/0/icon attribute to point to the file you
+copied to your users directory. NOTE: The image file must be a format your
+evas has a loader for.
+
[EMAIL PROTECTED] config_sessions Setting up XSessions
+Hopefully we'll have an application to do this for us soon. If it makes
+sense to you, you'll figure it out, if not sorry it can be rather painful on
+some systems. Do not that <strong>~/.xsession</strong> will be executed
+on most systems if you choose the "Default" session from the session list.
+If you don't have a <strong>~/.xsession</strong>, create your own! It
+should look something like the following.
[EMAIL PROTECTED]
+eval `ssh-agent`
+exec /usr/bin/enlightenment
[EMAIL PROTECTED]
+Please be sure that <strong>~/.xsession</strong> is executable.
[EMAIL PROTECTED]
+$ chmod +x ~/.xsession
[EMAIL PROTECTED]
+
@section config_auth Setting up the Authentication Type
-TODO
+Most systems use pam for authentication and you won't need to change this
+for the most part. If you're on a system lacking pam support you can use
+the shadow support entrance also offers. Load up your system's
+configuration in edb_gtk_ed and change the
[EMAIL PROTECTED]
+/entrance/auth 1
[EMAIL PROTECTED]
+<ol>
+<li>Set this variable to 1 if you want pam authentication</li>
+<li>Set this variable to 2 if you want shadow authentication</li>
+</ol>
@section config_engine Setting the Evas Engine
-TODO
-
+Some systems have GL built into their evas and ecore_evas systems. We offer
+the ability to use this feature, but don't support any problems you find
+running under the GL Engine. If it works in software_x11 and not in GL it's
+considered a GL bug. To try out Entrance in GL mode you need to
+load up your system's configuration in edb_gtk_ed and change the
[EMAIL PROTECTED]
+/entrance/engine software
[EMAIL PROTECTED]
+<ol>
+<li>Set this variable to "software" if you want software_x11 ecore evas</li>
+<li>Set this variable to "gl" if you want gl_x11 ecore_evas </li>
+</ol>
@section example1 Example One
You'll need to get comfortable with Edje. This is not an intro to Edje,
@@ -781,26 +858,31 @@
process, but after digging around in other themes long enough I was ready to
begin. </P>
<P>Using the template file above, I started working on the theme part by
-part, testing it as I went along.(The only current way to test Entrance
-themes is to a) set X_TESTING to 1 in src/client/entrance.h of the entrance
-source, or start Entrance in an Xnest session) Sub-Edjes, smaller components
-of the whole edje, can be designed independently, and reused if they're
-written with proper care. In order to make things more clear, Edje parts
-that have to do with entrance are LabeledSoTheyAreEasyToIdentify, while Edje
-parts that are not relevant to Entrance are named in lower case. Also notice
-that the programs for each sub-edje are broken out for coherency also.</P>
-<P>
+part, testing it as I went along.
[EMAIL PROTECTED]
+$ ./cg
+$ sudo cp mynewtheme.eet /usr/share/entrance/themes/
+$ entrance -T -t mynewtheme
[EMAIL PROTECTED]
+Sub-Edjes, smaller components of the whole edje, can be designed
+independently, and reused if they're written with proper care. In order to
+make things more clear, Edje parts that have to do with entrance are
+LabeledSoTheyAreEasyToIdentify, while Edje parts that are not relevant to
+Entrance are named in lower case. Also notice that the programs for each
+sub-edje are broken out for coherency also.</p>
+<p>
What follows the main edc for Example3, titled "Headlights". A short divx4
-capture(poor quality) is available <A HREF="./headlights.avi">here</A>. A
-screenshot of this theme doesn't do it justice, the animation present has to
-be captured by video. The complete <A
-HREF="./EntranceExample3.tar.gz">source code</A> and images are available,
-and the reader is encouraged to disect this source code.
+capture(poor quality) is available <a
+href="http://www.atmos.org/files/entrance.avi";>here</a>. A screenshot of
+this theme doesn't do it justice, the animation present has to be captured
+by video. The complete <A HREF="./EntranceExample3.tar.gz">source code</A>
+and images are available, and the reader is encouraged to disect this source
+code.
@verbatim
/***************************************************************************
* Corey Donohoe<[EMAIL PROTECTED]>
- * Theme: headlights
+ * Theme: taillights
*
* Borders by Tokyo : tokyo.cored.org
* Various images by Rephorm: www.rephorm.com
@@ -808,6 +890,8 @@
* Various images by Raster : www.rasterman.com
**************************************************************************/
+#define DEBUG 0
+
/**
* include our image { } block elsewhere
*/
@@ -880,6 +964,22 @@
*/
#include "parts/login_area.edc"
+#if DEBUG
+#include "parts/debug.edc"
+#endif
+
+/**
+ * provides:
+ * confirmation_reboot_clip
+ * confirmation_reboot_yes
+ * confirmation_reboot_no
+ *
+ * confirmation_halt_clip
+ * confirmation_halt_yes
+ * confirmation_halt_no
+ *
+ */
+#include "parts/confirmation_dialog.edc"
}
programs {
program {
@@ -888,6 +988,21 @@
source, "";
action, SIGNAL_EMIT "EntranceUserAuthSuccessDone" "";
}
+#if DEBUG
+#include "programs/debug_programs.edc"
+#endif
+
+/**
+ * emit signals to entrance related to the system, AFTER the user
+ * clicks "Yes" on the confirmation dialog
+ * Also handle showing/hiding of the confirmation dialogs
+ *
+ * EntranceSystemHalt
+ * EntranceSystemReboot
+ *
+ */
+#include "programs/confirmation_dialog_programs.edc"
+
/**
* handle EntranceSessionList callbacks:
* minimize, show, etc
@@ -913,16 +1028,12 @@
#include "programs/login_area_programs.edc"
/**
- * emit signals to entrance, related to the system halting
- *
- * EntranceSystemHalt
+ * provide mouse effects to the power button
*/
#include "programs/power_button_programs.edc"
/**
- * emit signals to entrance, related to the system rebooting
- *
- * EntranceSystemReboot
+ * provide mouse effects to the restart button
*/
#include "programs/restart_button_programs.edc"
@@ -940,6 +1051,12 @@
* maintain
*/
#include "programs/effects_programs.edc"
+
+ /**
+ * enable user auto save of the sessions they select
+ */
+#include "programs/session_save_dialog_programs.edc"
+
}
}
/**
@@ -965,6 +1082,27 @@
#include "programs/session_group_programs.edc"
}
}
+ group
+ {
+ name, "User";
+ parts
+ {
+/**
+ * provides the EntranceUserIcon and EntranceUserName parts
+ */
+#include "parts/user_group.edc"
+ }
+ programs
+ {
+/**
+ * emit the following signals to entrance,
+ * UserSelected and
+ * UserUnSelected
+ */
+#include "programs/user_group_programs.edc"
+
+ }
+ }
}
@endverbatim
-------------------------------------------------------
SF.Net is sponsored by: Speed Start Your Linux Apps Now.
Build and deploy apps & Web services for Linux with
a free DVD software kit from IBM. Click Now!
http://ads.osdn.com/?ad_id=1356&alloc_id=3438&op=click
_______________________________________________
enlightenment-cvs mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
