<?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-packages">

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

<refmeta>
<refentrytitle>miktex-packages</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-packages</refname>
<refpurpose>manage &MiKTeX; packages</refpurpose>
</refnamediv>

<refsynopsisdiv>

<cmdsynopsis>
&miktex;
<arg choice="opt" rep="repeat"><replaceable>common-option</replaceable></arg>
<arg choice="plain">packages</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>Commands for managing &MiKTeX; packages.</para>

</refsect1>

<refsect1>

<title>Commands</title>

<variablelist>
<varlistentry>
<term><command>check-update</command> <optional><option>--repository <replaceable>url-or-directory</replaceable></option></optional></term>
<listitem>
<para>Check for &MiKTeX; package updates. The exit code will be 100, when package updates are available.</para></listitem>
</varlistentry>
<varlistentry>
<term><command>check-upgrade</command> <optional><option>--repository <replaceable>url-or-directory</replaceable></option></optional> <replaceable>package-level</replaceable></term>
<listitem>
<para>Check for a &MiKTeX; upgrade. The exit code will be 100, when an upgrade is available.</para></listitem>
</varlistentry>
<varlistentry>
<term><command>info</command> <optional><option>--template <replaceable>template</replaceable></option></optional> <replaceable>package-id</replaceable></term>
<listitem>
<para>Show information about &MiKTeX; packages.</para>
<para><replaceable>template</replaceable> controls the output of each record.
It can contain the following placeholders:</para>
<para><simplelist type='inline'>
<member><code>{archiveFileSize}</code></member>
<member><code>{copyrightOwner}</code></member>
<member><code>{copyrightYear}</code></member>
<member><code>{creator}</code></member>
<member><code>{ctanPath}</code></member>
<member><code>{description}</code></member>
<member><code>{digest}</code></member>
<member><code>{displayName}</code></member>
<member><code>{docFiles}</code></member>
<member><code>{id}</code></member>
<member><code>{isContained}</code></member>
<member><code>{isContainer}</code></member>
<member><code>{isInstalled}</code></member>
<member><code>{isInstalledCommon}</code></member>
<member><code>{isInstalledUser}</code></member>
<member><code>{isObsolete}</code></member>
<member><code>{isPureContainer}</code></member>
<member><code>{isRemovable}</code></member>
<member><code>{licenseType}</code></member>
<member><code>{minTargetSystemVersion}</code></member>
<member><code>{numFiles}</code></member>
<member><code>{refCount}</code></member>
<member><code>{releaseState}</code></member>
<member><code>{requiredBy}</code></member>
<member><code>{requiredPackages}</code></member>
<member><code>{runFiles}</code></member>
<member><code>{size}</code></member>
<member><code>{sizeDocFiles}</code></member>
<member><code>{sizeRunFiles}</code></member>
<member><code>{sizeSourceFiles}</code></member>
<member><code>{sourceFiles}</code></member>
<member><code>{targetSystem}</code></member>
<member><code>{timeInstalled}</code></member>
<member><code>{timeInstalledCommon}</code></member>
<member><code>{timeInstalledUser}</code></member>
<member><code>{timePackaged}</code></member>
<member><code>{title}</code></member>
<member><code>{version}</code></member>
<member><code>{versionDate}</code></member>
</simplelist></para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>install</command> <optional><option>--package-id-file <replaceable>file</replaceable></option></optional> <optional><option>--repository <replaceable>url-or-directory</replaceable></option></optional> <replaceable>package-id...</replaceable></term>
<listitem>
<para>Install &MiKTeX; packages.</para></listitem>
</varlistentry>
<varlistentry>
<term><command>list</command> <optional><option>--template <replaceable>template</replaceable></option></optional></term>
<listitem>
<para>List &MiKTeX; packages.</para>
<para><replaceable>template</replaceable> controls the output of each record.
See the <command>info</command> command, for a list of possible placeholders.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>remove</command> <optional><option>--package-id-file <replaceable>file</replaceable></option></optional> <replaceable>package-id...</replaceable></term>
<listitem>
<para>Remove installed &MiKTeX; packages.</para></listitem>
</varlistentry>
<varlistentry>
<term><command>update</command> <optional><option>--package-id-file <replaceable>file</replaceable></option></optional> <optional><option>--repository <replaceable>url-or-directory</replaceable></option></optional> <optional><replaceable>package-id...</replaceable></optional></term>
<listitem>
<para>Update &MiKTeX; packages.</para></listitem>
</varlistentry>
<varlistentry>
<term><command>update-package-database</command> <optional><option>--repository <replaceable>url-or-directory</replaceable></option></optional></term>
<listitem>
<para>Update the &MiKTeX; package database.</para></listitem>
</varlistentry>
<varlistentry>
<term><command>upgrade</command> <optional><option>--repository <replaceable>url-or-directory</replaceable></option></optional> <replaceable>package-level</replaceable></term>
<listitem>
<para>Upgrade &MiKTeX; to the specified level.</para></listitem>
</varlistentry>
<varlistentry>
<term><command>verify</command> <optional><option>--package-id-file=<replaceable>file</replaceable></option></optional> <optional><replaceable>package-id...</replaceable></optional></term>
<listitem>
<para>Verify the integrity of installed &MiKTeX; packages.</para></listitem>
</varlistentry>
</variablelist>

</refsect1>

<refsect1>

<title>See also</title>

<simplelist type="inline">
<member><citerefentry><refentrytitle>miktex</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
</simplelist>

</refsect1>

</refentry>
