ostree/man/ostree-cat.1

51 lines
1.9 KiB
Groff

'\" t
.\" Title: ostree cat
.\" Author: Colin Walters <walters@verbum.org>
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 11/23/2016
.\" Manual: ostree cat
.\" Source: OSTree
.\" Language: English
.\"
.TH "OSTREE CAT" "1" "" "OSTree" "ostree cat"
.\" -----------------------------------------------------------------
.\" * 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-cat \- Display or concatenate contents of files
.SH "SYNOPSIS"
.HP \w'\fBostree\ cat\fR\ 'u
\fBostree cat\fR {COMMIT} {PATH...}
.SH "DESCRIPTION"
.PP
This command functions much like the typical Unix "cat" command, in that it displays the contents of a file, or concatenates them given two or more files\&. However, this command requires the user to specify a commit \- a checksum or refspec corresponding to a given build\&. If you use a refspec, OSTree will refer to the most recent commit, unless you specify a parent build using the carat (^) at the end of the refspec\&. It will then operate the command in that given commit\&.
.SH "EXAMPLE"
.PP
\fB$ ostree cat my\-branch helloworld\&.txt\fR
.sp
.if n \{\
.RS 4
.\}
.nf
Hello, world!
.fi
.if n \{\
.RE
.\}