Module | MiniMagick::Configuration |
In: |
lib/mini_magick/configuration.rb
|
CLI_DETECTION | = | { imagemagick: "mogrify", graphicsmagick: "gm", imagemagick7: "magick", } |
cli | [RW] |
Set whether you want to use [ImageMagick](www.imagemagick.org) or
[GraphicsMagick](www.graphicsmagick.org).
@return [Symbol] `:imagemagick`, `:imagemagick7`, or `:graphicsmagick` |
cli_path | [RW] |
If you don‘t have the CLI tools in your PATH, you can set the path to
the executables.
@return [String] |
cli_prefix | [RW] |
Adds a prefix to the CLI command. For example, you could use `firejail` to
run all commands in a sandbox. Can be a string, or an array of strings.
e.g. ‘firejail’, or [‘firejail’,
’—force’]
@return [String] @return [Array<String>] |
debug | [RW] |
When set to `true`, it outputs each command to STDOUT in their shell
version.
@return [Boolean] |
logger | [RW] |
Logger for {debug}, default is `MiniMagick::Logger.new(STDOUT)`, but you
can override it, for example if you want the logs to be written to a file.
@return [Logger] |
processor | [RW] | @private (for backwards compatibility) |
processor_path | [RW] | @private (for backwards compatibility) |
shell_api | [RW] |
Instructs MiniMagick how to execute the
shell commands. Available APIs are "open3" (default) and
"posix-spawn" (requires the "posix-spawn" gem).
@return [String] |
timeout | [RW] |
If you don‘t want commands to take too long, you can set a timeout
(in seconds).
@return [Integer] |
validate_on_create | [RW] |
If set to `true`, it will `identify` every newly created image, and raise
`MiniMagick::Invalid` if the image is not valid.
Useful for validating user input, although it adds a bit of overhead.
Defaults to `true`.
@return [Boolean] |
validate_on_write | [RW] |
If set to `true`, it will `identify` every image that gets written (with
{MiniMagick::Image#write}), and raise `MiniMagick::Invalid` if the image is not valid.
Useful for validating that processing was sucessful, although it adds a bit
of overhead. Defaults to `true`.
@return [Boolean] |
whiny | [RW] |
If set to `false`, it will not raise errors when ImageMagick returns status
code different than 0. Defaults to `true`.
@return [Boolean] |