VirtualBox

Changeset 68140 in vbox for trunk/doc


Ignore:
Timestamp:
Jul 27, 2017 3:16:23 PM (8 years ago)
Author:
vboxsync
Message:

VBoxManage/unattended: Do the sub-command thing, moving the current operation to 'install' and adding a 'detect' sub-command for probing an ISO. Moved documentation to man_VBoxManage-unattended.xml (lots to do here).

Location:
trunk/doc/manual
Files:
3 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/manual/Makefile.kmk

    r67323 r68140  
    192192VBOX_MANUAL_XML_REFENTRY_FILES = \
    193193        man_VBoxManage-debugvm.xml \
    194         man_VBoxManage-extpack.xml
     194        man_VBoxManage-extpack.xml \
     195        man_VBoxManage-unattended.xml
    195196
    196197

  • trunk/doc/manual/en_US/man_VBoxManage-unattended.xml

    r68030 r68140  
    3737
    3838  <refsynopsisdiv>
    39     <cmdsynopsis id="synopsis-vboxmanage-unattended"> <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
    40       <command>VBoxManage unattended</command>
     39    <cmdsynopsis id="synopsis-vboxmanage-unattended-detect"> <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
     40      <command>VBoxManage unattended detect</command>
     41      <arg choice="req">--iso=<replaceable>install-iso</replaceable></arg>
     42      <arg>--machine-readable</arg>
     43    </cmdsynopsis>
     44    <cmdsynopsis id="synopsis-vboxmanage-unattended-install"> <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
     45      <command>VBoxManage unattended install</command>
    4146      <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
    42       <arg choice="req">--iso-path=<replaceable>install-iso</replaceable></arg>
     47      <arg choice="req">--iso=<replaceable>install-iso</replaceable></arg>
     48      <arg choice="req">incomplete</arg>
    4349    </cmdsynopsis>
    4450  </refsynopsisdiv>
    … …  
    4753    <title>Description</title>
    4854
    49     <refsect2 id="vboxmanage-unattended">
    50       <title>unattended installation</title>
     55    <refsect2 id="vboxmanage-unattended-detect">
     56      <title>unattended detect</title>
    5157      <remark role="help-copy-synopsis"/>
    5258      <para>
    53         docs.
     59        Detects the guest operating system (OS) on the specified installation ISO
     60        and displays the result.  This can be used as input when creating a VM for
     61        the ISO to be installed in.
     62      </para>
     63      <variablelist>
     64        <varlistentry>
     65          <term><option>--iso=<replaceable>install-iso</replaceable></option></term>
     66          <listitem><para>The installation ISO to run the detection on.</para></listitem>
     67        </varlistentry>
     68        <varlistentry>
     69          <term><option>--machine-readable</option></term>
     70          <listitem><para>Produce output that is simpler to parse from a script.</para></listitem>
     71        </varlistentry>
     72      </variablelist>
     73    </refsect2>
     74
     75    <refsect2 id="vboxmanage-unattended-install">
     76      <title>unattended install</title>
     77      <remark role="help-copy-synopsis"/>
     78      <para>
     79        Reconfigures the specified VM for installation and optionally starts it up.
    5480      </para>
    5581      <variablelist>
    … …  
    5884          <listitem><para>Either the UUID or the name (case sensitive) of a VM.</para></listitem>
    5985        </varlistentry>
     86        <varlistentry>
     87          <term><option>--iso=<replaceable>install-iso</replaceable></option></term>
     88          <listitem><para>The installation ISO to run the detection on.</para></listitem>
     89        </varlistentry>
     90        <!-- a lot more stuff here to document. -->
    6091      </variablelist>
    6192    </refsect2>

  • trunk/doc/manual/en_US/user_VBoxManage.xml

    r67240 r68140  
    26872687  </sect1>
    26882688
    2689 <sect1 id="vboxmanage-unattended">
    2690     <title>VBoxManage unattended</title>
    2691  
    2692     <para>The <computeroutput>unattended</computeroutput> subcommand allows you to run unattended
    2693     guest installation from the command line.
    2694     User is able to choose passing the settings for unattended installation via:
    2695       <itemizedlist>
    2696         <listitem>
    2697           <para>passing the data via a file with prepared settings using
    2698           <computeroutput>VBoxManage unattended usefile</computeroutput>
    2699           </para>
    2700           <itemizedlist>
    2701             <listitem>
    2702               <para><computeroutput>--settingfile
    2703               &lt;file&gt;</computeroutput>:
    2704               specifies a file with all settings needed for unattended installation. </para>
    2705             </listitem>
    2706           </itemizedlist>
    2707  
    2708           <para>In this case correctness of all settings and data lays upon on the user.</para>
    2709  
    2710         </listitem>
    2711  
    2712         <listitem>
    2713           <para>the command line using
    2714           <computeroutput>VBoxManage unattended usedata</computeroutput></para>
    2715           <para>Command line settings are:</para>
    2716           <itemizedlist>
    2717             <listitem>
    2718               <para><computeroutput>--user
    2719               &lt;user name&gt;</computeroutput>:
    2720               specifies a login name for the guest OS. </para>
    2721             </listitem>
    2722  
    2723             <listitem>
    2724               <para><computeroutput>--password
    2725               &lt;password&gt;</computeroutput>:
    2726               user's password for the logging to the guest OS. </para>
    2727             </listitem>
    2728  
    2729             <listitem>
    2730               <para><computeroutput>--key
    2731               &lt;key&gt;</computeroutput>:
    2732               product key for validating the installed OS. </para>
    2733             </listitem>
    2734  
    2735             <listitem>
    2736               <para><computeroutput>--isopath
    2737               &lt;OS ISO path&gt;</computeroutput>:
    2738               CD\DVD disk or ISO image with OS installation data. </para>
    2739             </listitem>
    2740  
    2741             <listitem>
    2742                <para><computeroutput>--addisopath
    2743               &lt;additions ISO path&gt;</computeroutput>:
    2744               ISO image with Virtualbox additions. Optional. </para>
    2745             </listitem>
    2746  
    2747             <listitem>
    2748               <para><computeroutput>--imageindex
    2749               &lt;number&gt;</computeroutput>:
    2750               The installation disk can contains the several images of OS (for example 32bits and 64bits systems).
    2751               At moment used only for Windows OS installation. Optional.
    2752               </para>
    2753             </listitem>
    2754  
    2755           </itemizedlist>
    2756         </listitem>
    2757       </itemizedlist>
    2758     </para>
    2759  
    2760     <para>The setting file has a simple structure as "key equal sign value".
    2761     One key is one line, at moment there are eight settings which supported by the command:
    2762       <itemizedlist>
    2763         <listitem>
    2764           <para><computeroutput>
    2765           username</computeroutput>:
    2766            See above description for "--username"</para>
    2767         </listitem>
    2768  
    2769         <listitem>
    2770           <para><computeroutput>
    2771           password</computeroutput>:
    2772           See above description for "--password"</para>
    2773         </listitem>
    2774  
    2775         <listitem>
    2776           <para><computeroutput>
    2777           key</computeroutput>:
    2778           See above description for "--key"</para>
    2779         </listitem>
    2780  
    2781         <listitem>
    2782           <para><computeroutput>
    2783           installation_iso</computeroutput>:
    2784           See above description for "--isopath"</para>
    2785         </listitem>
    2786  
    2787         <listitem>
    2788           <para><computeroutput>
    2789           addition_iso</computeroutput>:
    2790           See above description for "--addisopath"</para>
    2791         </listitem>
    2792  
    2793         <listitem>
    2794           <para><computeroutput>
    2795           aux_iso</computeroutput>:
    2796           Auxiliary CD disk which can be used during installation as simple bootable CD with unattended script on it.
    2797           Generally used for Linux installation.</para>
    2798         </listitem>
    2799  
    2800         <listitem>
    2801           <para><computeroutput>
    2802           aux_floppy</computeroutput>:
    2803           Auxiliary floppy disk which can be used during installation as source of unattended script used by the installer.
    2804           Generally used for Windows installation.
    2805           </para>
    2806         </listitem>
    2807  
    2808         <listitem>
    2809           <para><computeroutput>
    2810           image_index</computeroutput>:
    2811           See above description for "--imageindex".</para>
    2812         </listitem>
    2813       </itemizedlist>
    2814         <note>
    2815           <para>The most of parameters are the same parameters as passed via the command line
    2816           and two of them are related to two items which can be created on the fly during installation (it's auxiliary floppy and CD).
    2817           </para>
    2818         </note>
    2819     </para>
    2820  
    2821     <para>
    2822     Example "VBoxManage unattended usedata":
    2823     </para>
    2824     <para>
    2825     <computeroutput>
    2826     VBoxManage unattended 2a524618-dd30-4168-bd53-645d9d72bb25 usedata
    2827     --user smith
    2828     --password smile
    2829     --isopath /path/to/the/distributive/ubuntu-16.04.1-server-amd64.iso
    2830     --addisopath /path/to/Virtualbox/additions/VBoxGuestAdditions.iso
    2831     </computeroutput>
    2832     </para>
    2833 
    2834     <para>
    2835     Example "VBoxManage unattended usefile":
    2836     </para>
    2837     <para><computeroutput>
    2838     VBoxManage unattended 2a524618-dd30-4168-bd53-645d9d72bb25 usefile
    2839     --settingfile /path/to/the/file/unattended_settings.txt
    2840     </computeroutput></para>
    2841 
    2842   </sect1>
    2843 
    28442689  <sect1>
    28452690    <title>VBoxManage discardstate</title>
    … …  
    59435788
    59445789
    5945   <xi:include href="user_man_VBoxManage-debugvm.xml" xpointer="element(/1)"
    5946     xmlns:xi="http://www.w3.org/2001/XInclude" />
    5947 
    5948   <xi:include href="user_man_VBoxManage-extpack.xml" xpointer="element(/1)"
    5949     xmlns:xi="http://www.w3.org/2001/XInclude" />
     5790  <xi:include href="user_man_VBoxManage-debugvm.xml"    xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
     5791  <xi:include href="user_man_VBoxManage-extpack.xml"    xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
     5792  <xi:include href="user_man_VBoxManage-unattended.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
    59505793</chapter>
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