PageRenderTime 51ms CodeModel.GetById 41ms app.highlight 6ms RepoModel.GetById 1ms app.codeStats 0ms


XML | 484 lines | 442 code | 36 blank | 6 comment | 0 complexity | 8bbe420e2b95785c7fec1200008c801a 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 3997 2002-01-26 13:40:00Z 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        You will need to know the path of the Java application launcher, which is
 29        called <filename>java.exe</filename> on Windows systems and simply
 30        <filename>java</filename> on others.
 31      </para>
 32      <para>
 33        Next, decide whether you want the current stable version or the latest
 34        development version. The stable version is a good choice for first-time
 35        users. Download the Java installer for the version you have chosen from
 36        the jEdit web site; it consists of a single file with a name in the
 37        style <filename>jeditXXXinstall.jar</filename>.
 38        This file is a compressed archive containing all of the files you need
 39        for jEdit to run as well as an installer application written in Java.
 40        You can put this file anywhere on your hard disk that is convenient.
 41      </para>
 42      <para>
 43        To run the installer, do whatever you normally do to run a Java jar
 44        archive. If this is your first time, follow these steps:
 45      </para>
 46      <procedure>
 47        <step><para>Open a terminal or command interpreter window.</para></step>
 48        <step><para>Change the current directory to the directory in which you
 49        have stored the jEdit installer file.</para></step>
 50        <step><para>Run this command:
 51          <userinput>[full path to java application launcher] -jar
 52          jeditXXXinstall.jar</userinput></para>
 53        </step>
 54      </procedure>
 55      <para>
 56        The installer will load and display a series of dialogs for selecting a
 57        few simple options, including the directory in which you wish jEdit
 58        installed. It will also tell you how much disk space you need for
 59        the main program and various installation options.
 60      </para>
 61      <para>
 62        If this is your first download of jEdit, you should definitely install
 63        the set of macros that come with the application. Many of them are
 64        useful for all programmers, and even the ones you don't use can
 65        serve as models for when you eventually begin writing your own macros.
 66      </para>
 67      <para>
 68        The installation process is very short. If you are installing the
 69        program on Windows and you select the jEditLauncher option, you should
 70        be able to start jEdit by clicking on any of the icons that the
 71        installation program provides. On other systems, you can enter
 72        <userinput>jedit</userinput> in a terminal window or create your own
 73        desktop or menu shortcut.
 74      </para></answer>
 75    </qandaentry>
 76    <qandaentry>
 77      <question id="install-no-such-file"><para>
 78        What should I do when the installer displays the message,
 79        <screen>No such file or directory</screen>?
 80      </para></question>
 81      <answer><para>
 82        The full message that you may receive from the Java application launcher
 83        begins as follows:
 84        <screen>Exception in thread "main" No such file or directory
 86        This means that the Java application launcher cannot read the
 87        jar archive file that you specified on the command line. If your Java
 88        runtime environment otherwise runs properly, then either you have named
 89        the incorrect file name or the installation file is corrupt or
 90        incomplete. Check the file name, download the installer again if
 91        necessary, and be sure to follow any specific instructions for your
 92        operating system posted on the <ulink
 93        url="">jEdit web site</ulink>.
 94      </para></answer>
 95    </qandaentry>
 98	<question id="install-noclassdef">
 99		<para>
