setupwiz
| Chapter 6. Programs |

## Name

setupwiz — MiKTeX setup wizard

## Synopsis

`basic-miktex-2.9.`xxxx`.exe` [``options``]

`setup-2.9.`xxxx`.exe` [``options``]

## Description

MiKTeX Setup Wizard is used to install MiKTeX.

There a two instances of the installer:

Basic MiKTeX Installer (basic-miktex-2.9.`xxxx`.exe)

  Basic MiKTeX Installer is used to set up a basic MiKTeX system. All required resources are embedded in the installer, i.e., nothing else needs to be downloaded from the Internet.

MiKTeX Net Installer (setup-2.9.`xxxx`.exe)

  MiKTeX Net Installer is used to set up a complete MiKTeX system. In a first step, all required resources will be downloaded from the Internet. In a second step, a complete MiKTeX system is installed.

Both installers read command-line options from the file `setupwiz.opt`, if it exists.

## Options

`--allow-unattended-reboot`

  Restart the system, if necessary.

`--common-config=`dir``

  Set the location of the common configuration directory. This option requires administrator privileges.

`--common-data=`dir``

  Set the location of the common data directory. This option requires administrator privileges.

`--common-install=`dir``

  Set the common installation directory. This option requires administrator privileges.

`--common-roots=`dirs``

  Register additional directories for all users. `dirs` must be a semicolon-separated list of fully qualified path names. This option requires administrator privileges.

  Environment variables (<VARNAME>) can be used.

`--download-only`

  Download all required packages, but do not otherwise install MiKTeX.

`--dry-run`

  Simulate. No files shall be downloaded and/or installed.

`--install-from-local-repository`

  Install MiKTeX from a directory (to be specified with the `--local-package-repository` option).

`--local-package-repository=`dir``

  Download into (Install from) the specified directory.

`--no-additional-roots`

  Do not integrate additional TEXMF root directories into the MiKTeX setup.

`--no-registry`

  Do not store path information in the Windows Registry but write the startup configuration file (`miktexstartup.ini`).

`--package-set=`set``

  Download/Install the specified package set. This must be one of `basic`, `complete`.

`--portable`

  Setup MiKTeX Portable.

`--private`

  Install MiKTeX for the current user only.

`--program-folder=`name``

  Add shortcuts to the specified program folder.

`--remote-package-repository=`url``

  Download from the specified the URL.

`--shared`

  Install MiKTeX for everyone using this computer. This option requires administrator privileges.

`--unattended`

  Run in unattended mode.

`--user-config=`dir``

  Set the location of the configuration directory for the current user.

  Environment variables (<VARNAME>) can be used. See the example below.

`--user-data=`dir``

  Set the location of the data directory for the current user.

  Environment variables (<VARNAME>) can be used. See the example below.

`--user-install=`dir``

  Set the user installation directory.

  Environment variables (<VARNAME>) can be used. See the example below.

`--user-roots=`dirs``

  Register additional directories for the current user. `dirs` must be a semicolon-separated list of fully qualified path names.

  Environment variables (<VARNAME>) can be used.

## Examples

In this example, MiKTeX is installed from a network share (`\\server\miktex\repository`). User directories are specified by using environment variables (<VARNAME>) which are expanded at run-time.

    > setupwiz --install-from-local-repository ^
      --local-package-repository==\\server\miktex\repository ^
      --package-set=complete ^
      --shared ^
      --user-config=^<APPDATA^>\MiKTeX\2.9 ^
      --user-data=^<LOCALAPPDATA^>\MiKTeX\2.9 ^
      --user-install=^<APPDATA^>\MiKTeX\2.9

miktex-pdftex |  | tex