* xbuild.1: Add info about env var XBUILD_COLORS.
[mono.git] / man / xbuild.1
1 .TH "xbuild" 1
2 .SH NAME
3 xbuild \- Mono's tool to build MSBuild project files
4 .SH SYNOPSIS
5 .B xbuild
6 [option] [project-file]
7 .SH DESCRIPTION
8 xbuild can be used to build MSBuild project files. Integrated Development
9 Environments like MonoDevelop and "Microsoft Visual Studio .NET" use msbuild
10 project file format.
11
12 xbuild takes the path of the project or solution file to build, as the main argument.
13 If no file is specified then it tries to build any solution file or project file in
14 the current directory, that has a *proj extension.
15 .SH OPTIONS
16 .TP
17 .B \//target:T1[,TN]
18 List of targets to build
19 .TP
20 .B \//property:Name=Value
21 Set or override project properties
22 .TP
23 .B \//logger:<logger>
24 Custom logger to log build events
25 .TP
26 .B \//verbosity:<level>
27 Logger verbosity level : quiet, minimal, normal, detailed, diagnostic
28 .TP
29 .B \//validate
30 Validate the project file against the schema
31 .TP
32 .B \//validate:<schema>
33 Validate the project file against the specified schema
34 .TP
35 .B \//consoleloggerparameters:<params>
36 Parameters for the console logger
37 .TP
38 .B \//nologo
39 Don't show the initial xbuild banner
40 .TP
41 .B \//help
42 Show xbuild usage
43 .TP
44 .B \//version
45 Display xbuild version
46 .SH ENVIRONMENT VARIABLES
47 .TP
48 .I "XBUILD_EMIT_SOLUTION"
49 If this variable is set, then the project file generated from a solution
50 file is emitted.
51 .TP
52 .I "XBUILD_COLORS"
53 If this variable is set, it contains a string of the form
54 "type=foreground,type=.." that specifies which color to use to display
55 errors/warnings etc on some terminals. Type here can be:
56
57 .nf
58         errors, warnings, messages or events
59
60         events: These are project/target/task start and end event
61                 messages.
62 .fi
63
64 .Sp
65 The possible colors for foreground are:
66 .B black, red, brightred, green, brightgreen, yellow, brightyellow,
67 blue, brightblue, magenta, brightmagenta, cyan, brightcyan, grey,
68 white and brightwhite.
69
70 .Sp
71 For example, you could set this variable from your shell:
72 .nf
73         export XBUILD_COLORS
74         XBUILD_COLORS=errors=brightred,warnings=blue
75 .fi
76 .Sp
77
78 You can disable the built-in color scheme by setting this variable to
79 "disable".
80
81 .SH SEE ALSO
82 .BR mono(1), mcs(1)
83 .SH COPYRIGHT
84 Copyright (C) 2009 Novell, Inc (http://www.novell.com)
85 .SH MAILING LISTS
86 Visit http://lists.ximian.com/mailman/listinfo/mono-devel-list for details.
87 .SH WEB SITE
88 Visit: http://www.mono-project.com for details