ostree/man/ostree-checkout.1

86 lines
2.4 KiB
Groff

'\" t
.\" Title: ostree checkout
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 10/05/2016
.\" Manual: ostree checkout
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE CHECKOUT" "1" "" "OSTree" "ostree checkout"
.\" -----------------------------------------------------------------
.\" * 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-checkout \- Check out a commit into a filesystem
.SH "SYNOPSIS"
.HP \w'\fBostree\ checkout\fR\ 'u
\fBostree checkout\fR [OPTIONS...] {COMMIT} [DESTINATION]
.SH "DESCRIPTION"
.PP
Checks out the given commit into the filesystem under directory DESTINATION\&. If DESTINATION is not specified, the COMMIT will become the destination checkout target\&. If COMMIT destination already exists, command will error unless
\fB\-\-union\fR
option is selected\&.
.SH "OPTIONS"
.PP
\fB\-\-user\-mode\fR,\fB \-u\fR
.RS 4
Do not change file ownership or initialize extended attributes\&.
.RE
.PP
\fB\-\-subpath\fR="PATH"
.RS 4
Checkout sub\-directory PATH\&.
.RE
.PP
\fB\-\-union\fR
.RS 4
Keep existing directories and unchanged files, overwrite existing files\&.
.RE
.PP
\fB\-\-allow\-noent\fR
.RS 4
Do nothing if specified path does not exist\&.
.RE
.PP
\fB\-\-from\-stdin\fR
.RS 4
Process many checkouts from standard input\&.
.RE
.PP
\fB\-\-from\-file\fR="FILE"
.RS 4
Process many checkouts from input file\&.
.RE
.SH "EXAMPLE"
.PP
\fB$ ostree checkout my\-branch\fR
.PP
\fB$ ls\fR
.sp
.if n \{\
.RS 4
.\}
.nf
file1\ \&\ \&\ \&\ \&file2\ \&\ \&\ \&\ \&\fImy\-branch\fR
.fi
.if n \{\
.RE
.\}