Site Skeletons: skeleton Utility

The skeleton utility is used to manage site directory structure skeletons through CLI. By using this utility, you can perform the following tasks:

Syntax

skeleton <command> [

<option_1> [<param>]

[<option_2> [<param>]]

…[<option_N> [<param>]]

]

Example

The following command line installs a site skeleton from the skeleton file /usr/local/skeletons/siteskeleton (in the ZIP format) for the client with client login name clientlogin:

# ./skeleton --install clientlogin -filename /usr/local/skeletons/siteskeleton -force-type zip

Commands

Command

Parameter

Description

Example

--install or -i

<client login name>

Installs a skeleton from a file for a client account.

Requires concomitant use of the --filename option.

To install a site skeleton from the skeleton file /usr/local/skeletons/siteskeleton.zip for the client with client login name clientlogin:

# ./skeleton --install clientlogin -filename /usr/local/skeletons/siteskeleton -force-type zip

or

# ./skeleton -i clientlogin -filename siteskeleton -force-type zip

--reset or -r

<client login name>

Installs the Plesk default skeleton for a client account.

To install the default site skeleton for the client with client login name clientlogin:

# ./skeleton --reset clientlogin

or

# ./skeleton -r clientlogin

--help or -h

 

Displays help on the use of the utility.

To view help on the use of the utility:

# ./skeleton --help

or

# ./skeleton -h

Options

Option

Parameter

Description

Example

-filename

<file path>

Specifies a site skeleton file.

Used only with the --install command.

To install a site skeleton from the skeleton file /usr/local/skeletons/siteskeleton (in the ZIP format) for the client with client login name clientlogin:

# ./skeleton -i clientlogin -filename /usr/local/skeletons/siteskeleton -force-type zip

-force-type

zip|tgz|tar.gz|tar

Forces specification of a site skeleton file format.

Used only with the --install command.