[6dcb9e77] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[66e5fd8b] | 7 | <!ENTITY volume_key-download-http "https://github.com/felixonmars/volume_key/archive/volume_key-&volume_key-version;.tar.gz">
|
---|
[6dcb9e77] | 8 | <!ENTITY volume_key-download-ftp " ">
|
---|
[66e5fd8b] | 9 | <!ENTITY volume_key-md5sum "d1c76f24e08ddd8c1787687d0af5a814">
|
---|
[cdf0106] | 10 | <!ENTITY volume_key-size "196 KB">
|
---|
[66e5fd8b] | 11 | <!ENTITY volume_key-buildsize "11 MB">
|
---|
| 12 | <!ENTITY volume_key-time "0.2 SBU">
|
---|
[6dcb9e77] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="volume_key" xreflabel="volume_key-&volume_key-version;">
|
---|
| 16 | <?dbhtml filename="volume_key.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
[fda29e4] | 19 | <date>$Date$</date>
|
---|
[6dcb9e77] | 20 | </sect1info>
|
---|
| 21 |
|
---|
| 22 | <title>volume_key-&volume_key-version;</title>
|
---|
| 23 |
|
---|
| 24 | <indexterm zone="volume_key">
|
---|
| 25 | <primary sortas="a-volume_key">volume_key</primary>
|
---|
| 26 | </indexterm>
|
---|
| 27 |
|
---|
| 28 | <sect2 role="package">
|
---|
| 29 | <title>Introduction to volume_key</title>
|
---|
| 30 |
|
---|
| 31 | <para>
|
---|
[8558044] | 32 | The <application>volume_key</application> package provides
|
---|
| 33 | a library for manipulating storage volume encryption keys and storing
|
---|
[6dcb9e77] | 34 | them separately from volumes to handle forgotten passphrases.
|
---|
| 35 | </para>
|
---|
| 36 |
|
---|
[7263a049] | 37 | &lfs112_checked;
|
---|
[6dcb9e77] | 38 |
|
---|
| 39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 40 | <itemizedlist spacing="compact">
|
---|
| 41 | <listitem>
|
---|
| 42 | <para>
|
---|
| 43 | Download (HTTP): <ulink url="&volume_key-download-http;"/>
|
---|
| 44 | </para>
|
---|
| 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>
|
---|
| 48 | Download (FTP): <ulink url="&volume_key-download-ftp;"/>
|
---|
| 49 | </para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>
|
---|
| 53 | Download MD5 sum: &volume_key-md5sum;
|
---|
| 54 | </para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>
|
---|
| 58 | Download size: &volume_key-size;
|
---|
| 59 | </para>
|
---|
| 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
| 62 | <para>
|
---|
| 63 | Estimated disk space required: &volume_key-buildsize;
|
---|
| 64 | </para>
|
---|
| 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
| 67 | <para>
|
---|
| 68 | Estimated build time: &volume_key-time;
|
---|
| 69 | </para>
|
---|
| 70 | </listitem>
|
---|
| 71 | </itemizedlist>
|
---|
[66e5fd8b] | 72 |
|
---|
[6dcb9e77] | 73 | <bridgehead renderas="sect3">volume_key Dependencies</bridgehead>
|
---|
| 74 |
|
---|
| 75 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 76 | <para role="required">
|
---|
[7dcab6e] | 77 | <xref linkend="cryptsetup"/>,
|
---|
[6dcb9e77] | 78 | <xref linkend="glib2"/>,
|
---|
[c4d96918] | 79 | <xref linkend="gpgme"/>, and
|
---|
| 80 | <xref linkend="nss"/>
|
---|
| 81 | </para>
|
---|
| 82 |
|
---|
| 83 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 84 | <para role="recommended">
|
---|
[0dc5ab2e] | 85 | <xref linkend="swig"/>
|
---|
[8c08e6a] | 86 | </para>
|
---|
[85ac148] | 87 | <!-- We prevent using Python2, so do not advertise it
|
---|
[c4d96918] | 88 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 89 | <para role="optional">
|
---|
| 90 | <xref linkend="python2"/>
|
---|
| 91 | </para>
|
---|
[85ac148] | 92 | -->
|
---|
[6dcb9e77] | 93 | <para condition="html" role="usernotes">User Notes:
|
---|
| 94 | <ulink url="&blfs-wiki;/volume_key"/>
|
---|
| 95 | </para>
|
---|
| 96 | </sect2>
|
---|
| 97 |
|
---|
| 98 | <sect2 role="installation">
|
---|
| 99 | <title>Installation of volume_key</title>
|
---|
| 100 |
|
---|
| 101 | <para>
|
---|
| 102 | Install <application>volume_key</application> by running the following
|
---|
| 103 | commands:
|
---|
| 104 | </para>
|
---|
| 105 |
|
---|
[66e5fd8b] | 106 | <note>
|
---|
[47274444] | 107 | <para>
|
---|
| 108 | This package expands to the directory
|
---|
| 109 | volume_key-volume_key-&volume_key-version;.
|
---|
[66e5fd8b] | 110 | </para>
|
---|
| 111 | </note>
|
---|
| 112 |
|
---|
[c4d96918] | 113 | <screen><userinput>autoreconf -fiv &&
|
---|
| 114 | ./configure --prefix=/usr \
|
---|
| 115 | --without-python &&
|
---|
[8c08e6a] | 116 | make</userinput></screen>
|
---|
[6dcb9e77] | 117 |
|
---|
| 118 | <para>
|
---|
| 119 | This package does not come with a functioning test suite.
|
---|
| 120 | </para>
|
---|
| 121 |
|
---|
| 122 | <para>
|
---|
| 123 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 124 | </para>
|
---|
| 125 |
|
---|
[d18f21a] | 126 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[0dc5ab2e] | 127 |
|
---|
| 128 | </sect2>
|
---|
| 129 |
|
---|
[c4d96918] | 130 | <sect2 role="commands">
|
---|
| 131 | <title>Command Explanations</title>
|
---|
| 132 |
|
---|
| 133 | <para>
|
---|
| 134 | <parameter>--without-python</parameter>: This parameter prevents building
|
---|
| 135 | the <application>Python 2</application> bindings, if <xref
|
---|
| 136 | linkend="python2"/> is installed.
|
---|
| 137 | </para>
|
---|
| 138 |
|
---|
| 139 | <para>
|
---|
| 140 | <option>--without-python3</option>: Use this option if you do not want
|
---|
| 141 | to build the <application>Python 3</application> bindings. In this case,
|
---|
| 142 | <xref linkend="swig"/> is not needed.
|
---|
| 143 | </para>
|
---|
| 144 |
|
---|
| 145 | </sect2>
|
---|
[6dcb9e77] | 146 | <sect2 role="content">
|
---|
| 147 | <title>Contents</title>
|
---|
| 148 |
|
---|
| 149 | <segmentedlist>
|
---|
| 150 | <segtitle>Installed Program</segtitle>
|
---|
| 151 | <segtitle>Installed Library</segtitle>
|
---|
| 152 | <segtitle>Installed Directory</segtitle>
|
---|
| 153 |
|
---|
| 154 | <seglistitem>
|
---|
| 155 | <seg>
|
---|
| 156 | volume_key
|
---|
| 157 | </seg>
|
---|
| 158 | <seg>
|
---|
| 159 | libvolume_key.so
|
---|
| 160 | </seg>
|
---|
| 161 | <seg>
|
---|
| 162 | /usr/include/volume_key
|
---|
| 163 | </seg>
|
---|
| 164 | </seglistitem>
|
---|
| 165 | </segmentedlist>
|
---|
| 166 |
|
---|
| 167 | <variablelist>
|
---|
| 168 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 169 | <?dbfo list-presentation="list"?>
|
---|
| 170 | <?dbhtml list-presentation="table"?>
|
---|
| 171 |
|
---|
| 172 | <varlistentry id="volume_key-prog">
|
---|
| 173 | <term><command>volume_key</command></term>
|
---|
| 174 | <listitem>
|
---|
| 175 | <para>
|
---|
[4c24eb0a] | 176 | manages encrypted volume keys and passphrases
|
---|
[6dcb9e77] | 177 | </para>
|
---|
| 178 | <indexterm zone="volume_key volume_key-prog">
|
---|
| 179 | <primary sortas="b-volume_key">volume_key</primary>
|
---|
| 180 | </indexterm>
|
---|
| 181 | </listitem>
|
---|
| 182 | </varlistentry>
|
---|
| 183 |
|
---|
| 184 | <varlistentry id="volume_key-lib">
|
---|
| 185 | <term><filename class="libraryfile">volume_key.so</filename></term>
|
---|
| 186 | <listitem>
|
---|
| 187 | <para>
|
---|
[4c24eb0a] | 188 | contains API functions for managing encrypted volume keys
|
---|
[6dcb9e77] | 189 | </para>
|
---|
| 190 | <indexterm zone="volume_key volume_key-lib">
|
---|
| 191 | <primary sortas="c-volume_key">volume_key.so</primary>
|
---|
| 192 | </indexterm>
|
---|
| 193 | </listitem>
|
---|
| 194 | </varlistentry>
|
---|
| 195 |
|
---|
| 196 | </variablelist>
|
---|
| 197 |
|
---|
| 198 | </sect2>
|
---|
| 199 |
|
---|
| 200 | </sect1>
|
---|