VirtualBox

Changeset 47004 in vbox for trunk/doc


Ignore:
Timestamp:
Jul 5, 2013 12:27:21 PM (12 years ago)
Author:
vboxsync
Message:

VBoxManage: unified parameter description + documented VBoxManage guestcontrol mktemp

Location:
trunk/doc/manual/en_US
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/manual/en_US/user_AdvancedTopics.xml

    r46920 r47004  
    28442844    is no option to use password hashes. This leaves no other choice than
    28452845    having a clear-text password in the VM configuration, which can be set with
    2846     the following command:<screen>VBoxManage modifyvm VMNAME --vrdeproperty VNCPassword=secret</screen></para>
     2846    the following command:<screen>VBoxManage modifyvm "VM name" --vrdeproperty VNCPassword=secret</screen></para>
    28472847
    28482848    <para>The user is responsible for keeping this password secret, and it
     
    29562956    <para>The expert storage management mode can be enabled per VM executing:</para>
    29572957
    2958     <screen>VBoxManage setextradata vmname "VBoxInternal2/SilentReconfigureWhilePaused" 1
     2958    <screen>VBoxManage setextradata "VM name" "VBoxInternal2/SilentReconfigureWhilePaused" 1
    29592959</screen>
    29602960
  • trunk/doc/manual/en_US/user_VBoxManage.xml

    r46821 r47004  
    13881388    <glosslist>
    13891389      <glossentry>
    1390         <glossterm>gui</glossterm>
     1390        <glossterm><computeroutput>gui</computeroutput></glossterm>
    13911391
    13921392        <glossdef>
     
    13961396
    13971397      <glossentry>
    1398         <glossterm>headless</glossterm>
     1398        <glossterm><computeroutput>headless</computeroutput></glossterm>
    13991399
    14001400        <glossdef>
     
    14041404
    14051405      <glossentry>
    1406         <glossterm>sdl</glossterm>
     1406        <glossterm><computeroutput>sdl</computeroutput></glossterm>
    14071407
    14081408        <glossdef>
     
    14821482
    14831483        <listitem>
    1484           <para><computeroutput>VBoxManage controlvm &lt;vm&gt; teleport
     1484          <para><computeroutput>VBoxManage controlvm "VM name" teleport
    14851485          --hostname &lt;name&gt; --port &lt;port&gt; [--passwordfile
    14861486          &lt;file&gt; | --password &lt;password&gt;]</computeroutput> makes
     
    17081708    <para>The common parameters are:<glosslist>
    17091709        <glossentry>
    1710           <glossterm>uuid|vmname</glossterm>
     1710          <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm>
    17111711
    17121712          <glossdef>
     
    17161716
    17171717        <glossentry>
    1718           <glossterm>storagectl</glossterm>
     1718          <glossterm><computeroutput>--storagectl</computeroutput></glossterm>
    17191719
    17201720          <glossdef>
     
    17271727
    17281728        <glossentry>
    1729           <glossterm>port</glossterm>
     1729          <glossterm><computeroutput>--port</computeroutput></glossterm>
    17301730
    17311731          <glossdef>
     
    17371737
    17381738        <glossentry>
    1739           <glossterm>device</glossterm>
     1739          <glossterm><computeroutput>--device</computeroutput></glossterm>
    17401740
    17411741          <glossdef>
     
    17471747
    17481748        <glossentry>
    1749           <glossterm>type</glossterm>
     1749          <glossterm><computeroutput>--type</computeroutput></glossterm>
    17501750
    17511751          <glossdef>
     
    17591759
    17601760        <glossentry>
    1761           <glossterm>medium</glossterm>
     1761          <glossterm><computeroutput>--medium</computeroutput></glossterm>
    17621762
    17631763          <glossdef>
     
    18171817
    18181818        <glossentry>
    1819           <glossterm>mtype</glossterm>
     1819          <glossterm><computeroutput>--mtype</computeroutput></glossterm>
    18201820
    18211821          <glossdef>
     
    18271827
    18281828        <glossentry>
    1829           <glossterm>comment</glossterm>
     1829          <glossterm><computeroutput>--comment</computeroutput></glossterm>
    18301830
    18311831          <glossdef>
     
    18381838
    18391839        <glossentry>
    1840           <glossterm>setuuid, setparentuuid</glossterm>
     1840          <glossterm><computeroutput>--setuuid, --setparentuuid</computeroutput></glossterm>
    18411841
    18421842          <glossdef>
     
    18531853
    18541854        <glossentry>
    1855           <glossterm>passthrough</glossterm>
     1855          <glossterm><computeroutput>--passthrough</computeroutput></glossterm>
    18561856
    18571857          <glossdef>
     
    18631863
    18641864        <glossentry>
    1865           <glossterm>tempeject</glossterm>
     1865          <glossterm><computeroutput>--tempeject</computeroutput></glossterm>
    18661866
    18671867          <glossdef>
     
    18741874
    18751875        <glossentry>
    1876           <glossterm>nonrotational</glossterm>
     1876          <glossterm><computeroutput>--nonrotational</computeroutput></glossterm>
    18771877
    18781878          <glossdef>
     
    18851885
    18861886        <glossentry>
    1887           <glossterm>bandwidthgroup</glossterm>
     1887          <glossterm><computeroutput>--bandwidthgroup</computeroutput></glossterm>
    18881888
    18891889          <glossdef>
     
    18941894
    18951895        <glossentry>
    1896           <glossterm>forceunmount</glossterm>
     1896          <glossterm><computeroutput>--forceunmount</computeroutput></glossterm>
    18971897
    18981898          <glossdef>
     
    19101910    be used:<glosslist>
    19111911        <glossentry>
    1912           <glossterm>server</glossterm>
     1912          <glossterm><computeroutput>--server</computeroutput></glossterm>
    19131913
    19141914          <glossdef>
     
    19191919
    19201920        <glossentry>
    1921           <glossterm>target</glossterm>
     1921          <glossterm><computeroutput>--target</computeroutput></glossterm>
    19221922
    19231923          <glossdef>
     
    19281928
    19291929        <glossentry>
    1930           <glossterm>tport</glossterm>
     1930          <glossterm><computeroutput>--tport</computeroutput></glossterm>
    19311931
    19321932          <glossdef>
     
    19371937
    19381938        <glossentry>
    1939           <glossterm>lun</glossterm>
     1939          <glossterm><computeroutput>--lun</computeroutput></glossterm>
    19401940
    19411941          <glossdef>
     
    19461946
    19471947        <glossentry>
    1948           <glossterm>username, password</glossterm>
     1948          <glossterm><computeroutput>--username, --password</computeroutput></glossterm>
    19491949
    19501950          <glossdef>
     
    19611961
    19621962        <glossentry>
    1963           <glossterm>intnet</glossterm>
     1963          <glossterm><computeroutput>--intnet</computeroutput></glossterm>
    19641964
    19651965          <glossdef>
     
    19941994    <para>where the parameters mean: <glosslist>
    19951995        <glossentry>
    1996           <glossterm>uuid|vmname</glossterm>
     1996          <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm>
    19971997
    19981998          <glossdef>
     
    20022002
    20032003        <glossentry>
    2004           <glossterm>name</glossterm>
     2004          <glossterm><computeroutput>--name</computeroutput></glossterm>
    20052005
    20062006          <glossdef>
     
    20102010
    20112011        <glossentry>
    2012           <glossterm>add</glossterm>
     2012          <glossterm><computeroutput>--add</computeroutput></glossterm>
    20132013
    20142014          <glossdef>
     
    20192019
    20202020        <glossentry>
    2021           <glossterm>controller</glossterm>
     2021          <glossterm><computeroutput>--controller</computeroutput></glossterm>
    20222022
    20232023          <glossdef>
     
    20282028
    20292029        <glossentry>
    2030           <glossterm>sataportcount</glossterm>
     2030          <glossterm><computeroutput>--sataportcount</computeroutput></glossterm>
    20312031
    20322032          <glossdef>
     
    20372037
    20382038        <glossentry>
    2039           <glossterm>hostiocache</glossterm>
     2039          <glossterm><computeroutput>--hostiocache</computeroutput></glossterm>
    20402040
    20412041          <glossdef>
     
    20472047
    20482048        <glossentry>
    2049           <glossterm>bootable</glossterm>
     2049          <glossterm><computeroutput>--bootable</computeroutput></glossterm>
    20502050
    20512051          <glossdef>
     
    20552055
    20562056        <glossentry>
    2057           <glossterm>remove</glossterm>
     2057          <glossterm><computeroutput>--remove</computeroutput></glossterm>
    20582058
    20592059          <glossdef>
     
    20952095    <para>The parameters mean:<glosslist>
    20962096        <glossentry>
    2097           <glossterm>uuid|vmname</glossterm>
     2097          <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm>
    20982098
    20992099          <glossdef>
     
    21032103
    21042104        <glossentry>
    2105           <glossterm>name</glossterm>
     2105          <glossterm><computeroutput>--name</computeroutput></glossterm>
    21062106
    21072107          <glossdef>
     
    21112111
    21122112        <glossentry>
    2113           <glossterm>type</glossterm>
     2113          <glossterm><computeroutput>--type</computeroutput></glossterm>
    21142114
    21152115          <glossdef>
     
    21242124
    21252125        <glossentry>
    2126           <glossterm>limit</glossterm>
     2126          <glossterm><computeroutput>--limit</computeroutput></glossterm>
    21272127
    21282128          <glossdef>
     
    21762176    <para>where the parameters mean:<glosslist>
    21772177        <glossentry>
    2178           <glossterm>filename</glossterm>
     2178          <glossterm><computeroutput>--filename</computeroutput></glossterm>
    21792179
    21802180          <glossdef>
     
    21842184
    21852185        <glossentry>
    2186           <glossterm>size</glossterm>
     2186          <glossterm><computeroutput>--size</computeroutput></glossterm>
    21872187
    21882188          <glossdef>
     
    21932193
    21942194        <glossentry>
    2195           <glossterm>format</glossterm>
     2195          <glossterm><computeroutput>--format</computeroutput></glossterm>
    21962196
    21972197          <glossdef>
     
    22022202
    22032203        <glossentry>
    2204           <glossterm>variant</glossterm>
     2204          <glossterm><computeroutput>--variant</computeroutput></glossterm>
    22052205
    22062206          <glossdef>
     
    22232223    <para>With the <computeroutput>modifyhd</computeroutput> command, you can
    22242224    change the characteristics of a disk image after it has been
    2225     created:<screen>VBoxManage modifyhd         &lt;uuid&gt;|&lt;filename&gt;
     2225    created:<screen>VBoxManage modifyhd         &lt;uuid|filename&gt;
    22262226                            [--type normal|writethrough|immutable|shareable|
    22272227                                    readonly|multiattach]
     
    23172317    linkend="cloningvdis" />. The syntax is as follows:</para>
    23182318
    2319     <screen>VBoxManage clonehd         &lt;uuid&gt;|&lt;filename&gt; &lt;outputfile&gt;
     2319    <screen>VBoxManage clonehd         &lt;uuid|inutfile&gt; &lt;uuid|outputfile&gt;
    23202320                           [--format VDI|VMDK|VHD|RAW|&lt;other&gt;]
    23212321                           [--variant Standard,Fixed,Split2G,Stream,ESX]
     
    23302330    <para>The following options are available:<glosslist>
    23312331        <glossentry>
    2332           <glossterm>format</glossterm>
     2332          <glossterm><computeroutput>--format</computeroutput></glossterm>
    23332333
    23342334          <glossdef>
     
    23392339
    23402340        <glossentry>
    2341           <glossterm>variant</glossterm>
     2341          <glossterm><computeroutput>--variant</computeroutput></glossterm>
    23422342
    23432343          <glossdef>
     
    23502350
    23512351        <glossentry>
    2352           <glossterm>existing</glossterm>
     2352          <glossterm><computeroutput>--existing</computeroutput></glossterm>
    23532353
    23542354          <glossdef>
     
    23852385    <para>where the parameters mean:<glosslist>
    23862386        <glossentry>
    2387           <glossterm>bytes</glossterm>
     2387          <glossterm><computeroutput>--bytes</computeroutput></glossterm>
    23882388
    23892389          <glossdef>
     
    23942394
    23952395        <glossentry>
    2396           <glossterm>format</glossterm>
     2396          <glossterm><computeroutput>--format</computeroutput></glossterm>
    23972397
    23982398          <glossdef>
     
    24032403
    24042404        <glossentry>
    2405           <glossterm>variant</glossterm>
     2405          <glossterm><computeroutput>--variant</computeroutput></glossterm>
    24062406
    24072407          <glossdef>
     
    24142414
    24152415        <glossentry>
    2416           <glossterm>uuid</glossterm>
     2416          <glossterm><computeroutput>--uuid</computeroutput></glossterm>
    24172417
    24182418          <glossdef>
     
    24722472    following properties are available:<glosslist>
    24732473        <glossentry>
    2474           <glossterm>machinefolder</glossterm>
     2474          <glossterm><computeroutput>machinefolder</computeroutput></glossterm>
    24752475
    24762476          <glossdef>
     
    24822482
    24832483        <glossentry>
    2484           <glossterm>vrdeauthlibrary</glossterm>
     2484          <glossterm><computeroutput>vrdeauthlibrary</computeroutput></glossterm>
    24852485
    24862486          <glossdef>
     
    24922492
    24932493        <glossentry>
    2494           <glossterm>websrvauthlibrary</glossterm>
     2494          <glossterm><computeroutput>websrvauthlibrary</computeroutput></glossterm>
    24952495
    24962496          <glossdef>
     
    25032503
    25042504        <glossentry>
    2505           <glossterm>vrdeextpack</glossterm>
     2505          <glossterm><computeroutput>vrdeextpack</computeroutput></glossterm>
    25062506
    25072507          <glossdef>
     
    25122512
    25132513        <glossentry>
    2514           <glossterm>loghistorycount</glossterm>
     2514          <glossterm><computeroutput>loghistorycount</computeroutput></glossterm>
    25152515
    25162516          <glossdef>
     
    25202520
    25212521        <glossentry>
    2522           <glossterm>autostartdbpath</glossterm>
     2522          <glossterm><computeroutput>autostartdbpath</computeroutput></glossterm>
    25232523
    25242524          <glossdef>
     
    25292529
    25302530        <glossentry>
    2531           <glossterm>defaultfrontend</glossterm>
     2531          <glossterm><computeroutput>defaultfrontend</computeroutput></glossterm>
    25322532
    25332533          <glossdef>
     
    27152715    <para>Generally, the syntax is as follows:</para>
    27162716
    2717     <screen>VBoxManage guestcontrol &lt;command&gt;</screen>
     2717    <screen>VBoxManage guestcontrol &lt;uuid|vmname&gt; &lt;command&gt;</screen>
    27182718
    27192719    <para>The following subcommands are available (where
    2720     <computeroutput>&lt;vm&gt;</computeroutput>, in each case, can either be a
     2720    <computeroutput>&lt;uuid|vmname&gt;</computeroutput>, in each case, can either be a
    27212721    VM name or a VM UUID, as with the other VBoxManage commands):<itemizedlist>
    27222722        <listitem>
    2723           <para><computeroutput>execute</computeroutput>, which allows for
     2723          <para><emphasis role="bold"><computeroutput>execute</computeroutput></emphasis>,
     2724          which allows for
    27242725          executing a program/script (process) which already is installed and
    27252726          runnable on the guest. This command only works while a VM is up and
    27262727          running and has the following syntax:</para>
    27272728
    2728           <screen>VBoxManage guestcontrol &lt;vmname&gt;|&lt;uuid&gt; exec[ute]
     2729          <screen>VBoxManage guestcontrol &lt;uuid|vmname&gt; exec[ute]
    27292730            --image &lt;path to program&gt; --username &lt;name&gt;
    27302731            [--passwordfile &lt;file&gt; | --password &lt;password&gt;]
     
    27372738          <para>where the parameters mean: <glosslist>
    27382739              <glossentry>
    2739                 <glossterm>uuid|vmname</glossterm>
     2740                <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm>
    27402741
    27412742                <glossdef>
     
    27452746
    27462747              <glossentry>
    2747                 <glossterm>--image "&lt;path to program&gt;"</glossterm>
     2748                <glossterm><computeroutput>--image "&lt;path to program&gt;"</computeroutput></glossterm>
    27482749
    27492750                <glossdef>
     
    27552756
    27562757              <glossentry>
    2757                 <glossterm>--username &lt;name&gt;</glossterm>
     2758                <glossterm><computeroutput>--username &lt;name&gt;</computeroutput></glossterm>
    27582759
    27592760                <glossdef>
     
    27642765
    27652766              <glossentry>
    2766                 <glossterm>--passwordfile &lt;file&gt;</glossterm>
     2767                <glossterm><computeroutput>--passwordfile &lt;file&gt;</computeroutput></glossterm>
    27672768
    27682769                <glossdef>
     
    27742775
    27752776              <glossentry>
    2776                 <glossterm>--password &lt;password&gt;</glossterm>
     2777                <glossterm><computeroutput>--password &lt;password&gt;</computeroutput></glossterm>
    27772778
    27782779                <glossdef>
     
    27842785
    27852786              <glossentry>
    2786                 <glossterm>--dos2unix</glossterm>
     2787                <glossterm><computeroutput>--dos2unix</computeroutput></glossterm>
    27872788
    27882789                <glossdef>
     
    27932794
    27942795              <glossentry>
    2795                 <glossterm>--environment
    2796                 "&lt;NAME&gt;=&lt;VALUE&gt;"</glossterm>
     2796                <glossterm><computeroutput>--environment
     2797                    "&lt;NAME&gt;=&lt;VALUE&gt;"</computeroutput></glossterm>
    27972798
    27982799                <glossdef>
     
    28172818
    28182819              <glossentry>
    2819                 <glossterm>--timeout &lt;msec&gt;</glossterm>
     2820                <glossterm><computeroutput>--timeout &lt;msec&gt;</computeroutput></glossterm>
    28202821
    28212822                <glossdef>
     
    28292830
    28302831              <glossentry>
    2831                 <glossterm>--unix2dos</glossterm>
     2832                <glossterm><computeroutput>--unix2dos</computeroutput></glossterm>
    28322833
    28332834                <glossdef>
     
    28382839
    28392840              <glossentry>
    2840                 <glossterm>--verbose</glossterm>
     2841                <glossterm><computeroutput>--verbose</computeroutput></glossterm>
    28412842
    28422843                <glossdef>
     
    28462847
    28472848              <glossentry>
    2848                 <glossterm>--wait-exit</glossterm>
     2849                <glossterm><computeroutput>--wait-exit</computeroutput></glossterm>
    28492850
    28502851                <glossdef>
     
    28552856
    28562857              <glossentry>
    2857                 <glossterm>--wait-stdout</glossterm>
     2858                <glossterm><computeroutput>--wait-stdout</computeroutput></glossterm>
    28582859
    28592860                <glossdef>
     
    28652866
    28662867              <glossentry>
    2867                 <glossterm>--wait-stderr</glossterm>
     2868                <glossterm><computeroutput>--wait-stderr</computeroutput></glossterm>
    28682869
    28692870                <glossdef>
     
    28752876
    28762877              <glossentry>
    2877                 <glossterm>[-- [&lt;argument1s&gt;] ... [&lt;argumentNs&gt;]]</glossterm>
     2878                <glossterm><computeroutput>[-- [&lt;argument1s&gt;] ... [&lt;argumentNs&gt;]]</computeroutput></glossterm>
    28782879
    28792880                <glossdef>
     
    29232924
    29242925        <listitem>
    2925           <para><computeroutput>copyto</computeroutput>, which allows copying
     2926          <para><emphasis role="bold"><computeroutput>copyto</computeroutput></emphasis>,
     2927          which allows copying
    29262928          files from the host to the guest (only with installed Guest
    29272929          Additions 4.0 and later).</para>
    29282930
    2929           <screen>VBoxManage guestcontrol &lt;vmname&gt;|&lt;uuid&gt; copyto|cp
     2931          <screen>VBoxManage guestcontrol &lt;uuid|vmname&gt; copyto|cp
    29302932            &lt;guest source&gt; &lt;host dest&gt; --username &lt;name&gt;
    29312933            [--passwordfile &lt;file&gt; | --password &lt;password&gt;]
     
    29342936          <para>where the parameters mean: <glosslist>
    29352937              <glossentry>
    2936                 <glossterm>uuid|vmname</glossterm>
     2938                <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm>
    29372939
    29382940                <glossdef>
     
    29422944
    29432945              <glossentry>
    2944                 <glossterm>source on host</glossterm>
     2946                <glossterm><computeroutput>source on host</computeroutput></glossterm>
    29452947
    29462948                <glossdef>
     
    29542956
    29552957              <glossentry>
    2956                 <glossterm>destination on guest</glossterm>
     2958                <glossterm><computeroutput>destination on guest</computeroutput></glossterm>
    29572959
    29582960                <glossdef>
     
    29632965
    29642966              <glossentry>
    2965                 <glossterm>--username &lt;name&gt;</glossterm>
     2967                <glossterm><computeroutput>--username &lt;name&gt;</computeroutput></glossterm>
    29662968
    29672969                <glossdef>
     
    29722974
    29732975              <glossentry>
    2974                 <glossterm>--passwordfile &lt;file&gt;</glossterm>
     2976                <glossterm><computeroutput>--passwordfile &lt;file&gt;</computeroutput></glossterm>
    29752977
    29762978                <glossdef>
     
    29822984
    29832985              <glossentry>
    2984                 <glossterm>--password &lt;password&gt;</glossterm>
     2986                <glossterm><computeroutput>--password &lt;password&gt;</computeroutput></glossterm>
    29852987
    29862988                <glossdef>
     
    29922994
    29932995              <glossentry>
    2994                 <glossterm>--dryrun</glossterm>
     2996                <glossterm><computeroutput>--dryrun</computeroutput></glossterm>
    29952997
    29962998                <glossdef>
     
    30013003
    30023004              <glossentry>
    3003                 <glossterm>--follow</glossterm>
     3005                <glossterm><computeroutput>--follow</computeroutput></glossterm>
    30043006
    30053007                <glossdef>
     
    30103012
    30113013              <glossentry>
    3012                 <glossterm>--recursive</glossterm>
     3014                <glossterm><computeroutput>--recursive</computeroutput></glossterm>
    30133015
    30143016                <glossdef>
     
    30193021
    30203022              <glossentry>
    3021                 <glossterm>--verbose</glossterm>
     3023                <glossterm><computeroutput>--verbose</computeroutput></glossterm>
    30223024
    30233025                <glossdef>
     
    30273029
    30283030              <glossentry>
    3029                 <glossterm>--flags &lt;flags&gt;</glossterm>
     3031                <glossterm><computeroutput>--flags &lt;flags&gt;</computeroutput></glossterm>
    30303032
    30313033                <glossdef>
     
    30383040
    30393041        <listitem>
    3040           <para><computeroutput>copyfrom</computeroutput>, which allows copying
     3042          <para><emphasis role="bold"><computeroutput>copyfrom</computeroutput></emphasis>,
     3043          which allows copying
    30413044          files from the guest to the host (only with installed Guest
    30423045          Additions 4.0 and later). It has the same parameters as
     
    30453048
    30463049        <listitem>
    3047           <para><computeroutput>createdirectory</computeroutput>, which allows
     3050          <para><emphasis role="bold"><computeroutput>createdirectory</computeroutput></emphasis>,
     3051          which allows
    30483052          copying files from the host to the guest (only with installed Guest
    30493053          Additions 4.0 and later).</para>
    30503054
    3051           <screen>VBoxManage guestcontrol &lt;vmname&gt;|&lt;uuid&gt; createdir[ectory]|mkdir|md
     3055          <screen>VBoxManage guestcontrol &lt;uuid|vmname&gt; createdir[ectory]|mkdir|md
    30523056            &lt;guest directory&gt;... --username &lt;name&gt;
    30533057            [--passwordfile &lt;file&gt; | --password &lt;password&gt;]
     
    30563060          <para>where the parameters mean: <glosslist>
    30573061              <glossentry>
    3058                 <glossterm>uuid|vmname</glossterm>
     3062                <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm>
    30593063
    30603064                <glossdef>
     
    30643068
    30653069              <glossentry>
    3066                 <glossterm>directory to create on guest</glossterm>
     3070                <glossterm><computeroutput>directory to create on guest</computeroutput></glossterm>
    30673071
    30683072                <glossdef>
     
    30783082
    30793083              <glossentry>
    3080                 <glossterm>--username &lt;name&gt;</glossterm>
     3084                <glossterm><computeroutput>--username &lt;name&gt;</computeroutput></glossterm>
    30813085
    30823086                <glossdef>
     
    30873091
    30883092              <glossentry>
    3089                 <glossterm>--passwordfile &lt;file&gt;</glossterm>
     3093                <glossterm><computeroutput>--passwordfile &lt;file&gt;</computeroutput></glossterm>
    30903094
    30913095                <glossdef>
     
    30973101
    30983102              <glossentry>
    3099                 <glossterm>--password &lt;password&gt;</glossterm>
     3103                <glossterm><computeroutput>--password &lt;password&gt;</computeroutput></glossterm>
    31003104
    31013105                <glossdef>
     
    31073111
    31083112              <glossentry>
    3109                 <glossterm>--parents</glossterm>
     3113                <glossterm><computeroutput>--parents</computeroutput></glossterm>
    31103114
    31113115                <glossdef>
     
    31213125
    31223126              <glossentry>
    3123                 <glossterm>--mode &lt;mode&gt;</glossterm>
     3127                <glossterm><computeroutput>--mode &lt;mode&gt;</computeroutput></glossterm>
    31243128
    31253129                <glossdef>
     
    31323136
    31333137              <glossentry>
    3134                 <glossterm>--verbose</glossterm>
     3138                <glossterm><computeroutput>--verbose</computeroutput></glossterm>
    31353139
    31363140                <glossdef>
     
    31423146
    31433147        <listitem>
    3144           <para><computeroutput>stat</computeroutput>, which displays file
     3148          <para><emphasis role="bold"><computeroutput>createtemporary</computeroutput></emphasis>,
     3149          which allows
     3150          copying files from the host to the guest (only with installed Guest
     3151          Additions 4.2 and later).</para>
     3152
     3153          <screen>VBoxManage guestcontrol &lt;uuid|vmname&gt; createtemp[orary]|mktemp
     3154            &lt;template&gt; --username &lt;name&gt;
     3155            [--passwordfile &lt;file&gt; | --password &lt;password&gt;]
     3156            [--directory] [--secure] [--tmpdir &lt;directory&gt;]
     3157            [--domain &lt;domain&gt;] [--mode &lt;mode&gt;] [--verbose]</screen>
     3158
     3159          <para>where the parameters mean: <glosslist>
     3160              <glossentry>
     3161                <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm>
     3162
     3163                <glossdef>
     3164                  <para>The VM UUID or VM name. Mandatory.</para>
     3165                </glossdef>
     3166              </glossentry>
     3167
     3168              <glossentry>
     3169                <glossterm><computeroutput>template</computeroutput></glossterm>
     3170
     3171                <glossdef>
     3172                  <para>A file name without a path and with at least three consecutive 'X'
     3173                    characters or ending in 'X'
     3174                  </para>
     3175                </glossdef>
     3176              </glossentry>
     3177
     3178              <glossentry>
     3179                <glossterm><computeroutput>--username &lt;name&gt;</computeroutput></glossterm>
     3180
     3181                <glossdef>
     3182                  <para>Name of the user the copy process should run under.
     3183                  This user must exist on the guest OS.</para>
     3184                </glossdef>
     3185              </glossentry>
     3186
     3187              <glossentry>
     3188                <glossterm><computeroutput>--passwordfile &lt;file&gt;</computeroutput></glossterm>
     3189
     3190                <glossdef>
     3191                  <para>Password of the user account specified to be read from
     3192                  the given file. If not given, an empty password is
     3193                  assumed.</para>
     3194                </glossdef>
     3195              </glossentry>
     3196
     3197              <glossentry>
     3198                <glossterm><computeroutput>--password &lt;password&gt;</computeroutput></glossterm>
     3199
     3200                <glossdef>
     3201                  <para>Password of the user account specified with
     3202                  <computeroutput>--username</computeroutput>. If not given,
     3203                  an empty password is assumed.</para>
     3204                </glossdef>
     3205              </glossentry>
     3206
     3207              <glossentry>
     3208                <glossterm><computeroutput>--directory</computeroutput></glossterm>
     3209
     3210                <glossdef>
     3211                  <para>Create a temporary directory instead of a file.</para>
     3212                </glossdef>
     3213              </glossentry>
     3214
     3215              <glossentry>
     3216                <glossterm><computeroutput>--secure</computeroutput></glossterm>
     3217
     3218                <glossdef>
     3219                  <para>
     3220                    Secure creation. The file mode is fixed to
     3221                    <computeroutput>0755</computeroutput>. And the operation
     3222                    will fail if it cannot performed securely.
     3223                  </para>
     3224                </glossdef>
     3225              </glossentry>
     3226
     3227              <glossentry>
     3228                <glossterm><computeroutput>--tmpdir &lt;directory&gt;</computeroutput></glossterm>
     3229
     3230                <glossdef>
     3231                  <para>
     3232                    Directory where the file / directory is created. If not
     3233                    specified, the platform-specific temp directory is used.
     3234                  </para>
     3235                </glossdef>
     3236              </glossentry>
     3237
     3238              <glossentry>
     3239                <glossterm><computeroutput>--mode &lt;mode&gt;</computeroutput></glossterm>
     3240
     3241                <glossdef>
     3242                  <para>Sets the permission mode of the specified directory.
     3243                  Only octal modes (e.g.
     3244                  <computeroutput>0755</computeroutput>) are supported right
     3245                  now.</para>
     3246                </glossdef>
     3247              </glossentry>
     3248
     3249              <glossentry>
     3250                <glossterm><computeroutput>--verbose</computeroutput></glossterm>
     3251
     3252                <glossdef>
     3253                  <para>Tells VBoxManage to be more verbose.</para>
     3254                </glossdef>
     3255              </glossentry>
     3256            </glosslist></para>
     3257        </listitem>
     3258
     3259        <listitem>
     3260          <para><emphasis role="bold"><computeroutput>stat</computeroutput></emphasis>,
     3261          which displays file
    31453262          or file system status on the guest.</para>
    31463263
    3147           <screen>VBoxManage guestcontrol &lt;vmname&gt;|&lt;uuid&gt; stat
     3264          <screen>VBoxManage guestcontrol &lt;uuid|vmname&gt; stat
    31483265            &lt;file&gt;... --username &lt;name&gt;
    31493266            [--passwordfile &lt;file&gt; | --password &lt;password&gt;]
     
    31523269          <para>where the parameters mean: <glosslist>
    31533270              <glossentry>
    3154                 <glossterm>uuid|vmname</glossterm>
     3271                <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm>
    31553272
    31563273                <glossdef>
     
    31603277
    31613278              <glossentry>
    3162                 <glossterm>file element(s) to check on guest</glossterm>
     3279                <glossterm><computeroutput>file element(s) to check on guest</computeroutput></glossterm>
    31633280
    31643281                <glossdef>
     
    31713288
    31723289              <glossentry>
    3173                 <glossterm>--username &lt;name&gt;</glossterm>
     3290                <glossterm><computeroutput>--username &lt;name&gt;</computeroutput></glossterm>
    31743291
    31753292                <glossdef>
     
    31803297
    31813298              <glossentry>
    3182                 <glossterm>--passwordfile &lt;file&gt;</glossterm>
     3299                <glossterm><computeroutput>--passwordfile &lt;file&gt;</computeroutput></glossterm>
    31833300
    31843301                <glossdef>
     
    31903307
    31913308              <glossentry>
    3192                 <glossterm>--password &lt;password&gt;</glossterm>
     3309                <glossterm><computeroutput>--password &lt;password&gt;</computeroutput></glossterm>
    31933310
    31943311                <glossdef>
     
    32003317
    32013318              <glossentry>
    3202                 <glossterm>--verbose</glossterm>
     3319                <glossterm><computeroutput>--verbose</computeroutput></glossterm>
    32033320
    32043321                <glossdef>
     
    32103327
    32113328        <listitem>
    3212           <para><computeroutput>updateadditions</computeroutput>, which allows
     3329          <para><emphasis role="bold"><computeroutput>updateadditions</computeroutput></emphasis>,
     3330          which allows
    32133331          for updating an already installed Guest Additions version on the
    32143332          guest (only already installed Guest Additions 4.0 and later).</para>
    32153333
    3216           <screen>VBoxManage guestcontrol &lt;vmname&gt;|&lt;uuid&gt; updateadditions
     3334          <screen>VBoxManage guestcontrol &lt;uuid|vmname&gt; updateadditions
    32173335            [--source "&lt;guest additions .ISO file to use&gt;"] [--verbose]
    32183336            [--wait-start] [-- [&lt;argument1&gt;] ... [&lt;argumentN&gt;]]</screen>
     
    32203338          <para>where the parameters mean: <glosslist>
    32213339              <glossentry>
    3222                 <glossterm>uuid|vmname</glossterm>
     3340                <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm>
    32233341
    32243342                <glossdef>
     
    32383356
    32393357              <glossentry>
    3240                 <glossterm>--verbose</glossterm>
     3358                <glossterm><computeroutput>--verbose</computeroutput></glossterm>
    32413359
    32423360                <glossdef>
     
    32463364
    32473365              <glossentry>
    3248                 <glossterm>--wait-start</glossterm>
     3366                <glossterm><computeroutput>--wait-start</computeroutput></glossterm>
    32493367                <glossdef>
    32503368                  <para>Starts the regular updating process and waits until the
     
    32583376
    32593377              <glossentry>
    3260                 <glossterm>[-- [&lt;argument1s&gt;] ... [&lt;argumentNs&gt;]]</glossterm>
     3378                <glossterm><computeroutput>[-- [&lt;argument1s&gt;] ... [&lt;argumentNs&gt;]]</computeroutput></glossterm>
    32613379
    32623380                <glossdef>
     
    34613579    <glosslist>
    34623580      <glossentry>
    3463         <glossterm>list</glossterm>
     3581        <glossterm><computeroutput>list</computeroutput></glossterm>
    34643582
    34653583        <glossdef>
     
    34713589
    34723590      <glossentry>
    3473         <glossterm>setup</glossterm>
     3591        <glossterm><computeroutput>setup</computeroutput></glossterm>
    34743592
    34753593        <glossdef>
     
    34843602
    34853603      <glossentry>
    3486         <glossterm>enable</glossterm>
     3604        <glossterm><computeroutput>enable</computeroutput></glossterm>
    34873605
    34883606        <glossdef>
     
    34963614
    34973615      <glossentry>
    3498         <glossterm>disable</glossterm>
     3616        <glossterm><computeroutput>disable</computeroutput></glossterm>
    34993617
    35003618        <glossdef>
     
    35083626
    35093627      <glossentry>
    3510         <glossterm>query</glossterm>
     3628        <glossterm><computeroutput>query</computeroutput></glossterm>
    35113629
    35123630        <glossdef>
     
    35223640
    35233641      <glossentry>
    3524         <glossterm>collect</glossterm>
     3642        <glossterm><computeroutput>collect</computeroutput></glossterm>
    35253643
    35263644        <glossdef>
Note: See TracChangeset for help on using the changeset viewer.

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