Index of Section 5 Manual Pages
| Interix / SUA | gimprc.5 | Interix / SUA |
GIMPRC(5) GIMPRC(5)
NAME
gimprc - gimp configuration file
DESCRIPTION
The gimprc file is a configuation file read by the GIMP
when it starts up. There are two of these: one system-
wide one stored in ${prefix}/etc/gimp/2.0/gimprc and a
per-user $HOME/.gimp-2.0/gimprc which may override system
settings.
Comments are introduced by a hash sign (#), and continue
until the end of the line. Blank lines are ignored.
The gimprc file associates values with properties. These
properties may be set by lisp-like assignments of the
form:
(property-name value)
where:
property-name
is one of the property names described below.
value is the value the property is to be set to.
Either spaces or tabs may be used to separate the name
from the value.
PROPERTIES
Valid properties and their default values are:
(temp-path "${gimp_dir}/tmp")
Sets the temporary storage directory. Files will
appear here during the course of running the GIMP.
Most files will disappear when the GIMP exits, but
some files are likely to remain, so it is best if
this directory not be one that is shared by other
users. This is a single folder.
(swap-path "${gimp_dir}")
Sets the swap file location. The gimp uses a tile
based memory allocation scheme. The swap file is
used to quickly and easily swap tiles out to disk
and back in. Be aware that the swap file can easily
get very large if the GIMP is used with large
images. Also, things can get horribly slow if the
swap file is created on a directory that is mounted
over NFS. For these reasons, it may be desirable
to put your swap file in "/tmp". This is a single
folder.
(stingy-memory-use no)
There is always a tradeoff between memory usage and
speed. In most cases, the GIMP opts for speed over
memory. However, if memory is a big issue, try to
enable this setting. Possible values are yes and
no.
(num-processors 1)
On multiprocessor machines, if GIMP has been com-
piled with --enable-mp this sets how many proces-
sors GIMP should use simultaneously. This is an
integer value.
(tile-cache-size 64M)
The tile cache is used to make sure the GIMP
doesn't thrash tiles between memory and disk. Set-
ting this value higher will cause the GIMP to use
less swap space, but will also cause the GIMP to
use more memory. Conversely, a smaller cache size
causes the GIMP to use more swap space and less
memory. The integer size can contain a suffix of
'B', 'K', 'M' or 'G' which makes GIMP interpret the
size as being specified in bytes, kilobytes,
megabytes or gigabytes. If no suffix is specified
the size defaults to being specified in kilobytes.
(interpolation-type linear)
Sets the level of interpolation used for scaling
and other transformations. Possible values are
none, linear and cubic.
(plug-in-path "${gimp_dir}/plug-
ins:${gimp_plug_in_dir}/plug-ins")
Sets the plug-in search path. This is a colon-sep-
arated list of folders to search.
(module-path "${gimp_dir}/modules:${gimp_plug_in_dir}/mod-
ules")
Sets the module search path. This is a colon-sepa-
rated list of folders to search.
(environ-path "${gimp_dir}/envi-
ron:${gimp_plug_in_dir}/environ")
Sets the environ search path. This is a colon-sep-
arated list of folders to search.
(brush-path
"${gimp_dir}/brushes:${gimp_data_dir}/brushes")
Sets the brush search path. This is a colon-sepa-
rated list of folders to search.
(brush-path-writable "${gimp_dir}/brushes")
This is a colon-separated list of folders to
search.
(pattern-path "${gimp_dir}/patterns:${gimp_data_dir}/pat-
terns")
Sets the pattern search path. This is a colon-sep-
arated list of folders to search.
(pattern-path-writable "${gimp_dir}/patterns")
This is a colon-separated list of folders to
search.
(palette-path
"${gimp_dir}/palettes:${gimp_data_dir}/palettes")
Sets the palette search path. This is a colon-sep-
arated list of folders to search.
(palette-path-writable "${gimp_dir}/palettes")
This is a colon-separated list of folders to
search.
(gradient-path "${gimp_dir}/gradi-
ents:${gimp_data_dir}/gradients")
Sets the gradient search path. This is a colon-
separated list of folders to search.
(gradient-path-writable "${gimp_dir}/gradients")
This is a colon-separated list of folders to
search.
(font-path "${gimp_dir}/fonts:${gimp_data_dir}/fonts")
Where to look for fonts. This is a colon-separated
list of folders to search.
(font-path-writable "${gimp_dir}/fonts")
This is a colon-separated list of folders to
search.
(default-brush "Circle (11)")
Specify a default brush. The brush is searched for
in the specified brush path. This is a string
value.
(default-pattern "Pine")
Specify a default pattern. The pattern is searched
for in the specified pattern path. This is a
string value.
(default-palette "Default")
Specify a default palette. The palette is searched
for in the specified palette path. This is a
string value.
(default-gradient "FG to BG (RGB)")
Specify a default gradient. The gradient is
searched for in the specified gradient path. This
is a string value.
(default-font "Sans")
Specify a default font. The font is searched for
in the fontconfig font path.
This is a string value.
(global-brush yes)
When enabled, the selected brush will be used for
all tools. Possible values are yes and no.
(global-pattern yes)
When enabled, the selected pattern will be used for
all tools. Possible values are yes and no.
(global-palette yes)
When enabled, the selected palette will be used for
all tools. Possible values are yes and no.
(global-gradient yes)
When enabled, the selected gradient will be used
for all tools. Possible values are yes and no.
(global-font yes)
When enabled, the selected font will be used for
all tools. Possible values are yes and no.
(default-image
(width 256)
(height 256)
(unit inches)
(xresolution 72.000000)
(yresolution 72.000000)
(resolution-unit inches)
(image-type rgb)
(fill-type background-fill)
(comment "Created with The GIMP"))
Sets the default image in the "File/New" dialog.
This is a parameter list.
(default-grid
(style intersections)
(fgcolor (color-rgba 0.000000 0.000000 0.000000
1.000000))
(bgcolor (color-rgba 1.000000 1.000000 1.000000
1.000000))
(xspacing 10.000000)
(yspacing 10.000000)
(spacing-unit inches)
(xoffset 0.000000)
(yoffset 0.000000)
(offset-unit inches))
Specify a default image grid. This is a parameter
list.
(undo-levels 5)
Sets the minimal number of operations that can be
undone. More undo levels are kept available until
the undo-size limit is reached. This is an integer
value.
(undo-size 4M)
Sets an upper limit to the memory that is used per
image to keep operations on the undo stack. Regard-
less of this setting, at least as many undo-levels
as configured can be undone. The integer size can
contain a suffix of 'B', 'K', kilobytes, megabytes
or gigabytes. If no suffix is specified the size
defaults to being specified in kilobytes.
(undo-preview-size large)
Sets the size of the previews in the Undo History.
Possible values are tiny, extra-small, small,
medium, large, extra-large, huge, enormous and
gigantic.
(pluginrc-path "${gimp_dir}/pluginrc")
Sets the pluginrc search path. This is a single
filename.
(layer-previews yes)
Sets whether GIMP should create previews of layers
and channels. Previews in the layers and channels
dialog are nice to have but they can slow things
down when working with large images. Possible val-
ues are yes and no.
(layer-preview-size medium)
Sets the default preview size for layers and
channels. Possible values are tiny, extra-small,
small, medium, large, extra-large, huge, enormous
and gigantic.
(thumbnail-size normal)
Sets the size of the thumbnail saved with each
image. Note that GIMP can not save thumbnails if
layer previews are disabled. Possible values are
none, normal and large.
(install-colormap no)
Install a private colormap; might be useful on
pseudocolor visuals. Possible values are yes and
no.
(min-colors 144)
Generally only a concern for 8-bit displays, this
sets the minimum number of system colors allocated
for the GIMP. This is an integer value.
(marching-ants-speed 300)
Speed of marching ants in the selection outline.
This value is in milliseconds (less time indicates
faster marching). This is an integer value.
(resize-windows-on-zoom no)
When enabled, the image window will automatically
resize itself, when zooming into and out of images.
Possible values are yes and no.
(resize-windows-on-resize no)
When enabled, the image window will automatically
resize itself, whenever the physical image size
changes. Possible values are yes and no.
(default-dot-for-dot yes)
When enabled, this will ensure that each pixel of
an image gets mapped to a pixel on the screen.
Possible values are yes and no.
(initial-zoom-to-fit yes)
When enabled, this will ensure that the full image
is visible after a file is opened, otherwise it
will be displayed with a scale of 1:1. Possible
values are yes and no.
(perfect-mouse yes)
When enabled, the X server is queried for the
mouse's current position on each motion event,
rather than relying on the position hint. This
means painting with large brushes should be more
accurate, but it may be slower. Perversely, on
some X servers enabling this option results in
faster painting. Possible values are yes and no.
(cursor-mode tool-icon)
Sets the mode of cursor the GIMP will use. Possi-
ble values are tool-icon, tool-crosshair and
crosshair.
(cursor-updating yes)
Context-dependent cursors are cool. They are
enabled by default. However, they require overhead
that you may want to do without. Possible values
are yes and no.
(show-brush-outline yes)
When enabled, all paint tools will show a preview
of the current brush's outline. Possible values
are yes and no.
(image-title-format "%D*%f-%p.%i (%t, %L) %z%%")
Sets the text to appear in image window titles.
This is a format string; certain % character
sequences are recognised and expanded as follows:
%% literal percent sign
%f bare filename, or "Untitled"
%F full path to file, or "Untitled"
%p PDB image id
%i view instance number
%t image type (RGB, grayscale, indexed)
%z zoom factor as a percentage
%s source scale factor
%d destination scale factor
%Dx expands to x if the image is dirty, the empty
string otherwise
%Cx expands to x if the image is clean, the empty
string otherwise
%l the number of layers
%L the number of layers (long form)
%m memory used by the image
%n the name of the active layer/channel
%P the PDB id of the active layer/channel
%w image width in pixels
%W image width in real-world units
%h image height in pixels
%H image height in real-world units
%u unit symbol
%U unit abbreviation
(image-status-format "%n (%m)")
Sets the text to appear in image window status
bars. This is a format string; certain % character
sequences are recognised and expanded as follows:
%% literal percent sign
%f bare filename, or "Untitled"
%F full path to file, or "Untitled"
%p PDB image id
%i view instance number
%t image type (RGB, grayscale, indexed)
%z zoom factor as a percentage
%s source scale factor
%d destination scale factor
%Dx expands to x if the image is dirty, the empty
string otherwise
%Cx expands to x if the image is clean, the empty
string otherwise
%l the number of layers
%L the number of layers (long form)
%m memory used by the image
%n the name of the active layer/channel
%P the PDB id of the active layer/channel
%w image width in pixels
%W image width in real-world units
%h image height in pixels
%H image height in real-world units
%u unit symbol
%U unit abbreviation
(confirm-on-close yes)
Ask for confirmation before closing an image with-
out saving. Possible values are yes and no.
(monitor-xresolution 72.000000)
Sets the monitor's horizontal resolution, in dots
per inch. If set to 0, forces the X server to be
queried for both horizontal and vertical resolution
information. This is a float value.
(monitor-yresolution 72.000000)
Sets the monitor's vertical resolution, in dots per
inch. If set to 0, forces the X server to be
queried for both horizontal and vertical resolution
information. This is a float value.
(monitor-resolution-from-windowing-system yes)
When enabled, the GIMP will use the monitor resolu-
tion from the windowing system. Possible values
are yes and no.
(navigation-preview-size medium)
Sets the size of the navigation preview available
in the lower right corner of the image window.
Possible values are tiny, extra-small, small,
medium, large, extra-large, huge, enormous and
gigantic.
(default-view
(show-menubar yes)
(show-rulers yes)
(show-scrollbars yes)
(show-statusbar yes)
(show-selection yes)
(show-layer-boundary yes)
(show-guides yes)
(show-grid no)
(padding-mode default)
(padding-color (color-rgba 1.000000 1.000000
1.000000 1.000000)))
Sets the default settings for the image view. This
is a parameter list.
(default-fullscreen-view
(show-menubar no)
(show-rulers no)
(show-scrollbars no)
(show-statusbar no)
(show-selection no)
(show-layer-boundary no)
(show-guides no)
(show-grid no)
(padding-mode custom)
(padding-color (color-rgba 0.000000 0.000000
0.000000 1.000000)))
Sets the default settings used when an image is
viewed in fullscreen mode. This is a parameter
list.
(activate-on-focus yes)
When enabled, an image will become the active image
when its image window receives the focus. This is
useful for window managers using "click to focus".
Possible values are yes and no.
(transparency-size medium-checks)
Sets the size of the checkerboard used to display
transparency. Possible values are small-checks,
medium-checks and large-checks.
(transparency-type gray-checks)
Sets the manner in which transparency is displayed
in images. Possible values are light-checks, gray-
checks, dark-checks, white-only, gray-only and
black-only.
(snap-distance 8)
This is the distance in pixels where Guide and Grid
snapping activates. This is an integer value.
(default-threshold 15)
Tools such as fuzzy-select and bucket fill find
regions based on a seed-fill algorithm. The seed
fill starts at the intially selected pixel and pro-
gresses in all directions until the difference of
pixel intensity from the original is greater than a
specified threshold. This value represents the
default threshold. This is an integer value.
(info-window-per-display no)
When enabled, the GIMP will use a different info
window per image view. Possible values are yes and
no.
(trust-dirty-flag no)
When enabled, the GIMP will not save if the image
is unchanged since opening it. Possible values are
yes and no.
(save-device-status no)
Remember the current tool, pattern, color, and
brush across GIMP sessions. Possible values are
yes and no.
(save-session-info yes)
Save the positions and sizes of the main dialogs
when the GIMP exits. Possible values are yes and
no.
(restore-session yes)
Let GIMP try to restore your last saved session on
each startup. Possible values are yes and no.
(show-tips yes)
Enable to display a handy GIMP tip on startup.
Possible values are yes and no.
(show-tool-tips yes)
Enable to display tooltips. Possible values are
yes and no.
(tearoff-menus yes)
When enabled, menus can be torn off. Possible val-
ues are yes and no.
(can-change-accels no)
When enabled, you can change keyboard shortcuts for
menu items by hitting a key combination while the
menu item is highlighted. Possible values are yes
and no.
(save-accels yes)
Save changed keyboard shortcuts when the GIMP
exits. Possible values are yes and no.
(restore-accels yes)
Restore saved keyboard shortcuts on each GIMP
startup. Possible values are yes and no.
(last-opened-size 10)
How many recently opened image filenames to keep on
the File menu. This is an integer value.
(max-new-image-size 64M)
GIMP will warn the user if an attempt is made to
create an image that would take more memory than
the size specified here. The integer size can con-
tain a suffix of 'B', 'K', 'M' or 'G' which makes
GIMP interpret the size as being specified in
bytes, kilobytes, megabytes or gigabytes. If no
suffix is specified the size defaults to being
specified in kilobytes.
(theme-path "${gimp_dir}/themes:${gimp_data_dir}/themes")
Sets the theme search path. This is a colon-sepa-
rated list of folders to search.
(theme "Default")
The name of the theme to use. This is a string
value.
(use-help yes)
When enabled, pressing F1 will open the help
browser. Possible values are yes and no.
Specifies the language preferences used by the help sys-
tem. This is
acolon-separated list of language identifiers with
decreasing priority. If empty, the language is
taken from the user's locale setting. This is a
string value.
(help-browser gimp)
Sets the browser used by the help system. Possible
values are gimp and web-browser.
(web-browser "mozilla %s")
Sets the external web browser to be used. This can
be an absolute path or the name of an executable to
search for in the user's PATH. If the command con-
tains '%s' it will be replaced with the URL, else
the URL will be appended to the command with a
space separating the two. This is a single file-
name.
(toolbox-window-hint normal)
The window type hint that is set on the toolbox.
This may affect how your window manager decorates
and handles the toolbox window. Possible values
are normal and utility.
(dock-window-hint normal)
The window type hint that is set on dock windows.
This may affect the way your window manager deco-
rates and handles dock windows. Possible values
are normal and utility.
(fractalexplorer-path "${gimp_dir}/fractalex-
plorer:${gimp_data_dir}/fractalexplorer")
Where to search for fractals used by the Fractal
Explorer plug-in. This is a colon-separated list
of folders to search.
(gfig-path "${gimp_dir}/gfig:${gimp_data_dir}/gfig")
Where to search for Gfig figures used by the Gfig
plug-in. This is a colon-separated list of folders
to search.
(gflare-path "${gimp_dir}/gflare:${gimp_data_dir}/gflare")
Where to search for gflares used by the GFlare
plug-in. This is a colon-separated list of folders
to search.
(gimpressionist-path "${gimp_dir}/gimpression-
ist:${gimp_data_dir}/gimpressionist")
Where to search for data used by the Gimpressionist
plug-in. This is a colon-separated list of folders
to search.
(script-fu-path
"${gimp_dir}/scripts:${gimp_data_dir}/scripts")
This path will be searched for scripts when the
Script-Fu plug-in is run. This is a colon-sepa-
rated list of folders to search.
PATH EXPANSION
Strings of type PATH are expanded in a manner similar to
bash(1). Specifically: tilde (~) is expanded to the
user's home directory. Note that the bash feature of being
able to refer to other user's home directories by writing
~userid/ is not valid in this file.
${variable} is expanded to the current value of an envi-
ronment variable. There are a few variables that are pre-
defined:
gimp_dir
The personal gimp directory which is set to the
value of the environment variable GIMP2_DIRECTORY
or to ~/.gimp-2.0.
gimp_data_dir
Nase for paths to shareable data, which is set to
the value of the environment variable GIMP2_DATADIR
or to the compiled-in default value ${pre-
fix}/share/gimp/2.0.
gimp_plug_in_dir
Base to paths for architecture-specific plugins and
modules, which is set to the value of the environ-
ment variable GIMP2_PLUGINDIR or to the compiled-in
default value ${exec_prefix}/lib/gimp/2.0.
gimp_sysconf_dir
Path to configuration files, which is set to the
value of the environment variable GIMP2_SYSCONFDIR
or to the compiled-in default value ${pre-
fix}/etc/gimp/2.0.
FILES
${prefix}/etc/gimp/2.0/gimprc
System-wide configuration file
$HOME/.gimp-2.0/gimprc
Per-user configuration file
SEE ALSO
gimp(1), gimptool(1), gimp-remote(1)
GIMP Manual Pages Version 2.0.0 GIMPRC(5)