VirtualBox

source: vbox/trunk/doc/manual/en_US/man_VBoxManage-updatecheck.xml@ 103068

Last change on this file since 103068 was 99513, checked in by vboxsync, 19 months ago

manual,VBoxManage,isomaker/viso: Require all refsect1 and refsect2 elements to have @id attributes in manpages (refentry) to make these predictable and the split up topic files easier to handle for the docs team. Also requires these @id values to start with the refentry @id + '-'. Corrected a few bogus ones. Because 'controlvm' has too many sub-commands, HELP_SCOPE_ IDs will not be generated for 'See Also' and 'Examples' sections. bugref:10302

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 6.1 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 manpage, user manual, usage: VBoxManage updatecheck
4-->
5<!--
6 Copyright (C) 2020-2023 Oracle and/or its affiliates.
7
8 This file is part of VirtualBox base platform packages, as
9 available from https://www.virtualbox.org.
10
11 This program is free software; you can redistribute it and/or
12 modify it under the terms of the GNU General Public License
13 as published by the Free Software Foundation, in version 3 of the
14 License.
15
16 This program is distributed in the hope that it will be useful, but
17 WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 General Public License for more details.
20
21 You should have received a copy of the GNU General Public License
22 along with this program; if not, see <https://www.gnu.org/licenses>.
23
24 SPDX-License-Identifier: GPL-3.0-only
25-->
26<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
27 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[
28<!ENTITY % all.entities SYSTEM "all-entities.ent">
29%all.entities;
30]>
31<refentry id="vboxmanage-updatecheck" lang="en">
32 <refentryinfo>
33 <pubdate>$Date: 2023-04-21 21:59:02 +0000 (Fri, 21 Apr 2023) $</pubdate>
34 <title>VBoxManage updatecheck</title>
35 </refentryinfo>
36
37 <refmeta>
38 <refentrytitle>VBoxManage-updatecheck</refentrytitle>
39 <manvolnum>1</manvolnum>
40 </refmeta>
41
42 <refnamediv>
43 <refname>VBoxManage-updatecheck</refname>
44 <refpurpose>Checks for a newer version of VirtualBox</refpurpose>
45 <refclass>&product-name;</refclass>
46 </refnamediv>
47
48 <refsynopsisdiv>
49 <cmdsynopsis id="synopsis-vboxmanage-updatecheck-perform"> <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
50 <command>VBoxManage updatecheck perform</command>
51 <arg>--machine-readable</arg>
52 </cmdsynopsis>
53 <cmdsynopsis id="synopsis-vboxmanage-updatecheck-list">
54 <command>VBoxManage updatecheck list</command>
55 <arg>--machine-readable</arg>
56 </cmdsynopsis>
57 <cmdsynopsis id="synopsis-vboxmanage-updatecheck-modify">
58 <command>VBoxManage updatecheck modify</command>
59 <group>
60 <arg choice="plain">--disable</arg>
61 <arg choice="plain">--enable</arg>
62 </group>
63 <arg>--channel=<replaceable>stable | withbetas | all</replaceable></arg>
64 <arg>--frequency=<replaceable>days</replaceable></arg>
65 </cmdsynopsis>
66 </refsynopsisdiv>
67
68 <refsect1 id="vboxmanage-updatecheck-description">
69 <title>Description</title>
70
71 <para>The <command>updatecheck</command> subcommand is used to check if a newer
72 version of VirtualBox is available. The two subcommand options of <command>updatecheck</command>
73 are used for modifying or viewing the settings associated with checking for a newer version
74 of VirtualBox.</para>
75
76 <refsect2 id="vboxmanage-updatecheck-perform">
77 <title>updatecheck perform</title>
78 <remark role="help-copy-synopsis"/>
79 <para>
80 Checks if a newer version of VirtualBox is available.
81 </para>
82 <variablelist>
83 <varlistentry>
84 <term><option>--machine-readable</option></term><listitem><para>Machine readable output.</para></listitem>
85 </varlistentry>
86 </variablelist>
87 </refsect2>
88
89 <refsect2 id="vboxmanage-updatecheck-list">
90 <title>updatecheck list</title>
91 <remark role="help-copy-synopsis"/>
92 <para>
93 Displays the current settings used for specifying when to check for a newer version of VirtualBox.
94 </para>
95 <variablelist>
96 <varlistentry>
97 <term><option>--machine-readable</option></term><listitem><para>Machine readable output.</para></listitem>
98 </varlistentry>
99 </variablelist>
100 </refsect2>
101
102 <refsect2 id="vboxmanage-updatecheck-modify">
103 <title>updatecheck modify</title>
104 <remark role="help-copy-synopsis"/>
105 <para>
106 Modifies the settings used for specifying when to check for a newer version of VirtualBox.
107 </para>
108 <variablelist>
109 <varlistentry>
110 <term><option>--enable</option></term><listitem><para>Enable the update check service.</para></listitem>
111 </varlistentry>
112 <varlistentry>
113 <term><option>--disable</option></term><listitem><para>Disable the update check service.</para></listitem>
114 </varlistentry>
115 <varlistentry>
116 <term><option>--channel=stable | withbetas | all</option></term>
117 <listitem><para>The preferred release type used for determining whether a newer version of VirtualBox is available. The default is 'stable'.</para>
118 <variablelist>
119 <varlistentry>
120 <term><option>stable</option></term>
121 <listitem><para>Checks for newer stable releases (maintenance and minor releases within the same major release) of VirtualBox.</para> </listitem>
122 </varlistentry>
123 <varlistentry>
124 <term><option>all</option></term>
125 <listitem><para>Checks for newer stable releases (maintenance and minor releases within the same major release) and major releases of VirtualBox.</para></listitem>
126 </varlistentry>
127 <varlistentry>
128 <term><option>withbetas</option></term>
129 <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>
130 </varlistentry>
131 </variablelist>
132 </listitem>
133 </varlistentry>
134 <varlistentry>
135 <term><option>--frequency=days</option></term>
136 <listitem><para>Specifies how often in days to check for a newer version of VirtualBox.</para></listitem>
137 </varlistentry>
138 <varlistentry>
139 <term><option>--proxy-mode=system | manual | none</option></term>
140 <listitem><para>Specifies the proxy mode to use.</para></listitem>
141 </varlistentry>
142 <varlistentry>
143 <term><option>--proxy-url=&lt;address&gt;</option></term>
144 <listitem><para>Specifies the proxy address to use. Set to empty string to clear proxy address.</para></listitem>
145 </varlistentry>
146 </variablelist>
147 </refsect2>
148
149 </refsect1>
150
151</refentry>
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette