gimptool.1.in 7.78 KB
Newer Older
1
.TH GIMPTOOL\-2.0 1 "Version @GIMP_VERSION@" "GIMP Manual Pages"
2

3
.SH NAME
4 5 6
gimptool\-2.0 - script to perform various GIMPy functions


7
.SH SYNOPSIS
8
.B gimptool\-2.0
9
[\-\-prefix\fI[=DIR]\fP] [\-\-exec\-prefix\fI[=DIR]\fP] [\-\-version]
10
[\-\-help] [\-\-quiet] [\-\-silent] [\-n] [\-\-just-print] [\-\-dry-run]
11 12
[\-\-recon] [\-\-msvc-syntax]
[\-\-bindir] [\-\-sbindir] [\-\-libexecdir] [\-\-datadir]
13 14 15 16
[\-\-sysconfdir] [\-\-sharedstatedir] [\-\-localstatedir] [-\-libdir]
[\-\-infodir] [\-\-mandir] [\-\-includedir] [\-\-gimpplugindir]
[\-\-gimpdatadir] [\-\-libs] [\-\-libs-noui] [\-\-cflags] [\-\-cflags-noi]
[\-\-build \fIplug\-in.c\fP]
17 18 19
[\-\-build\-strip \fIplug\-in.c\fP] [\-\-install \fIplug\-in.c\fP]
[\-\-install-strip \fIplug\-in.c\fP] [\-\-install-admin \fIplug-in.c\fP] 
[\-\-install\-bin \fIplug\-in\fP]
20 21 22 23
[\-\-install\-admin\-strip \fIplug-in.c\fP]
[\-\-install\-bin\-strip \fIplug\-in\fP]
[\-\-\install\-admin\-bin \fIplug\-in\fP]
[\-\-install\-script \fIscript.scm\fP] 
24 25
[\-\-\install\-admin\-script \fIscript.scm\fP]
[\-\-uninstall\-bin \fIplug\-in\fP] [\-\-uninstall\-admin\-bin \fIplug\-in\fP]
26 27
[\-\-uninstall\-script \fIscript.scm\fP]
[\-\-uninstall\-admin\-script \fIscript.scm\fP]
28 29 30 31


.SH DESCRIPTION
.PP
32
\fIgimptool\-2.0\fP is a tool that can, among other things, build
33 34
plug-ins or scripts and install them if they are distributed in one
source file.
35
.PP
36
\fIgimptool\-2.0\fP can also be used by programs that need to know what
37 38 39
libraries and include-paths \fIGIMP\fP was compiled with. \fIgimptool\-2.0\fP
uses \fIpkg-config\fP for this task. For use in Makefiles, it is recommended
that you use \fIpkg-config\fP directly instead of calling \fIgimptool\-2.0\fP.
40

41

