<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
                          "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % entities.ent SYSTEM "entities.ent">
%entities.ent;
]>

<refentry id="miktex">

<?dbhh topicname="MIKTEXHELP_MIKTEX" topicid="0"?>

<refmeta>
<refentrytitle>miktex</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="source">&PACKAGE_NAME;</refmiscinfo>
<refmiscinfo class="version">&miktexrev;</refmiscinfo>
<refmiscinfo class="manual">User Commands</refmiscinfo>
</refmeta>

<refnamediv>
<refname>miktex</refname>
<refpurpose>&OneMiKTeXUtility;</refpurpose>
</refnamediv>

<refsynopsisdiv>

<cmdsynopsis>
&miktex;
<arg choice="opt" rep="repeat"><replaceable>common-option</replaceable></arg>
<arg choice="plain"><replaceable>topic</replaceable></arg>
<arg choice="plain"><replaceable>command</replaceable></arg>
<arg choice="opt" rep="repeat"><replaceable>command-option-or-parameter</replaceable></arg>
</cmdsynopsis>

</refsynopsisdiv>

<refsect1>

<title>Description</title>

<para>&miktex; is the utility to configure and maintain a &MiKTeX; installation.</para>

</refsect1>

<refsect1>
<title>User mode vs. administrator mode</title>

<para>This utility can be run in two modes:</para>

<variablelist>
<varlistentry>
<term>User mode (default)</term>
<listitem>
<para>&MiKTeX; operates on user-scoped configuration and data files.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Administrator mode</term>
<listitem>
<para>Only system-wide &MiKTeX; configuration and data files are
modified, assuming that the &MiKTeX; setup is shared by all users.
The utility must be run with administrator privileges.</para>
</listitem>
</varlistentry>
</variablelist>

<para>By default, the utility runs in user mode.  You can turn on
administrator mode with the <option>--admin</option> option.  For
example, if you want to update the system-wide file name database, you
invoke the utility as follows:</para>

<screen><prompt>&prompt;</prompt><userinput>miktex --admin fndb refresh</userinput></screen>

</refsect1>

<refsect1>

<title>Common options</title>

<variablelist>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../Options/admin.xml" />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../Options/disableinstaller.xml" />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../Options/enableinstaller.xml" />
<varlistentry>
<term><option>--quiet</option></term>
<listitem>
<indexterm>
<primary>--quiet</primary>
</indexterm>
<para>Suppress screen output.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--verbose</option></term>
<listitem>
<indexterm>
<primary>--verbose</primary>
</indexterm>
<para>Increase the verbosity level.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--version</option></term>
<listitem>
<indexterm>
<primary>--version</primary>
</indexterm>
<para>Print the version number and exit.</para></listitem>
</varlistentry>
</variablelist>

</refsect1>

<refsect1>

<title>Topics</title>

<variablelist>

<varlistentry>
<term><citerefentry><refentrytitle>miktex-filesystem</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>Commands for watching the file system.</para></listitem>
</varlistentry>

<varlistentry>
<term><citerefentry><refentrytitle>miktex-filetypes</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>Commands for managing Windows file types.</para></listitem>
</varlistentry>

<varlistentry>
<term><citerefentry><refentrytitle>miktex-fndb</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>Commands for managing the &MiKTeX; file name database.</para></listitem>
</varlistentry>

<varlistentry>
<term><citerefentry><refentrytitle>miktex-fontmaps</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>Commands for managing &PDF;/&PostScript; font maps.</para></listitem>
</varlistentry>

<varlistentry>
<term><citerefentry><refentrytitle>miktex-formats</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>Commands for managing &TeX; formats and &METAFONT; bases.</para></listitem>
</varlistentry>

<varlistentry>
<term><citerefentry><refentrytitle>miktex-languages</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>Commands for managing &LaTeX; language definitions.</para></listitem>
</varlistentry>

<varlistentry>
<term><citerefentry><refentrytitle>miktex-links</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>Commands for managing links from scripts and formats to executables.</para></listitem>
</varlistentry>

<varlistentry>
<term><citerefentry><refentrytitle>miktex-packages</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>Commands for managing &MiKTeX; packages.</para></listitem>
</varlistentry>

<varlistentry>
<term><citerefentry><refentrytitle>miktex-repositories</refentrytitle><manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>Commands for managing &MiKTeX; package repositories.</para></listitem>
</varlistentry>

</variablelist>

</refsect1>

<refsect1>

<title>See also</title>

<simplelist type="inline">
<member><citerefentry><refentrytitle>miktex.ini</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
</simplelist>

</refsect1>

</refentry>
