Commit 597aa225 authored by Sven Neumann's avatar Sven Neumann Committed by Sven Neumann

document some more environment variables.

2006-01-25  Sven Neumann  <sven@gimp.org>

	* docs/gimp.1.in: document some more environment variables.

	* docs/gimprc.5.in
	* docs/gimptool.1.in: unified spelling of "plug-in".
parent 1b8e351b
2006-01-25 Sven Neumann <sven@gimp.org>
* docs/gimp.1.in: document some more environment variables.
* docs/gimprc.5.in
* docs/gimptool.1.in: unified spelling of "plug-in".
2006-01-24 Michael Natterer <mitch@gimp.org>
* plug-ins/script-fu/scripts/guides-new.scm
......
.TH GIMP 1 "December 29 2005" "Version @GIMP_VERSION@" "GIMP Manual Pages"
.TH GIMP 1 "Version @GIMP_VERSION@" "GIMP Manual Pages"
.SH NAME
gimp - an image manipulation and paint program.
......@@ -30,7 +30,7 @@ variety of paint modes. It also offers an extensive array of
selection tools like rectangle, ellipse, fuzzy select, bezier select,
intelligent scissors, and select by color.
.PP
GIMP offers a variety of plugins that perform a variety of image
GIMP offers a variety of plug-ins that perform a variety of image
manipulations. Examples include bumpmap, edge detect, gaussian blur,
and many others. In addition, GIMP has several scripting extension
which allow for advanced non-interactive processing and creation of
......@@ -42,7 +42,7 @@ the \-\-no\-interface command\-line option.
.SH OPTIONS
.l
.l
The \fIgimp\fP accepts the following options:
.TP 8
.B \-h, \-\-help
......@@ -62,9 +62,9 @@ Output license information and exit.
.TP 8
.B \-\-verbose
Be verbose and create information on standard output.
.TP 8
.TP 8
.B \-\-no\-shm
Do not use shared memory between GIMP and its plugins.
Do not use shared memory between GIMP and its plug-ins.
Instead of using shared memory, GIMP will send the data via pipe. This
will result in slower performance than using shared memory.
.TP 8
......@@ -95,7 +95,7 @@ name is appended to the default sessionrc filename.
.TP 8
.B \-g, \-\-gimprc \fI<gimprc>\fP
Use an alternative gimprc instead of the default one. Useful in
cases where plugins paths or machine specs may be different.
cases where plug-in paths or machine specs may be different.
.TP 8
.B \-\-system\-gimprc \fI<gimprc>\fP
Use an alternate system gimprc file.
......@@ -125,36 +125,58 @@ Execute \fI<command>\fP non-interactively. This option may appear
multiple times. The \fI<command>\fP is passed to the batch
interpreter. When \fI<command>\fP is \fB-\fP the commands are read
from standard input.
.TP 8
.SH ENVIRONMENT
GIMP respects a number of environment variables.
.PP
.TP 8
.B DISPLAY
to get the default host and display number.
.TP 8
.B XENVIRONMENT
to get the name of a resource file that overrides the global resources
stored in the RESOURCE_MANAGER property.
.B GIMP2_DIRECTORY
to get the name of the personal GIMP directory. If unset @gimpdir@ is
used. If this is an absolute path, it is used as is. If it is a
relative path, it is taken to be a subdirectory of the home directory.
.TP 8
.B GIMP2_DATADIR
to get the base location for data files such as brushes and patterns.
If unset @gimpdatadir@ is used.
.TP 8
.B GIMP2_LOCALEDIR
to get the base location for translations. If unset @gimplocaledir@
is used.
.TP 8
.B GIMP2_PLUGINDIR
to get the base location for plug-ins and modules. If unset
@gimpplugindir@ is used.
.TP 8
.B GIMP2_SYSCONFDIR
to get the location of configuration files. If unset @gimpsysconfdir@
is used.
On Linux GIMP can be compiled with support for binary relocatibility.
This will cause data, plug-ins and configuration files to be searched
relative to the location of the gimp executable file unless overridden
by the environment variables mentioned above.
.SH FILES
GIMP's data files are stored in @gimpdatadir@, where ${prefix}
GIMP's data files are stored in @gimpdatadir@, where ${prefix}
is set on install, but is typically /usr/local. GIMP's system-wide
configuration files are stored in @gimpsysconfdir@.
Most GIMP configuration is read in from the user's init file,
\fB$HOME\fP/@gimpdir@/gimprc. The system wide equivalent is in
@sysconfdir@/gimprc. The system wide file is parsed
first and the user gimprc can override the system settings.
@sysconfdir@/gimprc. The system wide file is parsed
first and the user gimprc can override the system settings.
@sysconfdir@/gimprc_user is the default gimprc
placed in users' home directories the first time GIMP is run.
\fB$HOME\fP/@gimpdir@/devicerc - holds settings for input devices
together with the tool, colors, brush, pattern and gradient
together with the tool, colors, brush, pattern and gradient
associated to that device.
\fB$HOME\fP/@gimpdir@/documents - lists all images that have been
\fB$HOME\fP/@gimpdir@/documents - lists all images that have been
opened or saved using GIMP.
\fB$HOME\fP/@gimpdir@/gtkrc - users set of GIMP-specific GTK config
......@@ -190,9 +212,9 @@ database. You can modify this list with the unit editor. You are not
supposed to edit it manually, but of course you can do. This file
will be entirely rewritten every time you quit the GIMP.
\fB$HOME\fP/@gimpdir@/plug-ins - location of user installed plugins.
\fB$HOME\fP/@gimpdir@/plug-ins - location of user installed plug-ins.
\fB$HOME\fP/@gimpdir@/pluginrc - plugin initialization values are
\fB$HOME\fP/@gimpdir@/pluginrc - plug-in initialization values are
stored here. This file is parsed on startup and regenerated if need
be.
......@@ -206,13 +228,13 @@ temporary space.
\fB$HOME\fP/@gimpdir@/brushes - user created and installed brush
files. These files are in the .gbr, .gih or .vbr file formats.
\fB$HOME\fP/@gimpdir@/curves - Curve profiles and presets as saved from
\fB$HOME\fP/@gimpdir@/curves - Curve profiles and presets as saved from
the Curves tool.
\fB$HOME\fP/@gimpdir@/gimpressionist - Presets and user created brushes
\fB$HOME\fP/@gimpdir@/gimpressionist - Presets and user created brushes
and papers are stored here.
\fB$HOME\fP/@gimpdir@/levels - Level profiles and presets as saved from
\fB$HOME\fP/@gimpdir@/levels - Level profiles and presets as saved from
the Levels tool.
@gimpdatadir@/palettes - the system wide palette files.
......@@ -291,23 +313,23 @@ The canonical place to find GIMP info is at http://www.gimp.org/.
Here you can find links to just about many other GIMP sites,
tutorials, data sets, mailing list archives, and more.
There is also a GIMP User Manual available at
http://manual.gimp.org/ that goes into much more detail
There is also a GIMP User Manual available at
http://manual.gimp.org/ that goes into much more detail
about the interactive use of GIMP.
The latest version of GIMP and the GTK+ libs is always available at
The latest version of GIMP and the GTK+ libs is always available at
ftp://ftp.gimp.org/.
.SH AUTHORS
Spencer Kimball and Peter Mattis.
With patches, fixes, plugins, extensions, scripts,
translations, documentation, and more from lots
and lots of people all over the world.
With patches, fixes, plug-ins, extensions, scripts, translations,
documentation and more from lots and lots of people all over the
world.
.SH "SEE ALSO"
.BR gimprc (5),
.BR gimptool (1),
.BR gimprc (5),
.BR gimptool (1),
.BR gimp\-remote (1)
......@@ -844,7 +844,7 @@ environment variable GIMP2_DATADIR or to the compiled-in default value
@gimpdatadir@.
.TP
.I gimp_plug_in_dir
Base to paths for architecture-specific plugins and modules, which is set
Base to paths for architecture-specific plug-ins and modules, which is set
to the value of the environment variable GIMP2_PLUGINDIR or to the
compiled-in default value @gimpplugindir@.
.TP
......
.TH GIMPTOOL\-2.0 1 "March 23 2004" "Version @GIMP_VERSION@" "GIMP Manual Pages"
.TH GIMPTOOL\-2.0 1 "Version @GIMP_VERSION@" "GIMP Manual Pages"
.SH NAME
gimptool\-2.0 - script to perform various GIMPy functions
......@@ -103,7 +103,7 @@ Outputs the includedir used to install the \fIGIMP\fP.
Outputs the actual directory where the \fIGIMP\fP data files were installed.
.TP 8
.B \-\-gimpplugindir
Outputs the actual directory where the \fIGIMP\fP plugins were installed.
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.
......@@ -169,14 +169,14 @@ 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
plugins that do not require the GTK libs.
plug-ins that do not require the GTK libs.
.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 plugins that do not require the GTK libs.
for plug-ins that do not require the GTK libs.
.TP 8
.B \-\-prefix=PREFIX
If specified, use PREFIX instead of the installation prefix that \fIGIMP\fP
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment