gimptool.1.in 7.49 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 11 12 13 14 15
[\-\-help] [\-\-quiet] [\-\-silent] [\-n] [\-\-just-print] [\-\-dry-run]
[\-\-recon] [\-\-bindir] [\-\-sbindir] [\-\-libexecdir] [\-\-datadir]
[\-\-sysconfdir] [\-\-sharedstatedir] [\-\-localstatedir] [-\-libdir]
[\-\-infodir] [\-\-mandir] [\-\-includedir] [\-\-gimpplugindir]
[\-\-gimpdatadir] [\-\-libs] [\-\-libs-noui] [\-\-cflags] [\-\-cflags-noi]
[\-\-build \fIplug\-in.c\fP]
16 17 18
[\-\-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]
19 20 21 22
[\-\-install\-admin\-strip \fIplug-in.c\fP]
[\-\-install\-bin\-strip \fIplug\-in\fP]
[\-\-\install\-admin\-bin \fIplug\-in\fP]
[\-\-install\-script \fIscript.scm\fP] 
23 24
[\-\-\install\-admin\-script \fIscript.scm\fP]
[\-\-uninstall\-bin \fIplug\-in\fP] [\-\-uninstall\-admin\-bin \fIplug\-in\fP]
25 26
[\-\-uninstall\-script \fIscript.scm\fP]
[\-\-uninstall\-admin\-script \fIscript.scm\fP]
27 28 29 30


.SH DESCRIPTION
.PP
31
\fIgimptool\-2.0\fP is a tool that can, among other things, build
32 33
plug-ins or scripts and install them if they are distributed in one
source file.
34
.PP
35
\fIgimptool\-2.0\fP can also be used by programs that need to know what
36 37
libraries and include-paths \fIGIMP\fP was compiled with. This is
especially useful in Makefiles.
38

39

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

194

195 196 197 198 199 200 201 202 203
.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
204 205 206
.B DESTDIR
to add a prefix to the install/uninstall path.
.TP 8
207
.B LDFLAGS
Sven Neumann's avatar
Sven Neumann committed
208
to get the preferred flags for passing to the linker.
209 210 211 212
.TP 8
.B LIBS
for passing extra libs that may be needed in the build process. For example,
LIBS=-lintl .
213 214 215 216
.TP 8
.B PKG_CONFIG
to get the location of the pkg-config program used to determine details
about your glib, pango and gtk+ installation.
217

218

219 220
.SH SEE ALSO
.BR gimp (1), 
221
.BR gimprc (5),
222 223
.BR pkg\-config (1)

224 225

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

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>).