File: conjure.tex

package info (click to toggle)
imagemagick 6:6.0.6.2-2.9
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 33,284 kB
  • ctags: 14,844
  • sloc: ansic: 190,790; cpp: 17,203; sh: 8,740; perl: 4,190; makefile: 1,740; tcl: 459
file content (282 lines) | stat: -rw-r--r-- 7,667 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
\title{ImageMagick - Process a Magick Scripting Language (MSL) Script}
\toctitle{ImageMagick - Process a Magick Scripting Language (MSL) Script}
\titlerunning{ImageMagick - Process a Magick Scripting Language (MSL) Script}
\maketitle\label{ImageMagick - Process a Magick Scripting Language (MSL) Script}

\section{NAME}
conjure - process a Magick Scripting Language (MSL) script

{\bf WARNING: Conjure and MSL are in very early development and the
syntax is subject to change{!}}


\section{Synopsis}

{\bf conjure} {\bf [} {\it options\/} {\bf ]} {\it script.msl\/}
{\bf [ [} {\it options\/} {\bf ]} {\it script.msl\/} {\bf ]}


\section{Description}

The Magick scripting language (MSL) will primarily
benefit those that want to accomplish custom image processing tasks but
do not wish to program, or those that do not have access to a Perl
interpreter or a compiler.  The interpreter is called conjure and here
is an example script:

\begin{verbatim}
    <?xml version="1.0" encoding="UTF-8"?>
    <image size="400x400" >
      <read filename="image.gif" />
      <get width="base-width" height="base-height" />
      <resize geometry="%[dimensions]" />
      <get width="width" height="height" />
      <print output=
        "Image sized from %[base-width]x%[base-height]
         to %[width]x%[height].\n" />
      <write filename="image.png" />
    </image>
\end{verbatim}

invoked with

\begin{verbatim}
    conjure -dimensions 400x400 incantation.msl
\end{verbatim}

All operations will closely follow the key/value pairs defined in
PerlMagick, unless otherwise noted.


{\bf Conjure} is in the early stages of development as of
April 2002.


This early announcement is to allow ImageMagick users to contribute ideas 
early in the process so when the scripting language is released it will
be useful/stable from the get-go{!}  If you want to contribute suggestions
about the Magick scripting language (MSL), post them to
magick-developers@imagemagick.org.



\section{Options}

Options are processed in command line order. Any option you specify on
the command line remains in effect until it is explicitly changed by specifying
the option again with a different effect, or if it is changed by a statement
in the scripting language.


You can define your own keyword/value pairs on the command line.
The script can then use this information when setting values by including
\%[keyword] in the string.  For example, if you included
``-dimensions 400x400'' on the command line, as illustrated above,
then any string
containing ``\%[dimensions]'' would have 400x400 substituted.
The ``\%[string]'' can be used either an entire string, such as
geometry=``\%[dimensions]'' or as a part of a string such as
filename=``\%[basename].png''.

The keyword can be any string except for the following reserved
strings (in any upper, lower, or mixed case variant): {\bf debug},
{\bf help}, and {\bf verbose}, whose usage is described below.

The value can be any string.  If
either the keyword or the value contains white space or any
symbols that have special meanings to your shell such as ``\#'',
``$|$'',
or
``\%", enclose the string in quotation marks or use "\'' to escape the white
space and special symbols.

Keywords and values are case dependent.  ``Key'',
``key'',
and ``KEY'' would
be three different keywords.


For a more detailed description of each option, see
{\it ImageMagick(1)\/}.


\subsubsection{-debug $<$events$>$}
enable debug printout
\subsubsection{-help}
print usage instructions
\subsubsection{-log $<$string$>$}
\subsubsection{-verbose}
print detailed information about the image
\subsubsection{-version}
print ImageMagick version string


\section{Magick Scripting Language}
The Magick Scripting Language (MSL) presently defines the following
elements and their attributes:
\begin{description}
\item{$<$image$>$}
Define a new image object.
{\bf $<$/image$>$} destroys it. Because of this, if you wish
to reference multiple ``subimages'' (aka pages or layers),
you can embed one {\bf image} element inside of
another. For example:


