Taoufik Rida Bouftass | a2514e8 | 2020-04-27 13:31:34 +0000 | [diff] [blame] | 1 | .TH ImageMagick 1 "2020-04-25" "ImageMagick" |
| 2 | |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 3 | .SH NAME |
Taoufik Rida Bouftass | a2514e8 | 2020-04-27 13:31:34 +0000 | [diff] [blame] | 4 | ImageMagick \- a free software suite for the creation, modification and |
| 5 | display of bitmap images. |
| 6 | |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 7 | .SH SYNOPSIS |
anthony | 79da703 | 2012-03-19 05:22:12 +0000 | [diff] [blame] | 8 | \fBmagick\fP [\fIoptions\fP|\fIinput-file\fP]... \fIoutput-file\fP |
| 9 | \fBmagick-script\fP \fIscript-file\fP [\fIscript-arguments\fP]... |
Taoufik Rida Bouftass | a2514e8 | 2020-04-27 13:31:34 +0000 | [diff] [blame] | 10 | |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 11 | .SH OVERVIEW |
| 12 | |
Taoufik Rida Bouftass | a2514e8 | 2020-04-27 13:31:34 +0000 | [diff] [blame] | 13 | Use ImageMagick\[rg] to create, edit, compose, or convert bitmap images. It can |
| 14 | read and write images in a variety of formats (over 200) including PNG, JPEG, |
| 15 | GIF, HEIC, TIFF, DPX, EXR, WebP, Postscript, PDF, and SVG. Use ImageMagick to |
| 16 | resize, flip, mirror, rotate, distort, shear and transform images, adjust image |
| 17 | colors, apply various special effects, or draw text, lines, polygons, ellipses |
| 18 | and B\['e]zier curves. |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 19 | |
Taoufik Rida Bouftass | a2514e8 | 2020-04-27 13:31:34 +0000 | [diff] [blame] | 20 | The functionality of ImageMagick is typically utilized from the command-line. |
| 21 | It can also be accessed from programs written in your favorite language using |
| 22 | the corresponding interface: G2F (Ada), MagickCore (C), MagickWand (C), |
| 23 | ChMagick (Ch), ImageMagickObject (COM+), Magick++ (C++), JMagick (Java), |
| 24 | JuliaIO (Julia), L-Magick (Lisp), Lua (LuaJIT), NMagick (Neko/haXe), Magick.NET |
| 25 | (.NET), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), |
| 26 | IMagick (PHP), PythonMagick (Python), magick (R), RMagick (Ruby), or TclMagick |
| 27 | (Tcl/TK). With a language interface, use ImageMagick to modify or create images |
| 28 | dynamically and automagically. |
Cristy | 40d0cb3 | 2018-09-15 15:15:04 -0400 | [diff] [blame] | 29 | |
Taoufik Rida Bouftass | a2514e8 | 2020-04-27 13:31:34 +0000 | [diff] [blame] | 30 | ImageMagick utilizes multiple computational threads to increase performance. |
| 31 | It can read, process, or write mega-, giga-, or tera-pixel image sizes. |
Cristy | 40d0cb3 | 2018-09-15 15:15:04 -0400 | [diff] [blame] | 32 | |
Taoufik Rida Bouftass | a2514e8 | 2020-04-27 13:31:34 +0000 | [diff] [blame] | 33 | ImageMagick is free software delivered as a ready-to-run binary distribution, |
| 34 | or as source code that you may use, copy, modify, and distribute in both open |
| 35 | and proprietary applications. It is distributed under a derived Apache 2.0 |
| 36 | license. |
Cristy | 40d0cb3 | 2018-09-15 15:15:04 -0400 | [diff] [blame] | 37 | |
Taoufik Rida Bouftass | a2514e8 | 2020-04-27 13:31:34 +0000 | [diff] [blame] | 38 | The ImageMagick development process ensures a stable API and ABI. Before each |
| 39 | ImageMagick release, we perform a comprehensive security assessment that |
| 40 | includes memory error, thread data race detection, and continuous fuzzing to |
| 41 | help prevent security vulnerabilities. |
Cristy | 40d0cb3 | 2018-09-15 15:15:04 -0400 | [diff] [blame] | 42 | |
Taoufik Rida Bouftass | a2514e8 | 2020-04-27 13:31:34 +0000 | [diff] [blame] | 43 | The current release is ImageMagick 7.0.8-11. It runs on Linux, Windows, Mac Os |
| 44 | X, iOS, Android OS, and others. We continue to maintain the legacy release of |
| 45 | ImageMagick, version 6, at https://legacy.imagemagick.org. |
Cristy | 40d0cb3 | 2018-09-15 15:15:04 -0400 | [diff] [blame] | 46 | |
Taoufik Rida Bouftass | a2514e8 | 2020-04-27 13:31:34 +0000 | [diff] [blame] | 47 | The authoritative ImageMagick web site is https://imagemagick.org. The |
| 48 | authoritative source code repository is https://github.com/ImageMagick. We |
| 49 | maintain a source code mirror at https://gitlab.com/ImageMagick. |
Cristy | 40d0cb3 | 2018-09-15 15:15:04 -0400 | [diff] [blame] | 50 | |
Taoufik Rida Bouftass | a2514e8 | 2020-04-27 13:31:34 +0000 | [diff] [blame] | 51 | ImageMagick is a suite of command-line utilities for manipulating images. You |
| 52 | may have edited images at one time or another using programs such as GIMP or |
| 53 | Photoshop, which expose their functionality mainly through a graphical user |
| 54 | interface. However, a GUI program is not always the right tool. Suppose you |
| 55 | want to process an image dynamically from a web script, or you want to apply |
| 56 | the same operations to many images, or repeat a specific operation at different |
| 57 | times to the same or different image. For these types of operations, a |
| 58 | command-line utility is more suitable. |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 59 | |
Taoufik Rida Bouftass | a2514e8 | 2020-04-27 13:31:34 +0000 | [diff] [blame] | 60 | The remaining of this manpage is a list of the available command-line utilities |
| 61 | and their short descriptions. For further documentation conserning a |
| 62 | particular command and its options, consult the corresponding manpage. If you |
| 63 | are just getting aquainted with ImageMagick, start at the top of that list, the |
| 64 | magick(1) program, and work your way down. Also, make sure to check out Anthony |
| 65 | Thyssen's tutorial on how to use ImageMagick utilities to convert, compose, or |
| 66 | edit images from the command-line. |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 67 | |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 68 | .TP |
anthony | 79da703 | 2012-03-19 05:22:12 +0000 | [diff] [blame] | 69 | .B magick |
Taoufik Rida Bouftass | a2514e8 | 2020-04-27 13:31:34 +0000 | [diff] [blame] | 70 | Read images into memory, perform operations on those images, and write them out |
| 71 | to either the same or some other image file format. The "-script" option can |
| 72 | be used to switch from processing command line options, to reading options from |
| 73 | a file or pipeline. |
anthony | 79da703 | 2012-03-19 05:22:12 +0000 | [diff] [blame] | 74 | |
anthony | 79da703 | 2012-03-19 05:22:12 +0000 | [diff] [blame] | 75 | .TP |
| 76 | .B magick-script |
Chasarr | 7a0394f | 2020-10-11 17:25:59 +0200 | [diff] [blame] | 77 | This command is similar to magick(1) but with an implied "-script" option. It |
Taoufik Rida Bouftass | a2514e8 | 2020-04-27 13:31:34 +0000 | [diff] [blame] | 78 | is useful in special "#!/usr/bin/env magick-script" scripts that search for the |
| 79 | magick-script(1) command anywhere along the users PATH, rather than in a |
| 80 | hardcorded command location. |
anthony | 79da703 | 2012-03-19 05:22:12 +0000 | [diff] [blame] | 81 | |
| 82 | .TP |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 83 | .B convert |
Taoufik Rida Bouftass | a2514e8 | 2020-04-27 13:31:34 +0000 | [diff] [blame] | 84 | Available for Backward compatiblity with ImageMagick's version 6 convert(1). |
| 85 | Essentially, it is just an alias to a restrictive form of the magick(1) |
| 86 | command, which should be used instead. |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 87 | |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 88 | .TP |
| 89 | .B mogrify |
Taoufik Rida Bouftass | a2514e8 | 2020-04-27 13:31:34 +0000 | [diff] [blame] | 90 | Resize an image, blur, crop, despeckle, dither, draw on, flip, join, re-sample, |
| 91 | and much more. This command overwrites the original image file, whereas |
| 92 | convert(1) writes to a different image file. |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 93 | |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 94 | .TP |
anthony | 79da703 | 2012-03-19 05:22:12 +0000 | [diff] [blame] | 95 | .B identify |
Taoufik Rida Bouftass | a2514e8 | 2020-04-27 13:31:34 +0000 | [diff] [blame] | 96 | Describe the format and characteristics of one or more image files. |
anthony | 79da703 | 2012-03-19 05:22:12 +0000 | [diff] [blame] | 97 | |
anthony | 79da703 | 2012-03-19 05:22:12 +0000 | [diff] [blame] | 98 | .TP |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 99 | .B composite |
Taoufik Rida Bouftass | a2514e8 | 2020-04-27 13:31:34 +0000 | [diff] [blame] | 100 | Overlap one image over another. |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 101 | |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 102 | .TP |
| 103 | .B montage |
Taoufik Rida Bouftass | a2514e8 | 2020-04-27 13:31:34 +0000 | [diff] [blame] | 104 | Create a composite image by combining several separate ones. The images are |
| 105 | tiled on the composite image, optionally adorned with a border, frame, image |
| 106 | name, and more. |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 107 | |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 108 | .TP |
| 109 | .B compare |
Taoufik Rida Bouftass | a2514e8 | 2020-04-27 13:31:34 +0000 | [diff] [blame] | 110 | Mathematically and visually annotate the difference between an image and its |
| 111 | reconstruction. |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 112 | |
| 113 | .TP |
| 114 | .B stream |
Taoufik Rida Bouftass | a2514e8 | 2020-04-27 13:31:34 +0000 | [diff] [blame] | 115 | Stream one or more pixel components of the image or portion of the image to |
| 116 | your choice of storage formats. It writes the pixel components as they are read |
| 117 | from the input image, a row at a time, making stream(1) desirable when working |
| 118 | with large images, or when you require raw pixel components. |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 119 | |
| 120 | .TP |
| 121 | .B display |
Taoufik Rida Bouftass | a2514e8 | 2020-04-27 13:31:34 +0000 | [diff] [blame] | 122 | Display an image or image sequence on any X server. |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 123 | |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 124 | .TP |
| 125 | .B animate |
Taoufik Rida Bouftass | a2514e8 | 2020-04-27 13:31:34 +0000 | [diff] [blame] | 126 | Animate an image sequence on any X server. |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 127 | |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 128 | .TP |
| 129 | .B import |
Taoufik Rida Bouftass | a2514e8 | 2020-04-27 13:31:34 +0000 | [diff] [blame] | 130 | Save any visible window on any X server and output it as an image file. You can |
| 131 | capture a single window, the entire screen, or any rectangular portion of the |
| 132 | it. |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 133 | |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 134 | .TP |
| 135 | .B conjure |
Taoufik Rida Bouftass | a2514e8 | 2020-04-27 13:31:34 +0000 | [diff] [blame] | 136 | Interpret and execute scripts written in the Magick Scripting Language (MSL). |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 137 | |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 138 | .PP |
Taoufik Rida Bouftass | a2514e8 | 2020-04-27 13:31:34 +0000 | [diff] [blame] | 139 | For more information about the ImageMagick, point your browser to |
| 140 | file://@DOCUMENTATION_PATH@/index.html or |
| 141 | https://imagemagick.org/. |
| 142 | |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 143 | .SH SEE ALSO |
Taoufik Rida Bouftass | a2514e8 | 2020-04-27 13:31:34 +0000 | [diff] [blame] | 144 | convert(1), |
| 145 | compare(1), |
| 146 | composite(1), |
| 147 | conjure(1), |
| 148 | identify(1), |
| 149 | import(1), |
| 150 | magick(1), |
| 151 | magick-script(1), |
| 152 | montage(1), |
| 153 | display(1), |
| 154 | animate(1), |
| 155 | import(1), |
| 156 | Magick++-config(1), |
| 157 | MagickCore-config(1), |
| 158 | MagickWand-config(1) |
cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 159 | |
| 160 | .SH COPYRIGHT |
Taoufik Rida Bouftass | a2514e8 | 2020-04-27 13:31:34 +0000 | [diff] [blame] | 161 | \fBCopyright (C) 1999-2020 ImageMagick Studio LLC. Additional copyrights and |
| 162 | licenses apply to this software, see |
| 163 | file://@DOCUMENTATION_PATH@/www/license.html or |
| 164 | https://imagemagick.org/script/license.php\fP |