blob: 48bb78e50823861467e8fa22e940dc3bcc78f12f [file] [log] [blame]
Taoufik Rida Bouftassa2514e82020-04-27 13:31:34 +00001.TH ImageMagick 1 "2020-04-25" "ImageMagick"
2
cristy3ed852e2009-09-05 21:47:34 +00003.SH NAME
Taoufik Rida Bouftassa2514e82020-04-27 13:31:34 +00004ImageMagick \- a free software suite for the creation, modification and
5display of bitmap images.
6
cristy3ed852e2009-09-05 21:47:34 +00007.SH SYNOPSIS
anthony79da7032012-03-19 05:22:12 +00008\fBmagick\fP [\fIoptions\fP|\fIinput-file\fP]... \fIoutput-file\fP
9\fBmagick-script\fP \fIscript-file\fP [\fIscript-arguments\fP]...
Taoufik Rida Bouftassa2514e82020-04-27 13:31:34 +000010
cristy3ed852e2009-09-05 21:47:34 +000011.SH OVERVIEW
12
Taoufik Rida Bouftassa2514e82020-04-27 13:31:34 +000013Use ImageMagick\[rg] to create, edit, compose, or convert bitmap images. It can
14read and write images in a variety of formats (over 200) including PNG, JPEG,
15GIF, HEIC, TIFF, DPX, EXR, WebP, Postscript, PDF, and SVG. Use ImageMagick to
16resize, flip, mirror, rotate, distort, shear and transform images, adjust image
17colors, apply various special effects, or draw text, lines, polygons, ellipses
18and B\['e]zier curves.
cristy3ed852e2009-09-05 21:47:34 +000019
Taoufik Rida Bouftassa2514e82020-04-27 13:31:34 +000020The functionality of ImageMagick is typically utilized from the command-line.
21It can also be accessed from programs written in your favorite language using
22the corresponding interface: G2F (Ada), MagickCore (C), MagickWand (C),
23ChMagick (Ch), ImageMagickObject (COM+), Magick++ (C++), JMagick (Java),
24JuliaIO (Julia), L-Magick (Lisp), Lua (LuaJIT), NMagick (Neko/haXe), Magick.NET
25(.NET), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP),
26IMagick (PHP), PythonMagick (Python), magick (R), RMagick (Ruby), or TclMagick
27(Tcl/TK). With a language interface, use ImageMagick to modify or create images
28dynamically and automagically.
Cristy40d0cb32018-09-15 15:15:04 -040029
Taoufik Rida Bouftassa2514e82020-04-27 13:31:34 +000030ImageMagick utilizes multiple computational threads to increase performance.
31It can read, process, or write mega-, giga-, or tera-pixel image sizes.
Cristy40d0cb32018-09-15 15:15:04 -040032
Taoufik Rida Bouftassa2514e82020-04-27 13:31:34 +000033ImageMagick is free software delivered as a ready-to-run binary distribution,
34or as source code that you may use, copy, modify, and distribute in both open
35and proprietary applications. It is distributed under a derived Apache 2.0
36license.
Cristy40d0cb32018-09-15 15:15:04 -040037
Taoufik Rida Bouftassa2514e82020-04-27 13:31:34 +000038The ImageMagick development process ensures a stable API and ABI. Before each
39ImageMagick release, we perform a comprehensive security assessment that
40includes memory error, thread data race detection, and continuous fuzzing to
41help prevent security vulnerabilities.
Cristy40d0cb32018-09-15 15:15:04 -040042
Taoufik Rida Bouftassa2514e82020-04-27 13:31:34 +000043The current release is ImageMagick 7.0.8-11. It runs on Linux, Windows, Mac Os
44X, iOS, Android OS, and others. We continue to maintain the legacy release of
45ImageMagick, version 6, at https://legacy.imagemagick.org.
Cristy40d0cb32018-09-15 15:15:04 -040046
Taoufik Rida Bouftassa2514e82020-04-27 13:31:34 +000047The authoritative ImageMagick web site is https://imagemagick.org. The
48authoritative source code repository is https://github.com/ImageMagick. We
49maintain a source code mirror at https://gitlab.com/ImageMagick.
Cristy40d0cb32018-09-15 15:15:04 -040050
Taoufik Rida Bouftassa2514e82020-04-27 13:31:34 +000051ImageMagick is a suite of command-line utilities for manipulating images. You
52may have edited images at one time or another using programs such as GIMP or
53Photoshop, which expose their functionality mainly through a graphical user
54interface. However, a GUI program is not always the right tool. Suppose you
55want to process an image dynamically from a web script, or you want to apply
56the same operations to many images, or repeat a specific operation at different
57times to the same or different image. For these types of operations, a
58command-line utility is more suitable.
cristy3ed852e2009-09-05 21:47:34 +000059
Taoufik Rida Bouftassa2514e82020-04-27 13:31:34 +000060The remaining of this manpage is a list of the available command-line utilities
61and their short descriptions. For further documentation conserning a
62particular command and its options, consult the corresponding manpage. If you
63are just getting aquainted with ImageMagick, start at the top of that list, the
64magick(1) program, and work your way down. Also, make sure to check out Anthony
65Thyssen's tutorial on how to use ImageMagick utilities to convert, compose, or
66edit images from the command-line.
cristy3ed852e2009-09-05 21:47:34 +000067
cristy3ed852e2009-09-05 21:47:34 +000068.TP
anthony79da7032012-03-19 05:22:12 +000069.B magick
Taoufik Rida Bouftassa2514e82020-04-27 13:31:34 +000070Read images into memory, perform operations on those images, and write them out
71to either the same or some other image file format. The "-script" option can
72be used to switch from processing command line options, to reading options from
73a file or pipeline.
anthony79da7032012-03-19 05:22:12 +000074
anthony79da7032012-03-19 05:22:12 +000075.TP
76.B magick-script
Chasarr7a0394f2020-10-11 17:25:59 +020077This command is similar to magick(1) but with an implied "-script" option. It
Taoufik Rida Bouftassa2514e82020-04-27 13:31:34 +000078is useful in special "#!/usr/bin/env magick-script" scripts that search for the
79magick-script(1) command anywhere along the users PATH, rather than in a
80hardcorded command location.
anthony79da7032012-03-19 05:22:12 +000081
82.TP
cristy3ed852e2009-09-05 21:47:34 +000083.B convert
Taoufik Rida Bouftassa2514e82020-04-27 13:31:34 +000084Available for Backward compatiblity with ImageMagick's version 6 convert(1).
85Essentially, it is just an alias to a restrictive form of the magick(1)
86command, which should be used instead.
cristy3ed852e2009-09-05 21:47:34 +000087
cristy3ed852e2009-09-05 21:47:34 +000088.TP
89.B mogrify
Taoufik Rida Bouftassa2514e82020-04-27 13:31:34 +000090Resize an image, blur, crop, despeckle, dither, draw on, flip, join, re-sample,
91and much more. This command overwrites the original image file, whereas
92convert(1) writes to a different image file.
cristy3ed852e2009-09-05 21:47:34 +000093
cristy3ed852e2009-09-05 21:47:34 +000094.TP
anthony79da7032012-03-19 05:22:12 +000095.B identify
Taoufik Rida Bouftassa2514e82020-04-27 13:31:34 +000096Describe the format and characteristics of one or more image files.
anthony79da7032012-03-19 05:22:12 +000097
anthony79da7032012-03-19 05:22:12 +000098.TP
cristy3ed852e2009-09-05 21:47:34 +000099.B composite
Taoufik Rida Bouftassa2514e82020-04-27 13:31:34 +0000100Overlap one image over another.
cristy3ed852e2009-09-05 21:47:34 +0000101
cristy3ed852e2009-09-05 21:47:34 +0000102.TP
103.B montage
Taoufik Rida Bouftassa2514e82020-04-27 13:31:34 +0000104Create a composite image by combining several separate ones. The images are
105tiled on the composite image, optionally adorned with a border, frame, image
106name, and more.
cristy3ed852e2009-09-05 21:47:34 +0000107
cristy3ed852e2009-09-05 21:47:34 +0000108.TP
109.B compare
Taoufik Rida Bouftassa2514e82020-04-27 13:31:34 +0000110Mathematically and visually annotate the difference between an image and its
111reconstruction.
cristy3ed852e2009-09-05 21:47:34 +0000112
113.TP
114.B stream
Taoufik Rida Bouftassa2514e82020-04-27 13:31:34 +0000115Stream one or more pixel components of the image or portion of the image to
116your choice of storage formats. It writes the pixel components as they are read
117from the input image, a row at a time, making stream(1) desirable when working
118with large images, or when you require raw pixel components.
cristy3ed852e2009-09-05 21:47:34 +0000119
120.TP
121.B display
Taoufik Rida Bouftassa2514e82020-04-27 13:31:34 +0000122Display an image or image sequence on any X server.
cristy3ed852e2009-09-05 21:47:34 +0000123
cristy3ed852e2009-09-05 21:47:34 +0000124.TP
125.B animate
Taoufik Rida Bouftassa2514e82020-04-27 13:31:34 +0000126Animate an image sequence on any X server.
cristy3ed852e2009-09-05 21:47:34 +0000127
cristy3ed852e2009-09-05 21:47:34 +0000128.TP
129.B import
Taoufik Rida Bouftassa2514e82020-04-27 13:31:34 +0000130Save any visible window on any X server and output it as an image file. You can
131capture a single window, the entire screen, or any rectangular portion of the
132it.
cristy3ed852e2009-09-05 21:47:34 +0000133
cristy3ed852e2009-09-05 21:47:34 +0000134.TP
135.B conjure
Taoufik Rida Bouftassa2514e82020-04-27 13:31:34 +0000136Interpret and execute scripts written in the Magick Scripting Language (MSL).
cristy3ed852e2009-09-05 21:47:34 +0000137
cristy3ed852e2009-09-05 21:47:34 +0000138.PP
Taoufik Rida Bouftassa2514e82020-04-27 13:31:34 +0000139For more information about the ImageMagick, point your browser to
140file://@DOCUMENTATION_PATH@/index.html or
141https://imagemagick.org/.
142
cristy3ed852e2009-09-05 21:47:34 +0000143.SH SEE ALSO
Taoufik Rida Bouftassa2514e82020-04-27 13:31:34 +0000144convert(1),
145compare(1),
146composite(1),
147conjure(1),
148identify(1),
149import(1),
150magick(1),
151magick-script(1),
152montage(1),
153display(1),
154animate(1),
155import(1),
156Magick++-config(1),
157MagickCore-config(1),
158MagickWand-config(1)
cristy3ed852e2009-09-05 21:47:34 +0000159
160.SH COPYRIGHT
Taoufik Rida Bouftassa2514e82020-04-27 13:31:34 +0000161\fBCopyright (C) 1999-2020 ImageMagick Studio LLC. Additional copyrights and
162licenses apply to this software, see
163file://@DOCUMENTATION_PATH@/www/license.html or
164https://imagemagick.org/script/license.php\fP