|
| 1 | +=== |
| 2 | +pip |
| 3 | +=== |
| 4 | + |
| 5 | + |
| 6 | +Usage |
| 7 | +***** |
| 8 | + |
| 9 | +.. tab:: Unix/macOS |
| 10 | + |
| 11 | + .. code-block:: shell |
| 12 | +
|
| 13 | + python -m pip <command> [options] |
| 14 | +
|
| 15 | +.. tab:: Windows |
| 16 | + |
| 17 | + .. code-block:: shell |
| 18 | +
|
| 19 | + py -m pip <command> [options] |
| 20 | +
|
| 21 | +Description |
| 22 | +*********** |
| 23 | + |
| 24 | + |
| 25 | +.. _`Logging`: |
| 26 | + |
| 27 | + |
| 28 | +Logging |
| 29 | +======= |
| 30 | + |
| 31 | +Console logging |
| 32 | +~~~~~~~~~~~~~~~ |
| 33 | + |
| 34 | +pip offers :ref:`-v, --verbose <--verbose>` and :ref:`-q, --quiet <--quiet>` |
| 35 | +to control the console log level. By default, some messages (error and warnings) |
| 36 | +are colored in the terminal. If you want to suppress the colored output use |
| 37 | +:ref:`--no-color <--no-color>`. |
| 38 | + |
| 39 | + |
| 40 | +.. _`FileLogging`: |
| 41 | + |
| 42 | +File logging |
| 43 | +~~~~~~~~~~~~ |
| 44 | + |
| 45 | +pip offers the :ref:`--log <--log>` option for specifying a file where a maximum |
| 46 | +verbosity log will be kept. This option is empty by default. This log appends |
| 47 | +to previous logging. |
| 48 | + |
| 49 | +Like all pip options, ``--log`` can also be set as an environment variable, or |
| 50 | +placed into the pip config file. See the :doc:`../topics/configuration` section. |
| 51 | + |
| 52 | +.. _`exists-action`: |
| 53 | + |
| 54 | +--exists-action option |
| 55 | +====================== |
| 56 | + |
| 57 | +This option specifies default behavior when path already exists. |
| 58 | +Possible cases: downloading files or checking out repositories for installation, |
| 59 | +creating archives. If ``--exists-action`` is not defined, pip will prompt |
| 60 | +when decision is needed. |
| 61 | + |
| 62 | +*(s)witch* |
| 63 | + Only relevant to VCS checkout. Attempt to switch the checkout |
| 64 | + to the appropriate URL and/or revision. |
| 65 | +*(i)gnore* |
| 66 | + Abort current operation (e.g. don't copy file, don't create archive, |
| 67 | + don't modify a checkout). |
| 68 | +*(w)ipe* |
| 69 | + Delete the file or VCS checkout before trying to create, download, or checkout a new one. |
| 70 | +*(b)ackup* |
| 71 | + Rename the file or checkout to ``{name}{'.bak' * n}``, where n is some number |
| 72 | + of ``.bak`` extensions, such that the file didn't exist at some point. |
| 73 | + So the most recent backup will be the one with the largest number after ``.bak``. |
| 74 | +*(a)bort* |
| 75 | + Abort pip and return non-zero exit status. |
| 76 | + |
| 77 | +.. _`2-build-system-interface`: |
| 78 | +.. rubric:: Build System Interface |
| 79 | + |
| 80 | +This is now covered in :doc:`../reference/build-system/index`. |
| 81 | + |
| 82 | +.. _`General Options`: |
| 83 | + |
| 84 | +General Options |
| 85 | +*************** |
| 86 | + |
| 87 | +.. pip-general-options:: |
0 commit comments