NAME

pmx-setup - Administer your PureMessage Installation


SYNOPSIS

    pmx-setup [options] [puremessage-installer.sh]


DESCRIPTION

pmx-setup allows you to perform various administration activities for your installation, such as installing additional components, creating and restoring snapshots, upgrading PureMessage packages and licenses, and uninstalling PureMessage.

When manually running the installer before the install has completed, the shell installer must be passed as the final argument.

Note: When performing upgrades, you must run pmx-setup as the root user. PureMessage will not permit you to upgrade packages or uninstall components as the PureMessage user ('pmx6' by default).


OPTIONS

The following option can be applied to pmx-setup:

Snapshot Options

The following options apply to snapshots:

--ss-list|L
Display a list of available snapshots.

--ss-create|C <snapshot name>
Create a new snapshot.

--ss-restore|R <snapshot name or number>
Restores a snapshot specified either by the snapshot name, or by the number returned by the --ss-list option.

If run from an interactive terminal, questions will be asked about what to do with file conflicts.

--ss-delete|E <snapshot name or number>
Deletes a snapshot specified either by the snapshot name, or by the number returned by the --ss-list option.

--v[erbose]
Verbose printing when creating and restoring snapshots.

Other Options

The following installation options can be used with pmx-setup:

--a[uto] FILE
This option can be used to perform automated installs. The specified file will be used for the installation. See the PureMessage installation guide for more information on auto-installs.

You can generate an install.conf file to use for auto-installation by proceeding through the installer menus (Full Install or Custom Install), and then choose ``Save and Exit'' at the review menu. You can then use the saved etc/install.conf for auto-installs.

--accept-eula
Use this option when performing an auto-install to avoid displaying the end user license agreement. By using this option, you agree that you have read and accept the PureMessage license agreement.

--r[epo] REPO
Set the PureMessage repository to REPO.

--u[pgrade] [dump | all | package]
With no arguments, the --upgrade option will open the installer directly to the upgrade menu. If ``dump'' is specified, then the list of packages that need updates will be displayed. If 'all' or a package name is specified, packages will be updated. Upgrades must be performed as the root user (see the note in the DESCRIPTION section).

--auto-upgrade
Performs an automatic upgrade of all packages with available updates, without prompting the user. This is equivalent to invoking --upgrade all and accepting default values for every prompt.

--force
Force an update of the packages selected by --upgrade.

--install-license
Extract the license information from the specified license installer.

--check-validator
Verify the authenticity of the PureMessage validation program itself prior to upgrading.


CONFIGURATION

etc/snapshot.conf
Configure various snapshot options, including where snapshots should be stored, and what kind of snapshots should be made.

etc/data/snapshot/flavour.conf
Configure what is included in a snapshot, and what options to use for those files. The format and content of this file may change in future PureMessage versions.


COPYRIGHT

Copyright (C) 2000-2008 Sophos Group. All rights reserved. Sophos and PureMessage are trademarks of Sophos Plc and Sophos Group.