From addec6339f9aa5900007e66416bd5c3d2a082faf Mon Sep 17 00:00:00 2001 From: Zearin Date: Thu, 20 Mar 2014 09:33:32 -0400 Subject: [PATCH] COMMANDS.md: Match order of commands from `pyenv --help` MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Also added `help` output for `pyenv {,un}install`, since those sections didn’t exist before. They should probably be revised at some point. In the meantime, I think something is better than nothing (in this case). --- COMMANDS.md | 57 ++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 39 insertions(+), 18 deletions(-) diff --git a/COMMANDS.md b/COMMANDS.md index f74855ab..595aa881 100644 --- a/COMMANDS.md +++ b/COMMANDS.md @@ -11,9 +11,9 @@ The most common subcommands are: * [`pyenv shell`](#pyenv-shell) * [`pyenv install`](#pyenv-install) * [`pyenv uninstall`](#pyenv-uninstall) -* [`pyenv versions`](#pyenv-versions) -* [`pyenv version`](#pyenv-version) * [`pyenv rehash`](#pyenv-rehash) +* [`pyenv version`](#pyenv-version) +* [`pyenv versions`](#pyenv-versions) * [`pyenv which`](#pyenv-which) * [`pyenv whence`](#pyenv-whence) @@ -187,24 +187,40 @@ or, if you prefer 3.3.3 over 2.7.6, Install a Python version (using `python-build`). + Usage: pyenv install [-f] [-kvp] + pyenv install [-f] [-kvp] + pyenv install -l|--list + + -l/--list List all available versions + -f/--force Install even if the version appears to be installed already + + python-build options: + + -k/--keep Keep source tree in $PYENV_BUILD_ROOT after installation + (defaults to $PYENV_ROOT/sources) + -v/--verbose Verbose mode: print compilation status to stdout + -p/--patch Apply a patch from stdin before building + -g/--debug Build a debug version + ## `pyenv uninstall` -Uninstall a specific Python version +Uninstall a specific Python version. + Usage: pyenv uninstall [-f|--force] -## `pyenv versions` + -f Attempt to remove the specified version without prompting + for confirmation. If the version does not exist, do not + display an error message. -Lists all Python versions known to pyenv, and shows an asterisk next to -the currently active version. - $ pyenv versions - 2.5.6 - 2.6.8 - * 2.7.6 (set by /home/yyuu/.pyenv/version) - 3.3.3 - jython-2.5.3 - pypy-2.2.1 +## `pyenv rehash` + +Installs shims for all Python binaries known to pyenv (i.e., +`~/.pyenv/versions/*/bin/*`). Run this command after you install a new +version of Python, or install a package that provides binaries. + + $ pyenv rehash ## `pyenv version` @@ -216,13 +232,18 @@ how it was set. 2.7.6 (set by /home/yyuu/.pyenv/version) -## `pyenv rehash` +## `pyenv versions` -Installs shims for all Python binaries known to pyenv (i.e., -`~/.pyenv/versions/*/bin/*`). Run this command after you install a new -version of Python, or install a package that provides binaries. +Lists all Python versions known to pyenv, and shows an asterisk next to +the currently active version. - $ pyenv rehash + $ pyenv versions + 2.5.6 + 2.6.8 + * 2.7.6 (set by /home/yyuu/.pyenv/version) + 3.3.3 + jython-2.5.3 + pypy-2.2.1 ## `pyenv which`