Sindbad~EG File Manager

.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" 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
..
.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 "WP-TOOLS 1"
.TH WP-TOOLS 1 "2018-09-14" "perl v5.26.3" "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"
wp\-tools \- tools to backup and upgrade WordPress installations
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    # simple installation from CPAN
\&    cpanm App::WordPressTools
\&
\&    # view usage information
\&    wp\-tools \-\-help
\&
\&    # common usage
\&    wp\-tools upgrade|backup|restore OPTIONS...
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
WordPress Tools is a set of tools that allow you to backup, restore, and upgrade WordPress sites. The tools are
especially useful for upgrading very outdated sites and for scripting the backing up and upgrading of \fBmany\fR sites.
.PP
WordPress Tools was built to make the Internet more secure. A huge number of websites on the Internet use
WordPress <https://wordpress.org/>, because it's awesome, but a large portion of those sites do not run the latest
version of WordPress which makes them susceptible to hacking. WordPress Tools can be used to get those sites up-to-date
again, and that makes the whole Internet more secure.
.PP
The code has been used in production and has already upgraded over two million WordPress sites, but it has little
real-world testing outside of Linux at this point so your mileage may vary if you have a different operating system.
Stay tuned as we add support for more platforms, and please contribute if you feel like it.
.PP
The command-line program also has a lot of options for managing server load, so you can upgrade your sites without
killing your server.
.SH "INSTALLATION"
.IX Header "INSTALLATION"
There are several ways to install WordPress Tools to your system.
.PP
Make sure you have WP-CLI <http://wp-cli.org/> and the other \*(L"\s-1DEPENDENCIES\*(R"\s0 installed.
.SS "Using cpanm"
.IX Subsection "Using cpanm"
You can install WordPress Tools using cpanm. If you have a local perl (plenv, perlbrew, etc.), you can just do:
.PP
.Vb 1
\&    cpanm App::WordPressTools
.Ve
.PP
to install the \fIwp-tools\fR executable and its dependencies. The executable will be installed to your perl's bin path,
like \fI~/perl5/perlbrew/bin/wp\-tools\fR.
.PP
If you're installing to your system perl, you can do:
.PP
.Vb 1
\&    cpanm \-\-sudo App::WordPressTools
.Ve
.PP
to install the \fIwp-tools\fR executable to a system directory, like \fI/usr/local/bin/wp\-tools\fR (depending on your perl).
.SS "Downloading just the executable"
.IX Subsection "Downloading just the executable"
You may also choose to download \fIwp-tools\fR as a single executable, like this:
.PP
.Vb 2
\&    curl \-OL https://raw.githubusercontent.com/bluehost/wp\-tools/solo/wp\-tools
\&    chmod +x wp\-tools
.Ve
.PP
This executable includes all the non-core Perl module dependencies built-in.
.SS "For developers"
.IX Subsection "For developers"
If you're a developer and want to hack on the source, clone the repository and pull the dependencies:
.PP
.Vb 5
\&    git clone https://github.com/bluehost/wp\-tools.git
\&    cd wp\-tools
\&    cpanm \-n Dist::Zilla
\&    dzil authordeps \-\-missing |cpanm \-n
\&    dzil listdeps \-\-author \-\-develop \-\-missing |cpanm \-n
.Ve
.SH "DEPENDENCIES"
.IX Header "DEPENDENCIES"
WordPress Tools requires these other programs and libraries in order to do its work. You probably have most of these on
your system already, and the cpanm method of installing wp-tools will handle the Perl module dependencies for you.
.IP "\(bu" 4
WP-CLI <http://wp-cli.org/>
.IP "\(bu" 4
\&\s-1GNU\s0 Coreutils <https://www.gnu.org/software/coreutils/>
.IP "\(bu" 4
\&\s-1GNU\s0 Tar <https://www.gnu.org/software/tar/>
.IP "\(bu" 4
awk
.IP "\(bu" 4
grep
.IP "\(bu" 4
mysql (MySQL server client)
.IP "\(bu" 4
procps
.IP "\(bu" 4
Various Perl modules (see the distributed \fIcpanfile\fR file for a list)
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\-\-help" 4
.IX Item "--help"
Show usage information and exit.
.IP "\-\-force" 4
.IX Item "--force"
If there are any resource limits in effect, ignore them and do the command anyway.
.IP "\-\-max\-count=num" 4
.IX Item "--max-count=num"
Delete the oldest backups, keeping the number provided (default: 5).
.IP "\-\-max\-dproc=num" 4
.IX Item "--max-dproc=num"
Refuse to execute if the maximum number of defunct processes on the system exceeds this number (default: 100).
.IP "\-\-max\-load=num" 4
.IX Item "--max-load=num"
Refuse to execute if the load average exceeds this number (default: 200).
.IP "\-\-max\-size=num" 4
.IX Item "--max-size=num"
Refuse to back up a site if its uncompressed size on disk exceeds this number of bytes (default: 5368709120).
.IP "\-\-max\-run=num" 4
.IX Item "--max-run=num"
Do not allow more than this number of concurrent system-wide executions of the script (default: 50).
.IP "\-\-min\-freemem=num" 4
.IX Item "--min-freemem=num"
Refuse to execute if free memory has dropped below this number of bytes (default: 1048576).
.IP "\-\-wp\-cli=path" 4
.IX Item "--wp-cli=path"
If your \fIwp-cli\fR program has a different name than \fIwp\fR or is not in your \f(CW$PATH\fR, you can specify the command to be
used to call wp-cli.
.IP "\-\-username=name" 4
.IX Item "--username=name"
If you run wp-tools as a root user, it will drop permissions to the specified user and \f(CW\*(C`chdir\*(C'\fR to their home directory.
.SH "COMMANDS"
.IX Header "COMMANDS"
.IP "upgrade" 4
.IX Item "upgrade"
The upgrade command will upgrade your WordPress core, themes, and plugins to the latest version available. It takes
a full backup prior to the update. After the update, wp-tools will do a quick check to try to determine that nothing
broke on your site. If any failures are detected, wp-tools will automatically restore to the backup taken prior to
update.
.IP "backup" 4
.IX Item "backup"
The backup command will create a full backup, including database, of your WordPress installation as long as it is under
the \-\-max\-size limit (pre-compression).
.IP "restore" 4
.IX Item "restore"
The restore command will restore a WordPress installation from a backup taken using the backup command.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
.Vb 3
\&    # upgrade a site
\&    wp\-tools upgrade \-\-path=/absolute/path/to/public_html/myblog \e
\&                     \-\-backupdir=/absolute/path/to/myblog_backups
\&
\&    # upgrade only plugins and themes
\&    wp\-tools upgrade \-\-path=/absolute/path/to/public_html/myblog  \e
\&                     \-\-backupdir=/absolute/path/to/myblog_backups \e
\&                     \-\-components=plugin,theme
\&
\&    # backup a site
\&    wp\-tools backup \-\-path=/absolute/path/to/public_html/mysite \e
\&                    \-\-backupdir=/absolute/path/to/backups/mysite
\&
\&    # restore a site to a previous state
\&    wp\-tools restore \-\-backupfile=/absolute/path/to/backups/mysite/wp_backup1428524082.tar.gz
.Ve
.SH "NOTES"
.IX Header "NOTES"
Beginning with version 1.03, passing relative paths to \f(CW\*(C`\-\-path\*(C'\fR, \f(CW\*(C`\-\-backupdir\*(C'\fR, and \f(CW\*(C`\-\-backupfile\*(C'\fR is \fBdeprecated\fR.
You should use absolute paths (i.e. that begin with a \fI/\fR). Relative paths are accepted but will print a warning to
\&\f(CW\*(C`STDERR\*(C'\fR. This is because using a relative path does not behave as you would think (for boring historical reasons).
.SH "CONTRIBUTORS"
.IX Header "CONTRIBUTORS"
Many people were involved in the creation of WordPress Tools. In particular:
.IP "\(bu" 4
Matt Andersen
.IP "\(bu" 4
Gabriel Peery
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "\(bu" 4
Seth Johnson <sj@bluehost.com>
.IP "\(bu" 4
Charles McGarvey <cmcgarvey@bluehost.com>
.IP "\(bu" 4
Garth Mortensen <gmortensen@bluehost.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2016\-2018 by Bluehost Inc.
.PP
This is free software, licensed under:
.PP
The \s-1GNU\s0 General Public License, Version 2, June 1991