aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorCarsten Haitzler <raster@rasterman.com>2004-11-25 03:26:33 +0000
committerCarsten Haitzler <raster@rasterman.com>2004-11-25 03:26:33 +0000
commitf2b45ed47126d12986591cb02a6fcfc5908255fe (patch)
tree804d8188540af5d13facb6610f7562899ff91f03 /doc
parentMore raster-speak (diff)
downloadenlightenment-f2b45ed47126d12986591cb02a6fcfc5908255fe.tar.gz
bye bye!
SVN revision: 12246
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am41
-rw-r--r--doc/figures/architecture.eps408
-rw-r--r--doc/figures/architecture.fig130
-rw-r--r--doc/figures/architecture.gifbin11286 -> 0 bytes
-rw-r--r--doc/figures/background.gifbin6432 -> 0 bytes
-rw-r--r--doc/figures/caution.gifbin1039 -> 0 bytes
-rw-r--r--doc/figures/note.gifbin1070 -> 0 bytes
-rw-r--r--doc/figures/warning.gifbin1052 -> 0 bytes
-rw-r--r--doc/html-customizations.dsl.in61
-rw-r--r--doc/kernel-doc.in1001
-rw-r--r--doc/manual.raw472
-rw-r--r--doc/stylesheet.css20
12 files changed, 0 insertions, 2133 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
deleted file mode 100644
index 7d4c237e6..000000000
--- a/doc/Makefile.am
+++ /dev/null
@@ -1,41 +0,0 @@
-## Process this file with automake to produce Makefile.in
-
-MAINTAINERCLEANFILES = Makefile.in
-
-EXTRA_DIST = \
-manual.raw \
-kernel-doc.in \
-stylesheet.css \
-figures/*.gif # Add any images you create here
-
-
-## Fill in all source files that you documented
-## with extractable comments here:
-##
-SOURCEDOC = $(top_srcdir)/src/e.h
-
-## For details on what can be specified in the
-## comments, see the beginning of kernel-doc
-## in this directory! -- cK.
-
-
-SGMLFILE = $(PACKAGE)-manual.sgml
-
-docs: manual.raw $(SOURCEDOC)
- ./kernel-doc -docbook <manual.raw >$(SGMLFILE)
-
-if HAVE_JADE
-
-FULLNAME = $(PACKAGE)-manual-$(VERSION)
-
-html-docs: docs html-customizations.dsl
- $(mkinstalldirs) ./$(FULLNAME)/figures
- cd $(FULLNAME) && @JADE@ -t sgml -d ../html-customizations.dsl ../$(SGMLFILE)
- - cd figures && cp -f *.gif ../$(FULLNAME)/figures
- - cd figures && cp -f *.png ../$(FULLNAME)/figures
- - cd figures && cp -f *.jpg ../$(FULLNAME)/figures
- cp -f stylesheet.css $(FULLNAME)/stylesheet.css
- tar cfvz $(FULLNAME).tar.gz $(FULLNAME)
-
-endif
-
diff --git a/doc/figures/architecture.eps b/doc/figures/architecture.eps
deleted file mode 100644
index dddb47aff..000000000
--- a/doc/figures/architecture.eps
+++ /dev/null
@@ -1,408 +0,0 @@
-%!PS-Adobe-2.0 EPSF-2.0
-%%Title: architecture.eps
-%%Creator: fig2dev Version 3.2 Patchlevel 3d
-%%CreationDate: Thu Nov 8 01:31:58 2001
-%%For: elwood@Gonzo (Elwood Blues,,,)
-%%BoundingBox: 0 0 689 403
-%%Magnification: 1.0000
-%%EndComments
-/$F2psDict 200 dict def
-$F2psDict begin
-$F2psDict /mtrx matrix put
-/col-1 {0 setgray} bind def
-/col0 {0.000 0.000 0.000 srgb} bind def
-/col1 {0.000 0.000 1.000 srgb} bind def
-/col2 {0.000 1.000 0.000 srgb} bind def
-/col3 {0.000 1.000 1.000 srgb} bind def
-/col4 {1.000 0.000 0.000 srgb} bind def
-/col5 {1.000 0.000 1.000 srgb} bind def
-/col6 {1.000 1.000 0.000 srgb} bind def
-/col7 {1.000 1.000 1.000 srgb} bind def
-/col8 {0.000 0.000 0.560 srgb} bind def
-/col9 {0.000 0.000 0.690 srgb} bind def
-/col10 {0.000 0.000 0.820 srgb} bind def
-/col11 {0.530 0.810 1.000 srgb} bind def
-/col12 {0.000 0.560 0.000 srgb} bind def
-/col13 {0.000 0.690 0.000 srgb} bind def
-/col14 {0.000 0.820 0.000 srgb} bind def
-/col15 {0.000 0.560 0.560 srgb} bind def
-/col16 {0.000 0.690 0.690 srgb} bind def
-/col17 {0.000 0.820 0.820 srgb} bind def
-/col18 {0.560 0.000 0.000 srgb} bind def
-/col19 {0.690 0.000 0.000 srgb} bind def
-/col20 {0.820 0.000 0.000 srgb} bind def
-/col21 {0.560 0.000 0.560 srgb} bind def
-/col22 {0.690 0.000 0.690 srgb} bind def
-/col23 {0.820 0.000 0.820 srgb} bind def
-/col24 {0.500 0.190 0.000 srgb} bind def
-/col25 {0.630 0.250 0.000 srgb} bind def
-/col26 {0.750 0.380 0.000 srgb} bind def
-/col27 {1.000 0.500 0.500 srgb} bind def
-/col28 {1.000 0.630 0.630 srgb} bind def
-/col29 {1.000 0.750 0.750 srgb} bind def
-/col30 {1.000 0.880 0.880 srgb} bind def
-/col31 {1.000 0.840 0.000 srgb} bind def
-/col32 {0.816 0.816 0.816 srgb} bind def
-/col33 {0.878 0.878 0.878 srgb} bind def
-
-end
-save
-newpath 0 403 moveto 0 0 lineto 689 0 lineto 689 403 lineto closepath clip newpath
--32.6 542.8 translate
-1 -1 scale
-
-/cp {closepath} bind def
-/ef {eofill} bind def
-/gr {grestore} bind def
-/gs {gsave} bind def
-/sa {save} bind def
-/rs {restore} bind def
-/l {lineto} bind def
-/m {moveto} bind def
-/rm {rmoveto} bind def
-/n {newpath} bind def
-/s {stroke} bind def
-/sh {show} bind def
-/slc {setlinecap} bind def
-/slj {setlinejoin} bind def
-/slw {setlinewidth} bind def
-/srgb {setrgbcolor} bind def
-/rot {rotate} bind def
-/sc {scale} bind def
-/sd {setdash} bind def
-/ff {findfont} bind def
-/sf {setfont} bind def
-/scf {scalefont} bind def
-/sw {stringwidth} bind def
-/tr {translate} bind def
-/tnt {dup dup currentrgbcolor
- 4 -2 roll dup 1 exch sub 3 -1 roll mul add
- 4 -2 roll dup 1 exch sub 3 -1 roll mul add
- 4 -2 roll dup 1 exch sub 3 -1 roll mul add srgb}
- bind def
-/shd {dup dup currentrgbcolor 4 -2 roll mul 4 -2 roll mul
- 4 -2 roll mul srgb} bind def
-/$F2psBegin {$F2psDict begin /$F2psEnteredState save def} def
-/$F2psEnd {$F2psEnteredState restore end} def
-
-$F2psBegin
-10 setmiterlimit
- 0.06299 0.06299 sc
-%
-% Fig objects follow
-%
-% Polyline
-15.000 slw
-n 3300 7020 m 3195 7020 3195 7455 105 arcto 4 {pop} repeat
- 3195 7560 4170 7560 105 arcto 4 {pop} repeat
- 4275 7560 4275 7125 105 arcto 4 {pop} repeat
- 4275 7020 3300 7020 105 arcto 4 {pop} repeat
- cp gs col32 1.00 shd ef gr gs col32 s gr
-% Polyline
-n 4515 7020 m 4410 7020 4410 7455 105 arcto 4 {pop} repeat
- 4410 7560 9615 7560 105 arcto 4 {pop} repeat
- 9720 7560 9720 7125 105 arcto 4 {pop} repeat
- 9720 7020 4515 7020 105 arcto 4 {pop} repeat
- cp gs col32 1.00 shd ef gr gs col32 s gr
-% Polyline
-n 4515 5985 m 4410 5985 4410 6420 105 arcto 4 {pop} repeat
- 4410 6525 7545 6525 105 arcto 4 {pop} repeat
- 7650 6525 7650 6090 105 arcto 4 {pop} repeat
- 7650 5985 4515 5985 105 arcto 4 {pop} repeat
- cp gs col32 1.00 shd ef gr gs col32 s gr
-% Polyline
-n 7890 5985 m 7785 5985 7785 6420 105 arcto 4 {pop} repeat
- 7785 6525 9615 6525 105 arcto 4 {pop} repeat
- 9720 6525 9720 6090 105 arcto 4 {pop} repeat
- 9720 5985 7890 5985 105 arcto 4 {pop} repeat
- cp gs col32 1.00 shd ef gr gs col32 s gr
-% Polyline
-n 4515 4950 m 4410 4950 4410 5385 105 arcto 4 {pop} repeat
- 4410 5490 6915 5490 105 arcto 4 {pop} repeat
- 7020 5490 7020 5055 105 arcto 4 {pop} repeat
- 7020 4950 4515 4950 105 arcto 4 {pop} repeat
- cp gs col32 1.00 shd ef gr gs col32 s gr
-% Polyline
-n 1365 2295 m 1260 2295 1260 3225 105 arcto 4 {pop} repeat
- 1260 3330 9660 3330 105 arcto 4 {pop} repeat
- 9765 3330 9765 2400 105 arcto 4 {pop} repeat
- 9765 2295 1365 2295 105 arcto 4 {pop} repeat
- cp gs col32 1.00 shd ef gr gs col32 s gr
-% Polyline
-n 1365 7020 m 1260 7020 1260 7455 105 arcto 4 {pop} repeat
- 1260 7560 2235 7560 105 arcto 4 {pop} repeat
- 2340 7560 2340 7125 105 arcto 4 {pop} repeat
- 2340 7020 1365 7020 105 arcto 4 {pop} repeat
- cp gs col32 1.00 shd ef gr gs col32 s gr
-% Polyline
-n 1365 8055 m 1260 8055 1260 8490 105 arcto 4 {pop} repeat
- 1260 8595 9615 8595 105 arcto 4 {pop} repeat
- 9720 8595 9720 8160 105 arcto 4 {pop} repeat
- 9720 8055 1365 8055 105 arcto 4 {pop} repeat
- cp gs col32 1.00 shd ef gr gs col32 s gr
-% Polyline
-n 3930 3870 m 3825 3870 3825 4305 105 arcto 4 {pop} repeat
- 3825 4410 6240 4410 105 arcto 4 {pop} repeat
- 6345 4410 6345 3975 105 arcto 4 {pop} repeat
- 6345 3870 3930 3870 105 arcto 4 {pop} repeat
- cp gs col32 1.00 shd ef gr gs col32 s gr
-% Polyline
-n 3255 6975 m 3150 6975 3150 7410 105 arcto 4 {pop} repeat
- 3150 7515 4125 7515 105 arcto 4 {pop} repeat
- 4230 7515 4230 7080 105 arcto 4 {pop} repeat
- 4230 6975 3255 6975 105 arcto 4 {pop} repeat
- cp gs col33 1.00 shd ef gr gs col0 s gr
-/Helvetica ff 240.00 scf sf
-3465 7335 m
-gs 1 -1 sc (Edb) col0 sh gr
-% Polyline
-n 4470 6975 m 4365 6975 4365 7410 105 arcto 4 {pop} repeat
- 4365 7515 9570 7515 105 arcto 4 {pop} repeat
- 9675 7515 9675 7080 105 arcto 4 {pop} repeat
- 9675 6975 4470 6975 105 arcto 4 {pop} repeat
- cp gs col33 1.00 shd ef gr gs col0 s gr
-/Helvetica ff 240.00 scf sf
-5985 7335 m
-gs 1 -1 sc (X Window System) col0 sh gr
-% Polyline
-n 4470 5940 m 4365 5940 4365 6375 105 arcto 4 {pop} repeat
- 4365 6480 7500 6480 105 arcto 4 {pop} repeat
- 7605 6480 7605 6045 105 arcto 4 {pop} repeat
- 7605 5940 4470 5940 105 arcto 4 {pop} repeat
- cp gs col33 1.00 shd ef gr gs col0 s gr
-/Helvetica ff 240.00 scf sf
-5670 6300 m
-gs 1 -1 sc (Imlib2) col0 sh gr
-% Polyline
-n 7845 5940 m 7740 5940 7740 6375 105 arcto 4 {pop} repeat
- 7740 6480 9570 6480 105 arcto 4 {pop} repeat
- 9675 6480 9675 6045 105 arcto 4 {pop} repeat
- 9675 5940 7845 5940 105 arcto 4 {pop} repeat
- cp gs col33 1.00 shd ef gr gs col0 s gr
-/Helvetica ff 240.00 scf sf
-8325 6300 m
-gs 1 -1 sc (Ecore) col0 sh gr
-% Polyline
-n 4470 4905 m 4365 4905 4365 5340 105 arcto 4 {pop} repeat
- 4365 5445 6870 5445 105 arcto 4 {pop} repeat
- 6975 5445 6975 5010 105 arcto 4 {pop} repeat
- 6975 4905 4470 4905 105 arcto 4 {pop} repeat
- cp gs col33 1.00 shd ef gr gs col0 s gr
-/Helvetica ff 240.00 scf sf
-5355 5265 m
-gs 1 -1 sc (Evas) col0 sh gr
-% Polyline
-n 1320 2250 m 1215 2250 1215 3180 105 arcto 4 {pop} repeat
- 1215 3285 9615 3285 105 arcto 4 {pop} repeat
- 9720 3285 9720 2355 105 arcto 4 {pop} repeat
- 9720 2250 1320 2250 105 arcto 4 {pop} repeat
- cp gs col7 1.00 shd ef gr gs col0 s gr
-/Helvetica ff 300.00 scf sf
-5130 2610 m
-gs 1 -1 sc (E 17) col0 sh gr
-% Polyline
-n 1320 6975 m 1215 6975 1215 7410 105 arcto 4 {pop} repeat
- 1215 7515 2190 7515 105 arcto 4 {pop} repeat
- 2295 7515 2295 7080 105 arcto 4 {pop} repeat
- 2295 6975 1320 6975 105 arcto 4 {pop} repeat
- cp gs col33 1.00 shd ef gr gs col0 s gr
-/Helvetica ff 240.00 scf sf
-1485 7335 m
-gs 1 -1 sc (Efsd) col0 sh gr
-% Polyline
-n 540 7740 m
- 11430 7740 l gs col33 1.00 shd ef gr gs col32 s gr
-% Polyline
-gs clippath
-1710 7035 m 1800 7035 l 1800 6878 l 1755 6998 l 1710 6878 l cp
-1800 3270 m 1710 3270 l 1710 3427 l 1755 3307 l 1800 3427 l cp
-eoclip
-n 1755 3285 m
- 1755 7020 l gs col33 1.00 shd ef gr gs col0 s gr gr
-
-% arrowhead
-n 1800 3427 m 1755 3307 l 1710 3427 l 1800 3427 l cp gs 0.00 setgray ef gr col0 s
-% arrowhead
-n 1710 6878 m 1755 6998 l 1800 6878 l 1710 6878 l cp gs 0.00 setgray ef gr col0 s
-% Polyline
-gs clippath
-2655 7980 m 2745 7980 l 2745 7823 l 2700 7943 l 2655 7823 l cp
-2745 3270 m 2655 3270 l 2655 3427 l 2700 3307 l 2745 3427 l cp
-eoclip
-n 2700 3285 m
- 2700 7965 l gs col33 1.00 shd ef gr gs col0 s gr gr
-
-% arrowhead
-n 2745 3427 m 2700 3307 l 2655 3427 l 2745 3427 l cp gs 0.00 setgray ef gr col0 s
-% arrowhead
-n 2655 7823 m 2700 7943 l 2745 7823 l 2655 7823 l cp gs 0.00 setgray ef gr col0 s
-% Polyline
-gs clippath
-3645 8070 m 3735 8070 l 3735 7913 l 3690 8033 l 3645 7913 l cp
-3735 7500 m 3645 7500 l 3645 7657 l 3690 7537 l 3735 7657 l cp
-eoclip
-n 3690 7515 m
- 3690 8055 l gs col33 1.00 shd ef gr gs col0 s gr gr
-
-% arrowhead
-n 3735 7657 m 3690 7537 l 3645 7657 l 3735 7657 l cp gs 0.00 setgray ef gr col0 s
-% arrowhead
-n 3645 7913 m 3690 8033 l 3735 7913 l 3645 7913 l cp gs 0.00 setgray ef gr col0 s
-% Polyline
-gs clippath
-5805 7035 m 5895 7035 l 5895 6878 l 5850 6998 l 5805 6878 l cp
-5895 6465 m 5805 6465 l 5805 6622 l 5850 6502 l 5895 6622 l cp
-eoclip
-n 5850 6480 m
- 5850 7020 l gs col33 1.00 shd ef gr gs col0 s gr gr
-
-% arrowhead
-n 5895 6622 m 5850 6502 l 5805 6622 l 5895 6622 l cp gs 0.00 setgray ef gr col0 s
-% arrowhead
-n 5805 6878 m 5850 6998 l 5895 6878 l 5805 6878 l cp gs 0.00 setgray ef gr col0 s
-% Polyline
-gs clippath
-8595 7035 m 8685 7035 l 8685 6878 l 8640 6998 l 8595 6878 l cp
-8685 6465 m 8595 6465 l 8595 6622 l 8640 6502 l 8685 6622 l cp
-eoclip
-n 8640 6480 m
- 8640 7020 l gs col33 1.00 shd ef gr gs col0 s gr gr
-
-% arrowhead
-n 8685 6622 m 8640 6502 l 8595 6622 l 8685 6622 l cp gs 0.00 setgray ef gr col0 s
-% arrowhead
-n 8595 6878 m 8640 6998 l 8685 6878 l 8595 6878 l cp gs 0.00 setgray ef gr col0 s
-% Polyline
-gs clippath
-8595 5955 m 8685 5955 l 8685 5798 l 8640 5918 l 8595 5798 l cp
-8685 3270 m 8595 3270 l 8595 3427 l 8640 3307 l 8685 3427 l cp
-eoclip
-n 8640 3285 m
- 8640 5940 l gs col33 1.00 shd ef gr gs col0 s gr gr
-
-% arrowhead
-n 8685 3427 m 8640 3307 l 8595 3427 l 8685 3427 l cp gs 0.00 setgray ef gr col0 s
-% arrowhead
-n 8595 5798 m 8640 5918 l 8685 5798 l 8595 5798 l cp gs 0.00 setgray ef gr col0 s
-% Polyline
-gs clippath
-5805 6000 m 5895 6000 l 5895 5843 l 5850 5963 l 5805 5843 l cp
-5895 5430 m 5805 5430 l 5805 5587 l 5850 5467 l 5895 5587 l cp
-eoclip
-n 5850 5445 m
- 5850 5985 l gs col33 1.00 shd ef gr gs col0 s gr gr
-
-% arrowhead
-n 5895 5587 m 5850 5467 l 5805 5587 l 5895 5587 l cp gs 0.00 setgray ef gr col0 s
-% arrowhead
-n 5805 5843 m 5850 5963 l 5895 5843 l 5805 5843 l cp gs 0.00 setgray ef gr col0 s
-% Polyline
-gs clippath
-7200 5955 m 7290 5955 l 7290 5798 l 7245 5918 l 7200 5798 l cp
-7290 3270 m 7200 3270 l 7200 3427 l 7245 3307 l 7290 3427 l cp
-eoclip
-n 7245 3285 m
- 7245 5940 l gs col33 1.00 shd ef gr gs col0 s gr gr
-
-% arrowhead
-n 7290 3427 m 7245 3307 l 7200 3427 l 7290 3427 l cp gs 0.00 setgray ef gr col0 s
-% arrowhead
-n 7200 5798 m 7245 5918 l 7290 5798 l 7200 5798 l cp gs 0.00 setgray ef gr col0 s
-% Polyline
-gs clippath
-4455 3840 m 4545 3840 l 4545 3683 l 4500 3803 l 4455 3683 l cp
-4545 3270 m 4455 3270 l 4455 3427 l 4500 3307 l 4545 3427 l cp
-eoclip
-n 4500 3285 m
- 4500 3825 l gs col33 1.00 shd ef gr gs col0 s gr gr
-
-% arrowhead
-n 4545 3427 m 4500 3307 l 4455 3427 l 4545 3427 l cp gs 0.00 setgray ef gr col0 s
-% arrowhead
-n 4455 3683 m 4500 3803 l 4545 3683 l 4455 3683 l cp gs 0.00 setgray ef gr col0 s
-% Polyline
-gs clippath
-6570 4920 m 6660 4920 l 6660 4763 l 6615 4883 l 6570 4763 l cp
-6660 3270 m 6570 3270 l 6570 3427 l 6615 3307 l 6660 3427 l cp
-eoclip
-n 6615 3285 m
- 6615 4905 l gs col33 1.00 shd ef gr gs col0 s gr gr
-
-% arrowhead
-n 6660 3427 m 6615 3307 l 6570 3427 l 6660 3427 l cp gs 0.00 setgray ef gr col0 s
-% arrowhead
-n 6570 4763 m 6615 4883 l 6660 4763 l 6570 4763 l cp gs 0.00 setgray ef gr col0 s
-% Polyline
-gs clippath
-5535 4920 m 5625 4920 l 5625 4763 l 5580 4883 l 5535 4763 l cp
-5625 4350 m 5535 4350 l 5535 4507 l 5580 4387 l 5625 4507 l cp
-eoclip
-n 5580 4365 m
- 5580 4905 l gs col33 1.00 shd ef gr gs col0 s gr gr
-
-% arrowhead
-n 5625 4507 m 5580 4387 l 5535 4507 l 5625 4507 l cp gs 0.00 setgray ef gr col0 s
-% arrowhead
-n 5535 4763 m 5580 4883 l 5625 4763 l 5535 4763 l cp gs 0.00 setgray ef gr col0 s
-% Polyline
-gs clippath
-1710 8025 m 1800 8025 l 1800 7868 l 1755 7988 l 1710 7868 l cp
-1800 7455 m 1710 7455 l 1710 7612 l 1755 7492 l 1800 7612 l cp
-eoclip
-n 1755 7470 m
- 1755 8010 l gs col33 1.00 shd ef gr gs col0 s gr gr
-
-% arrowhead
-n 1800 7612 m 1755 7492 l 1710 7612 l 1800 7612 l cp gs 0.00 setgray ef gr col0 s
-% arrowhead
-n 1710 7868 m 1755 7988 l 1800 7868 l 1710 7868 l cp gs 0.00 setgray ef gr col0 s
-% Polyline
-n 1320 8010 m 1215 8010 1215 8445 105 arcto 4 {pop} repeat
- 1215 8550 9570 8550 105 arcto 4 {pop} repeat
- 9675 8550 9675 8115 105 arcto 4 {pop} repeat
- 9675 8010 1320 8010 105 arcto 4 {pop} repeat
- cp gs col33 1.00 shd ef gr gs col0 s gr
-% Polyline
-n 3885 3825 m 3780 3825 3780 4260 105 arcto 4 {pop} repeat
- 3780 4365 6195 4365 105 arcto 4 {pop} repeat
- 6300 4365 6300 3930 105 arcto 4 {pop} repeat
- 6300 3825 3885 3825 105 arcto 4 {pop} repeat
- cp gs col33 1.00 shd ef gr gs col0 s gr
-% Polyline
-gs clippath
-3420 7035 m 3510 7035 l 3510 6878 l 3465 6998 l 3420 6878 l cp
-3510 3270 m 3420 3270 l 3420 3427 l 3465 3307 l 3510 3427 l cp
-eoclip
-n 3465 3285 m
- 3465 7020 l gs col33 1.00 shd ef gr gs col0 s gr gr
-
-% arrowhead
-n 3510 3427 m 3465 3307 l 3420 3427 l 3510 3427 l cp gs 0.00 setgray ef gr col0 s
-% arrowhead
-n 3420 6878 m 3465 6998 l 3510 6878 l 3420 6878 l cp gs 0.00 setgray ef gr col0 s
-% Polyline
-gs clippath
-3960 7035 m 4050 7035 l 4050 6878 l 4005 6998 l 3960 6878 l cp
-4050 4350 m 3960 4350 l 3960 4507 l 4005 4387 l 4050 4507 l cp
-eoclip
-n 4005 4365 m
- 4005 7020 l gs col33 1.00 shd ef gr gs col0 s gr gr
-
-% arrowhead
-n 4050 4507 m 4005 4387 l 3960 4507 l 4050 4507 l cp gs 0.00 setgray ef gr col0 s
-% arrowhead
-n 3960 6878 m 4005 6998 l 4050 6878 l 3960 6878 l cp gs 0.00 setgray ef gr col0 s
-/Helvetica ff 240.00 scf sf
-4950 8370 m
-gs 1 -1 sc (Filesystem) col0 sh gr
-/Helvetica ff 240.00 scf sf
-10080 7560 m
-gs 1 -1 sc (User Space) col0 sh gr
-/Helvetica ff 240.00 scf sf
-10305 8100 m
-gs 1 -1 sc (Kernel) col0 sh gr
-/Helvetica ff 240.00 scf sf
-4725 4185 m
-gs 1 -1 sc (Ebits) col0 sh gr
-$F2psEnd
-rs
diff --git a/doc/figures/architecture.fig b/doc/figures/architecture.fig
deleted file mode 100644
index 6166cf9f5..000000000
--- a/doc/figures/architecture.fig
+++ /dev/null
@@ -1,130 +0,0 @@
-#FIG 3.2
-Landscape
-Center
-Metric
-A4
-100.00
-Single
--2
-1200 2
-0 32 #d0d0d0
-0 33 #e0e0e0
-6 3105 6930 4320 7605
-2 4 0 2 0 33 50 0 20 0.000 0 0 7 0 0 5
- 4230 7515 3150 7515 3150 6975 4230 6975 4230 7515
-2 4 0 2 32 32 100 0 20 0.000 0 0 7 0 0 5
- 4275 7560 3195 7560 3195 7020 4275 7020 4275 7560
-4 0 0 50 0 16 16 0.0000 4 180 435 3465 7335 Edb\001
--6
-6 4320 6930 9765 7605
-2 4 0 2 32 32 100 0 20 0.000 0 0 7 0 0 5
- 9720 7560 4410 7560 4410 7020 9720 7020 9720 7560
-2 4 0 2 0 33 50 0 20 0.000 0 0 7 0 0 5
- 9675 7515 4365 7515 4365 6975 9675 6975 9675 7515
-4 0 0 50 0 16 16 0.0000 4 225 1950 5985 7335 X Window System\001
--6
-6 4320 5895 7695 6570
-2 4 0 2 0 33 50 0 20 0.000 0 0 7 0 0 5
- 7605 6480 4365 6480 4365 5940 7605 5940 7605 6480
-2 4 0 2 32 32 100 0 20 0.000 0 0 7 0 0 5
- 7650 6525 4410 6525 4410 5985 7650 5985 7650 6525
-4 0 0 50 0 16 16 0.0000 4 180 645 5670 6300 Imlib2\001
--6
-6 7695 5895 9765 6570
-2 4 0 2 0 33 50 0 20 0.000 0 0 7 0 0 5
- 9675 6480 7740 6480 7740 5940 9675 5940 9675 6480
-2 4 0 2 32 32 100 0 20 0.000 0 0 7 0 0 5
- 9720 6525 7785 6525 7785 5985 9720 5985 9720 6525
-4 0 0 50 0 16 16 0.0000 4 180 630 8325 6300 Ecore\001
--6
-6 4320 4860 7065 5535
-2 4 0 2 0 33 50 0 20 0.000 0 0 7 0 0 5
- 6975 5445 4365 5445 4365 4905 6975 4905 6975 5445
-2 4 0 2 32 32 100 0 20 0.000 0 0 7 0 0 5
- 7020 5490 4410 5490 4410 4950 7020 4950 7020 5490
-4 0 0 50 0 16 16 0.0000 4 180 540 5355 5265 Evas\001
--6
-6 1170 2205 9810 3375
-2 4 0 2 0 7 50 0 20 0.000 0 0 7 0 0 5
- 9720 3285 9720 2250 1215 2250 1215 3285 9720 3285
-2 4 0 2 32 32 100 0 20 0.000 0 0 7 0 0 5
- 9765 3330 1260 3330 1260 2295 9765 2295 9765 3330
-4 0 0 50 0 16 20 0.0000 4 210 570 5130 2610 E 17\001
--6
-6 1170 6930 2385 7605
-2 4 0 2 0 33 50 0 20 0.000 0 0 7 0 0 5
- 2295 7515 1215 7515 1215 6975 2295 6975 2295 7515
-2 4 0 2 32 32 100 0 20 0.000 0 0 7 0 0 5
- 2340 7560 1260 7560 1260 7020 2340 7020 2340 7560
-4 0 0 50 0 16 16 0.0000 4 180 480 1485 7335 Efsd\001
--6
-2 1 0 2 32 33 50 0 20 0.000 0 0 -1 0 0 2
- 540 7740 11430 7740
-2 1 0 2 0 33 50 0 20 0.000 0 0 -1 1 1 2
- 1 1 2.00 90.00 120.00
- 1 1 2.00 90.00 120.00
- 1755 3285 1755 7020
-2 1 0 2 0 33 50 0 20 0.000 0 0 -1 1 1 2
- 1 1 2.00 90.00 120.00
- 1 1 2.00 90.00 120.00
- 2700 3285 2700 7965
-2 1 0 2 0 33 50 0 20 0.000 0 0 -1 1 1 2
- 1 1 2.00 90.00 120.00
- 1 1 2.00 90.00 120.00
- 3690 7515 3690 8055
-2 1 0 2 0 33 50 0 20 0.000 0 0 -1 1 1 2
- 1 1 2.00 90.00 120.00
- 1 1 2.00 90.00 120.00
- 5850 6480 5850 7020
-2 1 0 2 0 33 50 0 20 0.000 0 0 -1 1 1 2
- 1 1 2.00 90.00 120.00
- 1 1 2.00 90.00 120.00
- 8640 6480 8640 7020
-2 1 0 2 0 33 50 0 20 0.000 0 0 -1 1 1 2
- 1 1 2.00 90.00 120.00
- 1 1 2.00 90.00 120.00
- 8640 3285 8640 5940
-2 1 0 2 0 33 50 0 20 0.000 0 0 -1 1 1 2
- 1 1 2.00 90.00 120.00
- 1 1 2.00 90.00 120.00
- 5850 5445 5850 5985
-2 1 0 2 0 33 50 0 20 0.000 0 0 -1 1 1 2
- 1 1 2.00 90.00 120.00
- 1 1 2.00 90.00 120.00
- 7245 3285 7245 5940
-2 1 0 2 0 33 50 0 20 0.000 0 0 -1 1 1 2
- 1 1 2.00 90.00 120.00
- 1 1 2.00 90.00 120.00
- 4500 3285 4500 3825
-2 1 0 2 0 33 50 0 20 0.000 0 0 -1 1 1 2
- 1 1 2.00 90.00 120.00
- 1 1 2.00 90.00 120.00
- 6615 3285 6615 4905
-2 1 0 2 0 33 50 0 20 0.000 0 0 -1 1 1 2
- 1 1 2.00 90.00 120.00
- 1 1 2.00 90.00 120.00
- 5580 4365 5580 4905
-2 1 0 2 0 33 50 0 20 0.000 0 0 -1 1 1 2
- 1 1 2.00 90.00 120.00
- 1 1 2.00 90.00 120.00
- 1755 7470 1755 8010
-2 4 0 2 0 33 50 0 20 0.000 0 0 7 0 0 5
- 9675 8550 1215 8550 1215 8010 9675 8010 9675 8550
-2 4 0 2 32 32 100 0 20 0.000 0 0 7 0 0 5
- 9720 8595 1260 8595 1260 8055 9720 8055 9720 8595
-2 4 0 2 32 32 100 0 20 0.000 0 0 7 0 0 5
- 6345 4410 3825 4410 3825 3870 6345 3870 6345 4410
-2 4 0 2 0 33 50 0 20 0.000 0 0 7 0 0 5
- 6300 4365 3780 4365 3780 3825 6300 3825 6300 4365
-2 1 0 2 0 33 50 0 20 0.000 0 0 -1 1 1 2
- 1 1 2.00 90.00 120.00
- 1 1 2.00 90.00 120.00
- 3465 3285 3465 7020
-2 1 0 2 0 33 50 0 20 0.000 0 0 -1 1 1 2
- 1 1 2.00 90.00 120.00
- 1 1 2.00 90.00 120.00
- 4005 4365 4005 7020
-4 0 0 50 0 16 16 0.0000 4 225 1155 4950 8370 Filesystem\001
-4 0 0 50 0 16 16 0.0000 4 240 1260 10080 7560 User Space\001
-4 0 0 50 0 16 16 0.0000 4 180 705 10305 8100 Kernel\001
-4 0 0 50 0 16 16 0.0000 4 180 540 4725 4185 Ebits\001
diff --git a/doc/figures/architecture.gif b/doc/figures/architecture.gif
deleted file mode 100644
index ba1f2b69f..000000000
--- a/doc/figures/architecture.gif
+++ /dev/null
Binary files differ
diff --git a/doc/figures/background.gif b/doc/figures/background.gif
deleted file mode 100644
index 1dc11ce83..000000000
--- a/doc/figures/background.gif
+++ /dev/null
Binary files differ
diff --git a/doc/figures/caution.gif b/doc/figures/caution.gif
deleted file mode 100644
index 542232911..000000000
--- a/doc/figures/caution.gif
+++ /dev/null
Binary files differ
diff --git a/doc/figures/note.gif b/doc/figures/note.gif
deleted file mode 100644
index 45fe08649..000000000
--- a/doc/figures/note.gif
+++ /dev/null
Binary files differ
diff --git a/doc/figures/warning.gif b/doc/figures/warning.gif
deleted file mode 100644
index 9c1104c2b..000000000
--- a/doc/figures/warning.gif
+++ /dev/null
Binary files differ
diff --git a/doc/html-customizations.dsl.in b/doc/html-customizations.dsl.in
deleted file mode 100644
index 4bf0404d0..000000000
--- a/doc/html-customizations.dsl.in
+++ /dev/null
@@ -1,61 +0,0 @@
-<!DOCTYPE style-sheet PUBLIC "-//James Clark//DTD DSSSL Style Sheet//EN" [
-<!ENTITY dbstyle SYSTEM "@DB_STYLESHEETS@/html/docbook.dsl" CDATA DSSSL>
-]>
-
-<style-sheet>
-<style-specification use="docbook">
-<style-specification-body>
-
-;; my own customizations for HTML output:
-
-(define %admon-graphics-path%
- ;; Path to admonition graphics
- "figures/")
-
-(define %admon-graphics%
- ;; Use graphics in admonitions?
- #t)
-
-(define %indent-programlisting-lines%
- ;; Indent lines in a 'ProgramListing'?
- " ")
-
-(define %shade-verbatim%
- ;; Should verbatim environments be shaded?
- #t)
-
-(define ($shade-verbatim-attr$)
- ;; Attributes used to create a shaded verbatim environment.
- (list
- (list "BORDER" "0")
- (list "BGCOLOR" "#f0f0f0")))
-
-(define %root-filename%
- ;; Name for the root HTML document
- "index")
-
-(define %body-attr%
- ;; What attributes should be hung off of BODY?
- (list
- (list "BGCOLOR" "#FFFFFF")
- (list "TEXT" "#0000A0")
- (list "LINK" "#2020D0")
- (list "VLINK" "#000060")
- (list "ALINK" "#5050F0")))
-
-(define %css-decoration%
- ;; Enable CSS decoration of elements
- #t)
-
-(define %stylesheet%
- ;; Name of the stylesheet to use
- "stylesheet.css")
-
-(define biblio-number
- ;; Enumerate bibliography entries
- #t)
-
-</style-specification-body>
-</style-specification>
-<external-specification id="docbook" document="dbstyle">
-</style-sheet>
diff --git a/doc/kernel-doc.in b/doc/kernel-doc.in
deleted file mode 100644
index 512752348..000000000
--- a/doc/kernel-doc.in
+++ /dev/null
@@ -1,1001 +0,0 @@
-#!@PERL@
-
-## This script is based on the script shipped with ##
-## 2.4 Linux kernel sources. All copyright notices etc ##
-## remain unchanged. --cK. ##
-
-## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ##
-## Copyright (C) 2000 Tim Waugh <twaugh@redhat.com> ##
-## ##
-## #define enhancements by Armin Kuster <akuster@mvista.com> ##
-## Copyright (c) 2000 MontaVista Software, Inc. ##
-## ##
-## This software falls under the GNU General Public License. ##
-## Please read the COPYING file for more information ##
-
-# w.o. 03-11-2000: added the '-filelist' option.
-
-#
-# This will read a 'c' file and scan for embedded comments in the
-# style of gnome comments (+minor extensions - see below).
-#
-
-# Note: This only supports 'c'.
-
-# usage:
-# kerneldoc [ -docbook | -html | -text | -man ]
-# [ -function funcname [ -function funcname ...] ] c file(s)s > outputfile
-# or
-# [ -nofunction funcname [ -function funcname ...] ] c file(s)s > outputfile
-#
-# Set output format using one of -docbook -html -text or -man. Default is man.
-#
-# -function funcname
-# If set, then only generate documentation for the given function(s). All
-# other functions are ignored.
-#
-# -nofunction funcname
-# If set, then only generate documentation for the other function(s). All
-# other functions are ignored. Cannot be used with -function together
-# (yes thats a bug - perl hackers can fix it 8))
-#
-# c files - list of 'c' files to process
-#
-# All output goes to stdout, with errors to stderr.
-
-#
-# format of comments.
-# In the following table, (...)? signifies optional structure.
-# (...)* signifies 0 or more structure elements
-# /**
-# * function_name(:)? (- short description)?
-# (* @parameterx: (description of parameter x)?)*
-# (* a blank line)?
-# * (Description:)? (Description of function)?
-# * (section header: (section description)? )*
-# (*)?*/
-#
-# So .. the trivial example would be:
-#
-# /**
-# * my_function
-# **/
-#
-# If the Description: header tag is ommitted, then there must be a blank line
-# after the last parameter specification.
-# e.g.
-# /**
-# * my_function - does my stuff
-# * @my_arg: its mine damnit
-# *
-# * Does my stuff explained.
-# */
-#
-# or, could also use:
-# /**
-# * my_function - does my stuff
-# * @my_arg: its mine damnit
-# * Description: Does my stuff explained.
-# */
-# etc.
-#
-# All descriptions can be multiline, apart from the short function description.
-#
-# All descriptive text is further processed, scanning for the following special
-# patterns, which are highlighted appropriately.
-#
-# 'funcname()' - function
-# '$ENVVAR' - environmental variable
-# '&struct_name' - name of a structure (up to two words including 'struct')
-# '@parameter' - name of a parameter
-# '%CONST' - name of a constant.
-
-# match expressions used to find embedded type information
-$type_constant = "\\\%([-_\\w]+)";
-$type_func = "(\\w+)\\(\\)";
-$type_param = "\\\@(\\w+)";
-$type_struct = "\\\&((struct\\s*)?[_\\w]+)";
-$type_env = "(\\\$\\w+)";
-
-
-# Output conversion substitutions.
-# One for each output format
-
-# these work fairly well
-%highlights_html = ( $type_constant, "<i>\$1</i>",
- $type_func, "<b>\$1</b>",
- $type_struct, "<i>\$1</i>",
- $type_param, "<tt><b>\$1</b></tt>" );
-$blankline_html = "<p>";
-
-# sgml, docbook format
-%highlights_sgml = ( "([^=])\\\"([^\\\"<]+)\\\"", "\$1<quote>\$2</quote>",
- $type_constant, "<constant>\$1</constant>",
- $type_func, "<function>\$1</function>",
- $type_struct, "<structname>\$1</structname>",
- $type_env, "<envar>\$1</envar>",
- $type_param, "<parameter>\$1</parameter>" );
-$blankline_sgml = "</para><para>\n";
-
-# gnome, docbook format
-%highlights_gnome = ( $type_constant, "<replaceable class=\"option\">\$1</replaceable>",
- $type_func, "<function>\$1</function>",
- $type_struct, "<structname>\$1</structname>",
- $type_env, "<envar>\$1</envar>",
- $type_param, "<parameter>\$1</parameter>" );
-$blankline_gnome = "</para><para>\n";
-
-# these are pretty rough
-%highlights_man = ( $type_constant, "\$1",
- $type_func, "\\\\fB\$1\\\\fP",
- $type_struct, "\\\\fI\$1\\\\fP",
- $type_param, "\\\\fI\$1\\\\fP" );
-$blankline_man = "";
-
-# text-mode
-%highlights_text = ( $type_constant, "\$1",
- $type_func, "\$1",
- $type_struct, "\$1",
- $type_param, "\$1" );
-$blankline_text = "";
-
-
-sub usage {
- print "Usage: $0 [ -v ] [ -docbook | -html | -text | -man ]\n";
- print " [ -function funcname [ -function funcname ...] ]\n";
- print " [ -nofunction funcname [ -nofunction funcname ...] ]\n";
- print " < inputfile > outputfile\n";
- exit 1;
-}
-
-# read arguments
-if ($#ARGV==-1) {
- usage();
-}
-
-$verbose = 0;
-$output_mode = "man";
-%highlights = %highlights_man;
-$blankline = $blankline_man;
-$modulename = "API Documentation";
-$function_only = 0;
-$filelist = '';
-
-while ($ARGV[0] =~ m/^-(.*)/) {
- $cmd = shift @ARGV;
- if ($cmd eq "-html") {
- $output_mode = "html";
- %highlights = %highlights_html;
- $blankline = $blankline_html;
- } elsif ($cmd eq "-man") {
- $output_mode = "man";
- %highlights = %highlights_man;
- $blankline = $blankline_man;
- } elsif ($cmd eq "-text") {
- $output_mode = "text";
- %highlights = %highlights_text;
- $blankline = $blankline_text;
- } elsif ($cmd eq "-docbook") {
- $output_mode = "sgml";
- %highlights = %highlights_sgml;
- $blankline = $blankline_sgml;
- } elsif ($cmd eq "-gnome") {
- $output_mode = "gnome";
- %highlights = %highlights_gnome;
- $blankline = $blankline_gnome;
- } elsif ($cmd eq "-module") { # not needed for sgml, inherits from calling document
- $modulename = shift @ARGV;
- } elsif ($cmd eq "-function") { # to only output specific functions
- $function_only = 1;
- $function = shift @ARGV;
- $function_table{$function} = 1;
- } elsif ($cmd eq "-nofunction") { # to only output specific functions
- $function_only = 2;
- $function = shift @ARGV;
- $function_table{$function} = 1;
- } elsif ($cmd eq "-v") {
- $verbose = 1;
- } elsif (($cmd eq "-h") || ($cmd eq "--help")) {
- usage();
- }
-}
-
-
-# generate a sequence of code that will splice in highlighting information
-# using the s// operator.
-$dohighlight = "";
-foreach $pattern (keys %highlights) {
-# print "scanning pattern $pattern ($highlights{$pattern})\n";
- $dohighlight .= "\$contents =~ s:$pattern:$highlights{$pattern}:gs;\n";
-}
-
-##
-# dumps section contents to arrays/hashes intended for that purpose.
-#
-sub dump_section {
- my $name = shift @_;
- my $contents = join "\n", @_;
-
- if ($name =~ m/$type_constant/) {
- $name = $1;
-# print STDERR "constant section '$1' = '$contents'\n";
- $constants{$name} = $contents;
- } elsif ($name =~ m/$type_param/) {
-# print STDERR "parameter def '$1' = '$contents'\n";
- $name = $1;
- $parameters{$name} = $contents;
- } else {
-# print STDERR "other section '$name' = '$contents'\n";
- $sections{$name} = $contents;
- push @sectionlist, $name;
- }
-}
-
-##
-# output function
-#
-# parameters, a hash.
-# function => "function name"
-# parameterlist => @list of parameters
-# parameters => %parameter descriptions
-# sectionlist => @list of sections
-# sections => %descriont descriptions
-#
-
-sub output_highlight {
- my $contents = join "\n", @_;
- my $line;
-
- eval $dohighlight;
- foreach $line (split "\n", $contents) {
- if ($line eq ""){
- print $lineprefix, $blankline;
- } else {
- $line =~ s/\\\\\\/\&/g;
- print $lineprefix, $line;
- }
- print "\n";
- }
-}
-
-
-# output in html
-sub output_html {
- my %args = %{$_[0]};
- my ($parameter, $section);
- my $count;
- print "<h2>Function</h2>\n";
-
- print "<i>".$args{'functiontype'}."</i>\n";
- print "<b>".$args{'function'}."</b>\n";
- print "(";
- $count = 0;
- foreach $parameter (@{$args{'parameterlist'}}) {
- $type = $args{'parametertypes'}{$parameter};
- if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
- # pointer-to-function
- print "<i>$1</i><b>$parameter</b>) <i>($2)</i>";
- } else {
- print "<i>".$type."</i> <b>".$parameter."</b>";
- }
- if ($count != $#{$args{'parameterlist'}}) {
- $count++;
- print ",\n";
- }
- }
- print ")\n";
-
- print "<h3>Arguments</h3>\n";
- print "<dl>\n";
- foreach $parameter (@{$args{'parameterlist'}}) {
- print "<dt><b>".$parameter."</b>\n";
- print "<dd>";
- output_highlight($args{'parameters'}{$parameter});
- }
- print "</dl>\n";
- foreach $section (@{$args{'sectionlist'}}) {
- print "<h3>$section</h3>\n";
- print "<blockquote>\n";
- output_highlight($args{'sections'}{$section});
- print "</blockquote>\n";
- }
- print "<hr>\n";
-}
-
-
-# output in html
-sub output_intro_html {
- my %args = %{$_[0]};
- my ($parameter, $section);
- my $count;
-
- foreach $section (@{$args{'sectionlist'}}) {
- print "<h3>$section</h3>\n";
- print "<ul>\n";
- output_highlight($args{'sections'}{$section});
- print "</ul>\n";
- }
- print "<hr>\n";
-}
-
-
-
-# output in sgml DocBook
-sub output_sgml {
- my %args = %{$_[0]};
- my ($parameter, $section);
- my $count;
- my $id;
-
- $id = "API-".$args{'function'};
- $id =~ s/[^A-Za-z0-9]/-/g;
-
- print "<refentry>\n";
- print "<refmeta>\n";
- print "<refentrytitle><phrase id=\"$id\">".$args{'function'}."</phrase></refentrytitle>\n";
- print "</refmeta>\n";
- print "<refnamediv>\n";
- print " <refname>".$args{'function'}."</refname>\n";
- print " <refpurpose>\n";
- print " ";
- output_highlight ($args{'purpose'});
- print " </refpurpose>\n";
- print "</refnamediv>\n";
-
- print "<refsynopsisdiv>\n";
- print " <title>Synopsis</title>\n";
- print " <funcsynopsis>\n";
- print " <funcdef>".$args{'functiontype'}." ";
- print "<function>".$args{'function'}." ";
- print "</function></funcdef>\n";
-
-# print "<refsect1>\n";
-# print " <title>Synopsis</title>\n";
-# print " <funcsynopsis>\n";
-# print " <funcdef>".$args{'functiontype'}." ";
-# print "<function>".$args{'function'}." ";
-# print "</function></funcdef>\n";
-
- $count = 0;
- if ($#{$args{'parameterlist'}} >= 0) {
- foreach $parameter (@{$args{'parameterlist'}}) {
- $type = $args{'parametertypes'}{$parameter};
- if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
- # pointer-to-function
- print " <paramdef>$1<parameter>$parameter</parameter>)\n";
- print " <funcparams>$2</funcparams></paramdef>\n";
- } else {
- print " <paramdef>".$type;
- print " <parameter>$parameter</parameter></paramdef>\n";
- }
- }
- } else {
- print " <void>\n";
- }
- print " </funcsynopsis>\n";
- print "</refsynopsisdiv>\n";
-# print "</refsect1>\n";
-
- # print parameters
- print "<refsect1>\n <title>Arguments</title>\n";
-# print "<para>\nArguments\n";
- if ($#{$args{'parameterlist'}} >= 0) {
- print " <variablelist>\n";
- foreach $parameter (@{$args{'parameterlist'}}) {
- print " <varlistentry>\n <term><parameter>$parameter</parameter></term>\n";
- print " <listitem>\n <para>\n";
- $lineprefix=" ";
- output_highlight($args{'parameters'}{$parameter});
- print " </para>\n </listitem>\n </varlistentry>\n";
- }
- print " </variablelist>\n";
- } else {
- print " <para>\n None\n </para>\n";
- }
- print "</refsect1>\n";
-
- # print out each section
- $lineprefix=" ";
- foreach $section (@{$args{'sectionlist'}}) {
- print "<refsect1>\n <title>$section</title>\n <para>\n";
-# print "<para>\n$section\n";
- if ($section =~ m/EXAMPLE/i) {
- print "<example><para>\n";
- }
- output_highlight($args{'sections'}{$section});
-# print "</para>";
- if ($section =~ m/EXAMPLE/i) {
- print "</para></example>\n";
- }
- print " </para>\n</refsect1>\n";
- }
-
- print "</refentry>\n\n";
-}
-
-# output in sgml DocBook
-sub output_intro_sgml {
- my %args = %{$_[0]};
- my ($parameter, $section);
- my $count;
- my $id;
-
- $id = $args{'module'};
- $id =~ s/[^A-Za-z0-9]/-/g;
-
- # print out each section
- $lineprefix=" ";
- foreach $section (@{$args{'sectionlist'}}) {
- print "<refsect1>\n <title>$section</title>\n <para>\n";
-# print "<para>\n$section\n";
- if ($section =~ m/EXAMPLE/i) {
- print "<example><para>\n";
- }
- output_highlight($args{'sections'}{$section});
-# print "</para>";
- if ($section =~ m/EXAMPLE/i) {
- print "</para></example>\n";
- }
- print " </para>\n</refsect1>\n";
- }
-
- print "\n\n";
-}
-
-# output in sgml DocBook
-sub output_gnome {
- my %args = %{$_[0]};
- my ($parameter, $section);
- my $count;
- my $id;
-
- $id = $args{'module'}."-".$args{'function'};
- $id =~ s/[^A-Za-z0-9]/-/g;
-
- print "<sect2>\n";
- print " <title id=\"$id\">".$args{'function'}."</title>\n";
-
-# print "<simplesect>\n";
-# print " <title>Synopsis</title>\n";
- print " <funcsynopsis>\n";
- print " <funcdef>".$args{'functiontype'}." ";
- print "<function>".$args{'function'}." ";
- print "</function></funcdef>\n";
-
- $count = 0;
- if ($#{$args{'parameterlist'}} >= 0) {
- foreach $parameter (@{$args{'parameterlist'}}) {
- $type = $args{'parametertypes'}{$parameter};
- if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
- # pointer-to-function
- print " <paramdef>$1 <parameter>$parameter</parameter>)\n";
- print " <funcparams>$2</funcparams></paramdef>\n";
- } else {
- print " <paramdef>".$type;
- print " <parameter>$parameter</parameter></paramdef>\n";
- }
- }
- } else {
- print " <void>\n";
- }
- print " </funcsynopsis>\n";
-# print "</simplesect>\n";
-# print "</refsect1>\n";
-
- # print parameters
-# print "<simplesect>\n <title>Arguments</title>\n";
-# if ($#{$args{'parameterlist'}} >= 0) {
-# print " <variablelist>\n";
-# foreach $parameter (@{$args{'parameterlist'}}) {
-# print " <varlistentry>\n <term><parameter>$parameter</parameter></term>\n";
-# print " <listitem>\n <para>\n";
-# $lineprefix=" ";
-# output_highlight($args{'parameters'}{$parameter});
-# print " </para>\n </listitem>\n </varlistentry>\n";
-# }
-# print " </variablelist>\n";
-# } else {
-# print " <para>\n None\n </para>\n";
-# }
-# print "</simplesect>\n";
-
-# print "<simplesect>\n <title>Arguments</title>\n";
- if ($#{$args{'parameterlist'}} >= 0) {
- print " <informaltable pgwide=\"1\" frame=\"none\" role=\"params\">\n";
- print "<tgroup cols=\"2\">\n";
- print "<colspec colwidth=\"2*\">\n";
- print "<colspec colwidth=\"8*\">\n";
- print "<tbody>\n";
- foreach $parameter (@{$args{'parameterlist'}}) {
- print " <row><entry align=\"right\"><parameter>$parameter</parameter></entry>\n";
- print " <entry>\n";
- $lineprefix=" ";
- output_highlight($args{'parameters'}{$parameter});
- print " </entry></row>\n";
- }
- print " </tbody></tgroup></informaltable>\n";
- } else {
- print " <para>\n None\n </para>\n";
- }
-# print "</simplesect>\n";
-
- # print out each section
- $lineprefix=" ";
- foreach $section (@{$args{'sectionlist'}}) {
- print "<simplesect>\n <title>$section</title>\n";
-# print "<para>\n$section\n";
- if ($section =~ m/EXAMPLE/i) {
- print "<example><programlisting>\n";
- } else {
- }
- print "<para>\n";
- output_highlight($args{'sections'}{$section});
-# print "</para>";
- print "</para>\n";
- if ($section =~ m/EXAMPLE/i) {
- print "</programlisting></example>\n";
- } else {
- }
- print " </simplesect>\n";
- }
-
- print "</sect2>\n\n";
-}
-
-##
-# output in man
-sub output_man {
- my %args = %{$_[0]};
- my ($parameter, $section);
- my $count;
-
- print ".TH \"$args{'module'}\" 4 \"$args{'function'}\" \"25 May 1998\" \"API Manual\" LINUX\n";
-
- print ".SH NAME\n";
- print $args{'function'}." \\- ".$args{'purpose'}."\n";
-
- print ".SH SYNOPSIS\n";
- print ".B \"".$args{'functiontype'}."\" ".$args{'function'}."\n";
- $count = 0;
- $parenth = "(";
- $post = ",";
- foreach $parameter (@{$args{'parameterlist'}}) {
- if ($count == $#{$args{'parameterlist'}}) {
- $post = ");";
- }
- $type = $args{'parametertypes'}{$parameter};
- if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
- # pointer-to-function
- print ".BI \"".$parenth.$1."\" ".$parameter." \") (".$2.")".$post."\"\n";
- } else {
- $type =~ s/([^\*])$/\1 /;
- print ".BI \"".$parenth.$type."\" ".$parameter." \"".$post."\"\n";
- }
- $count++;
- $parenth = "";
- }
-
- print ".SH Arguments\n";
- foreach $parameter (@{$args{'parameterlist'}}) {
- print ".IP \"".$parameter."\" 12\n";
- output_highlight($args{'parameters'}{$parameter});
- }
- foreach $section (@{$args{'sectionlist'}}) {
- print ".SH \"$section\"\n";
- output_highlight($args{'sections'}{$section});
- }
-}
-
-sub output_intro_man {
- my %args = %{$_[0]};
- my ($parameter, $section);
- my $count;
-
- print ".TH \"$args{'module'}\" 4 \"$args{'module'}\" \"25 May 1998\" \"API Manual\" LINUX\n";
-
- foreach $section (@{$args{'sectionlist'}}) {
- print ".SH \"$section\"\n";
- output_highlight($args{'sections'}{$section});
- }
-}
-
-##
-# output in text
-sub output_text {
- my %args = %{$_[0]};
- my ($parameter, $section);
-
- print "Function:\n\n";
- $start=$args{'functiontype'}." ".$args{'function'}." (";
- print $start;
- $count = 0;
- foreach $parameter (@{$args{'parameterlist'}}) {
- if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
- # pointer-to-function
- print $1.$parameter.") (".$2;
- } else {
- print $type." ".$parameter;
- }
- if ($count != $#{$args{'parameterlist'}}) {
- $count++;
- print ",\n";
- print " " x length($start);
- } else {
- print ");\n\n";
- }
- }
-
- print "Arguments:\n\n";
- foreach $parameter (@{$args{'parameterlist'}}) {
- print $parameter."\n\t".$args{'parameters'}{$parameter}."\n";
- }
- foreach $section (@{$args{'sectionlist'}}) {
- print "$section:\n\n";
- output_highlight($args{'sections'}{$section});
- }
- print "\n\n";
-}
-
-sub output_intro_text {
- my %args = %{$_[0]};
- my ($parameter, $section);
-
- foreach $section (@{$args{'sectionlist'}}) {
- print " $section:\n";
- print " -> ";
- output_highlight($args{'sections'}{$section});
- }
-}
-
-##
-# generic output function - calls the right one based
-# on current output mode.
-sub output_function {
-# output_html(@_);
- eval "output_".$output_mode."(\@_);";
-}
-
-##
-# generic output function - calls the right one based
-# on current output mode.
-sub output_intro {
-# output_html(@_);
- eval "output_intro_".$output_mode."(\@_);";
-}
-
-
-##
-# takes a function prototype and spits out all the details
-# stored in the global arrays/hashes.
-sub dump_function {
- my $prototype = shift @_;
-
- $prototype =~ s/^static +//;
- $prototype =~ s/^extern +//;
- $prototype =~ s/^inline +//;
- $prototype =~ s/^__inline__ +//;
- $prototype =~ s/^#define +//; #ak added
-
- # Yes, this truly is vile. We are looking for:
- # 1. Return type (may be nothing if we're looking at a macro)
- # 2. Function name
- # 3. Function parameters.
- #
- # All the while we have to watch out for function pointer parameters
- # (which IIRC is what the two sections are for), C types (these
- # regexps don't even start to express all the possibilities), and
- # so on.
- #
- # If you mess with these regexps, it's a good idea to check that
- # the following functions' documentation still comes out right:
- # - parport_register_device (function pointer parameters)
- # - atomic_set (macro)
- # - pci_match_device (long return type)
-
- if ($prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
- $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
- $prototype =~ m/^(\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
- $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
- $prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
- $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
- $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ ||
- $prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
- $prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
- $prototype =~ m/^(\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
- $prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
- $prototype =~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
- $prototype =~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ ||
- $prototype =~ m/^(\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/) {
- $return_type = $1;
- $function_name = $2;
- $args = $3;
-
- # allow for up to fours args to function pointers
- $args =~ s/(\([^\),]+),/\1#/g;
- $args =~ s/(\([^\),]+),/\1#/g;
- $args =~ s/(\([^\),]+),/\1#/g;
-# print STDERR "ARGS = '$args'\n";
-
- foreach $arg (split ',', $args) {
- # strip leading/trailing spaces
- $arg =~ s/^\s*//;
- $arg =~ s/\s*$//;
-
- if ($arg =~ m/\(/) {
- # pointer-to-function
- $arg =~ tr/#/,/;
- $arg =~ m/[^\(]+\(\*([^\)]+)\)/;
- $param = $1;
- $type = $arg;
- $type =~ s/([^\(]+\(\*)$param/\1/;
- } else {
- # evil magic to get fixed array parameters to work
- $arg =~ s/(.+\s+)(.+)\[.*/\1* \2/;
-# print STDERR "SCAN ARG: '$arg'\n";
- @args = split('\s', $arg);
-
-# print STDERR " -> @args\n";
- $param = pop @args;
-# print STDERR " -> @args\n";
- if ($param =~ m/^(\*+)(.*)/) {
- $param = $2;
- push @args, $1;
- }
- $type = join " ", @args;
- }
-
- if ($type eq "" && $param eq "...")
- {
- $type="...";
- $param="...";
- $parameters{"..."} = "variable arguments";
- }
- elsif ($type eq "" && $param eq "")
- {
- $type="";
- $param="void";
- $parameters{void} = "no arguments";
- }
- if ($type ne "" && $parameters{$param} eq "") {
- $parameters{$param} = "-- undescribed --";
- print STDERR "Warning($file:$lineno): Function parameter '$param' not described in '$function_name'\n";
- }
-
- push @parameterlist, $param;
- $parametertypes{$param} = $type;
-# print STDERR "param = '$param', type = '$type'\n";
- }
- } else {
- print STDERR "Error($lineno): cannot understand prototype: '$prototype'\n";
- return;
- }
-
- if ($function_only==0 ||
- ( $function_only == 1 && defined($function_table{$function_name})) ||
- ( $function_only == 2 && !defined($function_table{$function_name})))
- {
- output_function({'function' => $function_name,
- 'module' => $modulename,
- 'functiontype' => $return_type,
- 'parameterlist' => \@parameterlist,
- 'parameters' => \%parameters,
- 'parametertypes' => \%parametertypes,
- 'sectionlist' => \@sectionlist,
- 'sections' => \%sections,
- 'purpose' => $function_purpose
- });
- }
-}
-
-######################################################################
-# main
-# states
-# 0 - normal code
-# 1 - looking for function name
-# 2 - scanning field start.
-# 3 - scanning prototype.
-$state = 0;
-$section = "";
-
-$doc_special = "\@\%\$\&";
-
-$doc_start = "^/\\*\\*\\s*\$";
-$doc_end = "\\*/";
-$doc_com = "\\s*\\*\\s*";
-$doc_func = $doc_com."(\\w+):?";
-$doc_sect = $doc_com."([".$doc_special."]?[\\w ]+):(.*)";
-$doc_content = $doc_com."(.*)";
-$doc_block = $doc_com."DOC:\\s*(.*)?";
-
-%constants = ();
-%parameters = ();
-@parameterlist = ();
-%sections = ();
-@sectionlist = ();
-
-$contents = "";
-$section_default = "Description"; # default section
-$section_intro = "Introduction";
-$section = $section_default;
-
-while (<STDIN>)
- {
- if (/^!I(.*)/)
- {
- process_file("@top_srcdir@" . "/" . $1);
- }
- else
- {
- print;
- }
- }
-
-exit;
-
-sub process_file($) {
- my ($file) = @_;
-
- if (!open(IN,"<$file")) {
- print STDERR "Error: Cannot open file $file\n";
- return;
- }
-
- $lineno = 0;
- while (<IN>) {
- $lineno++;
-
- if ($state == 0) {
- if (/$doc_start/o) {
- $state = 1; # next line is always the function name
- }
- } elsif ($state == 1) { # this line is the function name (always)
- if (/$doc_block/o) {
- $state = 4;
- $contents = "";
- if ( $1 eq "" ) {
- $section = $section_intro;
- } else {
- $section = $1;
- }
- }
- elsif (/$doc_func/o) {
- $function = $1;
- $state = 2;
- if (/-(.*)/) {
- $function_purpose = $1;
- } else {
- $function_purpose = "";
- }
- if ($verbose) {
- print STDERR "Info($lineno): Scanning doc for $function\n";
- }
- } else {
- print STDERR "WARN($lineno): Cannot understand $_ on line $lineno",
- " - I thought it was a doc line\n";
- $state = 0;
- }
- } elsif ($state == 2) { # look for head: lines, and include content
- if (/$doc_sect/o) {
- $newsection = $1;
- $newcontents = $2;
-
- if ($contents ne "") {
- $contents =~ s/\&/\\\\\\amp;/g;
- $contents =~ s/\</\\\\\\lt;/g;
- $contents =~ s/\>/\\\\\\gt;/g;
- dump_section($section, $contents);
- $section = $section_default;
- }
-
- $contents = $newcontents;
- if ($contents ne "") {
- $contents .= "\n";
- }
- $section = $newsection;
- } elsif (/$doc_end/) {
-
- if ($contents ne "") {
- $contents =~ s/\&/\\\\\\amp;/g;
- $contents =~ s/\</\\\\\\lt;/g;
- $contents =~ s/\>/\\\\\\gt;/g;
- dump_section($section, $contents);
- $section = $section_default;
- $contents = "";
- }
-
-# print STDERR "end of doc comment, looking for prototype\n";
- $prototype = "";
- $state = 3;
- } elsif (/$doc_content/) {
- # miguel-style comment kludge, look for blank lines after
- # @parameter line to signify start of description
- if ($1 eq "" && $section =~ m/^@/) {
- $contents =~ s/\&/\\\\\\amp;/g;
- $contents =~ s/\</\\\\\\lt;/g;
- $contents =~ s/\>/\\\\\\gt;/g;
- dump_section($section, $contents);
- $section = $section_default;
- $contents = "";
- } else {
- $contents .= $1."\n";
- }
- } else {
- # i dont know - bad line? ignore.
- print STDERR "WARNING($lineno): bad line: $_";
- }
- } elsif ($state == 3) { # scanning for function { (end of prototype)
- if (m#\s*/\*\s+MACDOC\s*#io) {
- # do nothing
- }
- elsif (/([^\{]*)/) {
- $prototype .= $1;
- }
- if (/\{/ || /\#/ || /;/) { # added for #define AK
- $prototype =~ s@/\*.*?\*/@@gos; # strip comments.
- $prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
- $prototype =~ s@^ +@@gos; # strip leading spaces
- dump_function($prototype);
-
- $function = "";
- %constants = ();
- %parameters = ();
- %parametertypes = ();
- @parameterlist = ();
- %sections = ();
- @sectionlist = ();
- $prototype = "";
-
- $state = 0;
- }
- } elsif ($state == 4) {
- # Documentation block
- if (/$doc_block/) {
- dump_section($section, $contents);
- output_intro({'sectionlist' => \@sectionlist,
- 'sections' => \%sections });
- $contents = "";
- $function = "";
- %constants = ();
- %parameters = ();
- %parametertypes = ();
- @parameterlist = ();
- %sections = ();
- @sectionlist = ();
- $prototype = "";
- if ( $1 eq "" ) {
- $section = $section_intro;
- } else {
- $section = $1;
- }
- }
- elsif (/$doc_end/)
- {
- dump_section($section, $contents);
- output_intro({'sectionlist' => \@sectionlist,
- 'sections' => \%sections });
- $contents = "";
- $function = "";
- %constants = ();
- %parameters = ();
- %parametertypes = ();
- @parameterlist = ();
- %sections = ();
- @sectionlist = ();
- $prototype = "";
- $state = 0;
- }
- elsif (/$doc_content/)
- {
- if ( $1 eq "" )
- {
- $contents .= $blankline;
- }
- else
- {
- $contents .= $1 . "\n";
- }
- }
- }
- }
-}
-
diff --git a/doc/manual.raw b/doc/manual.raw
deleted file mode 100644
index c90254886..000000000
--- a/doc/manual.raw
+++ /dev/null
@@ -1,472 +0,0 @@
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
-<!ENTITY e17 "<productname>Enlightenment 0.17</productname>">
-]>
-
-
-<book id="e17-manual">
- <bookinfo>
- <title>The Enlightenment 0.17 Manual</title>
-
- <authorgroup>
- <author>
- <firstname>Christian</firstname>
- <surname>Kreibich</surname>
- <affiliation>
- <address>
- <email>cK@whoop.org</email>
- </address>
- </affiliation>
- </author>
- </authorgroup>
-
- <copyright>
- <year>2001</year>
- <holder>Christian Kreibich</holder>
- </copyright>
-
- <legalnotice>
- <para>
- Permission is hereby granted, free of charge, to any person obtaining a copy
- of this software and associated documentation files (the "Software"), to
- deal in the Software without restriction, including without limitation the
- rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
- sell copies of the Software, and to permit persons to whom the Software is
- furnished to do so, subject to the following conditions:
- </para>
- <para>
- The above copyright notice and this permission notice shall be included in
- all copies of the Software and its documentation and acknowledgment shall be
- given in the documentation and software packages that this Software was
- used.
- </para>
- <para>
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
- THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
- IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
- CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- </para>
- </legalnotice>
-
- <releaseinfo>
- This is document is nowhere near being finished. Be patient.
- </releaseinfo>
-
- </bookinfo>
-
- <toc></toc>
-
- <chapter id="introduction">
- <title>Introduction</title>
- <para>
- This document explains the &e17; release, for both users and
- developers.
- </para>
- </chapter>
-
- <chapter id="using">
- <title>Using &e17;</title>
- <para>
- Here's how you use &e17;.
- </para>
-
- <section id="features">
- <title id="features.title">Feature List</title>
- <para>
- At the moment, &e17; has not been released. The current feature list includes:
-
- <orderedlist>
- <listitem>
- <para>A fully functional and mostly ICCCM-compliant windowmanager.</para>
- </listitem>
- <listitem>
- <para>Multiple desktops (in the version 0.16 sense, so no large,
- virtual desktop area yet).</para>
- </listitem>
- <listitem>
- <para>Shading/unshading of windows.</para>
- </listitem>
- <listitem>
- <para>Ability to browse files in your filesystem through view windows,
- with recognition of the file types and appropriate icons.</para>
- </listitem>
- <listitem>
- <para>Support for icon bars in each view window. These are
- collections of icons for commonly needed applications or documents
- in a directory. For example, in a directory with lots of images
- you will want to have image viewers ready, in a directory with
- MP3 files you'll want music players etc. The icon bars keep
- those applications where you need them.</para>
- </listitem>
- </orderedlist>
-
- This feature list should not imply that &e17; is ready for public use
- yet. Many more features are in development, but their configuration
- is currently hard-coded. If you want a fancy windowmanager with
- full configurability, you best stick to the currently stable 0.16.5
- release.
- </para>
- <para>
- Please do not come to the mailing lists and ask for release dates etc.
- &e17; will be released when it has matured to a stable system that is
- usable also for novices. &e17; will <emphasis>not</emphasis> be as
- rich in features as the 0.16 series -- we intend to produce a simple,
- stable desktop shell for that release. Funky features will be considered
- for the 0.18 release.
- </para>
- </section>
-
- <section id="wm">
- <title id="wm.title">The Window Manager</title>
- <para>
- </para>
- </section>
-
- <section id="fm">
- <title id="fm.title">The File Manager</title>
- <para>
- </para>
- </section>
-
- <section id="concepts">
- <title id="concepts.title">Themeing</title>
- <section id="overview">
- <title id="overview.title">Overview</title>
- <para>
- </para>
- </section>
- <section id="system">
- <title id="system.title">System Settings</title>
- <para>
- </para>
- </section>
- <section id="user">
- <title id="user.title">User Settings</title>
- <para>
- </para>
- </section>
- </section>
-
- </chapter>
-
- <chapter id="inside">
- <title>Inside &e17;</title>
- <para>
- This chapter explains the inner workings of &e17;.
- </para>
-
- <section id="build">
- <title id="build.title">Building &e17;</title>
- <para>
- This chapter explains how to build &e17; manually. The Enlightenment
- Project is hosted by <ulink url="http://www.sourceforge.net">Sourceforge</ulink>,
- the project website is therefore
- <ulink url="http://www.sourceforge.net/projects/enlightenment">http://www.sf.net/projects/enlightenment</ulink>.
- Since you're reading this document, your probably know this already.
- CVS is used for version control, refer to the Sourceforge documentation
- for details about using CVS.
- </para>
- <para>
- <caution>
- <title>Make sure you know what you're doing!</title>
- <para>
- Building e17 from CVS code is not trivial. Expect problems.
- You're using development code, so do not expect the software
- to work. Things can and with all likelihood will break.
- Be sure you know how to handle the tools you need for the
- build.
- </para>
- <para>
- Experience from the mailing lists shows that way too many
- people try using CVS without the proper skills. We will try
- to give help, but by explaining how to build &e17; we lose
- time we'd otherwise spend coding, so try to solve issues
- yourselves first.
- </para>
- </caution>
- </para>
- <para>
- An incomplete tree of the current CVS contents is shown below.
- For details about the modules, please refer to the
- <link linkend="modules" endterm="modules.title">Modules</link>
- section below or the
- <ulink url="http://www.enlightenment.org/pages/components.html">webpage</ulink>.
-
- <programlisting>
-e17
- | \
- | apps
- | |___ e * Enlightenment 0.17, the main program.
- | |
- | |___ ebindings A keybingings and menu contents editor.
- | |
- | |___ ebony A background editor.
- | |
- | |___ efsd * The Enlightenment File System Daemon.
- | |
- | |___ entice An image viewer.
- | |
- | |___ etcher A GUI editor for window borders and more.
- | |
- | ...
- |
- \
- libs
- |___ ebits * A library for "bits", graphical layout structures.
- |
- |___ ecore * An X Windows wrapper and event loop library.
- |
- |___ edb * A database library based on Berkeley DB.
- |
- |___ etox A text layout engine.
- |
- |___ evas * A graphical canvas engine.
- |
- |___ ewl A widget library using evas.
- |
- |___ ewd A container library for hashes, lists etc.
- |
- |___ imlib2 * An image loading and manipulation library.
- |
- |___ imlib2_loaders * A set of loaders for imlib2, separated due to licensing issues.
- </programlisting>
-
- The modules you absolutely need to get &e17; running are marked
- with an asterisk. The next thing you need to know is the build
- sequence. A working sequence is the following:
-
- <orderedlist>
- <listitem>
- <para>Edb</para>
- </listitem>
- <listitem>
- <para>Imlib2</para>
- </listitem>
- <listitem>
- <para>Imlib2 Loaders</para>
- </listitem>
- <listitem>
- <para>Evas</para>
- </listitem>
- <listitem>
- <para>Ebits</para>
- </listitem>
- <listitem>
- <para>Ecore</para>
- </listitem>
- <listitem>
- <para>Efsd</para>
- </listitem>
- <listitem>
- <para>E 17</para>
- </listitem>
- </orderedlist>
-
- Some of the modules have other dependencies, you need:
-
- <itemizedlist mark="opencircle">
- <listitem>
- <para>For Imlib2, you need a few graphics libraries. [FIXME]</para>
- </listitem>
- <listitem>
- <para>For Efsd, you need libxml2 from
- (<ulink url="http://xmlsoft.org/">XMLSoft</ulink>) and fam from
- (<ulink url="http://prdownloads.sourceforge.net/enlightenment/fam-oss-2.6.4-NULL-fix.tar.gz">Version 2.6.4</ulink> or a later version)
- </para>
- </listitem>
- </itemizedlist>
-
- <note>
- <title>There's no real reason to build those packages from source.</title>
- <para>
- It's a lot easier
- to just install the packages of your distribution. Do not forget to
- install the development packages as well, or necessary C header files
- won't be available during the build.
- </para>
- </note>
- </para>
- <para>
- To build, you need recent versions of the following GNU tools:
-
- <itemizedlist mark="opencircle">
- <listitem>
- <para><command>autoconf</command> 2.13 and <command>automake</command> 1.4 <emphasis>OR</emphasis></para>
- </listitem>
- <listitem>
- <para><command>autoconf</command> 2.50+ and <command>automake</command> 1.5</para>
- </listitem>
- <listitem>
- <para><command>gettext</command> 0.10.39 or newer</para>
- </listitem>
- <listitem>
- <para><command>libtool</command> 1.4 or newer</para>
- </listitem>
- </itemizedlist>
-
- Other combinations of <command>automake</command> and
- <command>autoconf</command> may work, but are more
- prone to errors.
- </para>
- </section>
-
- <section id="architecture">
- <title id="architecture.title">&e17; Architecture</title>
- <section id="overall">
- <title id="overall.title">Overview</title>
- <para>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="figures/architecture.eps" format="eps">
- </imageobject>
- <imageobject>
- <imagedata fileref="figures/architecture.gif" format="gif">
- </imageobject>
- <textobject>
- <phrase>Image of &e17; Architecture</phrase>
- </textobject>
- <caption>
- <para>&e17; Architecture.</para>
- </caption>
- </mediaobject>
-
- </para>
- </section>
- <section id="modules">
- <title id="modules.title">Modules</title>
- <para>
-
- <itemizedlist mark="opencircle">
- <listitem>
- <para><command>e</command></para>
- <para>This is the main &e17; applicaton. It handles managing
- of windows, launching applications, managing icons and files
- on your desktop and in directories, drag and drop etc.
- </para>
- </listitem>
- <listitem>
- <para><command>ecore</command></para>
- <para>Ecore is a convenience library. It handles
- abstracting X calls so you don't have to pass as many parameters to them. It
- wraps lots of other sequences of X calls you want to do often, handles
- caching local geometry of windows to save extra X traffic, abstracts X's
- events and adds a timer system to be able to do timeouts, handles the core
- event loops, abstracts signals into being events in the event queue, and lets
- you arbitrarily add other file descriptors to the loop to listen on and have
- handlers be called when they become active, and much much more. Ecore also
- handles filtering events and calling idle handlers when appropriate. Ecore is
- just what it says - a very complex CORE subsystem. It is all callback based,
- and keeps everything abstracted - but does not move away from normal X11
- primitives like other abstractions (GDK for example), thus keeping 100%
- compatibility with normal Xlib stuff. The core innards of E17 rely heavily on
- Ecore and its ability to not just work, but work well and optimize silently for
- E17.
- </para>
- </listitem>
- <listitem>
- <para><command>evas</command></para>
- <para>Evas is a canvas abstraction that uses Imlib2, as well
- as OpenGL, and X11. It serves as a canvas accelerator and abstraction and
- does the job really well. It has made building the rendering parts of
- &e17; a lot easier.
- </para>
- </listitem>
- <listitem>
- <para><command>ebits</command></para>
- <para>Ebits is a higher-level abstraction of image groups
- built on top of Evas. Basically it's what the old E16 window border logic
- was - but on steroids. It can do a lot more and is being used as the
- basic building block for all widgets in E17. Etcher is a GUI editor that
- can edit Ebits files - thus letting you have a nice GUI to
- design your widgets, window borders etc. in.
- </para>
- </listitem>
- <listitem>
- <para><command>edb</command></para>
- <para>Edb is a database abstraction layer to Berkeley
- DB. Edb contains the source for DB 2.7.7, thus freezing the database
- format on disk, making sure it will never become incompatible (as is a habit
- of the DB interface in libc). Edb wraps this with a convenience and
- optimization API layer, making database access easy, fast and consistent. It
- handles typing of information in the database and much more. Edb is *VERY*
- fast and all of E17 configuration management is built on top of it -
- every configuration file is a database - including Ebits files. Also,
- Efsd stores its metadata information in Edb databases.
- </para>
- </listitem>
- <listitem>
- <para><command>efsd</command></para>
- <para>Efsd is the file system abstraction layer. It is a
- library and a daemon process that the library communicates with for the
- calling process (in this case E17). It handles all filing system interaction
- in an asynchronous manner, so E17 isn't ever left blocking on basic IO
- requests. It handles copying, renaming and deleting of files. Also listing of
- directories, monitoring for changes in directories, retrieving stat
- information on files, as well as metadata retrieval and modification for
- files. All of this is done in an asynchronous request/event system thus
- keeping E17 free to handle user interaction as much as possible while Efsd
- does the nasty IO work.
- </para>
- </listitem>
- <listitem>
- <para><command>imlib2</command></para>
- <para>Imlib2 is the abstraction layer that handles the
- raw nasty work of loading images, saving them, rendering them to a drawable
- or blending and scaling them onto other images, software anti-aliased
- truetype fonts and other goodies. This one is pretty much done and finished
- with. It gets minor updates and fixes as needed, but otherwise is left alone.
- </para>
- </listitem>
- <listitem>
- <para><command>imlib2_loaders</command></para>
- <para>This is a collection of loaders that are not packaged with Imlib2
- due to licensing issues or because the loaders are not commonly needed enough.
- It currently contains a loader for Edb files (where images can be accessed
- through character string keys) and a loader for Gimp's native XCF image
- format.</para>
- </listitem>
- </itemizedlist>
- </para>
- </section>
- </section>
-
- <section id="scripting">
- <title id="scripting.title">Scripting &e17;</title>
- <para>
- &e17; provides hooks to allow script interaction with the core systems,
- using the <ulink url="http://www.ferite.org">Ferite</ulink> scripting
- language. There basic scripting support is in the code now, but it's
- too early to think about writing larger scripts.
- </para>
- </section>
-
- <section id="code">
- <title>Code Documentation</title>
-!Isrc/actions.h
-!Isrc/border.h
-!Isrc/desktops.h
-!Isrc/entry.h
-!Isrc/fs.h
-!Isrc/guides.h
-!Isrc/iconbar.c
-!Isrc/icons.h
-!Isrc/menu.h
-!Isrc/menu.c
-!Isrc/object.h
-!Isrc/observer.h
-!Isrc/place.h
-!Isrc/view.h
- </section>
-
- <section id="roadmap">
- <title id="roadmap.title">Roadmap</title>
- <para>
- </para>
- </section>
-
- </chapter>
-
-</book>
-
diff --git a/doc/stylesheet.css b/doc/stylesheet.css
deleted file mode 100644
index 660965075..000000000
--- a/doc/stylesheet.css
+++ /dev/null
@@ -1,20 +0,0 @@
-body { margin-left:10px;
- margin-right:10px;
- margin-top:10px;
- margin-bottom:10px;
- color:#0000a0;
- font-size:12pt;
- background-image:url(figures/background.gif);
- background-repeat:no-repeat;
- }
-
-th {
- font-size:14pt;
- }
-
-td {
- font-size:12pt;
- }
-
-div.mediaobject { align:center; }
-div.caption { align:center; }