gimprc.5.in 35.8 KB
Newer Older
Sven Neumann's avatar
Sven Neumann committed
1
.\" This man-page is auto-generated by gimp --dump-gimprc-manpage.
2

3
.TH GIMPRC 5 "Version @GIMP_VERSION@" "GIMP Manual Pages"
4 5 6 7 8
.SH NAME
gimprc \- gimp configuration file
.SH DESCRIPTION
The
.B gimprc
9
file is a configuration file read by GIMP when it starts up.  There
10
are two of these: one system-wide one stored in
11
@gimpsysconfdir@/gimprc and a per-user @manpage_gimpdir@/gimprc
12 13 14 15 16 17 18 19
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
20
by lisp-like assignments of the form:
21
.IP
Sven Neumann's avatar
Sven Neumann committed
22
\f3(\f2property\-name\ value\f3)\f1
23 24 25
.TP
where:
.TP 10
Sven Neumann's avatar
Sven Neumann committed
26
.I property\-name
27 28 29 30 31 32 33 34 35 36 37 38 39 40
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")

41
Sets the folder for temporary storage. Files will appear here during the
42 43 44
course of running GIMP.  Most files will disappear when GIMP exits, but some
files are likely to remain, so it is best if this folder not be one that is
shared by other users.  This is a single folder.
45 46 47 48

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

Sven Neumann's avatar
Sven Neumann committed
49 50
Sets the swap file location. GIMP uses a tile based memory allocation scheme.
The swap file is used to quickly and easily swap tiles out to disk and back
Sven Neumann's avatar
Sven Neumann committed
51
in. Be aware that the swap file can easily get very large if GIMP is used with
Sven Neumann's avatar
Sven Neumann committed
52
large images. Also, things can get horribly slow if the swap file is created
53 54
on a folder that is mounted over NFS.  For these reasons, it may be desirable
to put your swap file in "/tmp".  This is a single folder.
55 56

.TP
57
(num-processors 1)
58

59 60
Sets how many threads GIMP should use for operations that support it.  This is
an integer value.
61 62

.TP
63
(tile-cache-size 2g)
64

65 66 67 68 69 70 71
When the amount of pixel data exceeds this limit, GIMP will start to swap
tiles to disk.  This is a lot slower but it makes it possible to work on
images that wouldn't fit into memory otherwise.  If you have a lot of RAM, you
may want to set this to a higher value.  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.
72

73
.TP
74
(use-opencl no)
75 76 77 78

When enabled, uses OpenCL for some operations.  Possible values are yes and
no.

Martin Nordholts's avatar
Martin Nordholts committed
79 80 81 82
.TP

Specifies the language to use for the user interface.  This is a string value.

83
.TP
84
(interpolation-type cubic)
85

86
Sets the level of interpolation used for scaling and other transformations. 
87
Possible values are none, linear, cubic, nohalo and lohalo.
88

Martin Nordholts's avatar
Martin Nordholts committed
89 90 91 92 93 94 95 96 97
.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 initially 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.

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

101
Sets the plug-in search path.  This is a colon-separated list of folders to
102 103 104 105 106
search.

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

107
Sets the module search path.  This is a colon-separated list of folders to
108 109
search.

110 111 112 113 114 115
.TP
(interpreter-path "${gimp_dir}/interpreters:${gimp_plug_in_dir}/interpreters")

Sets the interpreter search path.  This is a colon-separated list of folders
to search.

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

119 120
Sets the environ search path.  This is a colon-separated list of folders to
search.
121 122 123 124

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

125
Sets the brush search path.  This is a colon-separated list of folders to
126 127
search.

Sven Neumann's avatar
Sven Neumann committed
128 129 130
.TP
(brush-path-writable "${gimp_dir}/brushes")

Martin Nordholts's avatar
Martin Nordholts committed
131
This is a colon-separated list of folders to search.
Sven Neumann's avatar
Sven Neumann committed
132

Martin Nordholts's avatar
Martin Nordholts committed
133 134 135 136 137 138 139 140 141 142 143
.TP
(dynamics-path "${gimp_dir}/dynamics:${gimp_data_dir}/dynamics")

Sets the dynamics search path.  This is a colon-separated list of folders to
search.

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

This is a colon-separated list of folders to search.

144
.TP
145
(mypaint-brush-path "@mypaint_brushes_dir@:~/.mypaint/brushes")
146 147 148 149 150 151 152 153 154

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

.TP
(mypaint-brush-path-writable "~/.mypaint/brushes")

This is a colon-separated list of folders to search.

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

158
Sets the pattern search path.  This is a colon-separated list of folders to
159 160
search.

Sven Neumann's avatar
Sven Neumann committed
161 162 163
.TP
(pattern-path-writable "${gimp_dir}/patterns")

Martin Nordholts's avatar
Martin Nordholts committed
164
This is a colon-separated list of folders to search.
Sven Neumann's avatar
Sven Neumann committed
165

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

169
Sets the palette search path.  This is a colon-separated list of folders to
170 171
search.

Sven Neumann's avatar
Sven Neumann committed
172 173 174
.TP
(palette-path-writable "${gimp_dir}/palettes")

