PageRenderTime 111ms CodeModel.GetById 104ms app.highlight 3ms RepoModel.GetById 1ms app.codeStats 0ms


XML | 537 lines | 494 code | 37 blank | 6 comment | 0 complexity | a1957c36cc7de482cf51009235d47638 MD5 | raw file
  1<!-- jEdit buffer-local properties:                     -->
  2<!-- :indentSize=1:noTabs=true:maxLineLen=72:tab Size=2: -->
  4<!-- jEdit FAQ									        -->
  5<!-- Copyright (C) 2002 John Gellene                    -->
  7<!-- $Id: faq-items2.xml 4044 2002-02-18 15:22:27Z jgellene $
 10<sect1 id="installing-jedit"><title>Installing and Starting jEdit</title>
 12  This section deals with installing jEdit using the Java-based
 13  installation program, as well as installation issues that are specific
 14  to particular operating systems. It also deals with problems
 15  encountered in starting up jEdit.
 18<qandaset defaultlabel="qanda">
 20  <qandadiv id="install-general">
 21    <title>General installation questions</title>
 22    <qandaentry>
 23      <question id="easy-howto-install"><para>
 24        What is the easiest way to install jEdit?
 25      </para></question>
 26      <answer><para>
 27        First, make sure you have a working installation of the Java platform.
 28        To run jEdit, you will a platform package having a version number of at least 1.3.
 29        Versions 1.3, 1.3.1 or 1.4 will all work. If you do not have the Java platform,
 30        we recommend downloading the larger <quote>Software Development Kit</quote> (SDK), instead of
 31        the smaller <quote>Java Runtime Environment</quote> (JRE), because you will need
 32        the tools supplied with the SDK if you will be using Java for development.
 33        You will need to know the path of the Java application launcher, which is
 34        called <filename>java.exe</filename> on Windows systems and simply
 35        <filename>java</filename> on others.
 36      </para>
 37      <para>
 38        Next, decide whether you want the current stable version or the latest
 39        development version. The stable version is a good choice for first-time
 40        users. Download the Java installer for the version you have chosen from
 41        the jEdit web site; it consists of a single file with a name in the
 42        style <filename>jeditXXXinstall.jar</filename>.
 43        This file is a compressed archive containing all of the files you need
 44        for jEdit to run as well as an installer application written in Java.
 45        You can put this file anywhere on your hard disk that is convenient.
 46      </para>
 47      <para>
 48        To run the installer, do whatever you normally do to run a Java jar
 49        archive. If this is your first time, follow these steps:
 50      </para>
 51      <procedure>
 52        <step><para>Open a terminal or command interpreter window.</para></step>
 53        <step><para>Change the current directory to the directory in which you
 54        have stored the jEdit installer file.</para></step>
 55        <step><para>Run this command:
 56          <userinput>[full path to java application launcher] -jar
 57          jeditXXXinstall.jar</userinput></para>
 58        </step>
 59      </procedure>
 60      <para>
 61        The installer will load and display a series of dialogs for selecting a
 62        few simple options, including the directory in which you wish jEdit
 63        installed. It will also tell you how much disk space you need for
 64        the main program and various installation options.
 65      </para>
 66      <para>
 67        If this is your first download of jEdit, you should definitely install
 68        the set of macros that come with the application. Many of them are
 69        useful for all programmers, and even the ones you don't use can
 70        serve as models when you eventually begin writing your own macros.
 71      </para>
 72      <para>
 73        The installation process is very short. If you are installing the
 74        program on Windows and you select the jEditLauncher option, you should
 75        be able to start jEdit by clicking on any of the icons that the
 76        installation program provides. On other systems, you can enter
 77        <userinput>jedit</userinput> in a terminal window or create your own
 78        desktop or menu shortcut.
 79      </para></answer>
 80    </qandaentry>
 81    <qandaentry>
 82      <question id="install-no-such-file"><para>
 83        What should I do when the installer displays the message,
 84        <screen>No such file or directory</screen>?
 85      </para></question>
 86      <answer><para>
 87        The full message that you may receive from the Java application launcher
 88        begins as follows:
 89        <screen>Exception in thread "main" No such file or directory
 91        This means that the Java application launcher cannot read the
 92        jar archive file that you specified on the command line. If your Java
 93        runtime environment otherwise runs properly, then either you have named
 94        the incorrect file name or the installation file is corrupt or
 95        incomplete. Check the file name, download the installer again if
 96        necessary, and be sure to follow any specific instructions for your
 97        operating system posted on the <ulink
 98        url="">jEdit web site</ulink>.
 99      </para></answer>
