'\" t
.\"     Title: ostree refs
.\"    Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 01/31/2019
.\"    Manual: ostree refs
.\"    Source: OSTree
.\"  Language: English
.\"
.TH "OSTREE REFS" "1" "" "OSTree" "ostree refs"
.\" -----------------------------------------------------------------
.\" * 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-refs \- List refs
.SH "SYNOPSIS"
.HP \w'\fBostree\ refs\fR\ 'u
\fBostree refs\fR [OPTIONS...] [PREFIX]
.HP \w'\fBostree\ refs\fR\ 'u
\fBostree refs\fR {EXISTING} {\-\-create=NEWREF}
.SH "DESCRIPTION"
.PP
Lists all refs available on the host\&. If specified, PREFIX assigns the refspec prefix; default prefix is null, which lists all refs\&. This command can also be used to create or delete refs\&.
.SH "OPTIONS"
.PP
\fB\-\-list\fR
.RS 4
For historical reasons,
refs
without this option will strip the specified prefix from the output\&. Normally, one wants to see the full ref, so providing this option ensures the refs are printed in full, rather than truncated\&.
.RE
.PP
\fB\-\-create\fR=NEWREF
.RS 4
Create a ref pointing to the commit EXISTING\&. NEWREF must not already exist, and EXISTING must be an existing commit\&. More than one ref can point to the same commit\&.
.RE
.PP
\fB\-\-delete\fR
.RS 4
Delete refs which match PREFIX, rather than listing them\&. If you are trying to reclaim space, you will then need to
\fBostree prune\fR
or
\fBostree admin cleanup\fR\&.
.RE
.PP
\fB\-\-alias\fR, \fB\-A\fR
.RS 4
If used with
\fB\-\-create\fR, create an alias\&. Otherwise just list aliases\&.
.RE
.PP
\fB\-\-collections\fR, \fB\-c\fR
.RS 4
Enable interactions with refs using the combination of their collection IDs and ref names\&. When listing refs, this changes the output format to include collection IDs, and enables listing remote mirrored refs\&.
.sp
When creating refs, the refspec value passed to the
\fB\-\-create\fR
option is treated as
COLLECTION\-ID:REF\-NAME
and a mirrored ref is created\&. (This is an abuse of the refspec syntax\&.)
.sp
When deleting refs, all refs whose collection ID equals PREFIX are deleted\&.
.RE
.SH "EXAMPLE"
.PP
\fB$ ostree refs\fR
.sp
.if n \{\
.RS 4
.\}
.nf
        my\-branch
        gnome\-ostree/buildmaster/x86_64\-runtime
.fi
.if n \{\
.RE
.\}