2007-10-23 Marek Habersack <mhabersack@novell.com>
authorMarek Habersack <grendel@twistedcode.net>
Mon, 22 Oct 2007 22:46:07 +0000 (22:46 -0000)
committerMarek Habersack <grendel@twistedcode.net>
Mon, 22 Oct 2007 22:46:07 +0000 (22:46 -0000)
* mconfig.1: added

* Makefile.am (man_MANS): added mconfig.1

svn path=/trunk/mono/; revision=87949

man/ChangeLog
man/Makefile.am
man/mconfig.1 [new file with mode: 0644]

index 2d952a25cff45ec1ac4cf14080f57c41c79e9567..2b0c13e2f61a3cd6257836f0e1004cd6babf926e 100644 (file)
@@ -1,3 +1,9 @@
+2007-10-23  Marek Habersack  <mhabersack@novell.com>
+
+       * mconfig.1: added
+
+       * Makefile.am (man_MANS): added mconfig.1
+
 2007-10-17  Sebastien Pouliot  <sebastien@ximian.com>
 
        * sn.1: Fix help for -T / -t as this shows the public key token
index f2c96d9aa2b140be9966120dd0da6ba669679954..aa6eaff5c0410489c2dc86dbc3e92ba35a759b06 100644 (file)
@@ -2,6 +2,6 @@ man_MANS = mcs.1 mono.1 monostyle.1 mono-config.5 sqlsharp.1 oldmono.1 ilasm.1 \
           cert2spc.1 cilc.1 genxs.1 wsdl.1 disco.1 soapsuds.1 makecert.1 \
           chktrust.1 setreg.1 sn.1 secutil.1 signcode.1 certmgr.1 monop.1 xsd.1 gacutil.1 \
           macpack.1 mkbundle.1 dtd2xsd.1 permview.1 prj2make.1 mono-service.1 mono-shlib-cop.1 \
-          al.1 mozroots.1 mono-xmltool.1 sgen.1 httpcfg.1 vbnc.1 resgen.1 monolinker.1
+          al.1 mozroots.1 mono-xmltool.1 sgen.1 httpcfg.1 vbnc.1 resgen.1 monolinker.1 mconfig.1
 
 EXTRA_DIST = $(man_MANS)
diff --git a/man/mconfig.1 b/man/mconfig.1
new file mode 100644 (file)
index 0000000..1dcfc71
--- /dev/null
@@ -0,0 +1,88 @@
+.TH Mono "mconfig"
+.SH NAME
+mconfig, \- Utility for modifying .NET configuration files
+.SH SYNOPSIS
+.B mconfig [options] command [command_parameters]
+.SH DESCRIPTION
+mconfig can be used to edit .NET configuration files, by adding "features"
+(that is sets of xml statements) defined in one of the config files read
+by mconfig. The config file can also define layouts of default configuration
+files, which may be useful for bootstrapping your .NET projects.
+.SH OPTIONS
+.TP
+.B -c <config_file>, --config=<config_file>
+Read the specified config file after reading the other, preconfigured, config
+files for the utility. Settings in the specified file override those found in
+the other configuration locations.
+.TP
+.B -t {any | web | application}, --target={any | web | application}
+Features and default configuration files defined in the mconfig config file(s)
+can be assigned to one of the three targets - \fIweb\fR (for ASP.NET features/config files),
+\fIapplication\fR - for .NET applications, \fIany\fR - applicable in both of the previous
+targets. Defaults to \fIany\fR.
+.TP
+.B -C, --list-configs
+List all the default configuration file names that are defined in the mconfig
+configuration files.
+.TP
+.B -F, --list-features
+List all the features that are defined in the mconfig configuration files and
+which can be added to your existing (or new) .NET configuration files.
+.TP
+.B -?, -h, --help
+Show a summary usage screen.
+.TP
+.B -v, --version
+Show the mconfig version
+.SH COMMANDS
+.TP
+.B {addfeature, af} <feature_name> [config_file_path]
+Adds the feature named \fI<feature_name>\fR to the specified config file. If 
+\fI[config_file_path]\fR is omitted, the name of the output configuration file 
+will be chosen based on the selected target (see the \fI-t\fR option). The \fIweb\fR
+target outputs configuration to file named \fIWeb.config\fR, and the \fIapplication\fR
+target outputs to file named \fIapplication.exe.config\fR. The \fIany\fR target does not
+have a default output file.
+
+If the specified config file exists, the feature will be injected into it at the locations
+specified by mconfig configuration. If the target config file does not exist, it will be created
+and will contain only the specified feature and all its dependencies.
+.TP
+.B {defaultconfig, dc} [config_name [target_directory]]
+Generates a default config file using the configuration entry named \fI[config_name]\fR and outputs
+the resulting configuration file to the directory given by the \fI[target_directory]\fR option.
+If \fI[config_name]\fR is omitted, it defaults to \fIWeb.config\fR for the \fIweb\fR target and
+\fIapplication\fR target. The \fIany\fR target does not specify any default output configuration
+name. If the \fI[target_directory]\fR parameter is omitted, it defaults to the current directory.
+
+Name of the output config file created in \fI[target_directory]\fR is given in the config file
+layout definition.
+.PP
+.SH FILES
+Config files are read in the order given below. Each subsequent file may override settings found
+in the files read before it.
+.TP
+.B $prefix/etc/mono/mconfig/config.xml
+.Sp
+The default configuration file, distributed with mconfig. \fI$prefix\fR is the mconfig installation
+prefix specified on the compilation time.
+.TP
+.B $config_dir/mconfig/config.xml
+.Sp
+$config_dir is the directory specified in the \fIXDG_CONFIG_HOME\fR environment variable or,
+ if it is empty, in the \fI.config\fR directory located in the user's home directory. This file
+is not distributed with Mono.
+.TP
+.B ./mconfig.xml
+.Sp
+Local configuration file which can contain per-application settings.
+.SH SEE ALSO
+mconfig.config (5)
+.SH AUTHOR
+Written by Marek Habersack
+.SH COPYRIGHT
+Copyright (C) 2007 Novell, Inc (http://www.novell.com)
+.SH MAILING LISTS
+Visit http://lists.ximian.com/mailman/listinfo/mono-devel-list for details.
+.SH WEB SITE
+Visit: http://www.mono-project.com for details