100    </qandaentry>
103	<question id="install-noclassdef">
104		<para>
105			After downloading <filename>jeditXXXinstall.jar</filename> (the
106            <filename>XXX</filename> represents the version number), I tried to run
107			<userinput>java jeditXXXinstall.jar</userinput>, but got the error message,
108			<screen>Exception in main(), NoClassDefFoundError: jeditXXXinstall/jar.</screen> What am I doing wrong?
109		</para>
110	</question>
111	<answer>
113		<para>
114			You need to specify the <userinput>-jar</userinput> option for the Java
115			application loader so that the loader will search the installation archive
116			for the starting class file. Without the option, it treats the archive as a
117			single class file (which it is not!), thus producing the error. The correct
118			command line would be <userinput>java -jar jeditXXXinstall.jar</userinput>.
119		</para>
120	</answer>
125  </qandadiv>
127  <qandadiv id="install-linux">
128    <title>Installing jEdit on Linux systems</title>
131	<question id="install-jedit-home">
132		<para>
133			After installing jEdit on Linux, running the <userinput>jedit</userinput>
134			command causes the error message:
135			<screen>Warning: JAVA_HOME environment variable not set</screen>
136			How can I fix this?
137		</para>
138	</question>
139	<answer>
140		<para>
141			Your <filename>jedit</filename> shell script should
142			be modified to set the <userinput>JAVA_HOME</userinput> variable
143			to the directory containing	the executables of
144			your desired Java runtime environment (JRE).
145		</para>
146	</answer>
150	<question id="install-mandrake-kaffe">
151		<para>
152			How can I get jEdit to run on Mandrake Linux 8.1? When I try to start the
153			program, I keep getting an error which begins as follows:
154			<screen>java/lang/NoClassDefFoundError: Ljavax/swing/text/Document; at
155			java.lang.reflect.Method.invoke( at
156			kaffe.jar.ExecJarName.main</screen>
157		</para>
158	</question>
159	<answer>
160	  	<para>
161			This version of Mandrake Linux uses the Open Source Kaffe package as its default
162			Java virtual machine. Kaffe is compliant with version 1.1 (and to a limited extent,
163            version 1.2) of the Java platform.  However, the latest version of jEdit, version 4.0, requires
164            at least version 1.3. You will need to install another Java package for Linux
165            (either Blackdown, IBM or Sun) that complies with at least version 1.3.
166		</para>
167	</answer>
171	<question id="install-linux-keyboard">
172		<para>
173			I installed jEdit 3.2.2 from the RPM on Mandrake 8.1 and I am unable to send any
174			keyboard inputs to jEdit. But the mouse interacts with the program just fine. I
175			have tried running it on Sun's JDK 1.3.1 and Blackdown's latest JDK (Dec. 2001)
176			without any luck.
177		</para>
178	</question>
179	<answer>
180		<para>
181			This problem has been reported with various combinations of window managers and
182			desktop environments. The IBM JDK has not been reported to have this problem. In
183			addition, there have not been reported problems with the Sun and Blackdown JDK's
184			when running under the Sawfish window manager.
185		</para>
186	</answer>
191<qandadiv id="install-mac">
192  <title>Install jEdit on MacOS</title>
193  <qandaentry>
194    <question id="install.mac9-basic">
195      <para>How do I install jEdit on MacOS 8 or MacOS 9?</para>
196    </question>
197    <answer>
198      <para>
199        The latest version of jEdit, version 4.0, requires MacOS X, because the
200        Java platforms of earlier MacOS version out outdated.
201      </para>
202      <para>
203        The followng steps outline how to install jEdit 3.2.2 on Mac OS 9.1
204        and earlier.
205      </para>
206      <procedure>
207        <step><para>Download and install JBinary which
208        is part of the MRJ SDK 2.2 package available from Apple.</para></step>
209        <step><para>Once jBinary is installed, drag the jEdit installer to
210        JBinary and JBinary will launch.</para></step>
211        <step><para>In the Command window in the Class path box replace
212        <userinput>jedit322install,</userinput> with
213        <userinput>installer.Install</userinput>.</para></step>
214        <step><para>Then click the Run button. The installer will
215        install jEdit on your system.</para></step>
216      </procedure>
217      <para>
218        Once you have completed installing jEdit locate the jedit.jar
219        file and do the following:
220      </para>
221      <procedure>
222        <step><para>Drag the <filename>jedit.jar</filename> to JBinary
223        and JBinary will launch.</para></step>
224        <step><para>In the Command window in the Class path box replace
225        <userinput>jedit</userinput> with
226        <userinput>org.gjt.sp.jedit.jEdit</userinput>.</para></step>
227        <step><para>Then click the Save settings button. It will ask
228        for an application name and will create a double-clickable icon
229        on your desktop.</para></step>
230        <step><para>Double-click on your icon to launch jEdit.</para></step>
231       </procedure>
232     </answer>
233   </qandaentry>
238  <qandadiv id="install-windows">
239    <title>Installing jEdit on Windows</title>
240    <qandaentry>
241      <question id="install-windows-basic"><para>
242        Is there anything different about installing jEdit on Windows?
243      </para></question>
244      <answer><para>
245        For the Microsoft Windows family of operating systems, jEdit
246        provides an additional package of features called jEditLauncher.
247        These features include:
248        <itemizedlist>
249            <listitem><para>
250              Built-in shortcut icons for launching jEdit;
251            </para></listitem>
252            <listitem><para>
253              Support for opening files in jEdit using custom entries in
254              the context (right-click) menu of the Windows shell;
255            </para></listitem>
256            <listitem><para>
257              Support for running BeanShell scripts in jEdit from
258              outside the application;
259            </para></listitem>
260            <listitem><para>
261              Support for launching jEdit and loading files using
262              scripting languages such as VBScript, Perl and Python;
263            </para></listitem>
264            <listitem><para>
265              Automatic uninstallation of jEdit using the
266              <quote>Add/Remove Programs</quote> applet in Control Panel.
267            </para></listitem>
268        </itemizedlist>
269        The package is a recommended option that is selected by default when you
270        install jEdit. The Java installer application launches a separate
271        Windows installer module for the native Windows executables that
272        comprise the jEditLauncher package. If the installation involves an
273        upgrade, you may be asked to reboot your computer to complete the process.
274      </para></answer>
275    </qandaentry>
277    <qandaentry>
278      <question id="install-windows-components"><para>
279        Do I need any special Windows components to run jEditLauncher?
280      </para></question>
281      <answer><para>
282        Regardless of the version of Windows that you use, if you have kept it
283        reasonably up-to-date with service packs or component upgrades from
284        Microsoft, you should have no trouble running jEditLauncher.
285        Users of Windows 98, Windows ME, Windows NT (version 4.0),
286        Windows 2000 and Windows XP have not reported problems involving missing
287        components.
288      </para>
289      <para>
290        Some users of older versions of Windows 95 may need to upgrade their
291        version of the Windows Sockets package. Others may be missing
292        Microsoft's package for supporting DCOM (Distributed Component
293        Object Model) components on Windows 95. Both the <ulink url=
294        "">
295        Windows Sockets upgrade</ulink> and the <ulink
296        url="">
297        DCOM package</ulink> are available for download from Microsoft.
298      </para></answer>
299    </qandaentry>
301    <qandaentry>
302        <question id="install-windows-vm"><para>
303            Can I run jEdit on Microsoft's virtual machine?
304        </para></question>
305        <answer>
306           <para>
307                The latest version of jEdit, version 4.0, requires at least
308                version 1.3 of the Java 2 platform, and therefore will not
309                be compatible with Microsoft's virtual machine.
310           </para>
311          <para>
312             You can run jEdit version 3.2.2 if you put Sun's Swing 1.1.1
313             package in the classpath of Microsoft's Java application loaders
314             <command>jview</command> or <command>wjview</command>.
315             An article describing the advantages and disadvantages
316             of doing this, and detailing the necessary procedures, may
317             be found on the <ulink
318             url=";mode=&amp;order=0">jEdit
319             Community</ulink> web site.
320         </para>
321        </answer>
322    </qandaentry>
326	<question id="install-windows-badcommand">
327		<para>
328			When trying to install jEdit on Windows Me with an MS-DOS prompt, after entering
329			<userinput>java -jar jeditXXXinstall.jar</userinput> I get the message
330			<userinput>bad command or file name</userinput>.
331			I have tried various alternatives but still cannot install.
332		</para>
333	</question>
334	<answer>
335		<para>
336			You should confirm that you have a Java runtime environment installed, which
337			will include <filename>java.exe</filename> and the version that omits a separate
338            terminal window, <filename>javaw.exe</filename>. Make sure that the directory
339			containing <filename>java.exe</filename> or <filename>javaw.exe</filename>is found
340			in the value of your <filename>PATH</filename> environment variable.
341			Otherwise you should give the full path to the chosen loader on your command line.
342		</para>
343	</answer>
349	<question id="install-windows-errmessage">
350		<para>
351			After installing jEdit on Windows, when I try to run
352			<filename>jedit.exe</filename> I get the message
353			<screen>The JEditLauncher component does not appear to be installed.</screen>
354		</para>
355	</question>
356	<answer>
357		<para>
358			The dialog presenting this message asks if you would like to install the
359			launcher. Select <userinput>Yes</userinput> and supply further information
360			as prompted. A file	named <filename>install.log</filename> is generated in the
361			same directory as <filename>jedit.exe</filename> that
362			contains information on the launcher's installation. You can send this file
363			along with jEdit's Activity Log if you continue to have problems running jEdit
364			with the launcher package.
365		</para>
366	</answer>
370	<question id="install-error-regkey">
371		<para>
372			When I try to run the jEdit installation package in Windows, I get an error
373			message, <screen>Error opening registration key
374            "software\javasoft\java runtime	environment".</screen> How can I fix this?
375		</para>
376	</question>
377	<answer>
378		<para>
379			The problem is not with jEdit but may be caused by your installation of the Java
380			runtime environment. Under Windows, Sun's Java application loader relies on
381			entries in the Windows registry to find the files that create the runtime
382			environment and a Java virtual machine. The loader (<filename>java.exe</filename>e or
383            <filename>javaw.exe</filename>) is
384			unable to find the necessary registration entry and therefore sends the error
385			message. The best approach to fixing this is to uninstall and reinstall the JDK.
386		</para>
387	</answer>
390  </qandadiv>
393  <qandadiv id="problems-starting">
394    <title>Problems starting jEdit</title>
396    <qandaentry>
397      <question id="wont-start"><para>
398        jEdit won't start.  What should I do?
399      </para></question>
400      <answer><para>
401        If you don't have a clue as to why you cannot run jEdit, it's
402        best to perform a step-by-step diagnosis.  Begin by finding the
403        Java application loader you are using: <filename>java.exe</filename>,
404        <filename>javaw.exe</filename> or <filename>java</filename>. Make sure
405        it is running by entering its full path with the <userinput>-h</userinput>
406        parameter in a terminal or console window.  If you can't find
407        the Java application loader, your Java runtime environment package
408        may be missing or incomplete.
409      </para>
410      <para>
411          Next, find where you have installed jEdit.  You should look
412          for the file <filename>jedit.jar</filename> which contains all
413          of the application's Java class files in a compressed archive.
414      </para>
415      <para>
416          Once you have both files, run the Java loader with the
417          <userinput>-jar</userinput> option and with
418          <filename>jedit.jar</filename> as the target.  Make sure that
419          you either specify full paths for both files or that the
420          directories for the files are part of your <filename>PATH</filename>
421          environment variable. If jEdit does not load at this point, the likely
422          problem is a corrupt <filename>jedit.jar</filename> file. Try
423          downloading the application again.
424      </para>
425      <para>
426          If jEdit does load using this procedure, you need to examine
427          the <quote>shortcut</quote> loading mechanism you wish to use.
428      </para>
429      <para>
430        On Linux and MacOS X, you need to find and examine the <filename>jedit</filename>
431        shell script provided by the installation routine to confirm that the
432        script's commands target the correct files and locations, and that
433        variables like <filename>JAVA_HOME</filename> are either defined in the
434        script or elsewhere in your shell's environment. Don't forget to make
435        sure that the script's file permissions allow you to execute it as a shell script.
436      </para>
437      <para>
438          On Windows, if you are using a batch script to run jEdit, the
439          same points (other than file permissions) apply to examining
440          <filename>jedit.bat</filename>.  If you are using
441          jEditLauncher, run <userinput>jedit /p</userinput> in jEdit's
442          installation directory from a command line to get the custom
443          loader's setup dialog.  Here you can check the paths for both
444          the Java application loader and jEdit as well as any command
445          line parameters for both programs.  Make sure that you have
446          placed Java and jEdit options in the correct input fields.
447          If the parameters seems correct
448          but jEdit will not load with the Windows launcher, try
449          uninstalling and reinstalling the launcher by running
450          <userinput>jedit /u</userinput> followed by
451          <userinput>jedit /i</userinput>.
452      </para>
453      <para>
454          If at this point you're still stuck, ask for help on the
455          jedit-users mailing list, the jEdit Community
456          <quote>Installation</quote> message board or on IRC.
457          You're bound to find someone quickly.
458      </para>
459      </answer>
460    </qandaentry>
462    <qandaentry>
463      <question id="start-missing-plugins"><para>
464        After jEdit starts, I can't see all of the plugins I have downloaded.
465        How can I make them appear?
466      </para></question>
467      <answer><para>
468        If you use jEdit's Plugin Manager to download and install plugins, your
469        plugins will be found in the <filename>jars</filename> subdirectory of
470        one of two directories: either the directory in which jEdit is
471        installed, or the current user's settings directory. These are the only
472        location jEdit examines when it loads plugins at startup.
473      </para>
474      <para>
475        The default location of the settings directory depends on your operating
476        system. You can find out its location during a jEdit session by
477        evaluating <userinput>jedit.getSettingsDirectory()</userinput> in BeanShell.
478      </para>
479      <para>
480          The settings directory can be changed by using the
481          <userinput>-settings</userinput> command line parameter. If you change the
482          location of the settings directory with this parameter, jEdit will not
483          be able to find plugin archive files in the old location.
484          If you use or change the <userinput>-settings</userinput>
485          parameter, make sure your plugins don't get left behind.
486      </para>
487      </answer>
488    </qandaentry>
490  </qandadiv>
492  <qandadiv id="problems-running-general">
493    <title>General problems running jEdit</title>
494    <qandaentry>
495      <question id="problems-out-of-memory"><para>
496        During an editing session I get a error message about an
497        <quote>OutOfMemoryError</quote> while working with a large file or
498        performing a lengthy operation. The message reappears every time
499        I retry the operation.  How can I prevent this?
500      </para></question>
501      <answer><para>
502        One solution that often works is to set or increase the allocation of
503        memory to the heap for Java objects created by the Java Virtual Machine
504        in which jEdit is running. Add the command line option
505        <userinput>-mxXXm</userinput> to the options passed to the version of
506        the Java application loader you are using (such as
507        <filename>java</filename>, <filename>java.exe</filename> or
508        <filename>javaw.exe</filename>). In place of the
509        <userinput>XX</userinput> in the option, use a multiple of 16
510        between 32 and 128. If you already are using the option, increase the
511        numeric portion of the <userinput>-mxXXm</userinput> parameter in
512        increments of 16. Many users have good results using 48 or 64, but you
513        should try different values for the best result on your installation.
514       </para>
515       <para>
516        If you are using the <userinput>-jar</userinput> command line option
517        with Java to run jEdit, remember that the <userinput>-jar</userinput>
518        parameter must be the last Java option, followed immediately by the path
519        to <filename>jedit.jar</filename> and then any jEdit command line options.
520       </para>
521       <para>
522        If out of memory errors occur while running a build or compilation
523        operation from within jEdit, you can also have the operation run in an
524        external process rather than inside the same Java Virtual Machine
525        running jEdit. The AntFarm plugin, for example, lets you select this
526        approach as a configuration option. In other cases, you can run an
527        external program using the command line interface of the Console plugin,
528        which will capture and display the output of the external process and in
529        many cases parse the output for error information.
530      </para></answer>
531    </qandaentry>
532  </qandadiv>