summaryrefslogtreecommitdiff
path: root/tools/rscryutil.1
diff options
context:
space:
mode:
authorMichael Biebl <biebl@debian.org>2014-03-28 00:23:42 +0100
committerMichael Biebl <biebl@debian.org>2014-03-28 00:23:42 +0100
commit209e193f14ec562df5aad945f04cd88b227cc602 (patch)
treee7c77568e4c9619c1ea38b4638d3143ea3ee2ca1 /tools/rscryutil.1
parent29b51b47d541217c16564ac1f8ecb4a6067c4dad (diff)
downloadrsyslog-209e193f14ec562df5aad945f04cd88b227cc602.tar.gz
Imported Upstream version 7.6.3upstream/7.6.3
Diffstat (limited to 'tools/rscryutil.1')
-rw-r--r--tools/rscryutil.129
1 files changed, 13 insertions, 16 deletions
diff --git a/tools/rscryutil.1 b/tools/rscryutil.1
index c1d8d04..cd6dc9d 100644
--- a/tools/rscryutil.1
+++ b/tools/rscryutil.1
@@ -1,4 +1,4 @@
-.\" Man page generated from reStructuredText.
+.\" Man page generated from reStructeredText.
.
.TH RSCRYUTIL 1 "2013-04-15" "" ""
.SH NAME
@@ -31,16 +31,12 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
-.INDENT 0.0
-.INDENT 3.5
.sp
.nf
.ft C
rscryutil [OPTIONS] [FILE] ...
.ft P
.fi
-.UNINDENT
-.UNINDENT
.SH DESCRIPTION
.sp
This tool performs various operations on encrypted log files.
@@ -48,46 +44,46 @@ Most importantly, it provides the ability to decrypt them.
.SH OPTIONS
.INDENT 0.0
.TP
-.B \-d\fP,\fB \-\-decrypt
+.B \-d, \-\-decrypt
Select decryption mode. This is the default mode.
.TP
-.BI \-W\fP,\fB \-\-write\-keyfile \ <file>
+.BI \-W, \-\-write\-keyfile \ <file>
Utility function to write a key to a keyfile. The key can be obtained
via any method.
.TP
-.B \-v\fP,\fB \-\-verbose
+.B \-v, \-\-verbose
Select verbose mode.
.TP
-.B \-f\fP,\fB \-\-force
+.B \-f, \-\-force
Forces operations that otherwise would fail.
.TP
-.BI \-k\fP,\fB \-\-keyfile \ <file>
+.BI \-k, \-\-keyfile \ <file>
Reads the key from <file>. File _must_ contain the key, only, no headers
or other meta information. Keyfiles can be generated via the
\fI\-\-write\-keyfile\fP option.
.TP
-.BI \-p\fP,\fB \-\-key\-program \ <path\-to\-program>
+.BI \-p, \-\-key\-program \ <path\-to\-program>
In this mode, the key is provided by a so\-called "key program". This program
is executed and must return the key to (as well as some meta information)
via stdout. The core idea of key programs is that using this interface the
user can implement as complex (and secure) method to obtain keys as
desired, all without the need to make modifications to rsyslog.
.TP
-.BI \-K\fP,\fB \-\-key \ <KEY>
+.BI \-K, \-\-key \ <KEY>
TESTING AID, NOT FOR PRODUCTION USE. This uses the KEY specified
on the command line. This is the actual key, and as such this mode
is highly insecure. However, it can be useful for intial testing
steps. This option may be removed in the future.
.TP
-.BI \-a\fP,\fB \-\-algo \ <algo>
+.BI \-a, \-\-algo \ <algo>
Sets the encryption algorightm (cipher) to be used. See below
for supported algorithms. The default is "AES128".
.TP
-.BI \-m\fP,\fB \-\-mode \ <mode>
+.BI \-m, \-\-mode \ <mode>
Sets the ciphermode to be used. See below for supported modes.
The default is "CBC".
.TP
-.BI \-r\fP,\fB \-\-generate\-random\-key \ <bytes>
+.BI \-r, \-\-generate\-random\-key \ <bytes>
Generates a random key of length <bytes>. This option is
meant to be used together with \fI\-\-write\-keyfile\fP (and it is hard
to envision any other valid use for it).
@@ -101,7 +97,7 @@ multiple operations mode are set on the command line, results are
unpredictable.
.SS decrypt
.sp
-The provided log files are decrypted. Note that the \fI\&.encinfo\fP side files
+The provided log files are decrypted. Note that the \fI.encinfo\fP side files
must exist and be accessible in order for decryption to to work.
.SS write\-keyfile
.sp
@@ -202,4 +198,5 @@ LGPLv2.
.SH AUTHOR
Rainer Gerhards <rgerhards@adiscon.com>
.\" Generated by docutils manpage writer.
+.\"
.