diff options
Diffstat (limited to 'doc/manual/en_US/man_VBoxManage-updatecheck.xml')
| -rw-r--r-- | doc/manual/en_US/man_VBoxManage-updatecheck.xml | 151 |
1 files changed, 151 insertions, 0 deletions
diff --git a/doc/manual/en_US/man_VBoxManage-updatecheck.xml b/doc/manual/en_US/man_VBoxManage-updatecheck.xml new file mode 100644 index 00000000..4f9cd981 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-updatecheck.xml @@ -0,0 +1,151 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + manpage, user manual, usage: VBoxManage updatecheck +--> +<!-- + Copyright (C) 2020-2022 Oracle and/or its affiliates. + + This file is part of VirtualBox base platform packages, as + available from https://www.virtualbox.org. + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation, in version 3 of the + License. + + This program is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, see <https://www.gnu.org/licenses>. + + SPDX-License-Identifier: GPL-3.0-only +--> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[ +<!ENTITY % all.entities SYSTEM "all-entities.ent"> +%all.entities; +]> +<refentry id="vboxmanage-updatecheck" lang="en"> + <refentryinfo> + <pubdate>$Date: 2022-08-22 19:43:14 +0200 (Mon, 22 Aug 2022) $</pubdate> + <title>VBoxManage updatecheck</title> + </refentryinfo> + + <refmeta> + <refentrytitle>VBoxManage-updatecheck</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>VBoxManage-updatecheck</refname> + <refpurpose>Checks for a newer version of VirtualBox</refpurpose> + <refclass>&product-name;</refclass> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis id="synopsis-vboxmanage-updatecheck-perform"> <!-- The 'id' is mandatory and must start with 'synopsis-'. --> + <command>VBoxManage updatecheck perform</command> + <arg>--machine-readable</arg> + </cmdsynopsis> + <cmdsynopsis id="synopsis-vboxmanage-updatecheck-list"> + <command>VBoxManage updatecheck list</command> + <arg>--machine-readable</arg> + </cmdsynopsis> + <cmdsynopsis id="synopsis-vboxmanage-updatecheck-modify"> + <command>VBoxManage updatecheck modify</command> + <group> + <arg choice="plain">--disable</arg> + <arg choice="plain">--enable</arg> + </group> + <arg>--channel=<replaceable>stable | withbetas | all</replaceable></arg> + <arg>--frequency=<replaceable>days</replaceable></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para>The <command>updatecheck</command> subcommand is used to check if a newer + version of VirtualBox is available. The two subcommand options of <command>updatecheck</command> + are used for modifying or viewing the settings associated with checking for a newer version + of VirtualBox.</para> + + <refsect2 id="vboxmanage-updatecheck-perform"> + <title>updatecheck perform</title> + <remark role="help-copy-synopsis"/> + <para> + Checks if a newer version of VirtualBox is available. + </para> + <variablelist> + <varlistentry> + <term><option>--machine-readable</option></term><listitem><para>Machine readable output.</para></listitem> + </varlistentry> + </variablelist> + </refsect2> + + <refsect2 id="vboxmanage-updatecheck-list"> + <title>updatecheck list</title> + <remark role="help-copy-synopsis"/> + <para> + Displays the current settings used for specifying when to check for a newer version of VirtualBox. + </para> + <variablelist> + <varlistentry> + <term><option>--machine-readable</option></term><listitem><para>Machine readable output.</para></listitem> + </varlistentry> + </variablelist> + </refsect2> + + <refsect2 id="vboxmanage-updatecheck-modify"> + <title>updatecheck modify</title> + <remark role="help-copy-synopsis"/> + <para> + Modifies the settings used for specifying when to check for a newer version of VirtualBox. + </para> + <variablelist> + <varlistentry> + <term><option>--enable</option></term><listitem><para>Enable the update check service.</para></listitem> + </varlistentry> + <varlistentry> + <term><option>--disable</option></term><listitem><para>Disable the update check service.</para></listitem> + </varlistentry> + <varlistentry> + <term><option>--channel=stable | withbetas | all</option></term> + <listitem><para>The preferred release type used for determining whether a newer version of VirtualBox is available. The default is 'stable'.</para> + <variablelist> + <varlistentry> + <term><option>stable</option></term> + <listitem><para>Checks for newer stable releases (maintenance and minor releases within the same major release) of VirtualBox.</para> </listitem> + </varlistentry> + <varlistentry> + <term><option>all</option></term> + <listitem><para>Checks for newer stable releases (maintenance and minor releases within the same major release) and major releases of VirtualBox.</para></listitem> + </varlistentry> + <varlistentry> + <term><option>withbetas</option></term> + <listitem><para>Checks for newer stable releases (maintenance and minor releases within the same major release), major releases, and beta releases of VirtualBox.</para></listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + <varlistentry> + <term><option>--frequency=days</option></term> + <listitem><para>Specifies how often in days to check for a newer version of VirtualBox.</para></listitem> + </varlistentry> + <varlistentry> + <term><option>--proxy-mode=system | manual | none</option></term> + <listitem><para>Specifies the proxy mode to use.</para></listitem> + </varlistentry> + <varlistentry> + <term><option>--proxy-url=<address></option></term> + <listitem><para>Specifies the proxy address to use. Set to empty string to clear proxy address.</para></listitem> + </varlistentry> + </variablelist> + </refsect2> + + </refsect1> + +</refentry> |