Merge pull request #5714 from alexischr/update_bockbuild
[mono.git] / man / mconfig.1
1 .TH Mono "mconfig"
2 .SH NAME
3 mconfig, \- Utility for modifying .NET configuration files
4 .SH SYNOPSIS
5 .B mconfig [options] command [command_parameters]
6 .SH DESCRIPTION
7 mconfig can be used to edit .NET configuration files, by adding "features"
8 (that is sets of xml statements) defined in one of the config files read
9 by mconfig. The config file can also define layouts of default configuration
10 files, which may be useful for bootstrapping your .NET projects.
11
12 To see the list of recognized commands, default configuration files and features, run
13 mconfig without passing any parameters.
14 .SH OPTIONS
15 .TP
16 .B -c <config_file>, --config=<config_file>
17 Read the specified config file after reading the other, preconfigured, config
18 files for the utility. Settings in the specified file override those found in
19 the other configuration locations.
20 .TP
21 .B -t {any | web | application}, --target={any | web | application}
22 Features and default configuration files defined in the mconfig config file(s)
23 can be assigned to one of the three targets - \fIweb\fR (for ASP.NET features/config files),
24 \fIapplication\fR - for .NET applications, \fIany\fR - applicable in both of the previous
25 targets. Defaults to \fIany\fR.
26 .TP
27 .B -?, -h, --help
28 Show a summary usage screen.
29 .TP
30 .B -v, --version
31 Show the mconfig version
32 .SH COMMANDS
33 .TP
34 .B {addfeature, af} <feature_name> [config_file_path]
35 Adds the feature named \fI<feature_name>\fR to the specified config file. If 
36 \fI[config_file_path]\fR is omitted, the name of the output configuration file 
37 will be chosen based on the selected target (see the \fI-t\fR option). The \fIweb\fR
38 target outputs configuration to file named \fIWeb.config\fR, and the \fIapplication\fR
39 target outputs to file named \fIapplication.exe.config\fR. The \fIany\fR target does not
40 have a default output file.
41
42 If the specified config file exists, the feature will be injected into it at the locations
43 specified by mconfig configuration. If the target config file does not exist, it will be created
44 and will contain only the specified feature and all its dependencies.
45 .TP
46 .B {defaultconfig, dc} [config_name [target_directory]]
47 Generates a default config file using the configuration entry named \fI[config_name]\fR and outputs
48 the resulting configuration file to the directory given by the \fI[target_directory]\fR option.
49 If \fI[config_name]\fR is omitted, it defaults to \fIWeb.config\fR for the \fIweb\fR target and
50 \fIapplication\fR target. The \fIany\fR target does not specify any default output configuration
51 name. If the \fI[target_directory]\fR parameter is omitted, it defaults to the current directory.
52
53 Name of the output config file created in \fI[target_directory]\fR is given in the config file
54 layout definition.
55 .PP
56 .SH FILES
57 Config files are read in the order given below. Each subsequent file may override settings found
58 in the files read before it.
59 .TP
60 .B $prefix/etc/mono/mconfig/config.xml
61 .Sp
62 The default configuration file, distributed with mconfig. \fI$prefix\fR is the mconfig installation
63 prefix specified on the compilation time.
64 .TP
65 .B $config_dir/mconfig/config.xml
66 .Sp
67 $config_dir is the directory specified in the \fIXDG_CONFIG_HOME\fR environment variable or,
68  if it is empty, in the \fI.config\fR directory located in the user's home directory. This file
69 is not distributed with Mono.
70 .TP
71 .B ./mconfig.xml
72 .Sp
73 Local configuration file which can contain per-application settings.
74 .SH SEE ALSO
75 mconfig.config (5)
76 .SH AUTHOR
77 Written by Marek Habersack
78 .SH COPYRIGHT
79 Copyright (C) 2007 Novell, Inc (http://www.novell.com)
80 .SH MAILING LISTS
81 Visit http://lists.ximian.com/mailman/listinfo/mono-devel-list for details.
82 .SH WEB SITE
83 Visit: http://www.mono-project.com for details