100			After downloading <filename>jedit322install.jar</filename>, I tried to run
101			<userinput>java jedit322install.jar</userinput>, but got the error message,
102			<screen>Exception in main(), NoClassDefFoundError: jedit322install/jar.</screen> What am I doing wrong?
103		</para>
104	</question>
105	<answer>
107		<para>
108			You need to specify the <userinput>-jar</userinput> option for the Java
109			application loader so that the loader will search the installation archive
110			for the starting class file. Without the option, it treats the archive as a
111			single class file (which it is not!), thus producing the error. The correct
112			command line would be <userinput>java -jar jedit322install.jar</userinput>.
113		</para>
114	</answer>
119  </qandadiv>
121  <qandadiv id="install-linux">
122    <title>Installing jEdit on Linux systems</title>
125	<question id="install-jedit-home">
126		<para>
127			After installing jEdit on Linux, running the <userinput>jedit</userinput>
128			command causes the error message:
129			<screen>Warning: JAVA_HOME environment variable not set</screen>
130			How can I fix this?
131		</para>
132	</question>
133	<answer>
134		<para>
135			Your <filename>jedit</filename> shell script should
136			be modified to have the <userinput>JAVA_HOME</userinput> variable
137			defined as the directory containing	the executables of
138			your desired Java runtime environment (JRE).
139		</para>
140	</answer>
144	<question id="install-mandrake-kaffe">
145		<para>
146			How can I get jEdit to run on Mandrake Linux 8.1? When I try to start the
147			program, I keep getting an error which begins as follows:
148			<screen>java/lang/NoClassDefFoundError: Ljavax/swing/text/Document; at
149			java.lang.reflect.Method.invoke( at
150			kaffe.jar.ExecJarName.main</screen>
151		</para>
152	</question>
153	<answer>
154	  	<para>
155			This version of Mandrake Linux uses the Open Source Kaffe package as its default
156			Java virtual machine. The jEdit application requires Sun's Swing package, which
157			is not included with Kaffe. However, the developers of Kaffe claim that Kaffe
158			and Swing are fully compatible. You therefore have two choices. You can obtain a
159			copy of Sun's Swing package (version 1.1.1 is known to work with Kaffe) and
160			place it on the classpath used by Kaffe. Alternatively, you can install Sun's
161			JDK for Linux and modify the script used to launch jEdit to point to Sun's
162			application loader instead of Kaffe. This is likely to be a simpler operation.
163		</para>
164	</answer>
168	<question id="install-linux-keyboard">
169		<para>
170			I installed jEdit 3.2.2 from the RPM on Mandrake 8.1 and I am unable to send any
171			keyboard inputs to jEdit. But the mouse interacts with the program just fine. I
172			have tried running it on Sun's JDK 1.3.1 and Blackdown's latest JDK (Dec. 2001)
173			without any luck.
174		</para>
175	</question>
176	<answer>
177		<para>
178			This problem has been reported with various combinations of window managers and
179			desktop environments. The IBM JDK has not been reported to have this problem. In
180			addition, there have not been reported problems with the Sun and Blackdown JDK's
181			when running under the Sawfish window manager.
182		</para>
183	</answer>
188<qandadiv id="install-mac">
189  <title>Install jEdit on MacOS</title>
190  <qandaentry> 
191    <question id="install.mac9-basic">
192      <para>How do I install jEdit on MacOS 8 or MacOS 9?</para>
193    </question>
194    <answer>
195      <para>
196        To install Jedit on Mac OS 9.1 and earlier download JBinary which 
197        is part of the MRJ SDK 2.2 package available from Apple. Once 
198        you have installed JBinary do the following:
199      </para>  
200      <procedure>
201        <step><para>Drag the jEdit installer to JBinary and JBinary 
202        will launch.</para></step>
203        <step><para>In the Command window in the Class path box replace 
204        <userinput>jedit322install,</userinput> with 
205        <userinput>installer.Install</userinput>.</para></step>
206        <step><para>Then click the Run button. The installer will 
207        install jEdit on your system.</para></step>
208      </procedure>
209      <para>
210        Once you have completed installing jEdit locate the jedit.jar 
211        file and do the following:
212      </para>  
213      <procedure>
214        <step><para>Drag the <filename>jedit.jar</filename> to JBinary 
215        and JBinary will launch.</para></step>
216        <step><para>In the Command window in the Class path box replace 
217        <userinput>jedit</userinput> with 
218        <userinput>org.gjt.sp.jedit.jEdit</userinput>.</para></step>
219        <step><para>Then click the Save settings button. It will ask 
220        for an application name and will create a double-clickable icon 
221        on your desktop.</para></step>
222        <step><para>Double-click on your icon to launch jEdit.</para></step>
223       </procedure>
224     </answer>
225   </qandaentry>  
230  <qandadiv id="install-windows">
231    <title>Installing jEdit on Windows</title>
232    <qandaentry>
233      <question id="install-windows-basic"><para>
234        Is there anything different about installing jEdit on Windows?
235      </para></question>
236      <answer><para>
237        For the Microsoft Windows family of operating systems, jEdit
238        provides an additional package of features called jEditLauncher.
239        These features include:
240        <itemizedlist>
241            <listitem><para>
242              Built-in shortcut icons for launching jEdit;
243            </para></listitem>
244            <listitem><para>
245              Support for opening files in jEdit using custom entries in
246              the context (right-click) menu of the Windows shell;
247            </para></listitem>
248            <listitem><para>
249              Support for running BeanShell scripts in jEdit from
250              outside the application;
251            </para></listitem>
252            <listitem><para>
253              Support for launching jEdit and loading files using
254              scripting languages such as VBScript, Perl and Python;
255            </para></listitem>
256            <listitem><para>
257              Automatic uninstallation of jEdit using the
258              <quote>Add/Remove Programs</quote> applet in Control Panel.
259            </para></listitem>
260        </itemizedlist>
261        The package is a recommended option that is selected by default when you
262        install jEdit. The Java installer application launches a separate
263        Windows installer module for the native Windows executables that
264        comprise the jEditLauncher package. If the installation involves an
265        upgrade, you may be asked to reboot your computer to complete the process.
266      </para></answer>
267    </qandaentry>
269    <qandaentry>
270      <question id="install-windows-components"><para>
271        Do I need any special Windows components to run jEditLauncher?
272      </para></question>
273      <answer><para>
274        Regardless of the version of Windows that you use, if you have kept it
275        reasonably up-to-date with service packs or component upgrades from
276        Microsoft, you should have no trouble running jEditLauncher.
277        Users of Windows 98, Windows ME, Windows NT (version 4.0) or
278        Windows 2000 have not reported problems involving missing
279        components.
280      </para>
281      <para>
282        Some users of older versions of Windows 95 may need to upgrade their
283        version of the Windows Sockets package. Others may be missing
284        Microsoft's package for supporting DCOM (Distributed Component
285        Object Model) components on Windows 95. Both the <ulink url=
286        "">
287        Windows Sockets upgrade</ulink> and the <ulink
288        url="">
289        DCOM package</ulink> are available for download from Microsoft.
290      </para></answer>
291    </qandaentry>
293    <qandaentry>
294        <question id="install-windows-vm"><para>
295            Can I run jEdit on Microsoft's virtual machine?
296        </para></question>
297        <answer>
298          <para>
299             You can run version 3.2.2 if you put Sun's Swing 1.1.1
300             package in the classpath of Microsoft's Java application loaders
301             <command>jview</command> or <command>wjview</command>.
302             An article describing the advantages and disadvantages
303             of doing this, and detailing the necessary procedures, may
304             be found on the <ulink
305             url=";mode=&amp;order=0">jEdit
306             Community</ulink> web site.
307         </para>
308           <para>
309                The forthcoming new version of jEdit, version 4.0, will require
310                the Java 2 platform, and therefore will not be compatible with
311                Microsoft's virtual machine.
312            </para>
313        </answer>
314    </qandaentry>
318	<question id="install-windows-badcommand">
319		<para>
320			When trying to install jEdit on Windows Me with an MS-DOS prompt, after entering
321			<userinput>java -jar jedit322install.jar</userinput> I get the message
322			<userinput>bad command or file	name</userinput>.
323			I have tried various alternatives but still cannot install.
324		</para>
325	</question>
326	<answer>
327		<para>
328			You should confirm that you have a Java runtime environment installed, which
329			will include <filename>java.exe</filename>. Make sure that the directory
330			containing <filename>java.exe</filename> is found
331			in the value of your <filename>PATH</filename> environment variable.
332			Otherwise you should give the full path to <filename>java.exe</filename>
333			on your command line.
334		</para>
335	</answer>
341	<question id="install-windows-errmessage">
342		<para>
343			After installing jEdit on Windows, when I try to run
344			<filename>jedit.exe</filename> I get the message
345			<screen>The JEditLauncher component does not appear to be installed.</screen>
346		</para>
347	</question>
348	<answer>
349		<para>
350			The dialog presenting this message asks if you would like to install the
351			launcher. Select <userinput>Yes</userinput> and supply further information
352			as prompted. A file	named <filename>install.log</filename> is generated in the
353			same directory as <filename>jedit.exe</filename> that
354			contains information on the launcher's installation. You can send this file
355			along with jEdit's Activity Log if you continue to have problems running jEdit
356			with the launcher package.
357		</para>
358	</answer>
362	<question id="install-error-regkey">
363		<para>
364			When I try to run the jEdit installation package in Windows, I get an error
365			message, <screen>Error opening registration key
366            "software\javasoft\java runtime	environment".</screen> How can I fix this?
367		</para>
368	</question>
369	<answer>
370		<para>
371			The problem is not with jEdit but may be caused by your installation of the Java
372			runtime environment. Under Windows, Sun's Java application loader relies on
373			entries in the Windows registry to find the files that create the runtime
374			environment and a Java virtual machine. The loader (java.exe or javaw.exe) is
375			unable to find the necessary registration entry and therefore sends the error
376			message. The best approach to fixing this is to uninstall and reinstall the JDK.
377		</para>
378	</answer>
381  </qandadiv>
384  <qandadiv id="problems-starting">
385    <title>Problems starting jEdit</title>
387    <qandaentry>
388      <question id="wont-start"><para>
389        jEdit won't start.  What should I do?
390      </para></question>
391      <answer><para>
392        If you don't have a clue as to why you cannot run jEdit, it's
393        best to perform a step-by-step diagnosis.  Begin by finding the
394        Java application loader you are using: <userinput>java.exe</userinput>,
395        <userinput>javaw.exe</userinput> or <userinput>java</userinput>. Make sure
396        it is running by entering its full path with the <userinput>-h</userinput>
397        parameter in a terminal or console window.  If you can't find
398        the Java application loader, your Java runtime environment package
399        may be missing or incomplete.
400      </para>
401      <para>
402          Next, find where you have installed jEdit.  You should look
403          for the file <filename>jedit.jar</filename> which contains all
404          of the application's Java class files in a compressed archive.
405      </para>
406      <para>
407          Once you have both files, run the Java loader with the
408          <userinput>-jar</userinput> option and with
409          <filename>jedit.jar</filename> as the target.  Make sure that
410          you either specify full paths for both files or that the
411          directories for the files are part of your <filename>PATH</filename>
412          environment variable. If jEdit does not load at this point, the likely
413          problem is a corrupt <filename>jedit.jar</filename> file. Try
414          downloading the application again.
415      </para>
416      <para>
417          If jEdit does load using this procedure, you need to examine
418          the <quote>shortcut</quote> loading mechanism you wish to use.
419      </para>
420      <para>
421        On Linux and MacOS X, you need to find and examine the <filename>jedit</filename>
422        shell script provided by the installation routine to confirm that the
423        script's commands target the correct files and locations, and that
424        variables like <filename>JAVA_HOME</filename> are either defined in the
425        script or elsewhere in your shell's environment. Don't forget to make
426        sure that the script's file permissions allow you to execute it.
427      </para>
428      <para>
429          On Windows, if you are using a batch script to run jEdit, the
430          same points (other than file permissions) apply to examining
431          <filename>jedit.bat</filename>.  If you are using
432          jEditLauncher, run <userinput>jedit /p</userinput> in jEdit's
433          installation directory from a command line to get the custom
434          loader's setup dialog.  Here you can check the paths for both
435          the Java application loader and jEdit as well as any command
436          line parameters for both programs.  If the parameters seems correct
437          but jEdit will not load with the Windows launcher, try
438          uninstalling and reinstalling the launcher by running
439          <userinput>jedit /u</userinput> followed by
440          <userinput>jedit /i</userinput>.
441      </para>
442      <para>
443          If at this point you're still stuck, ask for help on the
444          jedit-users mailing list, the jEdit Community
445          <quote>Installation</quote> message board or on IRC.
446          You're bound to find someone quickly.
447      </para>
448      </answer>
449    </qandaentry>
451    <qandaentry>
452      <question id="start-missing-plugins"><para>
453        After jEdit starts, I can't see all of the plugins I have downloaded.
454        How can I make them appear?
455      </para></question>
456      <answer><para>
457        If you use jEdit's Plugin Manager to download and install plugins, your
458        plugins will be found in the <filename>jars</filename> subdirectory of
459        one of two directories: either the directory in which jEdit is
460        installed, or the current user's settings directory. These are the only
461        location jEdit examines when it loads plugins at startup.
462      </para>
463      <para>
464        The default location of the settings directory depends on your operating
465        system. You can find out its location during a jEdit session by
466        evaluating <userinput>jedit.getSettingsDirectory()</userinput> in BeanShell.
467      </para>
468      <para>
469          The settings directory can be changed by using the
470          <userinput>-settings</userinput> userinput line parameter. If you change the
471          location of the settings directory with this parameter, jEdit will not
472          be able to find plugin archive files in the old location.
473          If you use or change the <userinput>-settings</userinput>
474          parameter, make sure your plugins don't get left behind.
475      </para>
476      </answer>
477    </qandaentry>
479  </qandadiv>