<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="install-installer-command-line-reference">
  <title><?oxy_comment_start author="steven_higgs" timestamp="20160426T160526+0300" comment="Converted to topic with same name."?><ph
      keyref="product"/> Installer Command Line Reference<?oxy_comment_end?></title>
  <shortdesc>Command line options of the <ph keyref="product"/> installer.</shortdesc>
  <prolog>
    <metadata>
      <keywords>
        <indexterm>Command line options</indexterm>
      </keywords>
    </metadata>
  </prolog>
  <refbody>
    <section id="responsevarfile">
      <title><filepath>response.varfile</filepath></title>
      <p>The <ph keyref="product"/> installers for Windows and Linux creates a file called
          <filepath>response.varfile</filepath>, which records the choices that the user made when
        running the installer interactively. You can use a <filepath>response.varfile</filepath> to
        set the options for an unintended install. Here is an example of a
          <filepath>response.varfile</filepath>:</p>
      <codeblock outputclass="language-ini">#install4j response file for Oxygen XML Editor 16.0
#Fri Jul 18 21:52:15 EDT 2014
sys.adminRights$Boolean=true
sys.programGroupDisabled$Boolean=false
createDesktopLinkAction$Boolean=true
autoVersionChecking=true
sys.fileAssociation.launchers$StringArray="19","19","19","19","19","19","19","19","19","19","19","19","19","19","19","19","19","19","19","19","19","19","19","19","19","19"
sys.programGroupAllUsers$Boolean=true
reportProblem=true
downloadResources=true
sys.languageId=en
sys.installationDir=C\:\\Program Files (x86)\\Oxygen XML Editor 16
createQuicklaunchIconAction$Boolean=true
sys.programGroupName=Oxygen XML Editor 16.0
executeLauncherAction$Boolean=true
sys.fileAssociation.extensions$StringArray="xml","dita","ditamap","ditaval","xsl","xslt","xspec","xsd","rng","rnc","sch","dtd","mod","ent","nvdl","fo","wsdl","xquery","xq","xqy","xqm","xql","xpl","css","json","xpr"</codeblock>
      <p>The following table describes some of the settings that can be used in the
          <filepath>response.varfile</filepath>:</p>
      <table frame="all" id="table_ncm_v3r_x4">
        <title><filepath>response.varfile</filepath> Options Parameters</title>
        <tgroup cols="3">
          <colspec colname="c1" colnum="1" colwidth="1*" colsep="1" rowsep="1"/>
          <colspec colname="newCol2" colnum="2" colwidth="2.53*" colsep="1" rowsep="1"/>
          <colspec colname="c2" colnum="3" colwidth="1.53*" colsep="1" rowsep="1"/>
          <thead>
            <row>
              <entry>Parameter Name</entry>
              <entry>Description</entry>
              <entry>Values</entry>
            </row>
          </thead>
          <tbody>
            <row>
              <entry><codeph>autoVersionChecking</codeph></entry>
              <entry>Automatic version checking.</entry>
              <entry><codeph>true</codeph> / <codeph>false</codeph>. Default setting is
                  <codeph>true</codeph>.</entry>
            </row>
            <row>
              <entry><codeph>reportProblem</codeph></entry>
              <entry>Allows you to report a problem encountered while using <ph keyref="product"
                />.</entry>
              <entry><codeph>true</codeph> / <codeph>false</codeph>. Default setting is
                  <codeph>true</codeph>.</entry>
            </row>
            <row>
              <entry><codeph>downloadResources</codeph></entry>
              <entry>Allows <ph keyref="product"/> to download resources (links to video
                demonstrations, webinars and upcoming events) from <ph
                  conkeyref="reusable_links/home"/> to populate the application welcome
                screen.</entry>
              <entry><codeph>true</codeph> / <codeph>false</codeph>. Default setting is
                  <codeph>true</codeph>.</entry>
            </row>
          </tbody>
        </tgroup>
      </table>
      <p>The <ph keyref="product"/> installation uses the install4j installer. A description of the
          <filepath>response.varfile</filepath> format can be found on the <xref
          href="http://resources.ej-technologies.com/install4j/help/doc/index.html#install4j.helptopics.installers.responseFile"
          format="html" scope="external">install4j site</xref>.</p>
    </section>
    <section id="command_line_parameters">
      <title>Command line parameters</title>
      <p>The <ph keyref="product"/> installer supports the following command line parameters:</p>
      <simpletable frame="all" id="simpletable_m4s_cjr_x4">
        <sthead>
          <stentry>Option</stentry>
          <stentry>Meaning</stentry>
        </sthead>
        <strow>
          <stentry><codeph>-q</codeph></stentry>
          <stentry>Run the installer in unattended mode. The installer will not prompt the user for
            input during the install. Default settings will be used for all options unless a
              <filepath>response.varfile</filepath> is specified using the <codeph>-varfile</codeph>
            option or individual settings are specified using <dl>
              <dlentry>
                <dt>- on Windows: </dt>
                <dd>
                  <p>
                    <codeblock><ph keyref="executableInstallWindows"/> -q </codeblock>
                  </p>
                </dd>
              </dlentry>
              <dlentry>
                <dt>- on Linux: </dt>
                <dd>
                  <p>
                    <codeblock><ph keyref="executableInstallLinux"/> -q </codeblock>
                  </p>
                </dd>
              </dlentry>
            </dl></stentry>
        </strow>
        <strow>
          <stentry><codeph>-overwrite</codeph></stentry>
          <stentry>In unattended mode, the installer does not overwrite files with the same name if
            a previous version of the <ph keyref="product"/> is installed in the same folder. The
              <parmname>-overwrite</parmname> parameter added after the <parmname>-q</parmname>
            parameter forces the overwriting of these files. <dl>
              <dlentry>
                <dt>- on Windows: </dt>
                <dd>
                  <p>
                    <codeblock><ph keyref="executableInstallWindows"/> -q -overwrite</codeblock>
                  </p>
                </dd>
              </dlentry>
              <dlentry>
                <dt>- on Linux: </dt>
                <dd>
                  <p>
                    <codeblock><ph keyref="executableInstallLinux"/> -q -overwrite</codeblock>
                  </p>
                </dd>
              </dlentry>
            </dl></stentry>
        </strow>
        <strow>
          <stentry><codeph>-console</codeph></stentry>
          <stentry>
            <p>To display a console for the unattended installation, add a
                <parmname>-console</parmname> parameter to the command line. <dl>
                <dlentry>
                  <dt>- on Windows: </dt>
                  <dd>
                    <p>
                      <codeblock>start /wait <ph keyref="executableInstallWindows"/> -q -console</codeblock>
                    </p>
                    <note>The use of <codeph>start /wait</codeph> on Windows is required to make the
                      installer run in the foreground. It you run it without <codeph>start
                        /wait</codeph>, it will run in the background.</note>
                  </dd>
                </dlentry>
                <dlentry>
                  <dt>- on Linux: </dt>
                  <dd>
                    <p>
                      <codeblock><ph keyref="executableInstallLinux"/> -q -console</codeblock>
                    </p>
                  </dd>
                </dlentry>
              </dl></p>
          </stentry>
        </strow>
        <strow>
          <stentry><codeph>-varfile</codeph></stentry>
          <stentry>Points to the location of a <filepath>response.varfile</filepath> to be used
            during an unattended installation. For example:<dl>
              <dlentry>
                <dt>- on Windows: </dt>
                <dd>
                  <p>
                    <codeblock><ph keyref="executableInstallWindows"/> -q -varfile response.varfile</codeblock>
                  </p>
                </dd>
              </dlentry>
              <dlentry>
                <dt>- on Linux: </dt>
                <dd>
                  <p>
                    <codeblock><ph keyref="executableInstallLinux"/> -q -varfile response.varfile</codeblock>
                  </p>
                </dd>
              </dlentry>
            </dl></stentry>
        </strow>
        <strow>
          <stentry><codeph>-V</codeph></stentry>
          <stentry>Is used to define a variable to be used by an unattended installation. For example:<dl>
              <dlentry>
                <dt>- on Windows: </dt>
                <dd>
                  <p>
                    <codeblock><keyword keyref="executableInstallWindows"/> -q -VusageDataCollector=false</codeblock>
                  </p>
                </dd>
              </dlentry>
              <dlentry>
                <dt>- on Linux: </dt>
                <dd>
                  <p>
                    <codeblock><keyword keyref="executableInstallLinux"/> -q -VusageDataCollector=false</codeblock>
                  </p>
                </dd>
              </dlentry>
            </dl></stentry>
        </strow>
      </simpletable>
      <p>The <ph keyref="product"/> installation uses the install4j installer. A full list of the
        command line parameters supported by the install4j installer can be found on the <xref
          href="http://resources.ej-technologies.com/install4j/help/doc/index.html#install4j.helptopics.installers.responseFile"
          format="html" scope="external">install4j site</xref>. </p>
    </section>
  </refbody>
</reference>


