'\" t
.\"     Title: gyp
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 11/07/2020
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "GYP" "1" "11/07/2020" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
gyp \- cross\-platform makefile generator for Chromium
.SH "SYNOPSIS"
.sp
\fIgyp\fR [options] [build_file\&...]
.SH "DESCRIPTION"
.sp
Uses the specified build files to generate build scripts or project files in the current platform\(cqs native format\&. If no build file is specified, all files in the current directory with a \&.gyp suffix are used\&.
.SH "OPTIONS"
.PP
\-D<variable>=<value>
.RS 4
Provide a default value for the given variable\&. This supplements settings from the
\fIGYP_DEFINES\fR
environment variable, which should be a space\-separated list of <variable>=<value> pairs\&.
.RE
.PP
\-f<format>[(,<format>)\&...], \-\-format=<format>[(,<format>)\&...]
.RS 4
Generate output in the formats listed\&. Valid formats include
make
(GNU makefile),
xcode
(Xcode project file),
msvs
(Visual Studio project file),
scons
(SCons rule set), and
gypd
(\fIgyp\fR
input, for debugging)\&.
.sp
Defaults to the value of the
\fIGYP_GENERATORS\fR
environment variable, which should be a comma\-separated list of formats, or the platform\(cqs native format if unset (\fIxcode\fR
for Mac OS X,
\fImsvs\fR
for Windows, including Cygwin,
\fImake\fR
for other Unix)\&.
.RE
.PP
\-I<path>, \-\-include=<path>
.RS 4
Implicitly include the contents of the
\fI<path>\fR
file in all loaded
\&.gyp
files\&.
.RE
.PP
\-\-depth=<path>
.RS 4
For Chromium, the gyp "depth" variable should always be a relative path to Chromium\(cqs top\-level
src
directory\&. This option allows one to specify a path the DEPTH variable should be set relative to\&.
.sp
Defaults to the first directory named
src
found as an ancestor of one of the build files passed on the command line\&.
.RE
.PP
\-d<debug mode>, \-\-debug=<debug mode>
.RS 4
Turn on debugging output\&. Valid debugging modes include "general" to list options used, "variables" to trace variable expansion, and "includes" to trace build file include directives\&.
.RE
.PP
\-S<suffix>, \-\-suffix=<suffix>
.RS 4
Insert the specified string in the names of generated files before the standard extension\&. For example, with the
\fImake\fR
backend and a suffix of "\&.foo",
\fIgyp\fR
will write the main makefile to
Makefile\&.foo
and target\-specific snippets to
target\&.foo\&.mk\&.
.RE
.PP
\-G<flag>=<value>
.RS 4
Set a "generator flag", which is an option specific to the particular output format\&. All generator flags have names beginning with the name of the output format\&. This supplements the
\fIGYP_GENERATOR_FLAGS\fR
environment variable, which should be a space\-separated list of <flag>=<value> pairs\&.
.RE
.PP
\-\-generator\-output=<dir>
.RS 4
Write the generated build files under the <dir> directory and adjust paths accordingly\&. This allows building in a separate directory from the source files\&.
.sp
This overrides the
\fIGYP_GENERATOR_OUTPUT\fR
environment variable\&.
.RE
.PP
\-\-ignore\-environment
.RS 4
Do not read options from environment variables\&.
.RE
.PP
\-\-check
.RS 4
Take extra time to verify the syntax of each
\fIbuild_file\fR\&.
.RE
.PP
\-\-parallel
.RS 4
Use multiprocessing for speed (experimental)\&.
.RE
.PP
\-\-toplevel\-dir=<dir>
.RS 4
Directory to use as the root of the source tree\&.
.RE
.PP
\-\-build=<configs>
.RS 4
Configuration for build after project generation\&.
.RE
.PP
\-\-no\-circular\-check
.RS 4
Disable the check for circular relationships between
\&.gyp
files\&. These relationships should not exist, but they\(cqve only been observed to be harmful with the Xcode output format\&. Chromium\(cqs
\&.gyp
files currently have some circular relationships on non\-Mac platforms, so this option allows the strict behavior to be used on Macs and the lenient behavior to be used elsewhere\&.
.sp
This option is likely to be removed once all circular relationships in Chromium are eliminated\&.
.RE
.SH "ENVIRONMENT"
.PP
GYP_DEFINES, GYP_GENERATORS, GYP_GENERATOR_FLAGS, GYP_GENERATOR_OUTPUT
.RS 4
See the
\-D,
\-\-format,
\-G, and
\-\-generator\-output
options\&.
.RE
.SH "FILES"
.PP
~/\&.gyp/include\&.gypi
.RS 4
Implicitly included before anything else in every
\&.gyp
file\&.
.RE
.SH "SEE ALSO"
.sp
\fBqmake\fR(1), \fBcmake\fR(1)