Martin Nordholts's avatar
Martin Nordholts committed
175
This is a colon-separated list of folders to search.
Sven Neumann's avatar
Sven Neumann committed
176

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

180
Sets the gradient search path.  This is a colon-separated list of folders to
181 182
search.

Sven Neumann's avatar
Sven Neumann committed
183 184 185
.TP
(gradient-path-writable "${gimp_dir}/gradients")

Martin Nordholts's avatar
Martin Nordholts committed
186
This is a colon-separated list of folders to search.
Sven Neumann's avatar
Sven Neumann committed
187

Martin Nordholts's avatar
Martin Nordholts committed
188 189 190 191 192 193 194 195 196 197 198
.TP
(tool-preset-path "${gimp_dir}/tool-presets:${gimp_data_dir}/tool-presets")

Sets the dynamics search path.  This is a colon-separated list of folders to
search.

.TP
(tool-preset-path-writable "${gimp_dir}/tool-presets")

This is a colon-separated list of folders to search.

Sven Neumann's avatar
Sven Neumann committed
199 200 201
.TP
(font-path "${gimp_dir}/fonts:${gimp_data_dir}/fonts")

202 203
Where to look for fonts in addition to the system-wide installed fonts.  This
is a colon-separated list of folders to search.
Sven Neumann's avatar
Sven Neumann committed
204

205
.TP
206
(default-brush "2. Hardness 050")
207 208 209 210

Specify a default brush.  The brush is searched for in the specified brush
path.  This is a string value.

Martin Nordholts's avatar
Martin Nordholts committed
211
.TP
Martin Nordholts's avatar
Martin Nordholts committed
212
(default-dynamics "Dynamics Off")
Martin Nordholts's avatar
Martin Nordholts committed
213 214 215 216

Specify a default dynamics.  The dynamics is searched for in the specified
dynamics path.  This is a string value.

217 218 219 220 221
.TP
(default-mypaint-brush "Fixme")

Specify a default MyPaint brush.  This is a string value.

222 223 224
.TP
(default-pattern "Pine")

225
Specify a default pattern.  This is a string value.
226 227 228 229

.TP
(default-palette "Default")

230
Specify a default palette.  This is a string value.
231 232 233 234

.TP
(default-gradient "FG to BG (RGB)")

235
Specify a default gradient.  This is a string value.
236

Martin Nordholts's avatar
Martin Nordholts committed
237 238 239 240 241 242
.TP
(default-tool-preset "Current Options")

Specify a default tool preset.  The tool preset is searched for in the
specified tool prests path.  This is a string value.

243
.TP
244
(default-font "Sans-serif")
245

246
Specify a default font.  This is a string value.
247

Sven Neumann's avatar
Sven Neumann committed
248 249 250 251 252 253
.TP
(global-brush yes)

When enabled, the selected brush will be used for all tools.  Possible values
are yes and no.

Martin Nordholts's avatar
Martin Nordholts committed
254 255 256 257 258 259
.TP
(global-dynamics yes)

When enabled, the selected dynamics will be used for all tools.  Possible
values are yes and no.

Sven Neumann's avatar
Sven Neumann committed
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
.TP
(global-pattern yes)

When enabled, the selected pattern will be used for all tools.  Possible
values are yes and no.

.TP
(global-palette yes)

When enabled, the selected palette will be used for all tools.  Possible
values are yes and no.

.TP
(global-gradient yes)

When enabled, the selected gradient will be used for all tools.  Possible
values are yes and no.

.TP
(global-font yes)

When enabled, the selected font will be used for all tools.  Possible values
are yes and no.

284
.TP
285
(default-image
286 287
    (width 2001)
    (height 1984)
288
    (unit pixels)
289 290
    (xresolution 300.000000)
    (yresolution 300.000000)
291 292
    (resolution-unit inches)
    (image-type rgb)
293
    (precision u8-non-linear)
294
    (color-profile NULL)
295
    (fill-type background)
Sven Neumann's avatar
Sven Neumann committed
296
    (comment "Created with GIMP"))
297

298
Sets the default image in the "File/New" dialog.  This is a parameter list.
299 300

.TP
301
(default-grid
302
    (style solid)
303 304
    (fgcolor (color-rgba 0.000000 0.000000 0.000000 1.000000))
    (bgcolor (color-rgba 1.000000 1.000000 1.000000 1.000000))
305 306
    (xspacing 10.000000)
    (yspacing 10.000000)
307 308 309 310
    (spacing-unit inches)
    (xoffset 0.000000)
    (yoffset 0.000000)
    (offset-unit inches))
311

312
Specify a default image grid.  This is a parameter list.
313 314 315 316

.TP
(undo-levels 5)

Sven Neumann's avatar
Sven Neumann committed
317 318
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
319 320
value.

Sven Neumann's avatar
Sven Neumann committed
321
.TP
322
(undo-size 1g)
Sven Neumann's avatar
Sven Neumann committed
323

