[Rpm-maint] [PATCH v9 11/13] Documentation for file signing

[Fionnuala Gunter]

From: "fin at linux.vnet.ibm.com" <fin at linux.vnet.ibm.com>

This patch adds documentation for signing files.

Changelog:
- Removed new file signature macro example -  Mimi
---
 doc/rpmsign.8 | 24 ++++++++++++++++++++++--
 1 file changed, 22 insertions(+), 2 deletions(-)

diff --git a/doc/rpmsign.8 b/doc/rpmsign.8
index 53f2d70..80ffb6a 100644
--- a/doc/rpmsign.8
+++ b/doc/rpmsign.8
@@ -2,11 +2,17 @@
 .SH NAME
 rpmsign \- RPM Package Signing
 .SH SYNOPSIS
+.SS "SIGNING PACKAGES:"
+.PP
 
-\fBrpm\fR \fB--addsign|--resign\fR \fB\fIPACKAGE_FILE\fB\fR\fI ...\fR
+\fBrpm\fR \fB--addsign|--resign\fR [\fBrpmsign-options\fR] \fB\fIPACKAGE_FILE\fB\fR\fI ...\fR
 
 \fBrpm\fR \fB--delsign\fR \fB\fIPACKAGE_FILE\fB\fR\fI ...\fR
 
+.SS "rpmsign-options"
+.PP
+[\fb--fskpath \fIKEY\fb\fR] [\fB--signfiles\fR]
+
 .SH DESCRIPTION
 .PP
 Both of the \fB--addsign\fR and \fB--resign\fR
@@ -20,6 +26,19 @@ there is no difference in behavior currently.
 .PP
 Delete all signatures from each package \fIPACKAGE_FILE\fR given.
 
+.SS "SIGN OPTIONS"
+.PP
+.TP
+\fB--fskpath \fIKEY\fB\fR
+Used with \fB--signfiles\fR, use file signing key \fIKey\fR.
+.TP
+\fB--signfiles\fR
+Sign package files. The macro \fB%_binary_filedigest_algorithm\fR must
+be set to a supported algorithm before building the package. The
+supported algorithms are SHA1, SHA256, SHA384, and SHA512, which are
+represented as 2, 8, 9, and 10 respectively.  The file signing key (RSA
+private key) must be set before signing the package, it can be configured on the command line with \fB--fskpath\fR or the macro %_file_signing_key.
+
 .SS "USING GPG TO SIGN PACKAGES"
 .PP
 In order to sign packages using GPG, \fBrpm\fR
@@ -52,7 +71,7 @@ using the executable \fI/usr/bin/gpg\fR you would include
 in a macro configuration file. Use \fI/etc/rpm/macros\fR
 for per-system configuration and \fI~/.rpmmacros\fR
 for per-user configuration. Typically it's sufficient to set just %_gpg_name.
-
+.PP
 .SH "SEE ALSO"
 .nf
 \fBpopt\fR(3),
@@ -78,4 +97,5 @@ Marc Ewing <marc at redhat.com>
 Jeff Johnson <jbj at redhat.com>
 Erik Troan <ewt at redhat.com>
 Panu Matilainen <pmatilai at redhat.com>
+Fionnuala Gunter <fin at linux.vnet.ibm.com>
 .fi
-- 
2.4.3