42
.SH OPTIONS
43
\fIgimptool\-2.0\fP accepts the following options:
44 45
.TP 8
.B  \-\-version
46
Print the currently installed version of \fIGIMP\fP on the standard output.
47 48 49 50 51 52 53 54 55 56 57
.TP 8
.B \-\-help
Print out the help blurb, showing commonly used commandline options.
.TP 8
.B \-\-quiet
Run quietly without echoing any of the build commands.
.TP 8
.B \-\-silent
Run silently without echoing any of the build commands. Same as \-\-quiet.
.TP 8
.B \-n
58
Test mode. Print the commands but don't actually execute them. Useful for
59 60 61
making dry runs for testing.
.TP 8
.B \-\-just-print
62
Test mode. Print the commands but don't actually execute them. Same as \-n.
63 64
.TP 8
.B \-\-dry-run
65
Test mode. Print the commands but don't actually execute them. Same as \-n.
66 67
.TP 8
.B \-\-recon
68
Test mode. Print the commands but don't actually execute them. Same as \-n.
69
.TP 8
70 71 72 73 74
.B \-\-msvc-syntax
Useful on Windows. Outputs the compiler and linker flags in the syntax
used by Microsoft's toolchain. Passed to the pkg-config command that
does most of \fIgimptool\-2.0\fP's work.
.TP 8
75
.B \-\-bindir
76
Outputs the bindir used to install the \fIGIMP\fP.
77 78
.TP 8
.B \-\-sbindir
79
Outputs the sbindir used to install the \fIGIMP\fP.
80 81
.TP 8
.B \-\-libexecdir
82
Outputs the libexecdir used to install the \fIGIMP\fP.
83 84
.TP 8
.B \-\-datadir
85
Outputs the datadir used to install the \fIGIMP\fP.
86 87
.TP 8
.B \-\-sysconfdir
88
Outputs the sysconfdir used to install the \fIGIMP\fP.
89 90
.TP 8
.B \-\-sharedstatedir
91
Outputs the sharedstatedir used to install the \fIGIMP\fP.
92 93
.TP 8
.B \-\-localstatedir
94
Outputs the localstatedir used to install the \fIGIMP\fP.
95 96
.TP 8
.B \-\-libdir
97
Outputs the libdir used to install the \fIGIMP\fP.
98 99
.TP 8
.B \-\-infodir
100
Outputs the infodir used to install the \fIGIMP\fP.
101 102
.TP 8
.B \-\-mandir
103
Outputs the mandir used to install the \fIGIMP\fP.
104 105
.TP 8
.B \-\-includedir
106
Outputs the includedir used to install the \fIGIMP\fP.
107 108
.TP 8
.B \-\-gimpdatadir
109
Outputs the actual directory where the \fIGIMP\fP data files were installed.
110 111
.TP 8
.B \-\-gimpplugindir
112
Outputs the actual directory where the \fIGIMP\fP plug-ins were installed.
113 114
.TP 8
.B  \-\-build \fIplug-in.c\fP
115
Compile and link \fIplug-in.c\fP into a \fIGIMP\fP plug-in.
116 117
.TP 8
.B  \-\-build\-strip \fIplug-in.c\fP
118
Compile,link, and strip \fIplug-in.c\fP into a \fIGIMP\fP plug-in.
119 120
.TP 8
.B  \-\-install \fIplug-in.c\fP
121
Compile, link, and install \fIplug-in.c\fP into the user's personal
122
\fIGIMP\fP plug-in directory (@manpage_gimpdir@/plug-ins)
123 124
.TP 8
.B  \-\-install\-strip \fIplug-in.c\fP
125 126
Compile, link,strip, and install \fIplug-in.c\fP into the user's
personal \fIGIMP\fP
127
plug-in directory (@manpage_gimpdir@/plug-ins)
128 129
.TP 8
.B  \-\-install\-admin \fIplug-in.c\fP
130
Compile, link, and install \fIplug-in.c\fP into the system-wide \fIGIMP\fP
131 132 133
plug-in directory (@gimpplugindir@/plug-ins)
.TP 8
.B  \-\-install\-bin \fIplug-in\fP
134
Install \fIplug-in\fP into the user's personal \fIGIMP\fP
135
plug-in directory (@manpage_gimpdir@/plug-ins)
136 137
.TP 8
.B  \-\-install\-admin\-bin \fIplug-in\fP
138
Install \fIplug-in\fP into the system-wide \fIGIMP\fP
139 140 141
plug-in directory (@gimpplugindir@/plug-ins)
.TP 8
.B  \-\-install\-bin\-strip \fIplug-in\fP
142
Install stripped \fIplug-in\fP into the user's personal \fIGIMP\fP
143
plug-in directory (@manpage_gimpdir@/plug-ins)
144 145
.TP 8
.B  \-\-install\-admin\-bin\-strip \fIplug-in\fP
146
Install stripped \fIplug-in\fP into the system-wide \fIGIMP\fP
147 148 149
plug-in directory (@gimpplugindir@/plug-ins)
.TP 8
.B  \-\-install\-script \fIscript.scm\fP
150
Install \fIscript.scm\fP into the user's personal \fIGIMP\fP
151
script directory (@manpage_gimpdir@/scripts)
152 153
.TP 8
.B  \-\-install\-admin\-script \fIscript.scm\fP
154
Install \fIscript.scm\fP into the system-wide \fIGIMP\fP
155 156 157
script directory (@gimpdatadir@/scripts)
.TP 8
.B  \-\-uninstall\-bin \fIplug-in\fP
158
Uninstall \fIplug-in\fP from the user's personal \fIGIMP\fP
159
plug-in directory (@manpage_gimpdir@/plug-ins)
160 161
.TP 8
.B  \-\-uninstall\-admin\-bin \fIplug-in\fP
162
Uninstall \fIplug-in\fP from the system-wide \fIGIMP\fP
163 164 165
plug-in directory (@gimpplugindir@/plug-ins)
.TP 8
.B  \-\-uninstall\-script \fIscript.scm\fP
166
Uninstall \fIscript.scm\fP from the user's personal \fIGIMP\fP
167
script directory (@manpage_gimpdir@/scripts)
168 169
.TP 8
.B  \-\-uninstall\-admin\-script \fIscript.scm\fP
170
Uninstall \fIscript.scm\fP from the system-wide \fIGIMP\fP
171 172 173
script directory (@gimpdatadir@/scripts)
.TP 8
.B  \-\-libs
174
Print the linker flags that are necessary to link a \fIGIMP\fP plug-in.
175 176
.TP 8
.B \-\-libs-noui
177
Print the linker flags that are necessary to link a \fIGIMP\fP plug-in, for
178
plug-ins that do not require the GTK+ libraries.
179 180
.TP 8
.B  \-\-cflags
181
Print the compiler flags that are necessary to compile a \fIGIMP\fP plug-in.
182 183
.TP 8
.B \-\-clags-noui
184
Print the compiler flags that are necessary to compile a \fIGIMP\fP plug-in
185
for plug-ins that do not require the GTK+ libraries.
186 187
.TP 8
.B  \-\-prefix=PREFIX
188
If specified, use PREFIX instead of the installation prefix that \fIGIMP\fP
189 190 191 192 193 194 195
was built with when computing the output for the \-\-cflags and
\-\-libs options. This option is also used for the exec prefix
if \-\-exec\-prefix was not specified. This option must be specified
before any \-\-libs or \-\-cflags options.
.TP 8
.B  \-\-exec\-prefix=PREFIX
If specified, use PREFIX instead of the installation exec prefix that
196
\fIGIMP\fP was built with when computing the output for the \-\-cflags
197 198 199
and \-\-libs options. This option must be specified before any
\-\-libs or \-\-cflags options.

