'\" t
.\"     Title: ostree summary
.\"    Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 07/04/2017
.\"    Manual: ostree summary
.\"    Source: OSTree
.\"  Language: English
.\"
.TH "OSTREE SUMMARY" "1" "" "OSTree" "ostree summary"
.\" -----------------------------------------------------------------
.\" * 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-summary \- Regenerate the summary metadata file
.SH "SYNOPSIS"
.HP \w'\fBostree\ summary\fR\ 'u
\fBostree summary\fR [OPTIONS...]
.SH "DESCRIPTION"
.PP
The
summary
file is an optional higher level form of repository metadata that describes the available branches\&. It needs to be manually regenerated after a series of commits\&. Among other things, this allows atomically updating multiple commits\&.
.SH "OPTIONS"
.PP
\fB\-u\fR
.RS 4
Update the summary file\&.
.sp
Any additional arguments to the command are treated as additional key\(envalue pairs to be added to the summary file as additional metadata\&. They must be in the format
\fB\fIKEY\fR\fR\fB=\fR\fB\fIVALUE\fR\fR
or as two separate arguments\&. The keys must be namespaced for your organisation or repository using a dot prefix\&. The values must be in GVariant text format\&. For example,
\fBexampleos\&.end\-of\-life "@t 1445385600"\fR\&.
.RE
.PP
\fB\-\-gpg\-sign\fR=KEYID
.RS 4
GPG Key ID to sign the delta with\&.
.RE
.PP
\fB\-\-gpg\-homedir\fR=HOMEDIR
.RS 4
GPG Homedir to use when looking for keyrings\&.
.RE