summaryrefslogtreecommitdiff
path: root/man/ostree-static-delta.xml
blob: 4936ada5336a1eae8d2a256f089a5bb0ced54da1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<!--
Copyright 2014 Anne LoVerso <anne.loverso@students.olin.edu>

SPDX-License-Identifier: LGPL-2.0+

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library. If not, see <https://www.gnu.org/licenses/>.
-->

<refentry id="ostree">

    <refentryinfo>
        <title>ostree static-delta</title>
        <productname>OSTree</productname>

        <authorgroup>
            <author>
                <contrib>Developer</contrib>
                <firstname>Colin</firstname>
                <surname>Walters</surname>
                <email>walters@verbum.org</email>
            </author>
        </authorgroup>
    </refentryinfo>

    <refmeta>
        <refentrytitle>ostree static-delta</refentrytitle>
        <manvolnum>1</manvolnum>
    </refmeta>

    <refnamediv>
        <refname>ostree-static-delta</refname>
        <refpurpose>Manage static delta files</refpurpose>
    </refnamediv>

    <refsynopsisdiv>
            <cmdsynopsis>
                <command>ostree static-delta list</command>
            </cmdsynopsis>
            <cmdsynopsis>
                <command>ostree static-delta show</command>
            </cmdsynopsis>
            <cmdsynopsis>
                <command>ostree static-delta delete</command>
            </cmdsynopsis>
            <cmdsynopsis>
                <command>ostree static-delta generate</command> <arg choice="req">--to=REV</arg> <arg choice="opt" rep="repeat">OPTIONS</arg>
            </cmdsynopsis>
            <cmdsynopsis>
                <command>ostree static-delta apply-offline</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">PATH</arg> <arg choice="opt" rep="repeat">KEY-ID</arg>
            </cmdsynopsis>
            <cmdsynopsis>
                <command>ostree static-delta verify</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">STATIC-DELTA</arg> <arg choice="opt" rep="repeat">KEY-ID</arg>
            </cmdsynopsis>
    </refsynopsisdiv>

    <refsect1>
        <title>Description</title>

        <para>
            List and manipulate static delta files.
        </para>
    </refsect1>

    <refsect1>
        <title>'Generate' Options</title>

        <variablelist>
            <varlistentry>
                <term><option>--from</option>="REV"</term>

                <listitem><para>
                    Create delta from revision REV.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--to</option>="REV"</term>

                <listitem><para>
                    Create delta to revision REV.  (This option is required.)
                    The delta is from the parent of REV, unless specified otherwise by <option>--from</option>
                    or <option>--empty</option>.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--empty</option></term>

                <listitem><para>
                    Create delta from scratch.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--max-usize</option>=SIZE</term>

                <listitem><para>
                    Maximum uncompressed size in megabytes.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--sign-type</option>=ENGINE</term>

                <listitem><para>
                    Use particular signature engine. Currently
                    available <arg choice="plain">ed25519</arg> and <arg choice="plain">dummy</arg>
                    signature types.

                    The default is <arg choice="plain">ed25519</arg>.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--sign</option>="KEY-ID"</term>
                <listitem><para>
                        There <literal>KEY-ID</literal> is:
                        <variablelist>
                            <varlistentry>
                                <term><option>for ed25519:</option></term>
                                <listitem><para>
                                        <literal>base64</literal>-encoded secret key for signing.
                                </para></listitem>
                            </varlistentry>

                            <varlistentry>
                                <term><option>for dummy:</option></term>
                                <listitem><para>
                                            ASCII-string used as secret key.
                                </para></listitem>
                            </varlistentry>
                        </variablelist>
                </para></listitem>
            </varlistentry>
        </variablelist>
    </refsect1>

        <refsect1>
            <title>'Apply-offline' Options</title>

            <variablelist>
                <varlistentry>
                    <term><option>KEY-ID</option></term>

                    <listitem><para>
                        <variablelist>
                            <varlistentry>
                                <term><option>for ed25519:</option></term>
                                <listitem><para>
                                        <literal>base64</literal>-encoded public key for verifying.
                                </para></listitem>
                            </varlistentry>

                            <varlistentry>
                                <term><option>for dummy:</option></term>
                                <listitem><para>
                                            ASCII-string used as public key.
                                </para></listitem>
                            </varlistentry>
                        </variablelist>
                    </para></listitem>
                </varlistentry>

                <varlistentry>
                    <term><option>--sign-type</option>=ENGINE</term>

                    <listitem><para>
                        Use particular signature engine. Currently
                        available <arg choice="plain">ed25519</arg> and <arg choice="plain">dummy</arg>
                        signature types.
                    </para></listitem>
                </varlistentry>

                <varlistentry>
                     <term><option>--keys-file</option></term>
                     <listitem><para>
                         Read key(s) from file <filename>filename</filename>.
                     </para></listitem>

                     <listitem><para>
                         Valid for <literal>ed25519</literal> signature type.
                         For <literal>ed25519</literal> this file must contain <literal>base64</literal>-encoded
                         public key(s) per line for verifying.
                     </para></listitem>
                 </varlistentry>

                 <varlistentry>
                     <term><option>--keys-dir</option></term>
                     <listitem><para>
                         Redefine the system path, where to search files and subdirectories with
                         well-known and revoked keys.
                     </para></listitem>
                 </varlistentry>
            </variablelist>
        </refsect1>

    <refsect1>
        <title>'Verify' Options</title>

        <variablelist>
            <varlistentry>
                <term><option>KEY-ID</option></term>

                <listitem><para>
                    <variablelist>
                        <varlistentry>
                            <term><option>for ed25519:</option></term>
                            <listitem><para>
                                    <literal>base64</literal>-encoded public key for verifying.
                            </para></listitem>
                        </varlistentry>

                        <varlistentry>
                            <term><option>for dummy:</option></term>
                            <listitem><para>
                                        ASCII-string used as public key.
                            </para></listitem>
                        </varlistentry>
                    </variablelist>
                </para></listitem>
            </varlistentry>

            <varlistentry>
                <term><option>--sign-type</option>=ENGINE</term>

                <listitem><para>
                    Use particular signature engine. Currently
                    available <arg choice="plain">ed25519</arg> and <arg choice="plain">dummy</arg>
                    signature types.

                    The default is <arg choice="plain">ed25519</arg>.
                </para></listitem>
            </varlistentry>

            <varlistentry>
                 <term><option>--keys-file</option></term>
                 <listitem><para>
                     Read key(s) from file <filename>filename</filename>.
                 </para></listitem>

                 <listitem><para>
                     Valid for <literal>ed25519</literal> signature type.
                     For <literal>ed25519</literal> this file must contain <literal>base64</literal>-encoded
                     public key(s) per line for verifying.
                 </para></listitem>
             </varlistentry>

             <varlistentry>
                 <term><option>--keys-dir</option></term>
                 <listitem><para>
                     Redefine the system path, where to search files and subdirectories with
                     well-known and revoked keys.
                 </para></listitem>
             </varlistentry>
        </variablelist>
    </refsect1>

<!-- Can we have an example for when it actually does something?-->
    <refsect1>
        <title>Example</title>
        <para><command>$ ostree static-delta</command></para>
<programlisting>
        (No static deltas)
</programlisting>
    </refsect1>
</refentry>