Mercurial > projects > sencrypt

annotate sencrypt.1.xml @ 1:f0ceb0ad20e7 version-1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add manpage
author Guido Berhoerster <guido+sencrypt@berhoerster.name>
date Thu, 30 Jan 2014 00:00:13 +0100
parents
children 8e9dd5328b5a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
1 <?xml version="1.0"?>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
2 <!--
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
3
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
4 Copyright (C) 2014 Guido Berhoerster <guido+sencrypt@berhoerster.name>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
5
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
6 Permission is hereby granted, free of charge, to any person obtaining
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
7 a copy of this software and associated documentation files (the
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
8 "Software"), to deal in the Software without restriction, including
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
9 without limitation the rights to use, copy, modify, merge, publish,
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
10 distribute, sublicense, and/or sell copies of the Software, and to
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
11 permit persons to whom the Software is furnished to do so, subject to
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
12 the following conditions:
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
13
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
14 The above copyright notice and this permission notice shall be included
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
15 in all copies or substantial portions of the Software.
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
16
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
17 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
18 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
19 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
20 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
21 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
22 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
23 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
24
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
25 -->
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
26 <refentry xmlns="http://docbook.org/ns/docbook" xml:lang="en">
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
27 <info>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
28 <author>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
29 <personname>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
30 <firstname>Guido</firstname>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
31 <surname>Berhoerster</surname>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
32 </personname>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
33 <email>guido+sencrypt@berhoerster.name</email>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
34 <personblurb/>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
35 </author>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
36 <date>21 January, 2014</date>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
37 </info>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
38 <refmeta>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
39 <refentrytitle>sencrypt</refentrytitle>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
40 <manvolnum>1</manvolnum>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
41 <refmiscinfo class="source"/>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
42 <refmiscinfo class="version"/>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
43 <refmiscinfo class="manual">User Commands</refmiscinfo>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
44 </refmeta>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
45 <refnamediv>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
46 <refname>sencrypt</refname>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
47 <refname>sdecrypt</refname>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
48 <refpurpose>encrypt and decrypt data</refpurpose>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
49 </refnamediv>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
50 <refsynopsisdiv>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
51 <cmdsynopsis>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
52 <command>sencrypt</command>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
53 <arg choice="req">
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
54 <option>-l</option>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
55 </arg>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
56 </cmdsynopsis>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
57 <cmdsynopsis>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
58 <command>sencrypt</command>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
59 <arg choice="opt">
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
60 <option>-v</option>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
61 </arg>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
62 <arg choice="req">
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
63 <option>-a</option>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
64 <replaceable>algorithm</replaceable>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
65 </arg>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
66 <arg choice="opt">
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
67 <option>-k</option>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
68 <replaceable>key_file</replaceable>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
69 </arg>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
70 <arg choice="opt">
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
71 <option>-i</option>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
72 <replaceable>input_file</replaceable>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
73 </arg>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
74 <arg choice="opt">
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
75 <option>-o</option>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
76 <replaceable>output_file</replaceable>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
77 </arg>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
78 </cmdsynopsis>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
79 <cmdsynopsis>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
80 <command>sdecrypt</command>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
81 <arg choice="req">
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
82 <option>-l</option>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
83 </arg>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
84 </cmdsynopsis>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
85 <cmdsynopsis>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
86 <command>sdecrypt</command>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
87 <arg choice="opt">
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
88 <option>-v</option>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
89 </arg>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
90 <arg choice="req">
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
91 <option>-a</option>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
92 <replaceable>algorithm</replaceable>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
93 </arg>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
94 <arg choice="opt">
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
95 <option>-k</option>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
96 <replaceable>key_file</replaceable>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
97 </arg>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
98 <arg choice="opt">
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
99 <option>-i</option>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
100 <replaceable>input_file</replaceable>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
101 </arg>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
102 <arg choice="opt">
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
103 <option>-o</option>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
104 <replaceable>output_file</replaceable>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
105 </arg>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
106 </cmdsynopsis>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
107 </refsynopsisdiv>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
108 <refsect1>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
109 <title>Description</title>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
110 <para>The <command>sencrypt</command> utility encrypts data and the
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
111 <command>sdecrypt</command> utility decrypts data using the specified
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
112 algorithm. A key file must be a regular file and have the exact size of the
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
113 desired key length, its content will be used verbatim as the key. If no key
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
114 file is specified <command>sencrypt</command> or
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
115 <command>sdecrypt</command> will ask for a passphrase and use that together
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
116 with a salt to derive a key using the PBKDF2 key derivation function. If no
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
117 input file is specfified, the input will be read from stdin. If no output
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
118 file is specfied, the output will be written to stdout. The input and
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
119 output file may be identical, in which case the content of the input file
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
120 is replaced with the output after successful encryption or decryption. The
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
121 algorithm used for encrypting data is not saved and needs to be explicitly
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
122 specified when decrypting data.</para>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
123 <para><command>sencrypt</command> and <command>sdecrypt</command> are
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
124 portable and compatible reimplementations of the <command>encrypt</command>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
125 and <command>decrypt</command> utilities in Solaris/Illumos-based operating
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
126 systems.</para>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
127 </refsect1>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
128 <refsect1>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
129 <title>Options</title>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
130 <para>The following options are supported:</para>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
131 <variablelist>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
132 <varlistentry>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
133 <term>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
134 <option>-l</option>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
135 </term>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
136 <listitem>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
137 <para>List the available algorithms and supported key lengths and
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
138 exit.</para>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
139 </listitem>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
140 </varlistentry>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
141 <varlistentry>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
142 <term>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
143 <option>-a</option>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
144 <replaceable>algorithm</replaceable>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
145 </term>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
146 <listitem>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
147 <para>Use the specified algorithm.</para>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
148 </listitem>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
149 </varlistentry>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
150 <varlistentry>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
151 <term>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
152 <option>-k</option>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
153 <replaceable>key_file</replaceable>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
154 </term>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
155 <listitem>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
156 <para>Read key data from specified key file. Key size requirements
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
157 depend on the selected algorithm.</para>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
158 </listitem>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
159 </varlistentry>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
160 <varlistentry>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
161 <term>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
162 <option>-i</option>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
163 <replaceable>input_file</replaceable>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
164 </term>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
165 <listitem>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
166 <para>Read the input from the specified file.</para>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
167 </listitem>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
168 </varlistentry>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
169 <varlistentry>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
170 <term>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
171 <option>-o</option>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
172 <replaceable>output_file</replaceable>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
173 </term>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
174 <listitem>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
175 <para>Write the output to the specified file.</para>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
176 </listitem>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
177 </varlistentry>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
178 <varlistentry>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
179 <term>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
180 <option>-v</option>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
181 </term>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
182 <listitem>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
183 <para>Ignored for compatibility with <command>encrypt</command> and
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
184 <command>decrypt</command>.</para>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
185 </listitem>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
186 </varlistentry>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
187 </variablelist>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
188 </refsect1>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
189 <refsect1>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
190 <title>Examples</title>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
191 <example>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
192 <title>Encrypt a file with the AES algorithm</title>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
193 <para>The following example encrypts a file with the AES algorithm:</para>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
194 <screen>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
195 $ sencrypt -a aes -i secret.txt -o secret.aes
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
196 </screen>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
197 </example>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
198 <example>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
199 <title>Decrypt a file in-place</title>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
200 <para>The following example decrypts a file in-place:</para>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
201 <screen>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
202 $ sdecrypt -a 3des -i data.bin -o data.bin
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
203 </screen>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
204 </example>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
205 <example>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
206 <title>Encrypt a file using a key file</title>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
207 <para>The following example generates a key file with 512 bits of random
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
208 data and uses it to encrypt a file:</para>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
209 <screen>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
210 $ dd if=/dev/urandom of=key.bin bs=64 count=1
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
211 $ sencrypt -a arcfour -k key.bin -i secret.txt -o secret.rc4
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
212 </screen>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
213 </example>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
214 <example>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
215 <title>Pipe data trough encrypt in order to make a remote encrypted
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
216 backup</title>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
217 <para>The following example creates an archive in the tar format,
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
218 encrypts it and sends it to a remote location via
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
219 <abbrev>SSH</abbrev>:</para>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
220 <screen>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
221 $ pax -w -x ustar /home | sencrypt -a aes -k backup-key.bin |\
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
222 ssh backuphost 'cat > home.tar'
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
223 </screen>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
224 </example>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
225 </refsect1>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
226 <refsect1>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
227 <title>Exit Status</title>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
228 <para>The following exit values are returned:</para>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
229 <variablelist>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
230 <varlistentry>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
231 <term>0</term>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
232 <listitem>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
233 <para>Command successfully executed.</para>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
234 </listitem>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
235 </varlistentry>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
236 <varlistentry>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
237 <term>&gt; 0</term>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
238 <listitem>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
239 <para>An error has occured.</para>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
240 </listitem>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
241 </varlistentry>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
242 </variablelist>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
243 </refsect1>
f0ceb0ad20e7 Add manpage
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
244 </refentry>