gimp/docs/gimprc.5.in

.\" This man-page is auto-generated by gimpconfig-dump.

.TH GIMPRC 5 "Version @GIMP_VERSION@" "GIMP Manual Pages"
.SH NAME
gimprc \- gimp configuration file
.SH DESCRIPTION
The
.B 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
@gimpsysconfdir@/gimprc and a per-user \fB$HOME\fP/@gimpdir@/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
.B gimprc
file associates values with properties.  These properties may be set
by lisp-like assignments of the form:
.IP
\f3(\f2property-name\ value\f3)\f1
.TP
where:
.TP 10
.I property-name
is one of the property names described below.
.TP
.I value
is the value the property is to be set to.
.PP

Either spaces or tabs may be used to separate the name from the value.
.PP
.SH PROPERTIES
Valid properties and their default values are:

.TP
(temp-path "${gimp_dir}/tmp")

Set 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, such as working palette files, so it is best if
this directory not be one that is shared by other users or is cleared on
machine reboot such as /tmp.  This is a single folder.

.TP
(swap-path "${gimp_dir}")

Set 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.

.TP
(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, set
stingy-memory-use.  Possible values are yes and no.

.TP
(num-processors 1)

On multiprocessor machines, if GIMP has been compiled with --enable-mp this
sets how many processors GIMP should use simultaneously.  This is an integer
value.

.TP
(tile-cache-size 32M)

The tile cache is used to make sure the gimp doesn't thrash tiles between
memory and disk. Setting 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.

.TP
(interpolation-type linear)

Set the level of interpolation used for scaling and other transformations. 
Possible values are none, linear and cubic.

.TP
(plug-in-path "${gimp_dir}/plug-ins:${gimp_plug_in_dir}/plug-ins")

Set the plug-in search path.  This is a colon-separated list of folders to
search.

.TP
(tool-plug-in-path "${gimp_dir}/tool-plug-ins:${gimp_plug_in_dir}/tool-plug-ins")

The tool-plug-in-path property has no description.  This is a colon-separated
list of folders to search.

.TP
(module-path "${gimp_dir}/modules:${gimp_plug_in_dir}/modules")

Set the module search path.  This is a colon-separated list of folders to
search.

.TP
(environ-path "${gimp_dir}/environ:${gimp_plug_in_dir}/environ")

The environ-path property has no description.  This is a colon-separated list
of folders to search.

.TP
(brush-path "${gimp_dir}/brushes:${gimp_data_dir}/brushes")

Set the brush search path.  This is a colon-separated list of folders to
search.

.TP
(pattern-path "${gimp_dir}/patterns:${gimp_data_dir}/patterns")

Set the pattern search path.  This is a colon-separated list of folders to
search.

.TP
(palette-path "${gimp_dir}/palettes:${gimp_data_dir}/palettes")

Set the palette search path.  This is a colon-separated list of folders to
search.

.TP
(gradient-path "${gimp_dir}/gradients:${gimp_data_dir}/gradients")

Set the gradient search path.  This is a colon-separated list of folders to
search.

.TP
(default-comment "Created with The GIMP")

The default-comment property has no description.  This is a string value.

.TP
(default-image-type rgb)

Set the default image type in the File/New dialog.  Possible values are rgb,
gray and indexed.

.TP
(default-image-width 256)

Set the default image width in the File/New dialog.  This is an integer value.

.TP
(default-image-height 256)

Set the default image height in the File/New dialog.  This is an integer
value.

.TP
(default-unit inches)

Set the default unit for new images and for the File/New dialog. This units
will be used for coordinate display when not in dot-for-dot mode.  The unit
can be one inches, millimeters, points or picas plus those in your user units
database.

.TP
(default-xresolution 72.000000)

Set the default horizontal resolution for new images and for the File/New
dialog. This value is always in dpi (dots per inch).  This is a float value.

.TP
(default-yresolution 72.000000)

Set the default vertical resolution for new images and for the File/New
dialog. This value is always in dpi (dots per inch).  This is a float value.

.TP
(default-resolution-unit inches)

Set the units for the display of the default resolution in the File/New
dialog.  The unit can be one inches, millimeters, points or picas plus those
in your user units database.

.TP
(undo-levels 5)

Set the number of operations kept on the undo stack.  This is an integer
value.

.TP
(pluginrc-path "${gimp_dir}/pluginrc")

The pluginrc-path property has no description.  This is a single filename.

.TP
(preview-size small)

Set the default preview size.  Possible values are none, tiny, extra-small,
small, medium, large, extra-large, huge, enormous and gigantic.

.TP
(thumbnail-size normal)

The thumbnail-size property has no description.  Possible values are none,
normal and large.

.TP
(gamma-correction 1.000000)

This setting is ignored.  This is a float value.

.TP
(install-colormap no)

Install a private colormap; might be useful on pseudocolor visuals.  Possible
values are yes and no.

.TP
(min-colors 144)

The min-colors property has no description.  This is an integer value.

.TP
(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.

.TP
(colormap-cycling no)

Specify that marching ants for selected regions will be drawn with colormap
cycling as oposed to redrawing with different stipple masks. This color
cycling option works only with 8-bit displays.  Possible values are yes and
no.

.TP
(resize-windows-on-zoom no)

When zooming into and out of images, this option enables the automatic
resizing of windows.   Possible values are yes and no.

.TP
(resize-windows-on-resize no)

When the physical image size changes, this option enables the automatic
resizing of windows.  Possible values are yes and no.

.TP
(default-dot-for-dot yes)

The default-dot-for-dot property has no description.  Possible values are yes
and no.

.TP
(perfect-mouse no)

If set to true, 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 turning on this option results in faster
painting.  Possible values are yes and no.

.TP
(cursor-mode tool-icon)

The cursor-mode property has no description.  Possible values are tool-icon,
tool-crosshair and crosshair.

.TP
(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.

.TP
(image-title-format "%f-%p.%i (%t)")

Set the text to appear in image window titles.  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
%m  memory used by the image
%l  the number of layers
%L  the name 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

  This is a string value.

.TP
(image-status-format "%f-%p.%i (%t)")

Set the text to appear in image window status bars. See image-title-format for
the list of possible % sequences.  This is a string value.

.TP
(show-menubar no)

Set the menubar visibility. This can also be toggled with the View->Toggle
Menubar command.  Possible values are yes and no.

.TP
(show-rulers yes)

Set the ruler visibility. This can also be toggled with the View->Toggle
Rulers command.  Possible values are yes and no.

.TP
(show-statusbar yes)

Controlling statusbar visibility. This can also be toggled with the
View->Toggle Statusbar command.  Possible values are yes and no.

.TP
(confirm-on-close yes)

Ask for confirmation before closing an image without saving.  Possible values
are yes and no.

.TP
(monitor-xresolution 72.000000)

Set 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.

.TP
(monitor-yresolution 72.000000)

Set 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.

.TP
(monitor-resolution-from-windowing-system yes)

The monitor-resolution-from-windowing-system property has no description. 
Possible values are yes and no.

.TP
(navigation-preview-size medium)

The navigation-preview-size property has no description.  Possible values are
none, tiny, extra-small, small, medium, large, extra-large, huge, enormous and
gigantic.

.TP
(canvas-padding-mode default)

The canvas-padding-mode property has no description.  Possible values are
default, light-check, dark-check and custom.

.TP
(canvas-padding-color (color-rgba 1.000000 1.000000 1.000000 1.000000))

The canvas-padding-color property has no description.  The color is specified
in the form (color-rgba red green blue alpha) with channel values as floats
between 0.0 and 1.0.

.TP
(transparency-size medium-checks)

Sets the size of the checkerboard used to display transparency.  Possible
values are small-checks, medium-checks and large-checks.

.TP
(transparency-type gray-checks)

Set 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.

.TP
(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 progresses
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.

.TP
(info-window-per-display no)

The info-window-per-display property has no description.  Possible values are
yes and no.

.TP
(trust-dirty-flag no)

The trust-dirty-flag property has no description.  Possible values are yes and
no.

.TP
(save-device-status no)

Remember the current tool, pattern, color, and brush across GIMP sessions. 
Possible values are yes and no.

.TP
(save-session-info yes)

Remember the positions and sizes of the main dialogs and asks your
window-manager to place them there again the next time you use the GIMP. 
Possible values are yes and no.

.TP
(restore-session yes)

The restore-session property has no description.  Possible values are yes and
no.

.TP
(show-tips yes)

Set to display a handy GIMP tip on startup.  Possible values are yes and no.

.TP
(show-tool-tips yes)

Set to display tooltips.  Possible values are yes and no.

.TP
(tearoff-menus yes)

The tearoff-menus property has no description.  Possible values are yes and
no.

.TP
(last-opened-size 4)

How many recently opened image filenames to keep on the File menu.  This is an
integer value.

.TP
(max-new-image-size 32M)

The max-new-image-size property has no description.  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.

.TP
(theme-path "${gimp_dir}/themes:${gimp_data_dir}/themes")

The theme-path property has no description.  This is a colon-separated list of
folders to search.

.TP
(use-help yes)

The use-help property has no description.  Possible values are yes and no.

.TP
(help-browser gimp)

The help-browser property has no description.  Possible values are gimp and
netscape.

.TP
(fractalexplorer-path "${gimp_dir}/fractalexplorer:${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.

.TP
(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.

.TP
(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.

.TP
(gimpressionist-path "${gimp_dir}/gimpressionist:${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.

.TP
(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-separated list of folders to search.

.PP
.SH PATH EXPANSION
Strings of type PATH are expanded in a manner similar to
.BR 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 environment variable.
There are a few variables that are pre-defined:
.TP
.I gimp_dir
The personal gimp directory which is set to the value of the environment
variable GIMP_DIRECTORY or to ~/@gimpdir@.
.TP
.I gimp_data_dir
Nase for paths to shareable data, which is set to the value of the
environment variable GIMP_DATADIR or to the compiled-in default value
@gimpdatadir@.
.TP
.I gimp_plug_in_dir
Base to paths for architecture-specific plugins and modules, which is set
to the value of the environment variable GIMP_PLUGINDIR or to the
compiled-in default value @gimpplugindir@.
.TP
.I gimp_sysconf_dir
Path to configuration files, which is set to the value of the environment
variable GIMP_SYSCONFDIR or to the compiled-in default value 
@gimpsysconfdir@.

.SH FILES
.TP
.I @gimpsysconfdir@/gimprc
System-wide configuration file
.TP
.I \fB$HOME\fP/@gimpdir@/gimprc
Per-user configuration file

.SH "SEE ALSO"
.BR gimp (1),
.BR gimptool (1),
.BR gimp-remote (1)