summaryrefslogtreecommitdiffstats
path: root/doc/manual/en_US/man_VBoxManage-updatecheck.xml
blob: 4f9cd981c94ec17a77f099889bd8e771b3080258 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
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=&lt;address&gt;</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>