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
|
<?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 pull</title>
<productname>OSTree</productname>
</refentryinfo>
<refmeta>
<refentrytitle>ostree pull</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ostree-pull</refname>
<refpurpose>Download data from a remote repository</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ostree pull <arg choice="req">REMOTE</arg> <arg choice="opt">BRANCH</arg></command>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>--commit-metadata-only</option></term>
<listitem><para>
Fetch only the commit metadata.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--cache-dir</option>=DIR</term>
<listitem><para>
Use an alternate cache directory in <literal>DIR</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--disable-fsync</option></term>
<listitem><para>
Do no invoke fsync().
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--localcache-repo</option></term>
<listitem><para>
Like git's <literal>clone --reference</literal>. Reuse the provided
OSTree repo as a local object cache when doing HTTP fetches.
May be specified multiple times.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--untrusted</option></term>
<listitem><para>
Do not trust local sources, verify checksums and don't hardlink into source.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--disable-static-deltas</option></term>
<listitem><para>
Do not use static deltas.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--mirror</option></term>
<listitem><para>
Write refs suitable for a mirror, i.e. refs are stored in the
<literal>heads/</literal> directory rather than the
<literal>remotes/</literal> directory. This makes the target repo
suitable to be exported for other clients to pull from as an ostree
remote. If no specific refs are specified, all refs will be fetched (the
remote must have a summary file present).
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--subpath</option>=SUBPATH</term>
<listitem><para>
Only pull the provided subpath.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--depth</option>=DEPTH</term>
<listitem><para>
Traverse DEPTH parents (-1=infinite) (default: 0).
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--network-retries</option>=N</term>
<listitem><para>
Specifies how many times each download should be retried upon error (default: 5)
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--disable-retry-on-network-errors</option></term>
<listitem><para>
Do not retry when network issues happen, instead fail automatically. (Currently only affects libcurl)
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--low-speed-limit-bytes</option>=N</term>
<listitem><para>
The average transfer speed per second of a transfer during the
time set via 'low-speed-time-seconds' for libcurl to abort
(default: 1000)
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--low-speed-time-seconds</option>=N</term>
<listitem><para>
The time in number seconds that the transfer speed should be
below the 'low-speed-limit-bytes' setting for libcurl to abort
(default: 30)
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--max-outstanding-fetcher-requests</option>=N</term>
<listitem><para>
The max amount of concurrent connections allowed. (default: 8)
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--disable-verify-bindings</option></term>
<listitem><para>
Disable verification of commit metadata bindings.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Description</title>
<para>
Without --mirror, this command will create new refs
under <literal>remotes/REMOTE/</literal> directory
for each pulled branch unless they are already created. Such
refs can be then referenced by <literal>REMOTE:BRANCH</literal> in
<literal>ostree</literal> subcommands (e.g. <literal>ostree log origin:exampleos/x86_64/standard</literal>).
</para>
<para>
This command can retrieve just a specific commit, or go all
the way to performing a full mirror of the remote
repository. If no <literal>BRANCH</literal> is specified,
all configured branches are retrieved.
</para>
<para>
A special syntax in the <literal>@</literal> character allows
specifying a specific commit to retrieve from a branch. The
use cases for this are somewhat similar to pulling a specific
git tag; one could e.g. script a system upgrade to a known-good
version, rather than the latest from the content provider.
</para>
</refsect1>
<refsect1>
<title>Example</title>
<para><command>$ ostree --repo=repo pull --depth=-1 --mirror remote_name</command></para>
<para>Perform a complete mirror of the remote. (This is
likely most useful if your repository is also
<literal>archive</literal> mode)</para>
<para><command>$ ostree --repo=repo pull remote_name exampleos/x86_64/standard</command></para>
<para>Fetch the most recent commit to <literal>exampleos/x86_64/standard</literal>.</para>
<para><command>$ ostree --repo=repo pull remote_name exampleos/x86_64/standard@98ea6e4f216f2fb4b69fff9b3a44842c38686ca685f3f55dc48c5d3fb1107be4</command></para>
<para>Download the specific commit starting with
<literal>98ea6e</literal> as if it was the latest commit for
<literal>exampleos/x86_64/standard</literal>.</para>
</refsect1>
</refentry>
|
