================
system-image-cli
================

------------------------------------------------
Ubuntu System Image Upgrader command line script
------------------------------------------------

:Author: Barry Warsaw <barry@ubuntu.com>
:Date: 2013-10-23
:Copyright: 2013-2014 Canonical Ltd.
:Version: 2.0
:Manual section: 1


SYNOPSYS
========

system-image-cli [options]


DESCRIPTION
===========

This script upgrades the system to the latest available image (i.e. build
number).  With no options, this script checks the latest version available on
the server and calculates an upgrade path to that version from the system's
current version.  If an upgrade path is found, the relevant files are
downloaded and the upgrade is applied by rebooting the system into recovery
mode.


OPTIONS
=======

-h, --help
    Show the program's message and exit.

--version
    Show the program's version number and exit.

-b NUMBER, --build NUMBER
    Override the device's current build number just this once.  ``NUMBER``
    must be an integer.  Use ``-b 0`` for force an upgrade.

-c CHANNEL, --channel CHANNEL
    Override the device's upgrade channel just this once.  Use in combination
    with ``--build 0`` to switch channels.

-d DEVICE, --device DEVICE
    Override the device name just this once.

--f FILTER, --filter FILTER
    Filter the candidate upgrade paths to only contain full or delta updates.
    ``FILTER`` must be either ``full`` or ``delta``.

-i, --info
    Show some information about the current device, including the current
    build number, device name, and channel, then exit.

-n, --dry-run
    Calculate and print the upgrade path, but do not download or apply it.

-v, --verbose
    Increase the logging verbosity.  With one ``-v``, logging goes to the
    console in addition to the log file, and logging at ``INFO`` level is
    enabled.  With two ``-v`` (or ``-vv``), logging both to the console and to
    the log file are output at ``DEBUG`` level.

-C FILE, --config FILE
    Use the given configuration file, otherwise use the default.  The program
    will optionally also read a ``channel.ini`` file in the same directory as
    ``FILE``.

--dbus
    Run in D-Bus client mode.  Normally, ``system-image-cli`` runs directly
    against the internal API.  With this switch, it instead acts as a D-Bus
    client, performing all operations against the ``system-image-dbus``
    service.  This mode more closely mimics how a user interface would perform
    updates.


FILES
=====

/etc/system-image/client.ini
    Default configuration file.

/etc/system-image/channel.ini
    Optional configuration file overrides (for the ``[service]`` section
    only).


SEE ALSO
========

client.ini(5), system-image-dbus(8)