Sven Neumann's avatar
Sven Neumann committed
324
Sets an upper limit to the memory that is used per image to keep operations on
325 326
the undo stack. Regardless of this setting, at least as many undo-levels as
configured can be undone.  The integer size can contain a suffix of 'B', 'K',
327
\&'M' or 'G' which makes GIMP interpret the size as being specified in bytes,
328 329
kilobytes, megabytes or gigabytes. If no suffix is specified the size defaults
to being specified in kilobytes.
Sven Neumann's avatar
Sven Neumann committed
330

Sven Neumann's avatar
Sven Neumann committed
331 332 333 334 335 336
.TP
(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.

337 338 339
.TP
(plug-in-history-size 10)

340 341
How many recently used filters and plug-ins to keep on the Filters menu.  This
is an integer value.
342

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

346
Sets the pluginrc search path.  This is a single filename.
347 348

.TP
Sven Neumann's avatar
Sven Neumann committed
349 350 351 352 353 354
(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 values are yes and no.

355 356 357 358 359 360 361
.TP
(group-layer-previews yes)

Sets whether GIMP should create previews of layer groups. Layer group previews
are more expensive than ordinary layer previews.  Possible values are yes and
no.

Sven Neumann's avatar
Sven Neumann committed
362 363
.TP
(layer-preview-size medium)
364

Sven Neumann's avatar
Sven Neumann committed
365 366 367
Sets the preview size used for layers and channel previews in newly created
dialogs.  Possible values are tiny, extra-small, small, medium, large,
extra-large, huge, enormous and gigantic.
368 369 370 371

.TP
(thumbnail-size normal)

372
Sets the size of the thumbnail shown in the Open dialog.  Possible values are
Sven Neumann's avatar
Sven Neumann committed
373 374 375 376 377 378 379 380 381 382
none, normal and large.

.TP
(thumbnail-filesize-limit 4M)

The thumbnail in the Open dialog will be automatically updated if the file
being previewed is smaller than the size set here.  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.
383

384 385 386
.TP
(color-management
    (mode display)
387
    (display-profile-from-gdk no)
388 389
    (display-rendering-intent relative-colorimetric)
    (display-use-black-point-compensation yes)
390
    (display-optimize yes)
391
    (simulation-rendering-intent perceptual)
392
    (simulation-use-black-point-compensation no)
393
    (simulation-optimize yes)
394
    (simulation-gamut-check no)
395
    (out-of-gamut-color (color-rgb 1.000000 0.000000 1.000000)))
396 397 398

Defines the color management behavior.  This is a parameter list.

Sven Neumann's avatar
Sven Neumann committed
399 400 401
.TP
(save-document-history yes)

402 403
Keep a permanent record of all opened and saved files in the Recent Documents
list.  Possible values are yes and no.
Sven Neumann's avatar
Sven Neumann committed
404

405 406 407 408 409 410 411
.TP
(quick-mask-color (color-rgba 1.000000 0.000000 0.000000 0.500000))

Sets the default quick mask color.  The color is specified in the form
(color-rgba red green blue alpha) with channel values as floats in the range
of 0.0 to 1.0.

412 413 414 415 416 417 418 419 420 421
.TP
(import-promote-float no)

Promote imported images to floating point precision. Does not apply to indexed
images.  Possible values are yes and no.

.TP
(import-promote-dither yes)

When promoting imported images to floating point precision, also add minimal
422
noise in order to distribute color values a bit.  Possible values are yes and
423 424 425 426 427 428 429 430 431 432 433 434 435 436
no.

.TP
(import-add-alpha no)

Add an alpha channel to all layers of imported images.  Possible values are
yes and no.

.TP
(import-raw-plug-in "")

Which plug-in to use for importing raw digital camera files.  This is a single
filename.

437 438 439 440 441
.TP
(export-color-profile yes)

Export the image's color profile by default.  Possible values are yes and no.

442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457
.TP
(export-metadata-exif yes)

Export Exif metadata by default.  Possible values are yes and no.

.TP
(export-metadata-xmp yes)

Export XMP metadata by default.  Possible values are yes and no.

.TP
(export-metadata-iptc yes)

Export IPTC metadata by default.  Possible values are yes and no.

.TP
458
(debug-policy warning)
459 460 461 462

Try generating debug data for bug reporting when appropriate.  Possible values
are warning, critical, fatal and never.

Sven Neumann's avatar
Sven Neumann committed
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
.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)

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.

.TP
(snap-distance 8)

This is the distance in pixels where Guide and Grid snapping activates.  This
is an integer value.

482
.TP
483
(marching-ants-speed 200)
484 485 486 487 488 489 490

Speed of marching ants in the selection outline.  This value is in
milliseconds (less time indicates faster marching).  This is an integer value.

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

491
When enabled, the image window will automatically resize itself when zooming
492 493
into and out of images. This setting only takes effect in multi-window mode. 
Possible values are yes and no.
494 495 496 497

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

498
When enabled, the image window will automatically resize itself whenever the
499 500
physical image size changes. This setting only takes effect in multi-window
mode.  Possible values are yes and no.
501 502 503 504

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

Sven Neumann's avatar
Sven Neumann committed
505
When enabled, this will ensure that each pixel of an image gets mapped to a
506
pixel on the screen.  Possible values are yes and no.
507

Sven Neumann's avatar
Sven Neumann committed
508 509 510 511 512 513 514
.TP
(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.

515
.TP
516
(cursor-mode tool-crosshair)
517

Sven Neumann's avatar
Sven Neumann committed
518
Sets the type of mouse pointers to use.  Possible values are tool-icon,
519 520 521 522 523
tool-crosshair and crosshair.

.TP
(cursor-updating yes)

Sven Neumann's avatar
Sven Neumann committed
524 525 526
Context-dependent mouse pointers are helpful.  They are enabled by default. 
However, they require overhead that you may want to do without.  Possible
values are yes and no.
527

Sven Neumann's avatar
Sven Neumann committed
528 529 530 531 532 533
.TP
(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.

Sven Neumann's avatar
Sven Neumann committed
534 535 536
.TP
(show-paint-tool-cursor yes)

Sven Neumann's avatar
Sven Neumann committed
537 538
When enabled, the mouse pointer will be shown over the image while using a
paint tool.  Possible values are yes and no.
Sven Neumann's avatar
Sven Neumann committed
539

540
.TP
541
(image-title-format "%D*%f-%p.%i (%t, %o, %L) %wx%h")
542

543 544 545
Sets the text to appear in image window titles.  This is a format string;
certain % character sequences are recognised and expanded as follows:
.br
546

547
.br
548
%%  literal percent sign
549
.br
550
%f  bare filename, or "Untitled"
551
.br
552
%F  full path to file, or "Untitled"
553
.br
554
%p  PDB image id
555
.br
556
%i  view instance number
557
.br
558
%t  image type (RGB, grayscale, indexed)
559
.br
560
%z  zoom factor as a percentage
561
.br
562
%s  source scale factor
563
.br
564
%d  destination scale factor
565
.br
566
%Dx expands to x if the image is dirty, the empty string otherwise
567
.br
568
%Cx expands to x if the image is clean, the empty string otherwise
569
.br
Sven Neumann's avatar
Sven Neumann committed
570 571 572 573
%B  expands to (modified) if the image is dirty, the empty string otherwise
.br
%A  expands to (clean) if the image is clean, the empty string otherwise
.br
574 575 576 577
%Nx expands to x if the image is export-dirty, the empty string otherwise
.br
%Ex expands to x if the image is export-clean, the empty string otherwise
.br
578
%l  the number of layers
579
.br
580 581 582 583 584
%L  the number of layers (long form)
.br
%m  memory used by the image
.br
%n  the name of the active layer/channel
585
.br
Sven Neumann's avatar
Sven Neumann committed
586 587
%P  the PDB id of the active layer/channel
.br
588
%w  image width in pixels
589
.br
590
%W  image width in real-world units
591
.br
592
%h  image height in pixels
593
.br
594
%H  image height in real-world units
595
.br
596 597
%M  the image size expressed in megapixels
.br
598
%u  unit symbol
599
.br
600
%U  unit abbreviation
601
.br
602 603 604 605 606 607 608 609 610 611
%x  the width of the active layer/channel in pixels
.br
%X  the width of the active layer/channel in real-world units
.br
%y  the height of the active layer/channel in pixels
.br
%Y  the height of the active layer/channel in real-world units
.br
%o  the name of the image's color profile
.br
612

613
.br
614 615

.TP
616
(image-status-format "%n (%m)")
617

618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644
Sets the text to appear in image window status bars.  This is a format string;
certain % character sequences are recognised and expanded as follows:
.br

.br
%%  literal percent sign
.br
%f  bare filename, or "Untitled"
.br
%F  full path to file, or "Untitled"
.br
%p  PDB image id
.br
%i  view instance number
.br
%t  image type (RGB, grayscale, indexed)
.br
%z  zoom factor as a percentage
.br
%s  source scale factor
.br
%d  destination scale factor
.br
%Dx expands to x if the image is dirty, the empty string otherwise
.br
%Cx expands to x if the image is clean, the empty string otherwise
.br
Sven Neumann's avatar
Sven Neumann committed
645 646 647 648
%B  expands to (modified) if the image is dirty, the empty string otherwise
.br
%A  expands to (clean) if the image is clean, the empty string otherwise
.br
649 650 651 652
%Nx expands to x if the image is export-dirty, the empty string otherwise
.br
%Ex expands to x if the image is export-clean, the empty string otherwise
.br
653 654
%l  the number of layers
.br
655 656 657 658 659
%L  the number of layers (long form)
.br
%m  memory used by the image
.br
%n  the name of the active layer/channel
660
.br
Sven Neumann's avatar
Sven Neumann committed
661 662
%P  the PDB id of the active layer/channel
.br
663 664 665 666 667 668 669 670
%w  image width in pixels
.br
%W  image width in real-world units
.br
%h  image height in pixels
.br
%H  image height in real-world units
.br
671 672
%M  the image size expressed in megapixels
.br
673 674 675 676
%u  unit symbol
.br
%U  unit abbreviation
.br
677 678 679 680 681 682 683 684 685
%x  the width of the active layer/channel in pixels
.br
%X  the width of the active layer/channel in real-world units
.br
%y  the height of the active layer/channel in pixels
.br
%Y  the height of the active layer/channel in real-world units
.br
%o  the name of the image's color profile
686
.br
687

688
.br
Sven Neumann's avatar
Sven Neumann committed
689 690

.TP
Sven Neumann's avatar
Sven Neumann committed
691
(monitor-xresolution 96.000000)
Sven Neumann's avatar
Sven Neumann committed
692 693 694 695 696 697

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.

.TP
Sven Neumann's avatar
Sven Neumann committed
698
(monitor-yresolution 96.000000)
Sven Neumann's avatar
Sven Neumann committed
699 700 701 702 703 704 705 706

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.

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

707 708
When enabled, GIMP will use the monitor resolution from the windowing system. 
Possible values are yes and no.
Sven Neumann's avatar
Sven Neumann committed
709 710 711 712 713 714 715 716

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

717
.TP
718 719
(default-view
    (show-menubar yes)
Martin Nordholts's avatar
Martin Nordholts committed
720
    (show-statusbar yes)
721 722 723
    (show-rulers yes)
    (show-scrollbars yes)
    (show-selection yes)
Sven Neumann's avatar
Sven Neumann committed
724
    (show-layer-boundary yes)
725 726
    (show-guides yes)
    (show-grid no)
727
    (show-sample-points yes)
728 729 730 731
    (snap-to-guides yes)
    (snap-to-grid no)
    (snap-to-canvas no)
    (snap-to-path no)
732
    (padding-mode default)
733
    (padding-color (color-rgb 1.000000 1.000000 1.000000)))
734 735 736 737 738

Sets the default settings for the image view.  This is a parameter list.

.TP
(default-fullscreen-view
739
    (show-menubar yes)
Martin Nordholts's avatar
Martin Nordholts committed
740
    (show-statusbar yes)
741 742 743 744 745
    (show-rulers yes)
    (show-scrollbars yes)
    (show-selection yes)
    (show-layer-boundary yes)
    (show-guides yes)
746
    (show-grid no)
747
    (show-sample-points yes)
748 749 750 751
    (snap-to-guides yes)
    (snap-to-grid no)
    (snap-to-canvas no)
    (snap-to-path no)
752
    (padding-mode default)
753
    (padding-color (color-rgb 1.000000 1.000000 1.000000)))
754 755 756

Sets the default settings used when an image is viewed in fullscreen mode. 
This is a parameter list.
757

Sven Neumann's avatar
Sven Neumann committed
758
.TP
Sven Neumann's avatar
Sven Neumann committed
759
(activate-on-focus yes)
Sven Neumann's avatar
Sven Neumann committed
760 761 762 763 764

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.

765 766 767 768 769 770
.TP
(space-bar-action pan)

What to do when the space bar is pressed in the image window.  Possible values
are none, pan and move.

771 772 773 774 775 776
.TP
(zoom-quality high)

There's a tradeoff between speed and quality of the zoomed-out display. 
Possible values are low and high.

Martin Nordholts's avatar
Martin Nordholts committed
777 778 779 780 781 782
.TP
(use-event-history no)

Bugs in event history buffer are frequent so in case of cursor offset problems
turning it off helps.  Possible values are yes and no.

Sven Neumann's avatar
Sven Neumann committed
783 784 785
.TP
(move-tool-changes-active no)

786 787 788
If enabled, the move tool sets the edited layer or path as active.  This used
to be the default behaviour in older versions.  Possible values are yes and
no.
Sven Neumann's avatar
Sven Neumann committed
789

Martin Nordholts's avatar
Martin Nordholts committed
790
.TP
791
(filter-tool-max-recent 10)
Martin Nordholts's avatar
Martin Nordholts committed
792

793
How many recent settings to keep around in filter tools.  This is an integer
794
value.
Martin Nordholts's avatar
Martin Nordholts committed
795

796 797 798 799 800 801
.TP
(filter-tool-use-last-settings no)

Default to the last used settings in filter tools.  Possible values are yes
and no.

802 803 804 805 806
.TP
(filter-tool-show-color-options no)

Show advanced color options in filter tools.  Possible values are yes and no.

807
.TP
Martin Nordholts's avatar
Martin Nordholts committed
808
(trust-dirty-flag no)
809

810 811
When enabled, GIMP will not save an image if it has not been changed since it
was opened.  Possible values are yes and no.
812 813

.TP
814
(save-device-status yes)
815 816 817 818

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

819 820 821 822 823 824 825
.TP
(devices-share-tool no)

When enabled, the same tool and tool options will be used for all input
devices. No tool switching will occur when the input device changes.  Possible
values are yes and no.

826 827 828
.TP
(save-session-info yes)

829 830
Save the positions and sizes of the main dialogs when GIMP exits.  Possible
values are yes and no.
831 832 833 834

.TP
(restore-session yes)

835 836
Let GIMP try to restore your last saved session on each startup.  Possible
values are yes and no.
837

838 839 840 841 842 843 844
.TP
(restore-monitor no)

When enabled, GIMP will try to restore windows on the monitor they were open
before.  When disabled, windows will appear on the currently used monitor. 
Possible values are yes and no.

845
.TP
846
(save-tool-options yes)
847

848
Save the tool options when GIMP exits.  Possible values are yes and no.
849

850 851 852
.TP
(can-change-accels no)

Sven Neumann's avatar
Sven Neumann committed
853 854 855
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.
856

Sven Neumann's avatar
Sven Neumann committed
857 858 859
.TP
(save-accels yes)

860 861
Save changed keyboard shortcuts when GIMP exits.  Possible values are yes and
no.
Sven Neumann's avatar
Sven Neumann committed
862 863 864 865 866 867 868

.TP
(restore-accels yes)

Restore saved keyboard shortcuts on each GIMP startup.  Possible values are
yes and no.

869
.TP
Sven Neumann's avatar
Sven Neumann committed
870
(last-opened-size 10)
871 872 873 874 875

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

.TP
Sven Neumann's avatar
Sven Neumann committed
876
(max-new-image-size 128M)
877

878 879 880 881 882
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 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.
883

884
.TP
885
(toolbox-color-area yes)
886

887 888
Show the current foreground and background colors in the toolbox.  Possible
values are yes and no.
889 890

.TP
891
(toolbox-foo-area no)
892

893 894
Show the currently selected brush, pattern and gradient in the toolbox. 
Possible values are yes and no.
895 896

.TP
Sven Neumann's avatar
Sven Neumann committed
897
(toolbox-image-area no)
898

899 900 901 902 903 904 905 906
Show the currently active image in the toolbox.  Possible values are yes and
no.

.TP
(toolbox-wilber yes)

Show the GIMP mascot at the top of the toolbox.  Possible values are yes and
no.
907

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

911 912
Sets the theme search path.  This is a colon-separated list of folders to
search.
913

914
.TP
915
(theme "Dark")
916 917 918

The name of the theme to use.  This is a string value.

919 920 921 922 923
.TP
(prefer-dark-theme yes)

The name of the theme to use.  Possible values are yes and no.

924 925 926 927 928 929 930
.TP
(icon-theme-path "${gimp_dir}/icons:${gimp_data_dir}/icons")

Sets the icon theme search path.  This is a colon-separated list of folders to
search.

.TP
931
(icon-theme "Symbolic")
932 933 934

The name of the icon theme to use.  This is a string value.

935
.TP
936
(prefer-symbolic-icons yes)
937

938 939
When enabled, symbolic icons will be preferred if available.  Possible values
are yes and no.
940

941 942 943
.TP
(use-help yes)

Sven Neumann's avatar
Sven Neumann committed
944
When enabled, pressing F1 will open the help browser.  Possible values are yes
945
and no.
946

Sven Neumann's avatar
Sven Neumann committed
947 948 949 950 951 952 953
.TP
(show-help-button yes)

When enabled, dialogs will show a help button that gives access to the related
help page.  Without this button, the help page can still be reached by
pressing F1.  Possible values are yes and no.

Sven Neumann's avatar
Sven Neumann committed
954
.TP
955
(help-locales "")
Sven Neumann's avatar
Sven Neumann committed
956

957 958
Specifies the language preferences used by the help system. This is a
colon-separated list of language identifiers with decreasing priority. If
Sven Neumann's avatar
Sven Neumann committed
959 960 961
empty, the language is taken from the user's locale setting.  This is a string
value.

962
.TP
963
(help-browser gimp)
964

965
Sets the browser used by the help system.  Possible values are gimp and
Sven Neumann's avatar
Sven Neumann committed
966
web-browser.
967

968 969 970 971 972 973 974 975 976 977 978
.TP
(search-show-unavailable-actions no)

When enabled, a search of actions will also return inactive actions.  Possible
values are yes and no.

.TP
(action-history-size 100)

The maximum number of actions saved in history.  This is an integer value.

979 980 981 982 983 984 985
.TP
(user-manual-online no)

When enabled, the online user manual will be used by the help system.
Otherwise the locally installed copy is used.  Possible values are yes and no.

.TP
986
(user-manual-online-uri "https://docs.gimp.org/2.99")
987 988 989 990

The location of the online user manual. This is used if 'user-manual-online'
is enabled.  This is a string value.

Sven Neumann's avatar
Sven Neumann committed
991
.TP
992
(dock-window-hint utility)
Sven Neumann's avatar
Sven Neumann committed
993

994 995 996
The window type hint that is set on dock windows and the toolbox window. This
may affect the way your window manager decorates and handles these windows. 
Possible values are normal, utility and keep-above.
Sven Neumann's avatar
Sven Neumann committed
997

Martin Nordholts's avatar
Martin Nordholts committed
998 999 1000 1001 1002 1003
.TP
(cursor-handedness right)

Sets the handedness for cursor positioning.  Possible values are left and
right.

1004 1005 1006 1007 1008 1009
.TP
(playground-npd-tool no)

Enable the N-Point Deformation tool.  Possible values are yes and no.

.TP
1010
(playground-seamless-clone-tool no)
1011

1012
Enable the Seamless Clone tool.  Possible values are yes and no.
1013

1014
.TP
1015
(color-profile-policy ask)
1016

1017 1018 1019
How to handle embedded color profiles when opening a file.  Possible values
are ask, keep and convert.

1020 1021 1022 1023 1024
.TP

Sets the default folder path for all color profile file dialogs.  This is a
single filename.

1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119
.TP
(image-convert-profile-intent relative-colorimetric)

Sets the default rendering intent for the 'Convert to Color Profile' dialog. 
Possible values are perceptual, relative-colorimetric, saturation and
absolute-colorimetric.

.TP
(image-convert-profile-black-point-compensation yes)

Sets the default 'Black Point Compensation' state for the 'Convert to Color
Profile' dialog.  Possible values are yes and no.

.TP
(image-convert-precision-layer-dither-method none)

Sets the default layer dithering method for the 'Convert Precision' dialog. 
Possible values are none, floyd-steinberg, bayer, random, random-covariant,
add, add-covariant, xor and xor-covariant.

.TP
(image-convert-precision-text-layer-dither-method none)

Sets the default text layer dithering method for the 'Convert Precision'
dialog.  Possible values are none, floyd-steinberg, bayer, random,
random-covariant, add, add-covariant, xor and xor-covariant.

.TP
(image-convert-precision-channel-dither-method none)

Sets the default channel dithering method for the 'Convert Precision' dialog. 
Possible values are none, floyd-steinberg, bayer, random, random-covariant,
add, add-covariant, xor and xor-covariant.

.TP
(image-convert-indexed-palette-type generate)

Sets the default palette type for the 'Convert to Indexed' dialog.  Possible
values are generate, web, mono and custom.

.TP
(image-convert-indexed-max-colors 256)

Sets the default maximum number of colors for the 'Convert to Indexed' dialog.
 This is an integer value.

.TP
(image-convert-indexed-remove-duplicates yes)

Sets the default 'Remove duplicate colors' state for the 'Convert to Indexed'
dialog.  Possible values are yes and no.

.TP
(image-convert-indexed-dither-type none)

Sets the default dithering type for the 'Convert to Indexed' dialog.  Possible
values are none, fs, fs-lowbleed and fixed.

.TP
(image-convert-indexed-dither-alpha no)

Sets the default 'Dither alpha' state for the 'Convert to Indexed' dialog. 
Possible values are yes and no.

.TP
(image-convert-indexed-dither-text-layers no)

Sets the default 'Dither text layers' state for the 'Convert to Indexed'
dialog.  Possible values are yes and no.

.TP
(image-resize-fill-type transparent)

Sets the default fill type for the 'Canvas Size' dialog.  Possible values are
foreground, background, white, transparent and pattern.

.TP
(image-resize-layer-set none)

Sets the default set of layers to resize for the 'Canvas Size' dialog. 
Possible values are none, all, image-sized, visible and linked.

.TP
(image-resize-resize-text-layers no)

Sets the default 'Resize text layers' state for the 'Canvas Size' dialog. 
Possible values are yes and no.

.TP
(layer-new-name "Layer")

Sets the default layer name for the 'New Layer' dialog.  This is a string
value.

.TP
1120
(layer-new-mode normal)
1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133

Sets the default mode for the 'New Layer' dialog.  Possible values are
normal-legacy, dissolve, behind-legacy, multiply-legacy, screen-legacy,
overlay-legacy, difference-legacy, addition-legacy, subtract-legacy,
darken-only-legacy, lighten-only-legacy, hsv-hue-legacy,
hsv-saturation-legacy, hsl-color-legacy, hsv-value-legacy, divide-legacy,
dodge-legacy, burn-legacy, hardlight-legacy, softlight-legacy,
grain-extract-legacy, grain-merge-legacy, color-erase-legacy, overlay,
lch-hue, lch-chroma, lch-color, lch-lightness, normal, behind, multiply,
screen, difference, addition, subtract, darken-only, lighten-only, hsv-hue,
hsv-saturation, hsl-color, hsv-value, divide, dodge, burn, hardlight,
softlight, grain-extract, grain-merge, vivid-light, pin-light, linear-light,
hard-mix, exclusion, linear-burn, luma-darken-only, luma-lighten-only,
1134 1135
luminance, color-erase, erase, merge, split, pass-through, replace and
anti-erase.
1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152

.TP
(layer-new-blend-space auto)

Sets the default blend space for the 'New Layer' dialog.  Possible values are
auto, rgb-linear, rgb-perceptual and lab.

.TP
(layer-new-composite-space auto)

Sets the default composite space for the 'New Layer' dialog.  Possible values
are auto, rgb-linear, rgb-perceptual and lab.

.TP
(layer-new-composite-mode auto)

Sets the default composite mode for the 'New Layer' dialog.  Possible values
1153
are auto, union, clip-to-backdrop, clip-to-layer and intersection.
1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312

.TP
(layer-new-opacity 1.000000)

Sets the default opacity for the 'New Layer' dialog.  This is a float value.

.TP
(layer-new-fill-type transparent)

Sets the default fill type for the 'New Layer' dialog.  Possible values are
foreground, background, white, transparent and pattern.

.TP
(layer-resize-fill-type transparent)

Sets the default fill type for the 'Layer Boundary Size' dialog.  Possible
values are foreground, background, white, transparent and pattern.

.TP
(layer-add-mask-type white)

Sets the default mask for the 'Add Layer Mask' dialog.  Possible values are
white, black, alpha, alpha-transfer, selection, copy and channel.

.TP
(layer-add-mask-invert no)

Sets the default 'invert mask' state for the 'Add Layer Mask' dialog. 
Possible values are yes and no.

.TP
(layer-merge-type expand-as-necessary)

Sets the default merge type for the 'Merge Visible Layers' dialog.  Possible
values are expand-as-necessary, clip-to-image, clip-to-bottom-layer and
flatten-image.

.TP
(layer-merge-active-group-only yes)

Sets the default 'Active group only' for the 'Merge Visible Layers' dialog. 
Possible values are yes and no.

.TP
(layer-merge-discard-invisible no)

Sets the default 'Discard invisible' for the 'Merge Visible Layers' dialog. 
Possible values are yes and no.

.TP
(channel-new-name "Channel")

Sets the default channel name for the 'New Channel' dialog.  This is a string
value.

.TP
(channel-new-color (color-rgba 0.000000 0.000000 0.000000 0.500000))

Sets the default color and opacity for the 'New Channel' dialog.  The color is
specified in the form (color-rgba red green blue alpha) with channel values as
floats in the range of 0.0 to 1.0.

.TP
(path-new-name "Path")

Sets the default path name for the 'New Path' dialog.  This is a string value.

.TP

Sets the default folder path for the 'Export Path' dialog.  This is a single
filename.

.TP
(path-export-active-only yes)

Sets the default 'Export the active path' state for the 'Export Path' dialog. 
Possible values are yes and no.

.TP

Sets the default folder path for the 'Import Path' dialog.  This is a single
filename.

.TP
(path-import-merge no)

Sets the default 'Merge imported paths' state for the 'Import Path' dialog. 
Possible values are yes and no.

.TP
(path-import-scale no)

Sets the default 'Scale imported paths to fit size' state for the 'Import
Path' dialog.  Possible values are yes and no.

.TP
(selection-feather-radius 5.000000)

Sets the default feather radius for the 'Feather Selection' dialog.  This is a
float value.

.TP
(selection-grow-radius 1.000000)

Sets the default grow radius for the 'Grow Selection' dialog.  This is a float
value.

.TP
(selection-shrink-radius 1.000000)

Sets the default shrink radius for the 'Shrink Selection' dialog.  This is a
float value.

.TP
(selection-shrink-edge-lock no)

Sets the default 'Selected areas continue outside the image' setting for the
\&'Shrink Selection' dialog.  Possible values are yes and no.

.TP
(selection-border-radius 5.000000)

Sets the default border radius for the 'Border Selection' dialog.  This is a
float value.

.TP
(selection-border-style smooth)

Sets the default border style for the 'Border Selection' dialog.  Possible
values are hard, smooth and feathered.

.TP
(selection-border-edge-lock no)

Sets the default 'Selected areas continue outside the image' setting for the
\&'Border Selection' dialog.  Possible values are yes and no.

.TP
(fill-options
    (style solid)
    (antialias yes))

The default fill options for the fill dialogs.  This is a parameter list.

.TP
(stroke-options
    (style solid)
    (antialias yes)
    (method line)
    (width 6.000000)
    (unit pixels)
    (cap-style butt)
    (join-style miter)
    (miter-limit 10.000000)
    (dash-offset 0.000000)
    (dash-info 0)
    (emulate-brush-dynamics no))

The default stroke options for the stroke dialogs.  This is a parameter list.
1313

1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352
.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.
1353
There are a few variables that are pre-defined:
1354 1355 1356
.TP
.I gimp_dir
The personal gimp directory which is set to the value of the environment
1357
variable GIMP3_DIRECTORY or to @manpage_gimpdir@.
1358 1359
.TP
.I gimp_data_dir
Sven Neumann's avatar
Sven Neumann committed
1360
Base for paths to shareable data, which is set to the value of the
1361
environment variable GIMP3_DATADIR or to the compiled-in default value
1362
@gimpdatadir@.
1363 1364
.TP
.I gimp_plug_in_dir
1365
Base to paths for architecture-specific plug-ins and modules, which is set
1366
to the value of the environment variable GIMP3_PLUGINDIR or to the
1367
compiled-in default value @gimpplugindir@.
1368 1369 1370
.TP
.I gimp_sysconf_dir
Path to configuration files, which is set to the value of the environment
1371
variable GIMP3_SYSCONFDIR or to the compiled-in default value 
1372
@gimpsysconfdir@.
1373 1374 1375

.SH FILES
.TP
1376
.I @gimpsysconfdir@/gimprc
1377
System-wide configuration file
1378
.TP
1379
.I @manpage_gimpdir@/gimprc
1380
Per-user configuration file
1381 1382

.SH "SEE ALSO"
Martin Nordholts's avatar
Martin Nordholts committed
1383
.BR gimp (1)