200

201 202 203 204 205 206 207 208 209 210
.SH ENVIRONMENT
.PP
.TP 8
.B CC
to get the name of the desired C compiler.
.TP 8
.B CFLAGS
to get the preferred flags to pass to the C compiler for plug-in building.
.TP 8
.B LDFLAGS
Sven Neumann's avatar
Sven Neumann committed
211
to get the preferred flags for passing to the linker.
212 213 214 215
.TP 8
.B LIBS
for passing extra libs that may be needed in the build process. For example,
LIBS=-lintl .
216 217
.TP 8
.B PKG_CONFIG
218 219
to get the location of the \fIpkg-config\fP program that is used to determine
details about your glib, pango, gtk+ and gimp installation.
220

221

222 223
.SH SEE ALSO
.BR gimp (1), 
224
.BR gimprc (5),
225 226
.BR pkg\-config (1)

227 228

.SH AUTHORS
229
gimptool was written by Manish Singh (yosh@gimp.org) and is based on
230
gtk\-config by Owen Taylor (owen@gtk.org).
231 232 233 234 235

This man page was written by Ben Gertzfield (che@debian.org), and tweaked
by Manish Singh (yosh@gimp.org), Adrian Likins (adrian@gimp.org) and Marc
Lehmann (pcg@goof.com>).