manpagez: man pages & more
man gimprc(5)
Home | html | info | man

gimprc(5)                                                            gimprc(5)




NAME

       gimprc - gimp configuration file


DESCRIPTION

       The gimprc file is a configuration file read by GIMP when it starts up.
       There  are  two  of  these:  one  system-wide  one  stored  in   ${pre-
       fix}/etc/gimp/2.0/gimprc  and  a  per-user $HOME/.gimp-2.8/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  folder  for temporary storage. Files will appear here
              during the 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.


       (swap-path "${gimp_dir}")

              Sets the swap file location. GIMP uses a tile based memory allo-
              cation 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 GIMP is used with large  images.  Also,
              things  can  get  horribly slow if the swap file is created 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.


       (num-processors 1)

              Sets how many processors GIMP should try to use  simultaneously.
              This is an integer value.


       (tile-cache-size 6119260k)

              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 oth-
              erwise.  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.



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


       (interpolation-type cubic)

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


       (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 dif-
              ference of pixel intensity from the original is greater  than  a
              specified  threshold.  This value represents the default thresh-
              old.  This is an integer value.


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

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


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

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


       (interpreter-path  "${gimp_dir}/interpreters:${gimp_plug_in_dir}/inter-
       preters")

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


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

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


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

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


       (brush-path-writable "${gimp_dir}/brushes")

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


       (dynamics-path "${gimp_dir}/dynamics:${gimp_data_dir}/dynamics")

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


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

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


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

              Sets the pattern search path.  This is a colon-separated 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-separated 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}/gradients:${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.


       (tool-preset-path  "${gimp_dir}/tool-presets:${gimp_data_dir}/tool-pre-
       sets")

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


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

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


       (font-path "${gimp_dir}/fonts:${gimp_data_dir}/fonts")

              Where to look for fonts in addition to the system-wide installed
              fonts.  This is a colon-separated list of folders to search.


       (default-brush "Round Fuzzy")

              Specify a default brush.  The brush is searched for in the spec-
              ified brush path.  This is a string value.


       (default-dynamics "Dynamics Off")

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


       (default-pattern "Pine")

              Specify a default pattern.  This is a string value.


       (default-palette "Default")

              Specify a default palette.  This is a string value.


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

              Specify a default gradient.  This is a string value.


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


       (default-font "Sans")

              Specify a default font.  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-dynamics yes)

              When  enabled, the selected dynamics 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 640)
                  (height 400)
                  (unit pixels)
                  (xresolution 72.000000)
                  (yresolution 72.000000)
                  (resolution-unit inches)
                  (image-type rgb)
                  (fill-type background-fill)
                  (comment "Created with GIMP"))

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


       (default-grid
                  (style solid)
                  (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 64M)

              Sets an upper limit to the memory that is used per image to keep
              operations on 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', 'M' or 'G'  which
              makes GIMP interpret the size as being specified in bytes, kilo-
              bytes, 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.


       (plug-in-history-size 10)

              How  many  recently  used  plug-ins to keep on the Filters menu.
              This is an integer value.


       (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.   Pos-
              sible values are yes and no.


       (layer-preview-size medium)

              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.


       (thumbnail-size normal)

              Sets the size of the thumbnail shown in the Open dialog.  Possi-
              ble values are none, normal and large.


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


       (color-management
                  (mode display)
                  (display-profile-from-gdk no)
                  (display-rendering-intent perceptual)
                  (simulation-rendering-intent perceptual)
                  (simulation-gamut-check no)
                  (out-of-gamut-color (color-rgb 0.501961 0.501961 0.501961))
                  (display-module "CdisplayLcms"))

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


       (color-profile-policy ask)

              How to handle embedded color profiles when opening a file.  Pos-
              sible values are ask, keep and convert.


       (save-document-history yes)

              Keep a permanent record of all opened and  saved  files  in  the
              Recent Documents list.  Possible values are yes and no.


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


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


       (marching-ants-speed 200)

              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 posi-
              tion hint.  This means painting with  large  brushes  should  be
              more  accurate,  but  it  may  be slower.  Conversely, on some X
              servers enabling this option results in faster painting.  Possi-
              ble values are yes and no.


       (cursor-mode tool-icon)

              Sets  the  type  of  mouse pointers to use.  Possible values are
              tool-icon, tool-crosshair and crosshair.


       (cursor-updating yes)

              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.


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


       (show-paint-tool-cursor yes)

              When  enabled,  the  mouse  pointer will be shown over the image
              while using a paint tool.  Possible values are yes and no.


       (image-title-format "%D*%f-%p.%i (%t, %L) %wx%h")

              Sets the text to appear in image window titles.  This is a  for-
              mat  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  other-
              wise
              %Cx  expands to x if the image is clean, the empty string other-
              wise
              %B  expands to (modified) if  the  image  is  dirty,  the  empty
              string otherwise
              %A   expands  to (clean) 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
              %M  the image size expressed in megapixels
              %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  other-
              wise
              %Cx  expands to x if the image is clean, the empty string other-
              wise
              %B  expands to (modified) if  the  image  is  dirty,  the  empty
              string otherwise
              %A   expands  to (clean) 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
              %M  the image size expressed in megapixels
              %u  unit symbol
              %U  unit abbreviation



       (monitor-xresolution 96.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 96.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, GIMP will use the monitor resolution from the win-
              dowing 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-statusbar yes)
                  (show-rulers yes)
                  (show-scrollbars yes)
                  (show-selection yes)
                  (show-layer-boundary yes)
                  (show-guides yes)
                  (show-grid no)
                  (show-sample-points yes)
                  (padding-mode default)
                  (padding-color (color-rgb 1.000000 1.000000 1.000000)))

              Sets the default settings for the image view.  This is a parame-
              ter list.


       (default-fullscreen-view
                  (show-menubar yes)
                  (show-statusbar yes)
                  (show-rulers yes)
                  (show-scrollbars yes)
                  (show-selection yes)
                  (show-layer-boundary yes)
                  (show-guides yes)
                  (show-grid no)
                  (show-sample-points yes)
                  (padding-mode default)
                  (padding-color (color-rgb 1.000000 1.000000 1.000000)))

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


       (default-snap-to-guides yes)

              Snap to guides by default in new image windows.  Possible values
              are yes and no.


       (default-snap-to-grid no)

              Snap to the grid by default in new image windows.  Possible val-
              ues are yes and no.


       (default-snap-to-canvas no)

              Snap to the canvas edge by default in new image windows.  Possi-
              ble values are yes and no.


       (default-snap-to-path no)

              Snap to the active path by default in new image windows.  Possi-
              ble values are yes and no.


       (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 man-
              agers using "click to focus".
               Possible values are yes and no.


       (space-bar-action pan)

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


       (zoom-quality high)

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


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


       (move-tool-changes-active no)

              If enabled, the move tool sets  the  edited  layer  or  path  as
              active.   This  used  to  be the default behaviour in older ver-
              sions.  Possible values are yes and no.


       (image-map-tool-max-recent 10)

              How many recent settings to  keep  around  in  color  correction
              tools  This is an integer value.


       (trust-dirty-flag no)

              When  enabled,  GIMP  will  not save an image if it has not been
              changed since it was opened.  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 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.


       (save-tool-options no)

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


       (show-tooltips yes)

              Show a tooltip when the pointer hovers over an  item.   Possible
              values are yes and no.


       (tearoff-menus yes)

              When  enabled,  menus  can be torn off.  Possible values 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 GIMP exits.  Possible  val-
              ues 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 128M)

              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, kilo-
              bytes,  megabytes  or  gigabytes.  If no suffix is specified the
              size defaults to being specified in kilobytes.


       (toolbox-color-area yes)

              Show the current foreground and background colors in  the  tool-
              box.  Possible values are yes and no.


       (toolbox-foo-area no)

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


       (toolbox-image-area no)

              Show the currently active image in the toolbox.  Possible values
              are yes and no.


       (toolbox-wilber yes)

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


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

              Sets the theme search path.  This is a colon-separated  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.


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


       (help-locales "")

              Specifies the language preferences used by the help system. This
              is a colon-separated list of language identifiers with  decreas-
              ing  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.


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


       (user-manual-online-uri "http://docs.gimp.org/2.8")

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


       (dock-window-hint utility)

              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.


       (cursor-format pixbuf)

              Sets  the pixel format to use for mouse pointers.  Possible val-
              ues are bitmap and pixbuf.


       (cursor-handedness right)

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


       (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}/gimpressionist:${gimp_data_dir}/gim-
       pressionist")

              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-separated 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  environment  vari-
       able.  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.8.

       gimp_data_dir
              Base for paths to shareable data, which is set to the  value  of
              the  environment  variable  GIMP2_DATADIR  or to the compiled-in
              default value ${datarootdir}/gimp/2.0.

       gimp_plug_in_dir
              Base to paths for  architecture-specific  plugins  and  modules,
              which   is   set  to  the  value  of  the  environment  variable
              GIMP2_PLUGINDIR or to the compiled-in default value  ${exec_pre-
              fix}/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 ${prefix}/etc/gimp/2.0.



FILES

       ${prefix}/etc/gimp/2.0/gimprc
              System-wide configuration file

       $HOME/.gimp-2.8/gimprc
              Per-user configuration file



SEE ALSO

       gimp(1)



GIMP Manual Pages               Version 2.8.16                       gimprc(5)

gimp 2.8.16 - Generated Tue Dec 1 18:44:51 CST 2015
© manpagez.com 2000-2024
Individual documents may contain additional copyright information.