.\" 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 "TARANTOOLCTL 1"
.TH TARANTOOLCTL 1 "2016-12-16" "--name=tarantoolctl" "tarantoolctl\ instances\ control"
.\" 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"
tarantoolctl \- an utility to control tarantool instances
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 4
\&    vim /etc/tarantool/instances.enabled/my_instance.lua
\&    tarantoolctl start my_instance
\&    tarantoolctl stop  my_instance
\&    tarantoolctl logrotate my_instance
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The script is read \f(CW\*(C`/etc/sysconfig/tarantool\*(C'\fR or \f(CW\*(C`/etc/default/tarantool\*(C'\fR.
The file contains common default instances options:
.PP
.Vb 1
\&    $ cat /etc/default/tarantool
\&
\&
\&    \-\- Options for Tarantool
\&    default_cfg = {
\&        \-\- will become pid_file .. instance .. \*(Aq.pid\*(Aq
\&        pid_file    =   "/var/run/tarantool",
\&        \-\- will become wal_dir/instance/
\&        wal_dir     =   "/var/lib/tarantool",
\&        \-\- snap_dir/instance/
\&        snap_dir    =   "/var/lib/tarantool",
\&
\&        \-\- vinyl_dir/instance/
\&        vinyl_dir  =   "/var/lib/tarantool/vinyl",
\&
\&        \-\- logger/instance .. \*(Aq.log\*(Aq
\&        logger      =   "/var/log/tarantool",
\&        username    =   "tarantool",
\&    }
\&
\&    instance_dir = "/etc/tarantool/instances.enabled"
.Ve
.PP
The file defines \f(CW\*(C`instance_dir\*(C'\fR where user can place his
applications (instances).
.PP
Each instance can be controlled by \f(CW\*(C`tarantoolctl\*(C'\fR:
.SS "Starting instance"
.IX Subsection "Starting instance"
.Vb 1
\&    tarantoolctl start instance_name
.Ve
.SS "Stopping instance"
.IX Subsection "Stopping instance"
.Vb 1
\&    tarantoolctl stop instance_name
.Ve
.SS "Logrotate instance's log"
.IX Subsection "Logrotate instance's log"
.Vb 1
\&    tarantoolctl logrotate instance_name
.Ve
.SS "Enter instance admin console"
.IX Subsection "Enter instance admin console"
.Vb 1
\&    tarantoolctl enter instance_name
.Ve
.SS "status"
.IX Subsection "status"
.Vb 1
\&    tarantoolctl status instance_name
.Ve
.PP
Check if instance is up.
.PP
If pid file exists and control socket exists and control socket is alive
returns code \f(CW0\fR.
.PP
Return code != 0 in other cases. Can complain in log (stderr) if pid file
exists and socket doesn't, etc.
.SS "separate instances control"
.IX Subsection "separate instances control"
If You use SysV init, You can use symlink from
\&\f(CW\*(C`tarantoolctl\*(C'\fR to \f(CW\*(C`/etc/init.d/instance_name[.lua]\*(C'\fR.
\&\f(CW\*(C`tarantoolctl\*(C'\fR detects if it is started by symlink and uses
instance_name as \f(CW\*(C`\`basename $0 .lua\`\*(C'\fR.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2010\-2013 Tarantool \s-1AUTHORS:\s0
please see \s-1AUTHORS\s0 file.