\begin{verbatim}
    <image>
    <read filename="input.png" />
    <get width="base-width" height="base-height" />
    <image height="base-height" width="base-width">
    <image />
    <write filename="output.mng" />
    </image>
\end{verbatim}


\begin{verbatim}
    <image size="400x400" />
\end{verbatim}

\item{$<$group$>$}
Define a new group of image objects.
By default, images are only valid for the life of
their {\bf $<$image$>$}element.


\begin{verbatim}
    <image>   -- creates the image
    .....     -- do stuff with it
    </image>  -- dispose of the image
\end{verbatim}


However, in a group, all images in that group will stay 
around for the life of the group:


\begin{verbatim}
    <group>                           -- start a group
        <image>                       -- create an image
        ....                          -- do stuff
        </image>                      -- NOOP
        <image>                       -- create another image
        ....                          -- do more stuff
        </image>                      -- NOOP
        <write filename="image.mng" />  -- output
    </group>                          -- dispose of both images
\end{verbatim}

\item{$<$read$>$}
Read a new image from a disk file.


\begin{verbatim}
    <read filename="image.gif" />
\end{verbatim}

To read two images use


\begin{verbatim}
    <read filename="image.gif" />
    <read filename="image.png />
\end{verbatim}

\item{$<$write$>$}
Write the image(s) to disk, either as
a single multiple-image file or multiple ones if necessary.


\begin{verbatim}
     <write filename=image.tiff" />
\end{verbatim}
\item{$<$get$>$}
Get any attribute recognized by
PerlMagick's GetAttribute() and stores it as an image attribute for later
use. Currently only {\it width\/} and {\it height\/} are supported.

\begin{verbatim}
    <get width="base-width" height="base-height" />
    <print output="Image size is %[base-width]x%[base-height].\n" />
\end{verbatim}

\item{$<$set$>$}
background, bordercolor, clip-mask, colorspace, density,
magick, mattecolor, opacity.  Set an attribute recognized by
PerlMagick's GetAttribute().
\item{$<$border$>$}
    fill, geometry, height, width
\item{$<$blur$>$}
    radius, sigma
\item{$<$charcoal$>$}
    radius, sigma
\item{$<$chop$>$}
    geometry, height, width, x, y
\item{$<$crop$>$}
    geometry, height, width, x, y
\item{$<$despeckle$>$}
\item{$<$emboss$>$}
    radius, sigma
\item{$<$enhance$>$}
\item{$<$equalize$>$}
\item{$<$flip$>$}
\item{$<$flop$>$}
\item{$<$frame$>$}
    fill, geometry, height, width, x, y, inner, outer
\item{$<$get$>$}
    height, width
\item{$<$image$>$}
    background, color, id, size
\item{$<$magnify$>$}
\item{$<$minify$>$}
\item{$<$normalize$>$}
\item{$<$print$>$}
    output
\item{$<$read$>$}
\item{$<$resize$>$}
    blur, filter, geometry, height, width
\item{$<$roll$>$}
    geometry, x, y
\item{$<$rotate$>$}
    degrees
\item{$<$sample$>$}
    geometry, height, width
\item{$<$scale$>$}
    geometry, height, width
\item{$<$sharpen$>$}
    radius, sigma
\item{$<$shave$>$}
    geometry, height, width
\item{$<$shear$>$}
    x, y
\item{$<$solarize$>$}
    threshold
\item{$<$spread$>$}
    radius
\item{$<$stegano$>$}
    image
\item{$<$stereo$>$}
    image
\item{$<$swirl$>$}
    degrees
\item{$<$texture$>$}
    image
\item{$<$threshold$>$}
    threshold
\item{$<$transparent$>$}
    color
\item{$<$trim$>$}
\end{description}


\section{Authors}

{\it 
John Cristy, ImageMagick Studio LLC,\newline{}
Glenn Randers-Pehrson, ImageMagick Studio LLC,\newline{}
Leonard Rosenthol, ImageMagick Studio LLC.
\/}