.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "sqitch-status 3pm"
.TH sqitch-status 3pm "2016-12-17" "perl v5.24.1" "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-status \- Show the current deployment status of a database
.SH "Synopsis"
.IX Header "Synopsis"
.Vb 1
\&  sqitch [options] status [<options>] [<database>]
.Ve
.SH "Description"
.IX Header "Description"
Displays information about the current deployment status of a database. The
most recently deployed change information is displayed, as well as any related
tags. If there are undeployed changes in the plan, they will be listed.
Otherwise, a message will indicate that the database is up-to-date.
.PP
The \f(CW\*(C`<database>\*(C'\fR parameter specifies the database to which to connect,
and may also be specified as the \f(CW\*(C`\-\-target\*(C'\fR option. It can be target name,
a \s-1URI,\s0 an engine name, or plan file path.
.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 to which to connect. This option can be either a \s-1URI\s0 or
the name of a target in the configuration.
.ie n .IP """\-\-project""" 4
.el .IP "\f(CW\-\-project\fR" 4
.IX Item "--project"
Project for which to retrieve the status. Defaults to the status of the
current project, if a plan can be found.
.ie n .IP """\-\-show\-changes""" 4
.el .IP "\f(CW\-\-show\-changes\fR" 4
.IX Item "--show-changes"
Also display a list of deployed changes.
.ie n .IP """\-\-show\-tags""" 4
.el .IP "\f(CW\-\-show\-tags\fR" 4
.IX Item "--show-tags"
Also display a list of applied tags.
.ie n .IP """\-\-date\-format""" 4
.el .IP "\f(CW\-\-date\-format\fR" 4
.IX Item "--date-format"
.PD 0
.ie n .IP """\-\-date""" 4
.el .IP "\f(CW\-\-date\fR" 4
.IX Item "--date"
.PD
Format to use for timestamps. Defaults to \f(CW\*(C`iso\*(C'\fR. Allowed values:
.RS 4
.ie n .IP """iso""" 4
.el .IP "\f(CWiso\fR" 4
.IX Item "iso"
.PD 0
.ie n .IP """iso8601""" 4
.el .IP "\f(CWiso8601\fR" 4
.IX Item "iso8601"
.PD
Shows timestamps in \s-1ISO\-8601\s0 format.
.ie n .IP """rfc""" 4
.el .IP "\f(CWrfc\fR" 4
.IX Item "rfc"
.PD 0
.ie n .IP """rfc2822""" 4
.el .IP "\f(CWrfc2822\fR" 4
.IX Item "rfc2822"
.PD
Show timestamps in \s-1RFC\-2822\s0 format.
.ie n .IP """full""" 4
.el .IP "\f(CWfull\fR" 4
.IX Item "full"
.PD 0
.ie n .IP """long""" 4
.el .IP "\f(CWlong\fR" 4
.IX Item "long"
.ie n .IP """medium""" 4
.el .IP "\f(CWmedium\fR" 4
.IX Item "medium"
.ie n .IP """short""" 4
.el .IP "\f(CWshort\fR" 4
.IX Item "short"
.PD
Show timestamps in the specified format length, using the system locale's
\&\f(CW\*(C`LC_TIME\*(C'\fR category.
.ie n .IP """raw""" 4
.el .IP "\f(CWraw\fR" 4
.IX Item "raw"
Show timestamps in raw format, which is strict \s-1ISO\-8601\s0 in the \s-1UTC\s0 time zone.
.ie n .IP """strftime:$string""" 4
.el .IP "\f(CWstrftime:$string\fR" 4
.IX Item "strftime:$string"
Show timestamps using an arbitrary \f(CW\*(C`strftime\*(C'\fR pattern. See
\&\*(L"strftime Paterns\*(R" in DateTime for comprehensive documentation of supported
patterns.
.ie n .IP """cldr:$string""" 4
.el .IP "\f(CWcldr:$string\fR" 4
.IX Item "cldr:$string"
Show timestamps using an arbitrary \f(CW\*(C`cldr\*(C'\fR pattern. See \*(L"\s-1CLDR\s0
Paterns\*(R" in DateTime for comprehensive documentation of supported patterns.
.RE
.RS 4
.RE
.SH "Configuration Variables"
.IX Header "Configuration Variables"
.ie n .IP """status.show_changes""" 4
.el .IP "\f(CWstatus.show_changes\fR" 4
.IX Item "status.show_changes"
Boolean value indicates whether or not to display changes in the output.
Defaults to false.
.ie n .IP """status.show_tags""" 4
.el .IP "\f(CWstatus.show_tags\fR" 4
.IX Item "status.show_tags"
Boolean value indicates whether or not to display tags in the output. Defaults
to false.
.ie n .IP """status.date_format""" 4
.el .IP "\f(CWstatus.date_format\fR" 4
.IX Item "status.date_format"
Format to use for timestamps. Supports the same values as the \f(CW\*(C`\-\-date\-format\*(C'\fR
option.
.SH "Sqitch"
.IX Header "Sqitch"
Part of the sqitch suite.