[PLinq] Sanitize QueryOptions to use property everywhere and add ShouldBeSequential...

[mono.git] / man / sn.1

diff --git a/man/sn.1 b/man/sn.1
old mode 100755 (executable)
new mode 100644 (file)
index b26ed9b..4e614ff
--- a/man/sn.1
+++ b/man/sn.1
@@ -1,18 +1,21 @@
 .\" 
 .\" sn manual page.
 .\" Copyright 2003 Motus Technologies
 .\" 
 .\" sn manual page.
 .\" Copyright 2003 Motus Technologies

-.\" Copyright 2004 Novell
+.\" Copyright (C) 2004-2005 Novell, Inc (http://www.novell.com)

 .\" Author:
 .\"   Sebastien Pouliot <sebastien@ximian.com>
 .\"
 .TH Mono "sn"
 .SH NAME
 .\" Author:
 .\"   Sebastien Pouliot <sebastien@ximian.com>
 .\"
 .TH Mono "sn"
 .SH NAME

-sn \- Digitally sign/verify/compare strongname on CLR assemblies.
+sn \- Digitally sign/verify/compare strongnames on CLR assemblies.

 .SH SYNOPSIS
 .PP
 .B sn [-q | -quiet] [options] [parameters]
 .SH DESCRIPTION
 .SH SYNOPSIS
 .PP
 .B sn [-q | -quiet] [options] [parameters]
 .SH DESCRIPTION

-Digitally sign, verify or compare, CLR assemblies using strongnames. 
+Digitally sign, verify or compare CLR assemblies using strongnames.
+.PP
+You can use the sn command to create "snk files" using the -k option
+described below.

 .SH CONFIGURATION OPTIONS
 Configuration options are stored in the machine.config configuration file
 under /configuration/strongNames.
 .SH CONFIGURATION OPTIONS
 Configuration options are stored in the machine.config configuration file
 under /configuration/strongNames.


@@ -31,7 +34,7 @@ strongNames/verificationSettings in machine.config.
 .TP
 .I "-Vr assembly [userlist]"
 Exempt the specified assembly from verification for the specified user list.
 .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
+Currently not supported by sn. You must edit machine.config manually if you

 require this.
 .TP
 .I "-Vu assembly"
 require this.
 .TP
 .I "-Vu assembly"


@@ -51,14 +54,14 @@ Import the specified strongname file into the specified container.
 .TP
 .I "-pc container publickey"
 Export the public key from the specified CSP container to the specified file.
 .TP
 .I "-pc container publickey"
 Export the public key from the specified CSP container to the specified file.

-.SH CONVERTION OPTIONS
+.SH CONVERSION OPTIONS

 .TP
 .I "-e assembly output.pub"
 Export the assembly public key to the specified output file.
 .TP
 .I "-p keypair.snk output.pub"
 .TP
 .I "-e assembly output.pub"
 Export the assembly public key to the specified output file.
 .TP
 .I "-p keypair.snk output.pub"

-Export the public key from the specified strongname key file (SNK) to the 
-specified output file.
+Export the public key from the specified strongname key file (SNK) or from
+a PKCS#12/PFX password protected file to the specified output file.

 .TP
 .I "-o input output.txt"
 Convert the input file to a CSV file (using decimal).
 .TP
 .I "-o input output.txt"
 Convert the input file to a CSV file (using decimal).


@@ -71,27 +74,31 @@ Convert the input file to a CSV file (using hexadecimal).
 Compare if assembly1 and assembly are the same exception for their signature.
 This is done by comparing the hash of the metadata of both assembly.
 .TP
 Compare if assembly1 and assembly are the same exception for their signature.
 This is done by comparing the hash of the metadata of both assembly.
 .TP

-.I "-k keypair.snk"
-Create a new strongname keypair (a 1024 bits RSA keypair) in the specified 
-file.
+.I "-k [size] keypair.snk"
+Create a new strongname keypair in the specified file. The default key 
+length is 1024 bits and MUST ALWAYS be used when signing 1.x assemblies. 
+Any value from 384 to 16384 bits (in increments of 8 bits) is a valid key 
+length to sign 2.x assemblies. To ensure maximum compatibility you may 
+want to continue using 1024 bits keys. Note that there's no good reason, 
+even if it's possible, to use length lesser than 1024 bits.

 .TP
 .I "-R assembly keypair.snk"
 .TP
 .I "-R assembly keypair.snk"

-Resign the specified assembly using the specified strongname keypair file 
-(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).
+Re-sign the specified assembly using the specified strongname keypair file 
+(SNK) or a PKCS#12/PFX password protected file. You can only sign an 
+assembly with the private key 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"
 .TP
 .I "-Rc assembly container"

-Resign the specified assembly using the specified strongname container.
+Re-sign the specified assembly using the specified strongname container.

 .TP
 .I "-t file"
 .TP
 .I "-t file"

-Show the public key from the specified file.
+Show the public key token from the specified file.

 .TP
 .I "-tp file"
 Show the public key and the public key token from the specified file.
 .TP
 .I "-T assembly"
 .TP
 .I "-tp file"
 Show the public key and the public key token from the specified file.
 .TP
 .I "-T assembly"

-Show the public key from the specified assembly.
+Show the public key token from the specified assembly.

 .TP
 .I "-Tp assembly"
 Show the public key and the public key token from the specified assembly.
 .TP
 .I "-Tp assembly"
 Show the public key and the public key token from the specified assembly.


@@ -113,7 +120,7 @@ Display configuration related help about this tool.
 Display Cryptographic Service Provider related help about this tool.
 .TP
 .I "-h convert", "-? convert"
 Display Cryptographic Service Provider related help about this tool.
 .TP
 .I "-h convert", "-? convert"

-Display convertion related help about this tool.
+Display conversion related help about this tool.

 .TP
 .I "-h sn", "-? sn"
 Display strongname related help about this tool.
 .TP
 .I "-h sn", "-? sn"
 Display strongname related help about this tool.


@@ -123,9 +130,9 @@ Strongnames configuration is kept in "machine.config" file. Currently two
 features can be configured.
 .TP
 .I "/configuration/strongNames/pubTokenMapping"
 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"
+This mechanism lets 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" need 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 
 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