Differences

This shows you the differences between two versions of the page.

--- user-manual:ch01 [2024/04/29 15:22] – [GroIMP Interfaces] gaetan
+++ user-manual:ch01 [2025/01/22 15:56] (current) – [GroIMP Interfaces] Tim
@@ Line 13: / Line 13: @@
 GroIMP is
-written in Java. Thus,  it should follow Java's WORA-principle (Write Once, Run
+written in Java, which means it should follow Java's WORA-principle (Write Once, Run
 Anywhere) and should run on every Java-capable platform. GroIMP has been tested
 successfully on Unix and  Windows platforms.
-GroIMP 2.1.3 requires
+GroIMP 2.1.5 requires
-the installation of a  Java runtime environment of version 17. Which
+the installation of a  Java runtime environment of version 17. This
 can be obtained from Oracle at [[https://www.oracle.com/|www.oracle.com]].
@@ Line 29: / Line 29: @@
 The binary distribution of GroIMP is available on the [[https://gitlab.com/grogra/groimp/-/releases|gitlab release section]] as a zip-file, windows exe, or debian release.
-====== Installation Installation from binaries ======
+====== Installation from binaries ======
-The windows exe and debian release are executable files that will extract and install GroIMP on your computer. It will also provide you to create a menu entry and a shortcut.
+The windows exe and debian release are executable files that will extract and install GroIMP on your computer. It will also provide you with the possibility to create a menu entry and a shortcut.
-Mac users need to download the zip-file, extract it and run GroIMP from command line.
+Mac users need to download the zip-file, extract it and run GroIMP from the command line.
 The directory structure of the zip-file has to be preserved, check
@@ Line 43: / Line 43: @@
 `README`
-This plain text file contains additional information about the GroIMP distribution. Read it
+This plain text file contains additional information about the GroIMP distribution. Please read it
 carefully.
@@ Line 49: / Line 49: @@
 This plain text file contains  instructions for the installation of the GroIMP
-distribution, legal notices and other information. Read it carefully. If you
+distribution, legal notices and other information. Please read it carefully. If you
-have troubles with the installation procedure described in this manual, consult
+have trouble with the installation procedure described in this manual, please consult
 the file `INSTALL` a solution.
@@ Line 65: / Line 65: @@
 ====== Running GroIMP ======
-Because `core.jar` is an executable java archive, it is possible to start GroIMP just by (double-)clicking on the file in your system's file browser as you would do it with a usual executable file. This requires a suitable setup of your file browser, see the documentation of the browser and your Java installation if it does not already work.
+Because `core.jar` is an executable java archive, it is possible to start GroIMP just by (double-)clicking on the file in your system's file browser as you would do with a usual executable file. This requires a suitable setup of your file browser, see the documentation of the browser and your Java installation if it does not already work.
 ==== From a Shortcut ====
@@ Line 84: / Line 84: @@
 > **java -Xverify:none -jar "C:\\Program Files\\GroIMP\\core.jar"**
+Alternatively, if you wish to start GroIMP from a batch file from your cmd console in Windows, you could write a file called groimp.bat (which you would place in your home directory, C:\\Users\\myself\\, where 'myself' is your user directory) with the following content:
+> **cd "C:\Program Files\GroIMP 2.1.5"**
+> **"C:\Program Files\Java\jdk-22\bin\javaw.exe" -Xmx3000m -Xss20M -noverify -jar core.jar**
+where "C:\Program Files\Java\jdk-22\bin\javaw.exe" is an example of the placement of your javaw version, assuming we use jdk22.
 ==== Additional Options ====
@@ Line 89: / Line 95: @@
 === Java Parameters ===
-The **java** command has several options which influence the runtime behaviour, see the documentation of your Java installation. These options have to be specified before the `-jar` option. E.g., for the Java runtime environment of Sun, the option `-Xmx` specifies the maximum amount of heap memory size that should be allocated. The default value of this option may be much smaller than your installed main memory size. In this case GroIMP cannot benefit from your memory until you specify the `-Xmx` option as in
+The **java** command has several options that influence the runtime behaviour, see the documentation of your Java installation. These options have to be specified before the `-jar` option. E.g., for the Java runtime environment of Sun, the option `-Xmx` specifies the maximum amount of heap memory size that should be allocated. The default value of this option may be much smaller than your installed main memory size. In this case GroIMP cannot benefit from your memory until you specify the `-Xmx` option as in
 > **java -Xmx400m -jar path/to/core.jar**
-which allows a maximum heap memory allocation of 400 MB. If you encounter `OutOfMemoryError`s when running GroIMP, you have to specify this option with a larger value.
+which allows a maximum heap memory allocation of 400 MB. If you encounter `OutOfMemoryError`s when running GroIMP, you have to specify this option with a larger value. Note that the opposite may happen, i.e. a too generous memory allocation might prevent GroIMP from starting at all. In that case you have to lower the alocated memory again until it works.
 === GroIMP Parameters ===
@@ Line 104: / Line 110: @@
 ==== GroIMP Interfaces ====
+See [[:user-guide:additional_interfaces|GroIMP interfaces]] for more details and tutorials.
 GroIMP can be run from different interfaces. By default, GroIMP use the "imp" interface which is its Graphical User Interface (GUI).
@@ Line 113: / Line 121: @@
  > **java -jar core.jar -a api**
-More information can be found for using GroIMP [[:groimp-platform:interfaces:headless|headless]], [[:groimp-platform:interfaces:cli|CLI]], and [[:groimp-platform:interfaces:api|API]].
+More information can be found for using GroIMP [[:user-guide:additional_interfaces:headless|headless]], [[:user-guide:additional_interfaces::cli|CLI]], and [[:user-guide:additional_interfaces:api|API]].
 ===== Plugin Architecture =====
@@ Line 121: / Line 129: @@
 Installation of Plugins for the Java Image I/O Framework.
-GroIMP requires only a Java runtime environment in order to run. However, the capabilities of some parts of the Java runtime environment can be extended by the installation of additional plugins. GroIMP makes use of the Java Image I/O Framework which provides such a pluggable architecture: The user may install plugins which add support for an image file format to the Java Image I/O Framework. If the standard installation of the Java runtime environment does not support an image file format you need, please consult the [[http://java.sun.com/j2se/1.4.2/docs/guide/imageio/index.html|Java Image I/O pages]] for a suitable plugin.
+GroIMP requires only a Java runtime environment in order to run. However, the capabilities of some parts of the Java runtime environment can be extended by the installation of additional plugins. GroIMP makes use of the Java Image I/O Framework which provides features such a pluggable architecture: The user may install plugins which add support for an image file format to the Java Image I/O Framework. If the standard installation of the Java runtime environment does not support an image file format you need, please consult the [[http://java.sun.com/j2se/1.4.2/docs/guide/imageio/index.html|Java Image I/O pages]] for a suitable plugin.
 ==== GroIMP Plugins ====
@@ Line 127: / Line 135: @@
 GroIMP is developed around a plugin architecture. New plugin can easily be added to your GroIMP installation by simply adding them to the loading directory of GroIMP.
-On startup GroIMP load all plugins under it's installed path/plugins, as well as plugins in the //user plugin path//. The //user plugin path// can be modified in the GroIMP options, and is by default at ~/.grogra.de-platform/plugins/.
+On startup GroIMP loads all plugins under its installed path/plugins, as well as plugins in the //user plugin path//. The //user plugin path// can be modified in the GroIMP options, and is by default at ~/.grogra.de-platform/plugins/.
 GroIMP plugins can be installed/ removed/ modified from within GroIMP with the [[:User-Guide:pluginmanager| Plugin Manager]].
-A complete list of available plugin can be found at [[https://grogra.gitlab.io/groimp-utils/plugin_web_explorer/]]
+A complete list of available plugins can be found at [[https://grogra.gitlab.io/groimp-utils/plugin_web_explorer/]]