'\" t
.\"     Title: ostree pull
.\"    Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 01/31/2019
.\"    Manual: ostree pull
.\"    Source: OSTree
.\"  Language: English
.\"
.TH "OSTREE PULL" "1" "" "OSTree" "ostree pull"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ostree-pull \- Download data from a remote repository
.SH "SYNOPSIS"
.HP \w'\fBostree\ pull\ \fR\fB{REMOTE}\fR\fB\ \fR\fB[BRANCH]\fR\ 'u
\fBostree pull \fR\fB{REMOTE}\fR\fB \fR\fB[BRANCH]\fR
.SH "OPTIONS"
.PP
\fB\-\-commit\-metadata\-only\fR
.RS 4
Fetch only the commit metadata\&.
.RE
.PP
\fB\-\-disable\-fsync\fR
.RS 4
Do no invoke fsync()\&.
.RE
.PP
\fB\-\-localcache\-repo\fR
.RS 4
Like git\*(Aqs
clone \-\-reference\&. Reuse the provided OSTree repo as a local object cache when doing HTTP fetches\&. May be specified multiple times\&.
.RE
.PP
\fB\-\-untrusted\fR
.RS 4
Do not trust local sources, verify checksums and don\*(Aqt hardlink into source\&.
.RE
.PP
\fB\-\-disable\-static\-deltas\fR
.RS 4
Do not use static deltas\&.
.RE
.PP
\fB\-\-mirror\fR
.RS 4
Write refs suitable for a mirror, i\&.e\&. refs are stored in the
heads/
directory rather than the
remotes/
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)\&.
.RE
.PP
\fB\-\-subpath\fR=SUBPATH
.RS 4
Only pull the provided subpath\&.
.RE
.PP
\fB\-\-depth\fR=DEPTH
.RS 4
Traverse DEPTH parents (\-1=infinite) (default: 0)\&.
.RE
.PP
\fB\-\-network\-retries\fR=N
.RS 4
Specifies how many times each download should be retried upon error (default: 5)
.RE
.SH "DESCRIPTION"
.PP
This command can retrieve just a specific commit, or go all the way to performing a full mirror of the remote repository\&. If no
BRANCH
is specified, all configured branches are retrieved\&.
.PP
A special syntax in the
@
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\&.
.SH "EXAMPLE"
.PP
\fB$ ostree \-\-repo=repo pull \-\-depth=\-1 \-\-mirror remote_name\fR
.PP
Perform a complete mirror of the remote\&. (This is likely most useful if your repository is also
archive
mode)
.PP
\fB$ ostree \-\-repo=repo pull remote_name exampleos/x86_64/standard\fR
.PP
Fetch the most recent commit to
exampleos/x86_64/standard\&.
.PP
\fB$ ostree \-\-repo=repo pull remote_name exampleos/x86_64/standard@98ea6e4f216f2fb4b69fff9b3a44842c38686ca685f3f55dc48c5d3fb1107be4\fR
.PP
Download the specific commit starting with
98ea6e
as if it was the latest commit for
exampleos/x86_64/standard\&.