1. Manuals
  2. Tumbleweed
  3. twups
  4. twups(1)

Scroll to navigation

TWUPS(1) User Manuals TWUPS(1)

NAME

twups - Tumbleweed Update Scrutinizer

SYNOPSIS

twups [OPTION...]

DESCRIPTION

Fetches and presents information from the openSUSE Tumbleweed Review hosted by Boombatower, optionally prompting to update based on stability ratings. Fetching is handled by curl (directed at https://review.tumbleweed.boombatower.com/data/score.yaml), snapshot selection is handled by tumbleweed-cli, and installation of updates is performed by zypper. The latter two functionalities require sudo privileges, which will be prompted for when needed.

To select a snapshot (and by extension install it), tumbleweed-cli must first be initialized with 'tumbleweed init' (this of course implies that tumbleweed-cli must also be installed).

When run, twups will print a brief description of each snapshot in the Boombatower database matching the criteria given by the user, by default the most recent snapshots (see the following section for options and defaults). These are, in order, the version number (i.e. date) of the snapshot, Boombatower's current stability rating for the snapshot, and the current stability score. A score greater than 90 is deemed "stable," a score between 71 and 90 inclusive is deemed "moderate," and any lower score is deemed "unstable." Snapshots less than a week old, whose scores are subject to change, are considered to be "pending." Snapshots newer than that currently installed, the currently installed snapshot, and snapshots older than that currently installed will be labeled as such after the version number of each result.

If any of the returned snapshots meet the user-specified criteria to be selected for an update, the most recent candidate from the list will be presented, and the user asked if the update should be performed. After an affirmative response, tumbleweed-cli will be called to switch to the desired snapshot (requiring sudo privileges) and zypper will be run interactively, allowing for a final review of packages to be modified before installation.

OPTIONS

-c COUNT, --count=COUNT

Specify the number of snapshots to be displayed. When --search is not in use, this equates to displaying the most recent COUNT snapshots. When --search has been specified, this limits the number of results. Default is 5 when --search is not specified and unlimited otherwise.

--color=WHEN

Determine whether to include colour escapes in output. Allowed values are never, always, and auto. auto will enable colours if the output is a terminal and disable them otherwise; this is the default setting.

-h, --help

Display a brief explanation of twups and its parameters, then exit.

-n, --no-upgrade

Exit immediately after retrieving snapshots, without prompting to update.

-r, --rollback

Permit selection of snapshots older than that currently installed. Note that this will still only select snaphots rated "stable" unless --unstable-upgrades is also specified.

-s QUERY, --search=QUERY

Rather than displaying the most recent snapshots, search the database for snapshots with a date in either yyyymmdd or yyyy-mm-dd format matching QUERY, which may be a regular expression. Results will be printed in reverse chronological order. This is the ideal method of selecting a specific snapshot if the most recent (or most recent stable) is not desired.

By default, this will search the entire database, even if a complete date is entered (which could yield at most one result). Combining this option with --count will not only limit the otherwise unbounded number of results, but also cease the search as soon as the specified number of results have been found, saving some time.

-u, --unstable-upgrades

Accept snapshots not rated "stable" as candidates for updates, i.e. prompt to update to the first snapshot listed (unless that snapshot is older than the current version and --rollback is not specified).

-v, --version

Print version and exit.

EXIT STATUS

Exit codes are roughly based on FreeBSD's sysexit specification, for want of any other standard to follow.

64
Input not recognized (e.g. nonexistent parameter).
65
Invalid argument (e.g. a requested result count of "foo" rather than an integer).
69
Attemping to perform an update when tumbleweed-cli has not been initialized.
70
tumbleweed-cli failed to select the requested snapshot.
75
Failure to acquire information from Boombatower (e.g. network issues, site outage).

NOTES

Users should be aware that stability scores (and by extension ratings) change over time, usually dropping. For this reason, snapshots less than a week old are labelled "pending" to reflect their volatile state, after which there is unlikely to be much further change. Those wishing to avoid unstable snapshots should wait for this first week to pass before updating to a new release (as is the default behaviour of this program).

The currently installed snapshot can appear in output, but cannot be selected for updating, as this would under normal circumstances have no effect. If need be, "switching" to the snapshot already marked as installed may be accomplished via the --force option available in tumbleweed-cli.

BUGS

Boombatower supports bug counts for each snapshot via Bugzilla, but does not have Bugzilla access at the time of writing. If this situation changes, bug counts may be implemented, but at the expense of pulling them from an additional file to be downloaded (as bugs are stored separately on Boombatower).

Further issues may be reported at https://codeberg.org/ProgrammerPolymathic/twups.

SEE ALSO

tumbleweed --help, zypper(8)

2020-08-14 twups 0.2.2