[Pkg-mono-svn-commits] rev 1328 - in mcs/trunk/debian: . man

Eduard Bloch blade@haydn.debian.org
Thu, 12 Aug 2004 06:19:28 -0600


Author: blade
Date: 2004-08-12 06:19:09 -0600 (Thu, 12 Aug 2004)
New Revision: 1328

Modified:
   mcs/trunk/debian/changelog
   mcs/trunk/debian/man/gacutil.1
   mcs/trunk/debian/man/mcs.1
   mcs/trunk/debian/man/sn.1
   mcs/trunk/debian/man/xsd.1
Log:
New manpages pulled from mono


Modified: mcs/trunk/debian/changelog
===================================================================
--- mcs/trunk/debian/changelog	2004-08-12 12:15:37 UTC (rev 1327)
+++ mcs/trunk/debian/changelog	2004-08-12 12:19:09 UTC (rev 1328)
@@ -1,6 +1,7 @@
-mcs (1.0.1-1) unstable; urgency=low
+mcs (1.0.1-1) unstable; urgency=medium
 
   * New upstream release
+  * updated the manpages with those from the mono package
 
  -- Debian Mono Group <pkg-mono-group@lists.alioth.debian.org>  Thu, 12 Aug 2004 10:28:26 +0200
 

Modified: mcs/trunk/debian/man/gacutil.1
===================================================================
--- mcs/trunk/debian/man/gacutil.1	2004-08-12 12:15:37 UTC (rev 1327)
+++ mcs/trunk/debian/man/gacutil.1	2004-08-12 12:19:09 UTC (rev 1328)
@@ -24,20 +24,17 @@
 directory for being accessed to the compiler.  This is done with the
 -package directive to gacutil.
 .PP
-The tool allows for installationl, removal, and listing of the
+The tool allows for installation, removal, and listing of the
 contents of the assembly cache.
 .PP
 The GAC is relative to the Mono installation prefix:
 mono_prefix/lib/mono.
-.SH FLAGS
-The "-user" flag enables you to install/remove the assembly into the
-user's assembly cache, as opposed to the global one.
 .PP
 .SH COMMANDS
-.I "-i path_to_assembly" [-f] [-root ROOTDIR] [-package NAME]
+.I -i <assembly_path> [-check_refs] [-package NAME] [-root ROOTDIR] [-gacdir GACDIR]
 .Sp
-The above installs the assembly into the GAC, use the -f flag to force
-an installation an overwrite anything in there.  
+ Installs an assembly into the global assembly cache. <assembly_path>
+is the name of the file that contains the assembly manifest
 .Sp
 The -package option can be used to also create a directory in in
 prefix/lib/mono with the name NAME, and a symlink is created from
@@ -47,18 +44,32 @@
 The -root option is used by developers integrating this with automake
 tools or packaging tools that require a prefix directory to be
 specified.  The root represents the "libdir" component of a prefix
-(typically prefix/lib).  
+(typically prefix/lib).
+.Sp
+The -gacdir option is used to specify the GACs base directory. Once an
+assembly has been installed to a non standard gacdir the MONO_GAC_PATH
+environment variable must be used to access the assembly.
+.Sp
+The -check_refs option is used to ensure that the assembly being
+installed into the GAC does not reference any non strong named
+assemblies. Assemblies being installed to the GAC should not reference
+non strong named assemblies, however the is an optional check.
 .fi
 .PP
-.I "-l"
+.I "-l" [assembly_name] [-root ROOTDIR] [-gacdir GACDIR]
 .Sp
-Lists the contents of the Global Assembly Cache
+Lists the contents of the global assembly cache. When the
+<assembly_name> parameter is specified only matching assemblies are
+listed.
 .PP
-.I "-u assembly_name [-root]"
+.I "-u" <assembly_display_name> [-package NAME] [-root ROOTDIR] [-gacdir GACDIR]
 .Sp
-The above removes the given assembly name from the Global Assembly
-Cache.  As opposed to the install option that takes a filename, this
-takes as an argument the assembly name, which looks like this:
+Uninstalls an assembly from the global assembly cache.
+<assembly_display_name> is the name of the assembly (partial or
+fully qualified) to remove from the global assembly cache. If a
+partial name is specified all matching assemblies will be
+uninstalled. As opposed to the install option that takes a filename,
+this takes as an argument the assembly name, which looks like this:
 .nf
 	MyLibrary.Something, version=1.0.0.0, publicKeyToken=xxxx,culture=neutral
 .fi
