User Tools

Site Tools


user-manual:ch01

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
user-manual:ch01 [2025/05/31 09:55] – [Requirements] tim2user-manual:ch01 [2025/06/17 19:27] (current) barley1965
Line 25: Line 25:
 ==== Windows ==== ==== Windows ====
  
-The windows exe is executable file that will extract and install GroIMP on your computer.+The windows exe is an executable file that will extract and install GroIMP on your computer.
  
-While you are downloading the file you might get some warning from your web browser that the software is not certified by Microsoft. Please ignore this warning, we do not found the funding and the time to go through the certification process.+While you are downloading the file you might get some warning from your web browser that the software is not certified by Microsoft. Please ignore this warning, as we neither had the funding nor the time to go through the certification process.
  
  
Line 54: Line 54:
 into one  and the same directory). into one  and the same directory).
  
-After extraction of the zip-file, the following files, among others, are present in the installation+After extraction of the zip-file, the following files, amongst others, are present in the installation
 directory: directory:
  
Line 67: Line 67:
 distribution, legal notices and other information. Please read it carefully. If you distribution, legal notices and other information. Please read it carefully. If you
 have trouble with the installation procedure described in this manual, please consult have trouble with the installation procedure described in this manual, please consult
-the file `INSTALL` a solution.+the file `INSTALL` for a solution.
  
 `plugins` `plugins`
Line 91: Line 91:
 === Increasing heap space on Linux === === Increasing heap space on Linux ===
  
-If you want to start GroIMP with additional heap space you can do so from command line:+If you want to start GroIMP with additional heap space you can do so from the command line:
  
 <code> <code>
Line 100: Line 100:
  
 As a java software it is possible to execute GroIMP on any system that can run a java virtual machine of version 21. This includes almost any version of Linux as well as some other systems.  As a java software it is possible to execute GroIMP on any system that can run a java virtual machine of version 21. This includes almost any version of Linux as well as some other systems. 
-For this case we provide archive with the compiled jar on the gitlab release page.  +For this case we provide an archive with the compiled jar on the Gitlab release page.  
-This can then be execute with java -jar core.jar+This can then be executed with java -jar core.jar
  
 ===== Running GroIMP ===== ===== Running GroIMP =====
Line 109: Line 109:
 === From a Shortcut === === From a Shortcut ===
  
-You can set up your desktop to show a menu entry for GroIMP. How this is done depends on your system. Usually your system provides a menu editor where you can create a new menu entry and specifiy the command to be executed when the entry is activated. Choose the command as you would do on command line.+You can set up your desktop to show a menu entry for GroIMP. How this is done depends on your system. Usually your system provides a menu editor where you can create a new menu entry and specifiy the command to be executed when the entry is activated. Choose the command as you would do on the command line.
  
 === From the Command Line === === From the Command Line ===
Line 144: Line 144:
 ==== Windows: GroIMP doesn't start ==== ==== Windows: GroIMP doesn't start ====
  
-Even if you installed the right version of java it can happen that the GroIMP installer is picking an wrong one from your system. {{ :tutorials:copy.png?100|}}  +Even if you have installed the right version of java it can happen that the GroIMP installer is picking wrong version of Java from your system. {{ :tutorials:copy.png?100|}}  
-In this case you have to edit the short cut to enter the right path: +In this case you have to edit the shortcut to enter the right path: 
-1. Find java 21 on your computer (most likely some where in "C:\Program Files" +1. Find java 21 on your computer (most likely somewhere in "C:\Program Files" 
-2. Right click on the the GroIMP desktop short cut and select properties (see image on the right)  +2. Right click on the the GroIMP desktop shortcut and select Properties (see image on the right)  
-3. In the preference find the filed target (see image below)  +3. In the Properties find the filled target (see image below)  
-4. change the first path to the javaw.exe of java 21.+4. Change the first path to the javaw.exe of java 21.
 {{ :tutorials:prefrences.png?200 |}}  {{ :tutorials:prefrences.png?200 |}} 
  
  
-==== GroIMP is to small / to large ====+==== GroIMP is too small / too large ====
  
-On modern screen java swing application sometimes struggle with the scaling making the font and the buttons way to small. To fix this you can just manually scale it with the following [[#java_parameters | java parameter]]:+On modern screens Java swing applications sometimes struggle with the scaling making the font and the buttons way too small. To fix this you can just manually scale it with the following [[#java_parameters | java parameter]]:
  
 <code> <code>
Line 161: Line 161:
 </code> </code>
  
-In stead of 2.5 you can place what ever scale fits for your screen, maybe you will have to try this out a few times.+Instead of 2.5 you can use whatever scale fits for your screen, you might have to try this out a few times.
  
-To apply this on windows please refer to ([[#windowsgroimp_doesn_t_start | Windows: GroIMP doesn't start ]] and to apply this on Debian/Ubuntu to [[#increasing_heap_space_on_Linux | Increasing heap space on Linux]].+To apply this on Windows please refer to ([[#windowsgroimp_doesn_t_start | Windows: GroIMP doesn't start ]] and to apply this on Debian/Ubuntu to [[#increasing_heap_space_on_Linux | Increasing heap space on Linux]].
  
  
Line 170: Line 170:
 ==== Java Parameters ==== ==== Java Parameters ====
  
-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+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 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** > **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. 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. +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 allocated memory again until it works. 
  
 ==== GroIMP Parameters ==== ==== GroIMP Parameters ====
  
-The command line also enables to provides parameters to GroIMP. These parameters need to be passed AFTER the //core.jar// file. E.g.+The command line also enables to send parameters to GroIMP. These parameters need to be passed AFTER the //core.jar// file. E.g.
  
 > **java -jar core.jar --project-tree** > **java -jar core.jar --project-tree**
Line 192: Line 192:
 GroIMP can also be started //headless//, from //CLI//, or //API//. GroIMP can also be started //headless//, from //CLI//, or //API//.
  
-To define which interface is usedwhen starting GroIMP you need to pass the parameter //-a//. E.g.+To define which interface is used when starting GroIMP you need to pass the parameter //-a//. E.g.
  
  > **java -jar core.jar -a api**  > **java -jar core.jar -a api**
Line 204: Line 204:
 Installation of Plugins for the Java Image I/O Framework. 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 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 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 as 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 ==== ==== GroIMP Plugins ====
  
-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. +GroIMP is developed around a plugin architecture. New plugins can easily be added to your GroIMP installation by simply adding them to the loading directory of GroIMP. 
  
 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/ 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/
user-manual/ch01.1748678104.txt.gz · Last modified: 2025/05/31 09:55 by tim2