source: xincludes/pip3-cmd-explain.xml@ fa411f6e

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

  <sect3 role="commands">
    <title>Command Explanations</title>

    <para>
      <parameter>-w dist</parameter>: builds the appropriate
      "wheel" for this module in the directory
      <filename class="directory">dist</filename>.
    </para>

    <para>
      <parameter>--no-build-isolation</parameter>: tells pip3 to run the
      build in the system environment instead of creating a temporary
      build environment.
    </para>

    <para>
      <parameter>--no-deps</parameter>: prevents pip3 from building wheels for
      the project's dependencies.
    </para>

    <para>
      <parameter>--no-index</parameter>: ignores the package index
      (only looking at --find-links URLs instead).
    </para>

    <para>
      <parameter>--find-links dist</parameter>: looks for links to archives
      such as wheel (.whl) files in the directory
      <filename class="directory">dist</filename>.
    </para>

    <para>
      <parameter>--no-cache-dir</parameter>: diables the cache to prevent
      a warning when installing as the &root; user.
    </para>

    <para>
      <option>--upgrade</option>: Upgrade the package to the newest
       available version.  This option is used with the install command
       if a version of the package is already installed.
    </para>

    <para>
      <option>--force-reinstall</option>: Reinstall the package even if
      it is up-to-date. This option is used with the install command
      if reinstalling the package or reverting to an earlier version
      of the package.
    </para>

    <para>
      <option>--no-deps</option>: Do not install package dependencies.
      This option may be needed with the --upgrade or --force-reinstall
      options.
    </para>

  </sect3>