PIKApp/docs/pikarc.5.in

1488 lines
38 KiB
Groff

.\" This man-page is auto-generated by pika --dump-pikarc-manpage.
.TH PIKARC 5 "Version 2.99.9" "PIKA Manual Pages"
.SH NAME
pikarc \- pika configuration file
.SH DESCRIPTION
The
.B pikarc
file is a configuration file read by PIKA when it starts up. There
are two of these: one system-wide one stored in
@pikasysconfdir@/pikarc and a per-user @manpage_pikadir@/pikarc
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 pikarc
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 "${pika_temp_dir}")
Sets the folder for temporary storage. Files will appear here during the
course of running PIKA. Most files will disappear when PIKA 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.
.TP
(swap-path "${pika_cache_dir}")
Sets the swap file location. PIKA 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 PIKA 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.
.TP
(swap-compression "fast")
The compression method used for tile data stored in the swap file. This is a
string value.
.TP
(num-processors 1)
Sets how many threads PIKA should use for operations that support it. This is
an integer value.
.TP
(tile-cache-size 2g)
When the amount of pixel data exceeds this limit, PIKA 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 PIKA 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
(use-opencl no)
When enabled, uses OpenCL for some operations. Possible values are yes and
no.
.TP
Specifies the language to use for the user interface. This is a string value.
.TP
(interpolation-type cubic)
Sets the level of interpolation used for scaling and other transformations.
Possible values are none, linear, cubic, nohalo and lohalo.
.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.
.TP
(plug-in-path "${pika_dir}/plug-ins:${pika_plug_in_dir}/plug-ins")
Sets the plug-in search path. This is a colon-separated list of folders to
search.
.TP
(module-path "${pika_dir}/modules:${pika_plug_in_dir}/modules")
Sets the module search path. This is a colon-separated list of folders to
search.
.TP
(interpreter-path "${pika_dir}/interpreters:${pika_plug_in_dir}/interpreters")
Sets the interpreter search path. This is a colon-separated list of folders
to search.
.TP
(environ-path "${pika_dir}/environ:${pika_plug_in_dir}/environ")
Sets the environ search path. This is a colon-separated list of folders to
search.
.TP
(brush-path "${pika_dir}/brushes:${pika_data_dir}/brushes")
Sets the brush search path. This is a colon-separated list of folders to
search.
.TP
(brush-path-writable "${pika_dir}/brushes")
This is a colon-separated list of folders to search.
.TP
(dynamics-path "${pika_dir}/dynamics:${pika_data_dir}/dynamics")
Sets the dynamics search path. This is a colon-separated list of folders to
search.
.TP
(dynamics-path-writable "${pika_dir}/dynamics")
This is a colon-separated list of folders to search.
.TP
(mypaint-brush-path "@mypaint_brushes_dir@:~/.mypaint/brushes")
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.
.TP
(pattern-path "${pika_dir}/patterns:${pika_data_dir}/patterns")
Sets the pattern search path. This is a colon-separated list of folders to
search.
.TP
(pattern-path-writable "${pika_dir}/patterns")
This is a colon-separated list of folders to search.
.TP
(palette-path "${pika_dir}/palettes:${pika_data_dir}/palettes")
Sets the palette search path. This is a colon-separated list of folders to
search.
.TP
(palette-path-writable "${pika_dir}/palettes")
This is a colon-separated list of folders to search.
.TP
(gradient-path "${pika_dir}/gradients:${pika_data_dir}/gradients")
Sets the gradient search path. This is a colon-separated list of folders to
search.
.TP
(gradient-path-writable "${pika_dir}/gradients")
This is a colon-separated list of folders to search.
.TP
(tool-preset-path "${pika_dir}/tool-presets:${pika_data_dir}/tool-presets")
Sets the dynamics search path. This is a colon-separated list of folders to
search.
.TP
(tool-preset-path-writable "${pika_dir}/tool-presets")
This is a colon-separated list of folders to search.
.TP
(font-path "${pika_dir}/fonts:${pika_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.
.TP
(default-brush "2. Hardness 050")
Specify a default brush. The brush is searched for in the specified brush
path. This is a string value.
.TP
(default-dynamics "Pressure Size")
Specify a default dynamics. The dynamics is searched for in the specified
dynamics path. This is a string value.
.TP
(default-mypaint-brush "Fixme")
Specify a default MyPaint brush. This is a string value.
.TP
(default-pattern "Pine")
Specify a default pattern. This is a string value.
.TP
(default-palette "Default")
Specify a default palette. This is a string value.
.TP
(default-gradient "FG to BG (RGB)")
Specify a default gradient. This is a string value.
.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.
.TP
(default-font "Sans-serif")
Specify a default font. This is a string value.
.TP
(global-brush yes)
When enabled, the selected brush will be used for all tools. Possible values
are yes and no.
.TP
(global-dynamics yes)
When enabled, the selected dynamics will be used for all tools. Possible
values are yes and no.
.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.
.TP
(default-image
(width 2001)
(height 1984)
(unit pixels)
(xresolution 300)
(yresolution 300)
(resolution-unit inches)
(image-type rgb)
(precision u8-non-linear)
(color-profile NULL)
(fill-type background)
(comment "Created with PIKA"))
Sets the default image in the "File/New" dialog. This is a parameter list.
.TP
(default-grid
(style solid)
(fgcolor (color-rgba 0 0 0 1))
(bgcolor (color-rgba 1 1 1 1))
(xspacing 10)
(yspacing 10)
(spacing-unit inches)
(xoffset 0)
(yoffset 0)
(offset-unit inches))
Specify a default image grid. This is a parameter list.
.TP
(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.
.TP
(undo-size 1g)
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 PIKA 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
(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.
.TP
(plug-in-history-size 10)
How many recently used filters and plug-ins to keep on the Filters menu. This
is an integer value.
.TP
(pluginrc-path "${pika_dir}/pluginrc")
Sets the pluginrc search path. This is a single filename.
.TP
(layer-previews yes)
Sets whether PIKA 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.
.TP
(group-layer-previews yes)
Sets whether PIKA should create previews of layer groups. Layer group previews
are more expensive than ordinary layer previews. Possible values are yes and
no.
.TP
(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.
.TP
(thumbnail-size normal)
Sets the size of the thumbnail shown in the Open dialog. Possible values are
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 PIKA 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
(color-management
(mode display)
(display-profile-from-gdk no)
(display-rendering-intent relative-colorimetric)
(display-use-black-point-compensation yes)
(display-optimize yes)
(simulation-rendering-intent perceptual)
(simulation-use-black-point-compensation no)
(simulation-optimize yes)
(simulation-gamut-check no)
(out-of-gamut-color (color-rgb 1 0 1)))
Defines the color management behavior. This is a parameter list.
.TP
(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.
.TP
(quick-mask-color (color-rgba 1 0 0 0.5))
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.
.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
noise in order to distribute color values a bit. Possible values are yes and
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.
.TP
(export-file-type png)
Export file type used by default. Possible values are png, jpg, ora, psd,
pdf, tif, bmp and webp.
.TP
(export-color-profile yes)
Export the image's color profile by default. Possible values are yes and no.
.TP
(export-comment yes)
Export the image's comment by default. Possible values are yes and no.
.TP
(export-thumbnail yes)
Export the image's thumbnail by default Possible values are yes and no.
.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
(debug-policy warning)
Try generating debug data for bug reporting when appropriate. Possible values
are warning, critical, fatal and never.
.TP
(check-updates yes)
Check for availability of PIKA updates through background internet queries.
Possible values are yes and no.
.TP
(check-update-timestamp 0)
Timestamp of the last update check. This is an integer value.
.TP
(last-release-timestamp 0)
The timestamp for the last known release date. This is an integer value.
.TP
The last known release version of PIKA as queried from official website. This
is a string value.
.TP
(last-revision 0)
The timestamp for the last known release date. This is an integer value.
.TP
The last known release version of PIKA as queried from official website. This
is a string value.
.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.
.TP
(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.
.TP
(resize-windows-on-zoom no)
When enabled, the image window will automatically resize itself when zooming
into and out of images. This setting only takes effect in multi-window mode.
Possible values are yes and no.
.TP
(resize-windows-on-resize no)
When enabled, the image window will automatically resize itself whenever the
physical image size changes. This setting only takes effect in multi-window
mode. Possible values are yes and no.
.TP
(default-show-all no)
Show full image content by default. Possible values are yes and no.
.TP
(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.
.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.
.TP
(cursor-mode tool-crosshair)
Sets the type of mouse pointers to use. Possible values are tool-icon,
tool-crosshair and crosshair.
.TP
(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.
.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.
.TP
(snap-brush-outline no)
When enabled, the brush outline will snap to individual dabs while painting.
Possible values are yes and no.
.TP
(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.
.TP
(image-title-format "%D*%f-%p.%i (%t, %o, %L) %wx%h")
Sets the text to appear in image window titles. 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
%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
%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
%l the number of layers
.br
%L the number of layers (long form)
.br
%m memory used by the image
.br
%n the name of the active layer/channel
.br
%P the PDB id of the active layer/channel
.br
%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
%M the image size expressed in megapixels
.br
%u unit symbol
.br
%U unit abbreviation
.br
%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
.br
.TP
(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:
.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
%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
%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
%l the number of layers
.br
%L the number of layers (long form)
.br
%m memory used by the image
.br
%n the name of the active layer/channel
.br
%P the PDB id of the active layer/channel
.br
%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
%M the image size expressed in megapixels
.br
%u unit symbol
.br
%U unit abbreviation
.br
%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
.br
.TP
(monitor-xresolution 96)
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
(monitor-yresolution 96)
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)
When enabled, PIKA will use the monitor resolution from the windowing system.
Possible values are yes and no.
.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.
.TP
(default-view
(show-menubar yes)
(show-statusbar yes)
(show-rulers yes)
(show-scrollbars yes)
(show-selection yes)
(show-layer-boundary yes)
(show-canvas-boundary yes)
(show-guides yes)
(show-grid no)
(show-sample-points yes)
(snap-to-guides yes)
(snap-to-grid no)
(snap-to-canvas no)
(snap-to-path no)
(padding-mode default)
(padding-color (color-rgb 1 1 1))
(padding-in-show-all no))
Sets the default settings for the image view. This is a parameter list.
.TP
(default-fullscreen-view
(show-menubar yes)
(show-statusbar yes)
(show-rulers yes)
(show-scrollbars yes)
(show-selection yes)
(show-layer-boundary yes)
(show-canvas-boundary yes)
(show-guides yes)
(show-grid no)
(show-sample-points yes)
(snap-to-guides yes)
(snap-to-grid no)
(snap-to-canvas no)
(snap-to-path no)
(padding-mode default)
(padding-color (color-rgb 1 1 1))
(padding-in-show-all no))
Sets the default settings used when an image is viewed in fullscreen mode.
This is a parameter list.
.TP
(activate-on-focus yes)
When enabled, an image will become the active image when its image window
receives the focus. This is useful for window managers using "click to focus".
Possible values are yes and no.
.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.
.TP
(zoom-quality high)
There's a tradeoff between speed and quality of the zoomed-out display.
Possible values are low and high.
.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.
.TP
(edit-non-visible no)
When enabled, non-visible layers can be edited as normal. Possible values are
yes and no.
.TP
(move-tool-changes-active no)
If enabled, the move tool sets the edited layer or path as active. This used
to be the default behavior in older versions. Possible values are yes and
no.
.TP
(filter-tool-max-recent 10)
How many recent settings to keep around in filter tools. This is an integer
value.
.TP
(filter-tool-use-last-settings no)
Default to the last used settings in filter tools. Possible values are yes
and no.
.TP
(filter-tool-show-color-options no)
Show advanced color options in filter tools. Possible values are yes and no.
.TP
(trust-dirty-flag no)
When enabled, PIKA will not save an image if it has not been changed since it
was opened. Possible values are yes and no.
.TP
(save-device-status yes)
Remember the current tool, pattern, color, and brush across PIKA sessions.
Possible values are yes and no.
.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.
.TP
(save-session-info yes)
Save the positions and sizes of the main dialogs when PIKA exits. Possible
values are yes and no.
.TP
(restore-session yes)
Let PIKA try to restore your last saved session on each startup. Possible
values are yes and no.
.TP
(restore-monitor no)
When enabled, PIKA 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.
.TP
(save-tool-options yes)
Save the tool options when PIKA exits. Possible values are yes and no.
.TP
(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.
.TP
(save-accels yes)
Save changed keyboard shortcuts when PIKA exits. Possible values are yes and
no.
.TP
(restore-accels yes)
Restore saved keyboard shortcuts on each PIKA startup. Possible values are
yes and no.
.TP
(last-opened-size 10)
How many recently opened image filenames to keep on the File menu. This is an
integer value.
.TP
(max-new-image-size 128M)
PIKA 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 PIKA 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
(toolbox-color-area yes)
Show the current foreground and background colors in the toolbox. Possible
values are yes and no.
.TP
(toolbox-foo-area no)
Show the currently selected brush, pattern and gradient in the toolbox.
Possible values are yes and no.
.TP
(toolbox-image-area no)
Show the currently active image in the toolbox. Possible values are yes and
no.
.TP
(toolbox-mascot yes)
Show the PIKA mascot at the top of the toolbox. Possible values are yes and
no.
.TP
(toolbox-groups yes)
Use a single toolbox button for grouped tools. Possible values are yes and
no.
.TP
(theme-path "${pika_dir}/themes:${pika_data_dir}/themes")
Sets the theme search path. This is a colon-separated list of folders to
search.
.TP
(theme "Default")
The name of the theme to use. This is a string value.
.TP
(prefer-dark-theme yes)
The name of the theme to use. Possible values are yes and no.
.TP
(icon-theme-path "${pika_dir}/icons:${pika_data_dir}/icons")
Sets the icon theme search path. This is a colon-separated list of folders to
search.
.TP
(icon-theme "Symbolic")
The name of the icon theme to use. This is a string value.
.TP
(prefer-symbolic-icons yes)
When enabled, symbolic icons will be preferred if available. Possible values
are yes and no.
.TP
(use-help yes)
When enabled, pressing F1 will open the help browser. Possible values are yes
and no.
.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.
.TP
(help-locales "")
Specifies the language preferences used by the help system. This is a
colon-separated list of language identifiers with decreasing priority. If
empty, the language is taken from the user's locale setting. This is a string
value.
.TP
(help-browser pika)
Sets the browser used by the help system. Possible values are pika and
web-browser.
.TP
(action-history-size 100)
The maximum number of actions saved in history. This is an integer value.
.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
(user-manual-online-uri "https://heckin.technology/AlderconeStudio/PIKApp/wiki/2.99")
The location of the online user manual. This is used if 'user-manual-online'
is enabled. This is a string value.
.TP
(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.
.TP
(cursor-handedness right)
Sets the handedness for cursor positioning. Possible values are left and
right.
.TP
(playground-npd-tool no)
Enable the N-Point Deformation tool. Possible values are yes and no.
.TP
(playground-seamless-clone-tool no)
Enable the Seamless Clone tool. Possible values are yes and no.
.TP
(playground-paint-select-tool no)
Enable the Paint Select tool. Possible values are yes and no.
.TP
(color-profile-policy ask)
What to do when opening a file with an embedded ICC color profile. Possible values
are ask, keep, convert-builtin and convert-preferred.
.TP
(metadata-rotation-policy ask)
How to handle "Orientation" metadata when opening a file. Possible values are
ask, keep and rotate.
.TP
Sets the default folder path for all color profile file dialogs. This is a
single filename.
.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, xor-covariant, blue-noise and blue-noise-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, xor-covariant, blue-noise and
blue-noise-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, xor-covariant, blue-noise and blue-noise-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
(layer-new-mode normal)
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,
luminance, color-erase, erase, merge, split, pass-through, replace and
anti-erase.
.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
are auto, union, clip-to-backdrop, clip-to-layer and intersection.
.TP
(layer-new-opacity 1)
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 0 0 0.5))
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)
Sets the default feather radius for the 'Feather Selection' dialog. This is a
float value.
.TP
(selection-feather-edge-lock yes)
Sets the default 'Selected areas continue outside the image' setting for the
\&'Feather Selection' dialog. Possible values are yes and no.
.TP
(selection-grow-radius 1)
Sets the default grow radius for the 'Grow Selection' dialog. This is a float
value.
.TP
(selection-shrink-radius 1)
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)
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)
(feather no)
(feather-radius 10))
The default fill options for the fill dialogs. This is a parameter list.
.TP
(stroke-options
(style solid)
(antialias yes)
(feather no)
(feather-radius 10)
(method line)
(width 6)
(unit pixels)
(cap-style butt)
(join-style miter)
(miter-limit 10)
(dash-offset 0)
(dash-info 0)
(emulate-brush-dynamics no))
The default stroke options for the stroke dialogs. This is a parameter list.
.TP
(fractalexplorer-path "${pika_dir}/fractalexplorer:${pika_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 "${pika_dir}/gfig:${pika_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 "${pika_dir}/gflare:${pika_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
(pikaressionist-path "${pika_dir}/pikaressionist:${pika_data_dir}/pikaressionist")
Where to search for data used by the Pikaressionist plug-in. This is a
colon-separated list of folders to search.
.TP
(script-fu-path "${pika_dir}/scripts:${pika_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 pika_dir
The personal pika directory which is set to the value of the environment
variable PIKA3_DIRECTORY or to @manpage_pikadir@.
.TP
.I pika_data_dir
Base for paths to shareable data, which is set to the value of the
environment variable PIKA3_DATADIR or to the compiled-in default value
@pikadatadir@.
.TP
.I pika_plug_in_dir
Base to paths for architecture-specific plug-ins and modules, which is set
to the value of the environment variable PIKA3_PLUGINDIR or to the
compiled-in default value @pikaplugindir@.
.TP
.I pika_sysconf_dir
Path to configuration files, which is set to the value of the environment
variable PIKA3_SYSCONFDIR or to the compiled-in default value
@pikasysconfdir@.
.TP
.I pika_cache_dir
Path to cached files, which is set to the value of the environment
variable PIKA3_CACHEDIR or to the system default for per-user cached files.
.TP
.I pika_temp_dir
Path to temporary files, which is set to the value of the environment
variable PIKA3_TEMPDIR or to the system default for temporary files.
.SH FILES
.TP
.I @pikasysconfdir@/pikarc
System-wide configuration file
.TP
.I @manpage_pikadir@/pikarc
Per-user configuration file
.SH "SEE ALSO"
.BR pika (1)