Merge pull request #5714 from alexischr/update_bockbuild
[mono.git] / man / sn.1
index 7ab6190c1ff4f474e09f9c1326be9d854ab0be59..2304e33e7e72e2d9745393b7322a54264a524f85 100644 (file)
--- a/man/sn.1
+++ b/man/sn.1
@@ -7,12 +7,15 @@
 .\"
 .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
-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.
@@ -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.
-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"
@@ -51,7 +54,7 @@ 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.
-.SH CONVERTION OPTIONS
+.SH CONVERSION OPTIONS
 .TP
 .I "-e assembly output.pub"
 Export the assembly public key to the specified output file.
@@ -68,8 +71,8 @@ Convert the input file to a CSV file (using hexadecimal).
 .SH STRONGNAME SIGNING OPTIONS
 .TP
 .I "-D assembly1 assembly2"
-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.
+Compare if assembly1 and assembly2 are the same except for their signature.
+This is done by comparing the hash of the metadata of both assemblies.
 .TP
 .I "-k [size] keypair.snk"
 Create a new strongname keypair in the specified file. The default key 
@@ -80,22 +83,22 @@ 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"
-Resign the specified assembly using the specified strongname keypair file 
+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
+assembly with the private key that matches 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.
+Re-sign the specified assembly using the specified strongname container.
 .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"
-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.
@@ -117,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 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.
@@ -127,12 +130,12 @@ 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"
+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 
+A new key cannot be used because it should change the 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"