@@ -69,6 +80,29 @@
 The removal performs a greedy removal, if you only specifiy one
 component like, "MyLibrary.Something", it will remove all versions of
 the library.
+.Sp
+.I "-us" <assembly_path> [-package NAME] [-root ROOTDIR] [-gacdir GACDIR]
+Uninstalls an assembly using the specifed assemblies full name.
+<assembly path> is the path to an assembly. The full assembly name
+is retrieved from the specified assembly if there is an assembly in
+the GAC with a matching name, it is removed. Unlike the -u option this
+option takes a file name, like this:
+.nf
+        Example: -us myDll.dll
+.fi
+.Sp
+.I "-ul" <assembly_list_file> [-package NAME] [-root ROOTDIR] [-gacdir GACDIR]
+Uninstalls one or more assemblies from the global assembly cache.
+<assembly_list_file> is the path to a test file containing a list of
+assembly names on separate lines.
+.nf
+Example -ul assembly_list.txt
+.fi
+.nf
+assembly_list.txt contents:
+    assembly1,Version=1.0.0.0,Culture=en,PublicKeyToken=0123456789abcdef
+    assembly2,Version=2.0.0.0,Culture=en,PublicKeyToken=0123456789abcdef
+.fi
 .SH FILES
 On Unix assemblies are loaded from the installation lib directory.  If you set
 `prefix' to /usr, the assemblies will be located in /usr/lib.  On

Modified: mcs/trunk/debian/man/mcs.1
===================================================================
--- mcs/trunk/debian/man/mcs.1	2004-08-12 12:15:37 UTC (rev 1327)
+++ mcs/trunk/debian/man/mcs.1	2004-08-12 12:19:09 UTC (rev 1328)
@@ -108,10 +108,6 @@
 AssemblyKeyName ("CONTAINER")] in your source code. Compiler option 
 takes precedence over the attributes.
 .TP
-.I \-\-stacktrace
-Generates a stack trace at the time the error is reported, useful for
-debugging the compiler.
-.TP
 .I -lib:PATHLIST
 Each path specified in the comma-separated list will direct the
 compiler to look for libraries in that specified path.
@@ -142,6 +138,16 @@
 .I \-\-parse
 Used for benchmarking.  The compiler will only parse its input files.
 .TP
+.I \-pkg:package1[,packageN]
+The compiler will invoke pkg-config --libs on the set of packages
+specified on the command line to obtain libraries and directories to
+compile the code.
+.PP
+This is typically used with third party components, like this:
+.nf
+		$ mcs -pkg:gtk-sharp demo.cs
+.fi
+.TP
 .I -resource:RESOURCE[,ID]
 Embeds to the given resource file.  The optional ID can be used to
 give a different name to the resource.  If not specified, the resource
@@ -165,9 +171,13 @@
 shell will perform globbing, so you migth want to use it like this:
 .PP
 .nf
-		bash$ mcs -recurse:'*.cs' 
+		$ mcs -recurse:'*.cs' 
 .fi
 .TP
+.I \-\-stacktrace
+Generates a stack trace at the time the error is reported, useful for
+debugging the compiler.
+.TP
 .I \-target:KIND, \-t:KIND
 Used to specify the desired target.  The possible values are: exe
 (plain executable), winexe (Windows.Forms executable), library

Modified: mcs/trunk/debian/man/sn.1
===================================================================
--- mcs/trunk/debian/man/sn.1	2004-08-12 12:15:37 UTC (rev 1327)
+++ mcs/trunk/debian/man/sn.1	2004-08-12 12:19:09 UTC (rev 1328)
@@ -1,8 +1,9 @@
 .\" 
 .\" sn manual page.
 .\" Copyright 2003 Motus Technologies
+.\" Copyright 2004 Novell
 .\" Author:
-.\"   Sebastien Pouliot (spouliot@motus.com)
+.\"   Sebastien Pouliot <sebastien@ximian.com>
 .\"
 .TH Mono "sn"
 .SH NAME
@@ -13,24 +14,33 @@
 .SH DESCRIPTION
 Digitally sign, verify or compare, CLR assemblies using strongnames. 
 .SH CONFIGURATION OPTIONS
+Configuration options are stored in the machine.config configuration file
+under /configuration/strongNames.
 .TP
 .I "-c provider"
-Change the default CSP (Crypto Service Provider).
+Change the default CSP (Crypto Service Provider). Currently not supported
+in Mono.
 .TP
 .I "-m [y|n]"
-Use a machine [y] key container or a user [n] key container.
+Use a machine [y] key container or a user [n] key container. Currently not
+supported in Mono.
 .TP
 .I "-Vl"
-List the verification options.
+List the verification options. The list is kept under /configuration/
+strongNames/verificationSettings in machine.config.
 .TP
 .I "-Vr assembly [userlist]"
 Exempt the specified assembly from verification for the specified user list.
+Currently not supported by sn, you must edit machine.config manually if you
+require this.
 .TP
 .I "-Vu assembly"
-Remove the exemption entry for the specified assembly.
+Remove the exemption entry for the specified assembly. Currently not 
+supported by sn, you must edit machine.config manually if you require this.
 .TP
 .I "-Vx"
-Remove all exemptions entries.
+Remove all exemptions entries. Currently not supported by sn, you must edit 
+machine.config manually if you require this.
 .SH CSP RELATED OPTIONS
 .TP
 .I "-d container"
@@ -62,11 +72,14 @@
 This is done by comparing the hash of the metadata of both assembly.
 .TP
 .I "-k keypair.snk"
-Create a new strongname keypair in the specified file.
+Create a new strongname keypair (a 1024 bits RSA keypair) in the specified 
+file.
 .TP
 .I "-R assembly keypair.snk"
 Resign the specified assembly using the specified strongname keypair file 
-(SNK).
+(SNK). You can only sign an assembly with the private key (SNK) that match 
+the public key inside the assembly (unless it's public key token has been
+remapped in machine.config).
 .TP
 .I "-Rc assembly container"
 Resign the specified assembly using the specified strongname container.
@@ -83,10 +96,10 @@
 .I "-Tp assembly"
 Show the public key and the public key token from the specified assembly.
 .TP
-.I "-V assembly"
+.I "-v assembly"
 Verify the specified assembly signature.
 .TP
-.I "-Vf assembly"
+.I "-vf assembly"
 Verify the specified assembly signature (even if disabled).
 .SH HELP OPTIONS
 .TP
@@ -104,10 +117,35 @@
 .TP
 .I "-h sn", "-? sn"
 Display strongname related help about this tool.
+.SH CONFIGURATION FILE
+.TP
+Strongnames configuration is kept in "machine.config" file. Currently two 
+features can be configured.
+.TP
+.I "/configuration/strongNames/pubTokenMapping"
+This mechanism let Mono remap a public key token, like the ECMA token, to
+another public key for verification. This is useful in two scenarios. First 
+assemblies signed with the "ECMA key" needs to be verified by the "runtime"
+key (as the ECMA key isn't a public key). Second, many assemblies are signed
+with private keys that Mono can't use (e.g. System.Security.dll assembly).
+A new key cannot be used because it should change thr strongname (a new key 
+pair would have a new public key which would produce a new token). Public 
+key token remapping is the solution for both problems. Each token must be
+configured in a "map" entry similar to this one: <map Token="b77a5c561934e089" 
+PublicKey="00..." />
+.TP
+.I "/configuration/strongNames/verificationSettings"
+It is often useful during development to use delay signed assemblies. 
+Normally* the runtime wouldn't allow delay-signed assemblies to be loaded.
+This feature allows some delay-signed assemblies (based on their public key
+token, optionally assembly name and user name) to be used like they were 
+fully signed assemblies. [*] Note that Mono 1.0 "runtime" doesn't validate 
+strongname signatures so this option shouldn't be required in most scenarios.
 .SH AUTHOR
 Written by Sebastien Pouliot
 .SH COPYRIGHT
 Copyright (C) 2003 Motus Technologies. 
+Copyright (C) 2004 Novell. 
 Released under BSD license.
 .SH MAILING LISTS
 Visit http://mail.ximian.com/mailman/mono-list for details.

Modified: mcs/trunk/debian/man/xsd.1
===================================================================
--- mcs/trunk/debian/man/xsd.1	2004-08-12 12:15:37 UTC (rev 1327)
+++ mcs/trunk/debian/man/xsd.1	2004-08-12 12:19:09 UTC (rev 1328)
@@ -49,6 +49,9 @@
 .I "/language:name" "/l:name"
 Specifies the programming language to use for the generated code. The only supported languages are CS (C#) and VB (Visual Basic.NET).
 .TP 
+.I "/generator:type,assembly" "/g:type,assembly"
+Indicates xsd.exe to use custom CodeDomProvider to generate code. The type name must be full name. Assembly name is a local file name that is going to be loaded. The specified Type must have the default constructor.
+.TP 
 .I "/outputdir:path" "/o:path"
 Specifies the directory where to generate the code or schemas.
 .TP