Java Desktop for X Window
Copyright © 2001-2004 The
JD4X Project
Refer to the GNU General Public License for more details.
How
To Build Your Own Java Desktop Using JD4X.
We have written an entire separate set of documents just on helping
others understand about JD4X's design, specification, extendsion and
development. You will need OpenOffice to view some of these documents.
You do not need to download the documentation package if you desire to
merely extend the desktop. However, if you desire to develop your own
Java desktop, then you will need to start reading and studying the
source code on top of the documentation that we have provided. We
recommend that you start with the Java end of the source code before
proceeding to the C code because the C code may be more complex and less
intuitive. Here are what is available to the developer in the
documentation package:
- Detail information about its design and specification can be
found in the dns.sxw file (OpenOffice word format) within the dns_doc
directory. This document includes details on how to customize your own
Java desktop, as well as, explain some of the key implementation details
of the system.
- The original source code and all its build scripts.
- A set of simple tutorials on how to write a minor module to
dynamically extend the JD4X desktop.
- There is also a set of HTML documents (Javadoc generated files)
in the format of an API for developers to use if they desire. This is
only for the Java code portion of the project. All C codes are
documented the same way as Java codes but they are not available in the
HTML format, so you need to look at the code itself.
For pure Java developers: If you only want to use and extend the JD4X
system on the Java front end, all you need is a good grasp of Java and a
good understanding of the JD4X design. You will be up and coding quickly
by just reading the documentation that we have provided. The default
Java desktop implementation will serve as a tutorial to help you
understand the facilities that are currently available.
For JD4X implementers and porters: If you want to understand about the
entire JD4X system, you will need to have intermediate to advance
knowledge in the area of Java Native Interface (JNI), ANSI C, Java, X
Window System, Linux and basic scripting including Makefile scripts.
Here is a list of other additional documents that you may need in order
to help you understand about the default JD4X implementation:
- A book on using and developing applications in Linux/Unix
environment.
- A reference book on ANSI C.
- The Java toolkit documentation.
- X Window System's XLib and ICCCM documentation.
- A book on the Linux kernel.
How To Setup The
Original Development Environment From The Documentation Package
- Unpack the documentation package in your home directory and clean
up.
- Command: gzip -d jd4x-doc.tar.gz
- Command: tar xvf jd4x-doc.tar
- Command: rm jd4x-doc.tar
- Before you move on to start hacking on the source code, check to
ensure that you have unzipped the source tree in your user home
directory. All existing scripts are configured automatically to your
home directory and the entire source tree build depends on this
assumuption.
- Command: ls ~/
- To compile the entire source tree from scratch, change into the
jd4x directory and execute the make command. At this point you may wish
to walk away and have a cup of coffee as it will take a while!
- Command: cd ~/jd4x
- Command: make
- The resulting binaries are placed automatically into the build
subdirectory which is located in the jd4x directory. At this point you
can either copy the new build over the existing one or zip up the build
and distribute it. It is that simple.
- Two files are created in the build directory. The first file is
the new zipped source tree. The second file is the new jd4x directory
which will hold the entire new distribution binaries. The new jd4x
directory found in the build directory is exactly the same as the one
you downloaded from our web site.
- If you are building your own Java desktop and you have derived it
from hacking on top of the default distribution, then all you need to do
is to distribute the jar file (and not the entire system) that is
created in the minor directory found in the new jd4x directory. That jar
file is named defaultwm.jar, you can then rename it and put it into the
minor directory of the original jd4x distribution (the original one
that you downloaded from us and installed into your Linux system) to
test if your hack works. Remember to change the Manifest.mf file and
other development information before you release it to the public
because the original build have our names in it.
- Finally, we have worked hard to make things simple for you, so be
kind and give us the credit for our work. We thank you in advance.