summaryrefslogtreecommitdiffstats
path: root/docs/gimptool.1.in
diff options
context:
space:
mode:
Diffstat (limited to 'docs/gimptool.1.in')
-rw-r--r--docs/gimptool.1.in235
1 files changed, 235 insertions, 0 deletions
diff --git a/docs/gimptool.1.in b/docs/gimptool.1.in
new file mode 100644
index 0000000..2fca41d
--- /dev/null
+++ b/docs/gimptool.1.in
@@ -0,0 +1,235 @@
+.TH GIMPTOOL\-2.0 1 "Version @GIMP_VERSION@" "GIMP Manual Pages"
+
+.SH NAME
+gimptool\-2.0 - script to perform various GIMPy functions
+
+
+.SH SYNOPSIS
+.B gimptool\-2.0
+[\-\-prefix\fI[=DIR]\fP] [\-\-exec\-prefix\fI[=DIR]\fP] [\-\-version]
+[\-\-help] [\-\-quiet] [\-\-silent] [\-n] [\-\-just-print] [\-\-dry-run]
+[\-\-recon] [\-\-msvc-syntax]
+[\-\-bindir] [\-\-sbindir] [\-\-libexecdir] [\-\-datadir]
+[\-\-sysconfdir] [\-\-sharedstatedir] [\-\-localstatedir] [-\-libdir]
+[\-\-infodir] [\-\-mandir] [\-\-includedir] [\-\-gimpplugindir]
+[\-\-gimpdatadir] [\-\-libs] [\-\-libs-noui] [\-\-cflags] [\-\-cflags-noi]
+[\-\-build \fIplug\-in.c\fP]
+[\-\-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]
+[\-\-install\-admin\-strip \fIplug-in.c\fP]
+[\-\-install\-bin\-strip \fIplug\-in\fP]
+[\-\-\install\-admin\-bin \fIplug\-in\fP]
+[\-\-install\-script \fIscript.scm\fP]
+[\-\-\install\-admin\-script \fIscript.scm\fP]
+[\-\-uninstall\-bin \fIplug\-in\fP] [\-\-uninstall\-admin\-bin \fIplug\-in\fP]
+[\-\-uninstall\-script \fIscript.scm\fP]
+[\-\-uninstall\-admin\-script \fIscript.scm\fP]
+
+
+.SH DESCRIPTION
+.PP
+\fIgimptool\-2.0\fP is a tool that can, among other things, build
+plug-ins or scripts and install them if they are distributed in one
+source file.
+.PP
+\fIgimptool\-2.0\fP can also be used by programs that need to know what
+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.
+
+
+.SH OPTIONS
+\fIgimptool\-2.0\fP accepts the following options:
+.TP 8
+.B \-\-version
+Print the currently installed version of \fIGIMP\fP on the standard output.
+.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
+Test mode. Print the commands but don't actually execute them. Useful for
+making dry runs for testing.
+.TP 8
+.B \-\-just-print
+Test mode. Print the commands but don't actually execute them. Same as \-n.
+.TP 8
+.B \-\-dry-run
+Test mode. Print the commands but don't actually execute them. Same as \-n.
+.TP 8
+.B \-\-recon
+Test mode. Print the commands but don't actually execute them. Same as \-n.
+.TP 8
+.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
+.B \-\-bindir
+Outputs the bindir used to install the \fIGIMP\fP.
+.TP 8
+.B \-\-sbindir
+Outputs the sbindir used to install the \fIGIMP\fP.
+.TP 8
+.B \-\-libexecdir
+Outputs the libexecdir used to install the \fIGIMP\fP.
+.TP 8
+.B \-\-datadir
+Outputs the datadir used to install the \fIGIMP\fP.
+.TP 8
+.B \-\-sysconfdir
+Outputs the sysconfdir used to install the \fIGIMP\fP.
+.TP 8
+.B \-\-sharedstatedir
+Outputs the sharedstatedir used to install the \fIGIMP\fP.
+.TP 8
+.B \-\-localstatedir
+Outputs the localstatedir used to install the \fIGIMP\fP.
+.TP 8
+.B \-\-libdir
+Outputs the libdir used to install the \fIGIMP\fP.
+.TP 8
+.B \-\-infodir
+Outputs the infodir used to install the \fIGIMP\fP.
+.TP 8
+.B \-\-mandir
+Outputs the mandir used to install the \fIGIMP\fP.
+.TP 8
+.B \-\-includedir
+Outputs the includedir used to install the \fIGIMP\fP.
+.TP 8
+.B \-\-gimpdatadir
+Outputs the actual directory where the \fIGIMP\fP data files were installed.
+.TP 8
+.B \-\-gimpplugindir
+Outputs the actual directory where the \fIGIMP\fP plug-ins were installed.
+.TP 8
+.B \-\-build \fIplug-in.c\fP
+Compile and link \fIplug-in.c\fP into a \fIGIMP\fP plug-in.
+.TP 8
+.B \-\-build\-strip \fIplug-in.c\fP
+Compile,link, and strip \fIplug-in.c\fP into a \fIGIMP\fP plug-in.
+.TP 8
+.B \-\-install \fIplug-in.c\fP
+Compile, link, and install \fIplug-in.c\fP into the user's personal
+\fIGIMP\fP plug-in directory (@manpage_gimpdir@/plug-ins)
+.TP 8
+.B \-\-install\-strip \fIplug-in.c\fP
+Compile, link,strip, and install \fIplug-in.c\fP into the user's
+personal \fIGIMP\fP
+plug-in directory (@manpage_gimpdir@/plug-ins)
+.TP 8
+.B \-\-install\-admin \fIplug-in.c\fP
+Compile, link, and install \fIplug-in.c\fP into the system-wide \fIGIMP\fP
+plug-in directory (@gimpplugindir@/plug-ins)
+.TP 8
+.B \-\-install\-bin \fIplug-in\fP
+Install \fIplug-in\fP into the user's personal \fIGIMP\fP
+plug-in directory (@manpage_gimpdir@/plug-ins)
+.TP 8
+.B \-\-install\-admin\-bin \fIplug-in\fP
+Install \fIplug-in\fP into the system-wide \fIGIMP\fP
+plug-in directory (@gimpplugindir@/plug-ins)
+.TP 8
+.B \-\-install\-bin\-strip \fIplug-in\fP
+Install stripped \fIplug-in\fP into the user's personal \fIGIMP\fP
+plug-in directory (@manpage_gimpdir@/plug-ins)
+.TP 8
+.B \-\-install\-admin\-bin\-strip \fIplug-in\fP
+Install stripped \fIplug-in\fP into the system-wide \fIGIMP\fP
+plug-in directory (@gimpplugindir@/plug-ins)
+.TP 8
+.B \-\-install\-script \fIscript.scm\fP
+Install \fIscript.scm\fP into the user's personal \fIGIMP\fP
+script directory (@manpage_gimpdir@/scripts)
+.TP 8
+.B \-\-install\-admin\-script \fIscript.scm\fP
+Install \fIscript.scm\fP into the system-wide \fIGIMP\fP
+script directory (@gimpdatadir@/scripts)
+.TP 8
+.B \-\-uninstall\-bin \fIplug-in\fP
+Uninstall \fIplug-in\fP from the user's personal \fIGIMP\fP
+plug-in directory (@manpage_gimpdir@/plug-ins)
+.TP 8
+.B \-\-uninstall\-admin\-bin \fIplug-in\fP
+Uninstall \fIplug-in\fP from the system-wide \fIGIMP\fP
+plug-in directory (@gimpplugindir@/plug-ins)
+.TP 8
+.B \-\-uninstall\-script \fIscript.scm\fP
+Uninstall \fIscript.scm\fP from the user's personal \fIGIMP\fP
+script directory (@manpage_gimpdir@/scripts)
+.TP 8
+.B \-\-uninstall\-admin\-script \fIscript.scm\fP
+Uninstall \fIscript.scm\fP from the system-wide \fIGIMP\fP
+script directory (@gimpdatadir@/scripts)
+.TP 8
+.B \-\-libs
+Print the linker flags that are necessary to link a \fIGIMP\fP plug-in.
+.TP 8
+.B \-\-libs-noui
+Print the linker flags that are necessary to link a \fIGIMP\fP plug-in, for
+plug-ins that do not require the GTK+ libraries.
+.TP 8
+.B \-\-cflags
+Print the compiler flags that are necessary to compile a \fIGIMP\fP plug-in.
+.TP 8
+.B \-\-clags-noui
+Print the compiler flags that are necessary to compile a \fIGIMP\fP plug-in
+for plug-ins that do not require the GTK+ libraries.
+.TP 8
+.B \-\-prefix=PREFIX
+If specified, use PREFIX instead of the installation prefix that \fIGIMP\fP
+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
+\fIGIMP\fP was built with when computing the output for the \-\-cflags
+and \-\-libs options. This option must be specified before any
+\-\-libs or \-\-cflags options.
+
+
+.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
+to get the preferred flags for passing to the linker.
+.TP 8
+.B LIBS
+for passing extra libs that may be needed in the build process. For example,
+LIBS=-lintl .
+.TP 8
+.B PKG_CONFIG
+to get the location of the \fIpkg-config\fP program that is used to determine
+details about your glib, pango, gtk+ and gimp installation.
+
+
+.SH SEE ALSO
+.BR gimp (1),
+.BR gimprc (5),
+.BR pkg\-config (1)
+
+
+.SH AUTHORS
+gimptool was written by Manish Singh (yosh@gimp.org) and is based on
+gtk\-config by Owen Taylor (owen@gtk.org).
+
+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>).
+