.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "sqitch-show 3pm"
.TH sqitch-show 3pm 2024-02-08 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH Name
.IX Header "Name"
sqitch-show \- Show object information or script contents
.SH Synopsis
.IX Header "Synopsis"
.Vb 1
\&  sqitch show [options] <type> <object>
.Ve
.SH Description
.IX Header "Description"
Shows information about Sqitch objects. The first argument must be the type of
object to show, and the second must be a key identifier for the object in the
plan. The second argument must be a a change name or tag as specified in
sqitchchanges. The supported types include:
.ie n .IP """change""" 4
.el .IP \f(CWchange\fR 4
.IX Item "change"
A change object. Outputs the text used to generate the change SHA1 ID.
.ie n .IP """tag""" 4
.el .IP \f(CWtag\fR 4
.IX Item "tag"
A tag. Outputs the text used to generate the tag SHA1 ID.
.ie n .IP """deploy""" 4
.el .IP \f(CWdeploy\fR 4
.IX Item "deploy"
A change deploy script.
.ie n .IP """revert""" 4
.el .IP \f(CWrevert\fR 4
.IX Item "revert"
A change revert script.
.ie n .IP """verify""" 4
.el .IP \f(CWverify\fR 4
.IX Item "verify"
A change verify script.
.SH Options
.IX Header "Options"
.ie n .IP """\-t""" 4
.el .IP \f(CW\-t\fR 4
.IX Item "-t"
.PD 0
.ie n .IP """\-\-target""" 4
.el .IP \f(CW\-\-target\fR 4
.IX Item "--target"
.PD
The target database, the plan for which should be read before deciding what
object to show. This option should be the name of a target in the
configuration.
.ie n .IP """\-e""" 4
.el .IP \f(CW\-e\fR 4
.IX Item "-e"
.PD 0
.ie n .IP """\-\-exists""" 4
.el .IP \f(CW\-\-exists\fR 4
.IX Item "--exists"
.PD
Suppress all output; instead exit with zero status if \f(CW\*(C`<object>\*(C'\fR exists
and is a valid object.
.ie n .IP """\-\-plan\-file""" 4
.el .IP \f(CW\-\-plan\-file\fR 4
.IX Item "--plan-file"
.PD 0
.ie n .IP """\-f""" 4
.el .IP \f(CW\-f\fR 4
.IX Item "-f"
.PD
Path to the deployment plan file. Overrides target, engine, and core
configuration values. Defaults to \fR\f(CI$top_dir\fR\fI/sqitch.plan\fR.
.SS Examples
.IX Subsection "Examples"
.IP \(bu 4
Show information about a specific change:
.Sp
.Vb 1
\&  sqitch show change add_users_table
.Ve
.IP \(bu 4
Show information about a change by ID:
.Sp
.Vb 1
\&  sqitch show change be7cd00571d7151eacb0691e825dfc8980cc14ff
.Ve
.IP \(bu 4
Show the most recent change info:
.Sp
.Vb 1
\&  sqitch show change @HEAD
.Ve
.IP \(bu 4
Show information about a tag:
.Sp
.Vb 1
\&  sqitch show tag @beta1
.Ve
.IP \(bu 4
Show the contents of a deploy file:
.Sp
.Vb 1
\&  sqitch show deploy add_users_table@HEAD
.Ve
.SH Sqitch
.IX Header "Sqitch"
Part of the sqitch suite.