New tests, message update
[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 .SH OPTIONS
12 .TP
13 .B -c <config_file>, --config=<config_file>
14 Read the specified config file after reading the other, preconfigured, config
15 files for the utility. Settings in the specified file override those found in
16 the other configuration locations.
17 .TP
18 .B -t {any | web | application}, --target={any | web | application}
19 Features and default configuration files defined in the mconfig config file(s)
20 can be assigned to one of the three targets - \fIweb\fR (for ASP.NET features/config files),
21 \fIapplication\fR - for .NET applications, \fIany\fR - applicable in both of the previous
22 targets. Defaults to \fIany\fR.
23 .TP
24 .B -C, --list-configs
25 List all the default configuration file names that are defined in the mconfig
26 configuration files.
27 .TP
28 .B -F, --list-features
29 List all the features that are defined in the mconfig configuration files and
30 which can be added to your existing (or new) .NET configuration files.
31 .TP
32 .B -?, -h, --help
33 Show a summary usage screen.
34 .TP
35 .B -v, --version
36 Show the mconfig version
37 .SH COMMANDS
38 .TP
39 .B {addfeature, af} <feature_name> [config_file_path]
40 Adds the feature named \fI<feature_name>\fR to the specified config file. If 
41 \fI[config_file_path]\fR is omitted, the name of the output configuration file 
42 will be chosen based on the selected target (see the \fI-t\fR option). The \fIweb\fR
43 target outputs configuration to file named \fIWeb.config\fR, and the \fIapplication\fR
44 target outputs to file named \fIapplication.exe.config\fR. The \fIany\fR target does not
45 have a default output file.
46
47 If the specified config file exists, the feature will be injected into it at the locations
48 specified by mconfig configuration. If the target config file does not exist, it will be created
49 and will contain only the specified feature and all its dependencies.
50 .TP
51 .B {defaultconfig, dc} [config_name [target_directory]]
52 Generates a default config file using the configuration entry named \fI[config_name]\fR and outputs
53 the resulting configuration file to the directory given by the \fI[target_directory]\fR option.
54 If \fI[config_name]\fR is omitted, it defaults to \fIWeb.config\fR for the \fIweb\fR target and
55 \fIapplication\fR target. The \fIany\fR target does not specify any default output configuration
56 name. If the \fI[target_directory]\fR parameter is omitted, it defaults to the current directory.
57
58 Name of the output config file created in \fI[target_directory]\fR is given in the config file
59 layout definition.
60 .PP
61 .SH FILES
62 Config files are read in the order given below. Each subsequent file may override settings found
63 in the files read before it.
64 .TP
65 .B $prefix/etc/mono/mconfig/config.xml
66 .Sp
67 The default configuration file, distributed with mconfig. \fI$prefix\fR is the mconfig installation
68 prefix specified on the compilation time.
69 .TP
70 .B $config_dir/mconfig/config.xml
71 .Sp
72 $config_dir is the directory specified in the \fIXDG_CONFIG_HOME\fR environment variable or,
73  if it is empty, in the \fI.config\fR directory located in the user's home directory. This file
74 is not distributed with Mono.
75 .TP
76 .B ./mconfig.xml
77 .Sp
78 Local configuration file which can contain per-application settings.
79 .SH SEE ALSO
80 mconfig.config (5)
81 .SH AUTHOR
82 Written by Marek Habersack
83 .SH COPYRIGHT
84 Copyright (C) 2007 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