<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
                         "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
<article id="index">
  <articleinfo>
    <title>About Enlightenment e16</title>
    <pubdate>Apr 19, 2009</pubdate>
    <abstract>
      <para>
	Coming soon. (maybe)
      </para>
    </abstract>
  </articleinfo>
  <sect1 id="credits">
    <title>Credits</title>
    <para>
      This note contains contributions by
      <itemizedlist>
	<listitem>
	  <para>
	    Kim Woelders
	  </para>
	</listitem>
	<listitem>
	  <para>
	    Peter Hyman <email>pete4abw@comcast.net</email>
	  </para>
	</listitem>
	<listitem>
	  <para>
	    Yasufumi Haga <email>yasufumi.haga@nifty.com</email>
	  </para>
	</listitem>
      </itemizedlist>
    </para>
  </sect1>
  <sect1 id="requirements">
    <title>Requirements</title>
    <para>
      <itemizedlist>
	<listitem>
	  <para>
	    <filename>imlib2</filename> &gt;= 1.2.0 is required, &gt;= 1.4.2 is recommended.
	  </para>
	</listitem>
	<listitem>
	  <para>
	    <filename>imlib2</filename> must be built with png support.
	  </para>
	</listitem>
      </itemizedlist>
    </para>
  </sect1>
  <sect1 id="installation">
    <title>Installation</title>
    <para>
      <programlisting>
	./configure
	make
	sudo make install
      </programlisting>
    </para>
    <para>
      For additional help on package configuration, see
      <programlisting>
	./configure --help
      </programlisting>
    </para>
  </sect1>
  <sect1 id="versions">
    <title>Versions</title>
    <para>
      <variablelist>
	<varlistentry>
	  <term>
	    e16-1.0.0:
	  </term>
	  <listitem>
	    <para>
              No major changes, might as well have been 0.16.8.16.
	    </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term>
	    e16-0.16.8
	  </term>
	  <listitem>
	    <para>
	      <itemizedlist>
		<listitem>
		  <para>
		    Released Feb 2006
		  </para>
		</listitem>
		<listitem>
		  <para>
		    enlightenment -&gt; e16
		  </para>
		</listitem>
		<listitem>
		  <para>
		    Major internal rewrite
		  </para>
		</listitem>
		<listitem>
		  <para>
		    Changed configuration system
		  </para>
		</listitem>
		<listitem>
		  <para>
		    Added compositing manager
		  </para>
		</listitem>
	      </itemizedlist>
	    </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term>
	    enlightenment-0.16.7
	  </term>
	  <listitem>
	    <para>
	      <itemizedlist>
		<listitem>
		  <para>
		    Released Jul 2004
		  </para>
		</listitem>
		<listitem>
		  <para>
                    Migrated to imlib2
		  </para>
		</listitem>
	      </itemizedlist>
	    </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term>
	    enlightenment-0.16.6
	  </term>
	  <listitem>
	    <para>
	      <itemizedlist>
		<listitem>
		  <para>
		    Released Nov 2003
		  </para>
		</listitem>
		<listitem>
		  <para>
                    Added extended window manager hint support
		  </para>
		</listitem>
	      </itemizedlist>
	    </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term>
	    enlightenment-0.16.5
	  </term>
	  <listitem>
	    <para>
	      Released Oct 2000
	    </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term>
	    enlightenment-0.16.0
	  </term>
	  <listitem>
	    <para>
	      Released Oct 1999
	    </para>
	  </listitem>
	</varlistentry>
      </variablelist>
    </para>
  </sect1>
  <sect1 id="configuration">
    <title>Configuration</title>
    <para>
      All settings can be shown and set using <application>eesh</application>.
    </para>
    <para>
      To get a full list of settings:
      <programlisting>
	$ eesh show
      </programlisting>
    </para>
    <para>
      To set some parameter:
      <programlisting>
	$ eesh set &lt;parameter&gt; &lt;value&gt;
      </programlisting>
    </para>
    <para>
      Some settings will not be effective until <application>E</application> is restarted.
    </para>
    <para>
      To get a list of all <application>eesh</application> commands:
      <programlisting>
	$ eesh help full
      </programlisting>
    </para>
    <para>
      The available configuration options are shown below. Values are the defaults.
      <programlisting>
	# [bool] High quality background rendering
	backgrounds.hiquality = 1
	# [bool] Prefer user selected backgrounds over theme settings
	backgrounds.user = 1
	# [bool] Do not scan all backgrounds when starting background configuration dialog
	backgrounds.no_scan = 0
	# [int] Time out for unused background image pixmaps
	backgrounds.timeout = 240

	# [bool] Enable composite manager
	compmgr.enable = 0
	# [int] Composite manager mode (always 1 atm)
	compmgr.mode = 1
	# [int] Dropshadow mode (0: off, 1: sharp, 2: blurry, 3: echo)
	compmgr.shadows.mode = 0
	# [int] Dropshadow offset
	compmgr.shadows.offset_x = 3
	compmgr.shadows.offset_y = 5
	# [int] Blurry dropshadow radius
	compmgr.shadows.blur.radius = 5
	# [int] Blurry dropshadow opacity(%)
	compmgr.shadows.blur.opacity = 75
	# [int] Sharp dropshadow opacity(%)
	compmgr.shadows.sharp.opacity = 30
	# [int] Shadow color (0xRRGGBB)
	compmgr.shadows.color = 0
	# [bool] Hack to fix problems with resize on old xorg servers
	compmgr.resize_fix_enable = 0
	# [bool] Experimental - leave at 0
	compmgr.use_name_pixmap = 0
	# [bool] Use composite overlay window
	compmgr.use_cow = 1
	# [bool] Enable fading
	compmgr.fading.enable = 1
	# [int] Fading time(ms)
	compmgr.fading.time = 200
	# [int] Composite redirection of override-redirect windows (0: off, 1: on map, ...: testing)
	# Should normally be 1 but 0 may be a partial workaround of problems with vanishing
	# pop-ups on certain X-server/toolkit versions.
	compmgr.override_redirect.mode = 1
	# [int] Opacity of override-redirect windows (pop-up's, etc)
	compmgr.override_redirect.opacity = 90

	# [int] Number of desktops
	desktops.num = 2
	# [int] Desktop dragging direction
	desktops.dragdir = 2
	# [int] Desktop dragbar width (0: disable)
	desktops.dragbar_width = 16
	# [int] Desktop dragbar length (0: full)
	desktops.dragbar_length = 0
	# [int] Desktop dragbar button ordering
	desktops.dragbar_ordering = 1
	# [bool] Wrap around on desk switch (last &lt;-&gt; first on next/prev)
	desktops.desks_wraparound = 0
	# [bool] Slide desks in when switching
	desktops.slidein = 1
	# [int] Desk slide speed
	desktops.slidespeed = 6000
	# [int] Size of virtual desktop
	desktops.areas_nx = 2
	desktops.areas_ny = 1
	# [bool] Wrap around on area switch (last &lt;-&gt; first on next/prev)
	desktops.areas_wraparound = 0
	# [int] Edge flip mode (0: off, 1: on, 2: only when moving window)
	desktops.edge_flip_mode = 1
	# [int] Edge flip resistance(pixels)
	desktops.edge_flip_resistance = 25

	# [bool] Enable ripples effect
	effects.ripples.enabled = 0
	# [bool] Enable waves effect
	effects.waves.enabled = 0

	# [int] Focus mode (0: pointer, 1: sloppy, 2: click)
	focus.mode = 1
	# [bool] Raise window when clicked
	focus.clickraises = 1
	# [bool] Transients are placed where leader is
	focus.transientsfollowleader = 1
	# [bool] When a transient is mapped the desk/area is switched to where the transient appears
	focus.switchfortransientmap = 1
	# [bool] Focus new windows
	focus.all_new_windows_get_focus = 0
	# [bool] Focus new transients
	focus.new_transients_get_focus = 0
	# [bool] Focus new transients if group is focused
	focus.new_transients_get_focus_if_group_focused = 1
	# [bool] Raise window on focus next
	focus.raise_on_next = 1
	# [bool] Warp pointer to window on focus next
	focus.warp_on_next = 0
	# [bool] Always warp pointer into window when new window is focused
	focus.warp_always = 0
	# [bool] Enable autoraise
	focus.autoraise.enable = 0
	# [int] Autoraise delay(ms)
	focus.autoraise.delay = 500

	# [bool] Default group settings
	groups.dflt.iconify = 1
	groups.dflt.kill = 0
	groups.dflt.move = 1
	groups.dflt.raise = 0
	groups.dflt.set_border = 1
	groups.dflt.stick = 1
	groups.dflt.shade = 1
	groups.swapmove = 1

	# [int] Iconbox animation time(ms)
	iconboxes.anim_time = 250

	# [string] Language used by e16 (dialogs, tooltips, etc.)
	# Inherit from environment if not set
	locale.internal = 
	# [string] Language exported when starting applications
	# Inherit from environment if not set
	locale.exported = 

	# [bool] Animate menus
	menus.animate = 0
	# [bool] Keep menus on-screen
	menus.onscreen = 1
	# [bool] Warp pointer when sliding menus
	menus.warp = 1
	# [bool] Enable icons in menus
	menus.show_icons = 1
	# [int] Menu icon size(pixels)
	menus.icon_size = 16
	# [int] Menu navigation keycodes
	menus.key.left = 0xff51
	menus.key.right = 0xff53
	menus.key.up = 0xff52
	menus.key.down = 0xff54
	menus.key.escape = 0xff1b
	menus.key.ret = 0xff0d

	# [int] Animation time step(ms)
	misc.animation.step = 10

	# [int] Button move resistance(pixels)
	misc.buttons.move_resistance = 10

	# [bool] Show headers in dialogs
	misc.dialogs.headers = 0
	# [bool] Enable images on dialog buttons
	misc.dialogs.button_image = 0

	# [bool] Enable docking of dockapps
	misc.dock.enable = 1
	# [bool] Make all dockapps sticky
	misc.dock.sticky = 1
	# [int] Dock direction
	misc.dock.dirmode = 3
	# [int] Dock start position
	misc.dock.startx = 0
	misc.dock.starty = 0

	# [bool] Enable desktop background compatibility mode
	# Fixes background in many apps using pseudotransparency
	# May cause major slowdowns in certain setups
	misc.hints.set_xroot_info_on_root_window = 0

	# [int] Move mode (0: opaque, 1: technical, 2: box, 3: shaded, 4: semi-solid, 5: translucent)
	misc.movres.mode_move = 0
	# [int] Resize mode (0: opaque, 1: technical, 2: box, 3: shaded, 4: semi-solid)
	misc.movres.mode_resize = 2
	# [int] Geometry indicator mode (0: off, 1: window center, 2: screen corner)
	misc.movres.mode_info = 1
	# [int] Default maximize mode (0: Absolute, 1: Available, 2: Conservative)
	misc.movres.mode_maximize_default = 1
	# [int] Move/resize color (RGB) when using non-server-grabbing technincal/box modes.
	misc.movres.color = 0xff0000
	# [bool] Avoid server grab
	# Use non-server-grabbing line drawing technique in technical and box modes.
	misc.movres.avoid_server_grab = 1
	# [bool] Send synthetic ConfigureNotify's while moving
	# Causes pseudotransparent apps to update while moving (expensive)
	misc.movres.update_while_moving = 0
	# [bool] Use SYNC_REQUEST's to synchronize move/resize with client
	misc.movres.enable_sync_request = 0
	# [bool] Do not cover dragbar when maximizing
	misc.movres.dragbar_nocover = 0

	# [int] Composite opacity of menu windows
	misc.opacity.menus = 85
	# [int] Composite opacity of windows being moved
	misc.opacity.movres = 60
	# [int] Composite opacity of tooltip windows
	misc.opacity.tooltips = 80
	# [int] Composite opacity of focused windows
	misc.opacity.focused = 100
	# [int] Composite opacity of unfocused windows
	misc.opacity.unfocused = 100

	# [bool] Place windows manually
	misc.place.manual = 0
	# [bool] Place windows under pointer
	misc.place.manual_mouse_pointer = 0
	# [bool] Center windows when desk is full
	misc.place.center_if_desk_full = 0
	# [bool] Ignore windows with struts (e.g. panels) when placing new window
	misc.place.ignore_struts = 0
	# [bool] Raise fullscreen windows (increase stacking level while fullscreen)
	misc.place.raise_fullscreen = 0
	# [bool] Slide windows in
	misc.place.slidein = 0
	# [bool] Slide windows around while cleaning up
	misc.place.cleanupslide = 1
	# [int] Window slide-in mode (0: opaque, 1: technical, 2: box, 3: shaded, 4: semi-solid)
	misc.place.slidemode = 0
	# [int] Window slide-in speed
	misc.place.slidespeedmap = 6000
	# [int] Window cleanup slidespeed
	misc.place.slidespeedcleanup = 8000

	# [bool] Enable session scripts
	misc.session.enable_script = 0
	# [string] Session script
	misc.session.script = $EROOT/scripts/session.sh
	# [bool] Enable logout dialog
	misc.session.enable_logout_dialog = 1
	# [bool] Enable reboot/halt in logout dialog
	misc.session.enable_reboot_halt = 0
	# [string] Reboot command
	misc.session.cmd_reboot = reboot
	# [string] Halt command
	misc.session.cmd_halt = poweroff

	# [bool] Enable animation of window shading
	misc.shading.animate = 1
	# [int] Shading speed
	misc.shading.speed = 8000

	# [bool] Enable resistance when moving windows
	misc.snap.enable = 1
	# [int] Resistance at other window edge
	misc.snap.edge_snap_dist = 8
	# [int] Resistance at screen edge
	misc.snap.screen_snap_dist = 32

	# [bool] First time flag
	misc.startup.firsttime = 0
	# [bool] Enable sliding startup windows
	misc.startup.animate = 1

	# [bool] Test options (do not change)
	misc.testing.argb_internal_objects = 0
	misc.testing.argb_internal_clients = 0
	misc.testing.argb_clients = 0
	misc.testing.argb_clients_inherit_attr = 0
	misc.testing.image_cache_size = -1
	misc.testing.mask_alpha_threshold = 8
	misc.testing.enable_startup_id = 1
	misc.testing.use_render_for_scaling = 0
	misc.testing.bindings_reload = 1
	misc.testing.no_sync_mask = 0

	# [bool] Save configuration changes
	misc.autosave = 1
	# [bool] Keep memory usage down (should probably always be 1)
	misc.memory_paranoia = 1
	# [bool] Use save-unders when appropriate
	misc.save_under = 0
	# [bool] Show differential time in debug output
	misc.difftime = 0

	# [bool] Enable pagers
	pagers.enable = 1
	# [bool] Enable zooming of pager snapshot windows
	pagers.zoom = 1
	# [bool] Show window name pop-ups
	pagers.title = 1
	# [bool] Enable high quality snapshots
	pagers.hiq = 1
	# [int] Pager mode (0: simple, 1: snap, 2: live)
	pagers.mode = 2
	# [int] Scan/update speed (lines/updates per second. Used only in snap or live mode)
	pagers.scanspeed = 10
	# [int] Pager buttons
	pagers.sel_button = 2
	pagers.win_button = 1
	pagers.menu_button = 3

	# [bool] Enable sound
	sound.enable = 0
	# [string] Use sounds from theme
	sound.theme = 
	# [int] Bits masks for disabling particular sounds
	sound.mask1 = 0
	sound.mask2 = 0

	# [string] Theme
	theme.name = winter
	# [string] Colon separated list of directories containing e16 themes
	theme.extra_path = 
	# [bool] Use font specified by theme
	theme.use_theme_font_cfg = 0
	# [bool] Use alternative font configuration file (specified by theme.font_cfg)
	theme.use_alt_font_cfg = 0
	# [string] Alternative font configuration file
	theme.font_cfg = 

	# [bool] Enable tooltips
	tooltips.enable = 1
	# [bool] Enable root window tooltips
	tooltips.showroottooltip = 1
	# [int] Tooltip delay
	tooltips.delay = 1500

	# [int] Theme transparency(0-255)
	transparency.alpha = 0
	# [int] Item transparencies (0: off, 1: background, 2: glass)
	transparency.menu = 1
	transparency.menu_item = 1
	transparency.tooltip = 2
	transparency.widget = 1
	transparency.hilight = 0
	transparency.border = 1
	transparency.iconbox = 1
	transparency.dialog = 1
	transparency.pager = 1
	transparency.warplist = 1

	# [bool] Enable focus list (alt-tab)
	warplist.enable = 1
	# [bool] Show sticky windows
	warplist.showsticky = 1
	# [bool] Show shaded windows
	warplist.showshaded = 1
	# [bool] Show iconified windows
	warplist.showiconified = 1
	# [bool] Show windows on all desks
	warplist.showalldesks = 0
	# [bool] Warp pointer to focused window
	warplist.warpfocused = 1
	# [bool] Raise window while selecting
	warplist.raise_on_select = 1
	# [bool] Warp pointer to window while selecting
	warplist.warp_on_select = 0
	# [bool] Icon mode (0: none, 3: e/app/snap, 4: app/e/snap)
	warplist.icon_mode = 3
      </programlisting>
    </para>
  </sect1>
  <sect1 id="configurationfiles">
    <title>Configuration files</title>
    <para>
      Skip this section unless you *really* want to know...
    </para>
    <para>
      It is here assumed that <option>--prefix</option> is <filename class="directory">/usr</filename>, and that the default user
      configuration directory (<filename class="directory">~/.e16</filename>) is used.
    </para>
    <para>
      In general, the configuration search order for theme related configuration
      files, say <filename>xyz.cfg</filename>, is:
      <orderedlist>
	<listitem>
	  <para>
	    User configuration directory, i.e. <filename>~/.e16/xyz.cfg</filename>.
	  </para>
	</listitem>
	<listitem>
	  <para>
	    Theme directory, i.e. <filename>/usr/share/e16/themes/&lt;theme&gt;/xyz.cfg</filename>, or
	    <filename>~/.e16/themes/&lt;theme&gt;/xyz.cfg</filename>.
	  </para>
	</listitem>
	<listitem>
	  <para>
	    Default configuration directory, i.e. <filename>/usr/share/e16/config/xyz.cfg</filename>.
	  </para>
	</listitem>
      </orderedlist>
    </para>
    <para>
      Mouse and keybindings are defined in <filename>bindings.cfg</filename>. <filename>bindings.cfg</filename> is searched in
      <orderedlist>
	<listitem>
	  <para>
	    User configuration directory, i.e. <filename>~/.e16/bindings.cfg</filename>.
	  </para>
	</listitem>
	<listitem>
	  <para>
	    Default configuration directory, i.e. <filename>/usr/share/e16/config/bindings.cfg</filename>.
	  </para>
	</listitem>
      </orderedlist>
    </para>
    <para>
      Window matches (border and icon associations) are defined in <filename>windowmatches.cfg</filename>
      and <filename>matches.cfg</filename>.
      <filename>windowmatches.cfg</filename> (deprecated, border associations only) is loaded first,
      and should be found only in theme directories.
      <filename>matches.cfg</filename> is loaded next, and searched in
      <orderedlist>
	<listitem>
	  <para>
	    User configuration directory, i.e. <filename>~/.e16/matches.cfg</filename>.
	  </para>
	</listitem>
	<listitem>
	  <para>
	    Default configuration directory, i.e. <filename>/usr/share/e16/config/matches.cfg</filename>.
	  </para>
	</listitem>
      </orderedlist>
      Window match items are appended to the window match list, in the order
      in which they are read from the configuration files.
      When doing border/icon matches, the window match list is searched from the
      start, and the first matching item will be used.
    </para>
  </sect1>
  <sect1 id="defaultkeybindings">
    <title>Default keybindings</title>
    <para>
      <simplelist type="horiz" columns="3">
	<member>Alt-Ctrl</member><member>Home</member><member>Auto-arrange windows</member>
	<member>Alt-Ctrl</member><member>Insert</member><member>Launch Eterm</member>
	<member>Alt-Ctrl</member><member>Delete</member><member>Log out</member>
	<member>Alt-Ctrl</member><member>End</member><member>Exit</member>
	<member>Alt-Ctrl</member><member>Right</member><member>Goto next desk</member>
	<member>Alt-Ctrl</member><member>Left</member><member>Goto previous desk</member>
	<member>Alt-Shift</member><member>Down</member><member>Move desk area down</member>
	<member>Alt-Shift</member><member>Up</member><member>-    -    -   up</member>
	<member>Alt-Shift</member><member>Left</member><member>-    -    -   left</member>
	<member>Alt-Shift</member><member>Right</member><member>-    -    -   right</member>
	<member>Alt</member><member>F1</member><member>Goto desk 0</member>
	<member>Alt</member><member>F2</member><member>-    -   1</member>
	<member>Alt</member><member>F3</member><member>-    -   2</member>
	<member>Alt</member><member>F4</member><member>-    -   3</member>
	<member>Alt</member><member>F5</member><member>-    -   4</member>
	<member>Alt</member><member>F6</member><member>-    -   5</member>
	<member>Alt</member><member>F7</member><member>-    -   6</member>
	<member>Alt</member><member>F8</member><member>-    -   7</member>
	<member>Alt</member><member>Tab</member><member>Switch focus (using focus list, if enabled)</member>
	<member>Alt-Ctrl</member><member>Up</member><member>Raise active window</member>
	<member>Alt-Ctrl</member><member>Down</member><member>Lower active window</member>
	<member>Alt-Ctrl</member><member>x</member><member>Close active window</member>
	<member>Alt-Ctrl</member><member>k</member><member>Destroy active window</member>
	<member>Alt-Ctrl</member><member>s</member><member>Toggle active window sticky state</member>
	<member>Alt-Ctrl</member><member>i</member><member>Iconify active window</member>
	<member>Alt-Ctrl</member><member>r</member><member>Toggle active window shaded state</member>
	<member>Alt-Ctrl</member><member>f</member><member>Toggle active window fullscreen state</member>
	<member>Alt-Ctrl</member><member>m</member><member>Toggle active window maximized state</member>
	<member>Alt-Ctrl</member><member>w</member><member>Show window-ops menu for active window</member>
	<member>Alt</member><member>Return</member><member>Toggle active window zoomed state</member>
	<member>Ctrl-Shift</member><member>F1</member><member>Show User menu          (default left mouse button)</member>
	<member>Ctrl-Shift</member><member>F2</member><member>Show Enlightenment menu (default middle mouse button)</member>
	<member>Ctrl-Shift</member><member>F3</member><member>Show Configuration menu (default right mouse button)</member>
	<member>Ctrl-Shift</member><member>F4</member><member>Show Window List menu   (default Alt-middle mouse button)</member>
	<member>Alt-Ctrl</member><member>a</member><member>Toggle visibility of all buttons</member>
	<member>Alt-Ctrl</member><member>b</member><member>Toggle visibility of theme buttons</member>
	<member>Alt-Ctrl</member><member>c</member><member>Toggle visibility of configuration buttons</member>
	<member>Alt-Ctrl</member><member>d</member><member>Switch dragbar position</member>
	<member>Alt-Ctrl</member><member>o</member><member>Switch dragbar button ordering</member>
      </simplelist>
    </para>
  </sect1>
  <sect1 id="sessionscripts">
    <title>Session Scripts</title>
    <para>
      <application>Enlightenment</application> can now automatically run user scripts or applications during
      Startup, Restart, and Shutdown. This facilitates the loading of system
      tray applets, rss readers, screensavers, and other daemons (e.g. dbus),
      and allows for cleanup of programs that don't terminate properly when <application>E</application>
      quits (this is especially common with <application>KDE</application> applications in <application>E</application> and the arts
      daemon or dcop server keeps running).
    </para>
    <para>
      <application>Enlightenment</application> accomplishes this with the addition of two new keys in
      the <filename>$ECONFDIR/e_config--#.#.cfg</filename> (#.# may vary depending on your X setup -- 
      for most people, it will be 0.0). These are:
      <programlisting>
	misc.session.enable_script 
	misc.session.script 
      </programlisting>
    </para>
    <para>
      <varname>misc.session.enable_script</varname> is a boolean. When set to 1, <application>Enlightenment</application> will 
      execute the script in the <varname>misc.session.script</varname> key. By default, this feature 
      is disabled. When enabled, it will do nothing until the user configures
      his/her home directory (<filename class="directory">$ECONFDIR</filename> -- normally <filename class="directory">~/.e16</filename>).
    </para>
    <para>
      The default session.script is located in <filename>$EROOT/scripts/session.sh</filename> (<filename class="directory">$EROOT</filename>
      is normally <filename class="directory">/usr/share/e16</filename> or <filename class="directory">/usr/local/share/e16</filename>). It will look for 
      directories in the user's <filename class="directory">$ECONFDIR/</filename> (<filename class="directory">~/.e16/</filename>) called:
      <programlisting>
	~/.e16/ ($ECONFDIR)
	        Init/
	        Start/
	        Stop/
      </programlisting>
      and run any and/or all scripts or executables in each when <application>E</application> starts, 
      restarts, and shuts down. If no scripts or executables are present, or
      if any of the directories <filename class="directory">Init</filename>, <filename class="directory">Start</filename>, and <filename class="directory">Stop</filename> do not exist, NOTHING
      will happen and <application>E</application> will start up as usual. So, in order to use session
      scripts, all the user has to do is to populate the <filename class="directory">Init</filename>, <filename class="directory">Start</filename>, and <filename class="directory">Stop</filename>
      directories with scripts, applications, or links to applications that
      should run during Startup, Restart, or when <application>E</application> is stopped.
    </para>
    <para>
      The default values for the new keys are:
      <programlisting>
	misc.session.enable_script = 0
	misc.session.script = $EROOT/scripts/session.sh
      </programlisting>
    </para>
    <para>
      The user may write a custom script and place it anywhere. Simply modify 
      the config file by using:
      <programlisting>
	$ eesh set misc.session.script myscript
      </programlisting>
      and modify it (be sure to <command>chmod +x</command> the file otherwise it won't run). 
      The session script is called with one of three command parameters; 
      <parameter class="command">init</parameter>, <parameter class="command">start</parameter>, and <parameter class="command">stop</parameter>. Any custom script should have a code block 
      similar to this in order to function properly in <application>Enlightenment</application>.
      <programlisting>
	case "$1" in
	init)
                # do blah
                # or do function init
	start)
                # do blah
                # of do function start
	stop)
                # do blah
                # or do function stop
	esac
      </programlisting>
    </para>
    <para>
      Automatic script running can be enabled/disabled via the Session Settings
      dialog in <application>Enlightenment</application> and checking/unchecking the option Enable Session
      Script, by editing the user cfg file and setting the
      <varname>misc.session.enable_script</varname> key to 1/0, or with
      <programlisting>
	$ eesh set misc.session.enable_script 1/0
      </programlisting>
      This process is very flexible since when used, the user can turn off
      individual scripts and applications by <command>chmod -x</command> or simply leave the
      startup directories empty or remove them.
    </para>
  </sect1>
  <sect1 id="compositemanagernotes">
    <title>Composite manager notes</title>
    <para>
      To use the composite manager it is required that the X-server has support
      enabled for the COMPOSITE, DAMAGE, FIXES, and RENDER extensions.
      For reasonable performance it is also required that hardware acceleration
      of the RENDER extension is enabled.
    </para>
    <para>
      As of version 0.16.8.2 it may happen that the borders on application windows
      using ARGB visuals (for transparency) are "ugly". Applications may use ARGB
      visuals intentionally (e.g. fdclock) or not (e.g. xv on 16 bit root depth).
      Applications unintentionally using an ARGB visual will normally not be
      rendered properly at all and should be started with the environment variable
      <varname>XLIB_SKIP_ARGB_VISUALS</varname> set.
      To fix border rendering on "real" ARGB windows it is required to use <filename>imlib2</filename>
      with version &gt;= 1.3.0.
    </para>
    <para>
      Tweaks:
    </para>
    <para>
      As of e16 &gt;= 0.16.8.9: If there is any kind of trouble with the composite
      manager, first check <varname>compmgr.mode</varname> (<command>eesh show compmgr</command>), and set it to 1 if
      it isn't (<command>eesh set compmgr.mode 1</command>, restart).
    </para>
    <para>
      If pop-up windows disappear immediately after having appeared (may happen
      e.g. with certain pop-up windows when using gnome &gt; 2.12), try:
      <programlisting>
	$ eesh set compmgr.override_redirect.mode 0
      </programlisting>
      This should make the pop-up windows usable, but not always rendered properly.
      This problem should not occur with recent X-servers.
    </para>
    <para>
      If window resize/shading with composite enabled is ugly, try:
      <programlisting>
	$ eesh set compmgr.resize_fix_enable 1
      </programlisting>
      This problem should not occur with recent X-servers.
    </para>
  </sect1>
  <sect1 id="fonts">
    <title>Fonts</title>
    <para>
      Theme font selection depends on a number of settings and whether or not
      the theme has font alias support.
    </para>
    <para>
      For themes with font alias support the fonts are determined by a font
      configuration file. This file is selected as follows, first hit applies:
      <itemizedlist>
	<listitem>
	  <para>
	    If <varname>theme.use_alt_font_cfg</varname> is set (default off) and the the file specified
	    by <varname>theme.font_cfg</varname> is found the fonts are determined by this file.
	  </para>
	</listitem>
	<listitem>
	  <para>
	    If <varname>theme.use_theme_font_cfg</varname> is set (default off) and the theme has a
	    <filename>fonts.theme.cfg</filename> the fonts are determined by the theme's <filename>fonts.theme.cfg</filename>.
	  </para>
	</listitem>
	<listitem>
	  <para>
	    If <application>e16</application> was built with <application>pango</application> support, look for <filename>fonts.pango.cfg</filename>.
	  </para>
	</listitem>
	<listitem>
	  <para>
	    If <application>e16</application> was built with <application>xft</application> support, look for <filename>fonts.xft.cfg</filename>.
	  </para>
	</listitem>
	<listitem>
	  <para>
	    Look for <filename>fonts.cfg</filename>.
	  </para>
	</listitem>
      </itemizedlist>
    </para>
    <para>
      The font configuration file search path is <filename class="directory">~/.e16, &lt;theme-dir&gt;</filename>, and
      <filename class="directory">/usr/share/e16/config</filename>.
      Default <filename>fonts.pango.cfg</filename> and <filename>fonts.xft.cfg</filename> are provided in <filename class="directory">/usr/share/e16/config</filename>.
    </para>
    <para>
      The default theme (winter) and the core themes (BlueSteel, BrushedMetal-Tigert,
      Ganymede, and ShinyMetal) do have font alias support.
    </para>
    <para>
      Don Harrop has made available a major number of <application>e16</application> themes which have been
      modified for font alias support (<ulink url="http://themes.effx.us"><citetitle>themes.effx.us</citetitle></ulink>).
    </para>
    <para>
      Other themes are likely to not have font alias support but in stead have font
      references more or less scattered around in TextClass definitions in the theme
      configuration files.
    </para>
    <para>
      There are several ways to specify a font (in the font configuration file or
      in TextClasses):
    </para>
    <itemizedlist>
      <listitem>
	<para>
	  "&lt;font name&gt;/&lt;size&gt;", e.g. "Vera/8".
	</para>
	<para>
	  In this case <application>e16</application> must be able to find "Vera.ttf" in <filename class="directory">&lt;theme dir&gt;/ttfonts</filename> or
	  <filename class="directory">/usr/share/e16/fonts</filename>.
	</para>
      </listitem>
      <listitem>
	<para>
	  XLFD font sets, e.g. "-*-lucida-medium-r-normal-*-12-120-*-*-*-*-*-*,-*-gulim*-medium-r-normal-*-12-120-*-*-*-*-ksc5601.1987-*".
	</para>
	<para>
	  <application>xfontsel</application>, <application>xlsfonts</application>, and <application>xfd</application> can be used to select and show these fonts.
	</para>
      </listitem>
      <listitem>
	<para>
	  Fontconfig font names, prefixed by "xft:", e.g. "xft:Luxi Sans-10:bold".
	</para>
	<para>
	  <application>fc-list</application> and <application>xfd</application> can be used to select and show these fonts.
	  This possibility (Xft support) is available as of version 0.16.8.5.
	</para>
      </listitem>
      <listitem>
	<para>
	  Pango font names, prefixed by "pango:", e.g. "pango:sans bold 10".
	</para>
	<para>
	  This possibility (Pango support) is available as of version 0.16.8.9.
	  Pango support must be explicitly enabled at build time with <option>--enable-pango</option>.
	</para>
      </listitem>
    </itemizedlist>
  </sect1>
  <sect1 id="usinge16withgnome">
    <title>Using e16 with GNOME</title>
    <para>
      Setting up <application>e16</application> as WM in a <application>GNOME</application> session unfortunately depends on the version
      of <application>gnome-session</application>.
    </para>
    <para>
      Recent versions of <application>gnome-session</application> seem to require that a gconf key is set
      and that an <filename>e16.desktop</filename> file can be found:
      <programlisting>
	$ gconftool-2 --set /desktop/gnome/session/required_components/windowmanager --type string e16
	$ gnome-sesssion
      </programlisting>
    </para>
    <para>
      <filename>/usr/share/applications/e16.desktop</filename> (or <filename>~/.local/share/applications/e16.desktop</filename>):
      <programlisting>
	[Desktop Entry]
	Encoding=UTF-8
	Type=Application
	Name=E16
	Comment=The Enlightenment (e16) window manager
	Exec=e16
	Icon=/usr/share/e16/misc/e16.png
      </programlisting>
    </para>
    <para>
      The section below seems to be obsolete as of <application>gnome-session-2.2x(?)</application>
    </para>
    <para>
      The <application>GNOME</application> desktop can be started using <application>e16</application> as WM with:
      <programlisting>
	$ export WINDOW_MANAGER=e16
	$ gnome-sesssion
      </programlisting>
    </para>
    <para>
      The section below is obsolete as of <application>gnome-session-2.16</application>
    </para>
    <para>
      However, somewhere along the way the script <filename>/usr/bin/gnome-wm</filename> is called.
      This is supposed to handle differences in all the different WM's out there,
      but does not know of "<application>e16</application>". This will cause a major delay when starting up
      the <application>GNOME</application> desktop.
      One way to fix this is to use <property>gnome-session-properties</property> to get rid of
      the "gnome-wm" session entry.
    </para>
    <para>
      Another is to apply this patch to <filename>/usr/bin/gnome-wm</filename>:
      <programlisting>
	--- /usr/bin/gnome-wm-org       2005-04-19 21:33:53.000000000 +0200
	+++ /usr/bin/gnome-wm   2005-11-15 20:46:09.000000000 +0100
	@@ -69,7 +69,7 @@
	OPT2=
	if [ ! -z "$SMID" ] ; then
	case `basename $WINDOW_MANAGER` in
	-    sawfish|sawmill|metacity)
	+    sawfish|sawmill|metacity|e16)
	OPT1=--sm-client-id=$SMID
	;;
	openbox)
      </programlisting>
    </para>
  </sect1>
  <sect1 id="usinge16withkde">
    <title>Using e16 with KDE</title>
    <para>
      The <application>KDE</application> desktop can be started using <application>e16</application> as WM with:
      <programlisting>
	$ export KDEWM=e16
	$ startkde
      </programlisting>
    </para>
  </sect1>
  <sect1 id="majorchangesandnewfeaturesin0168">
    <title>Major changes and new features in 0.16.8</title>
    <para>
      The following sections are only relevant for users upgrading from version 0.16.7
      or older.
    </para>
    <para>
      Changes:
      <itemizedlist>
	<listitem>
	  <para>
	    "enlightenment" has been renamed to "e16".
	  </para>
	</listitem>
	<listitem>
	  <para>
	    The default user configuration directory is "<filename class="directory">~/.e16</filename>".
	  </para>
	</listitem>
	<listitem>
	  <para>
	    The data install path is "<filename class="directory">&lt;somepath&gt;/e16</filename>", e.g. "<filename class="directory">/usr/share/e16</filename>".
	    Thus, an <application>e16.8</application> installation should not clash with any other versions.
	  </para>
	</listitem>
	<listitem>
	  <para>
	    Various configuration file formats have changed and should be easier
	    to read and modify, if needed.
	  </para>
	</listitem>
	<listitem>
	  <para>
	    The configuration is stored per display and per screen.  E.g. for
	    <varname>DISPLAY=:1.0</varname> the main configuration file is "<filename>~/.e16/e_config--1.0.cfg</filename>".
	  </para>
	</listitem>
	<listitem>
	  <para>
	    Actions(used by menus, keybindings, etc.) and IPC functions(<application>eesh</application>) have
	    been merged.
	  </para>
	</listitem>
	<listitem>
	  <para>
	    Many IPC(<application>eesh</application>) commands have been changed, possibly breaking compatibility
	    with a few epplets.
	  </para>
	</listitem>
	<listitem>
	  <para>
	    Window matches and icondefs have been merged (into <filename>matches.cfg</filename>), see below.
	  </para>
	</listitem>
      </itemizedlist>
    </para>
    <para>
      New features:
      <itemizedlist>
	<listitem>
	  <para>
	    Built-in composite manager.
	  </para>
	</listitem>
	<listitem>
	  <para>
	    An iconbox can be configured to act as System Tray
	    (<menuchoice><interface>middle mouse</interface><guimenu>Desktop</guimenu><guimenuitem>Create Systray</guimenuitem></menuchoice>).
	  </para>
	</listitem>
	<listitem>
	  <para>
	    Possibility to run programs on startup, restart, and shutdown, see
	    <link linkend="sessionscripts">"Session Scripts"</link> below.
	  </para>
	</listitem>
	<listitem>
	  <para>
	    Possibility to track changes in remembered settings.
	  </para>
	</listitem>
	<listitem>
	  <para>
	    Window operations by window matches (class, name, transient, ...),
	    e.g. for making all windows of a certain type sticky, put it on a certain
	    layer, etc. (see <filename>matches.cfg</filename>).
	  </para>
	</listitem>
      </itemizedlist>
    </para>
    <para>
      0.16.8 should be compatible with most <application>e16</application> themes. However, user installed
      themes will have to be moved/linked to <filename class="directory">~/.e16/themes/</filename> or <filename class="directory">&lt;datadir&gt;/e16/themes/</filename>.
      A few themes will have to be tweaked to work with <application>e16.8</application>. The most likely
      problem is that configuration settings are included in .cfg files where they
      are no longer accepted.
      See the <link linkend="migratingfromversionsolderthan0168">"Migrating ..."</link> section below for additional information.
    </para>
    <para>
      <application>e16keyedit</application> &gt;= 0.3 works with e16.8.
    </para>
    <para>
      If used to change the keybindings, the modified settings will be stored in
      <filename>~/.e16/bindings.cfg</filename>.
      It should also be fairly straightforward to modify the key- and buttonbindings
      by hand. Copy <filename>/usr/share/e16/config/bindings.cfg</filename> to <filename>~/.e16/bindings.cfg</filename> and
      modify as desired.
    </para>
    <para>
      NB! <application>e16keyedit</application> only modifies keybindings, not buttonbindings.
    </para>
    <para>
      NB!!! Do not rename <filename class="directory">~/.enlightenment</filename> to <filename class="directory">~/.e16</filename>. It will only cause trouble.
    </para>
  </sect1>
  <sect1 id="migratingfromversionsolderthan0168">
    <title>Migrating from versions older than 0.16.8</title>
    <para>
      Users upgrading from enlightenment 0.16.7 need to read the following.
    </para>
    <para>
      Several organizational changes have occurred that will require
      some manual adjustments. Mainly these deal with changes to 
      configuration and shared directory names. This was done to avoid
      collisions with the new enlightenment DR17.
      <orderedlist>
	<listitem>
	  <para>
	    home configuration directory is now <filename class="directory">~/.e16</filename>, not <filename class="directory">~/.enlightenment</filename>.
	  </para>
	</listitem>
	<listitem>
	  <para>
	    menu files have been moved to a subdirectory called menus
	    you will need to move customized menus and subdirectories to
	    <filename class="directory">~/.e16/menus</filename>.
	  </para>
	</listitem>
	<listitem>
	  <para>
	    you will need to move <filename class="directory">~/.enlightenment/backgrounds</filename> files to <filename class="directory">~/.e16</filename>
	    and any themes as well.
	  </para>
	</listitem>
	<listitem>
	  <para>
	    <filename class="directory">$prefix/share/enlightenment</filename> has been changed to <filename class="directory">$prefix/share/e16</filename>
	  </para>
	</listitem>
	<listitem>
	  <para>
	    if installed E-docs and Epplet directories will have to be moved 
	    to <filename class="directory">$prefix/share/e16</filename>
	  </para>
	</listitem>
	<listitem>
	  <para>
	    any additional themes that were added to the <filename class="directory">$prefix/share/enlightenment</filename>
	    directory will have to be moved to <filename class="directory">$prefix/share/e16</filename>
	  </para>
	</listitem>
	<listitem>
	  <para>
	    any startup scripts or Session scripts that reference the startup
	    executable `<command>enlightenment</command>` must be edited to the new <command>e16</command> program.
	  </para>
	</listitem>
      </orderedlist>
    </para>
    <para>
      A few themes have to be tweaked to work with 0.16.8.
    </para>
    <para>
      Some themes (Maw, Black E) have an <filename>actionclasses.cfg</filename> like:
      <programlisting>
	<![CDATA[
#include <definitions>
__E_CFG_VERSION 0
#include </usr/local/enlightenment/config/actionclasses.cfg>
#include </usr/share/enlightenment/config/actionclasses.cfg>
]]>
      </programlisting>
      The absolute path is obviously no longer valid.
      The most sensible fix for these themes is to remove the themes
      <filename>actionclasses.cfg</filename>. <application>e16</application> will then fall back to the default one.
    </para>
  </sect1>
  <sect1 id="resources">
    <title>Resources</title>
    <para>
      The e16-docs package is somewhat dated but still contains much relevant
      information about using e16.
      <variablelist>
	<varlistentry>
	  <term>
	    Enlightenment web site:
	  </term>
	  <listitem>
	    <para>
	      <ulink url="http://www.enlightenment.org"><citetitle>www.enlightenment.org</citetitle></ulink>
	    </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term>
	    Mailing lists:
	  </term>
	  <listitem>
	    <para>
	      <ulink url="http://sourceforge.net/mail/?group_id=2"><citetitle>sourceforge.net/mail</citetitle></ulink>
	    </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term>
	    IRC:
	  </term>
	  <listitem>
	    <para>
	      #e on freenode
	    </para>
	  </listitem>
	</varlistentry>
      </variablelist>
    </para>
  </sect1>
  <sect1>
    <title>
      Revision History
    </title>
    <para>
      <revhistory>
	<revision>
          <revnumber>33</revnumber>
          <date>Apr 19, 2009</date>
          <authorinitials>Yasufumi Haga</authorinitials>
          <revremark>
            rename README-0.16.8.xml to README.xml
          </revremark>
	</revision>
	<revision>
          <revnumber>32</revnumber>
          <date>Jan 25, 2009</date>
          <authorinitials>Yasufumi Haga</authorinitials>
          <revremark>
            Add html version converted from README-0.16.8.xml
	    rewritten by Yasufumi Haga based on the ascii version of the file.
          </revremark>
	</revision>
	<revision>
	  <revnumber>1-31</revnumber>
	  <date>2004-2009</date>
	  <authorinitials>Several</authorinitials>
	  <revremark>
	    Updates...
	  </revremark>
	</revision>
	<revision>
          <revnumber>0</revnumber>
          <date>Dec 30, 2004</date>
          <authorinitials>Peter Hyman</authorinitials>
          <revremark>
            Notes on migrating to 0.16.8
          </revremark>
	</revision>
      </revhistory>
    </para>
  </sect1>
</article>