Skip to content

Commit

Permalink
Updated command reference.
Browse files Browse the repository at this point in the history
  • Loading branch information
Maggie-M committed Jul 10, 2013
1 parent a1a5bef commit 3520b8c
Show file tree
Hide file tree
Showing 11 changed files with 42 additions and 36 deletions.
1 change: 0 additions & 1 deletion docs/scrape_help.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
'pip',
'index',
'share',
'launch',
'build',
'clone'
]
Expand Down
20 changes: 7 additions & 13 deletions docs/source/commands/build.txt
Original file line number Diff line number Diff line change
@@ -1,17 +1,11 @@
Build a package from source. (EXPERIMENTAL)
Build a package from recipe. (ADVANCED) For examples of recipes, see: https://github.com/ContinuumIO/conda-recipes

**usage**: ``conda build [-h] [--git | --tar | --zip | --svn | --dir] [-n NAME | -p PREFIX] URL``
**usage**: ``conda build [-h] [-s] [-t] PATH [PATH ...]``

*URL*
name of source (url, tarball, path, etc...)
*PATH*
path to recipe directory

optional arguments:
-h, --help show this help message and exit
--git build from git url
--tar build from local source tarball
--zip build from local source zipfile
--svn build from svn
--dir build from local source directory
-n NAME, --name NAME name of environment (directory in ROOT_DIR/envs)
-p PREFIX, --prefix PREFIX
full path to environment prefix (default: ROOT_DIR)
-h, --help show this help message and exit
-s, --source only obtain the source (but don't build)
-t, --test test package (assumes package is already build)
2 changes: 1 addition & 1 deletion docs/source/commands/clone.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Clone a "share package" (created using the share command)
**usage**: ``conda clone [-h] [-n NAME | -p PREFIX] PATH``

*PATH*
path to "share package"
path to "share package"

optional arguments:
-h, --help show this help message and exit
Expand Down
7 changes: 5 additions & 2 deletions docs/source/commands/create.txt
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
Create a new conda environment from a list of specified packages. To use the created environment, invoke the binaries in that environment's bin directory or adjust your PATH to look in that directory first. This command requires either the -n NAME or -p PREFIX option.

**usage**: ``conda create [-h] [--yes] [--dry-run] [-f FILE] [-n NAME | -p PREFIX] [-q] [package_spec [package_spec ...]]``
**usage**: ``conda create [-h] [--yes] [--dry-run] [-f FILE] [-c CHANNEL] [--override-channels] [-n NAME | -p PREFIX] [-q] [package_spec [package_spec ...]]``

*package_spec*
specification of package to install into new environment
specification of package to install into new environment

optional arguments:
-h, --help show this help message and exit
--yes do not ask for confirmation
--dry-run only display what would have been done
-f FILE, --file FILE filename to read package specs from
-c CHANNEL, --channel CHANNEL
additional channel to search for packages. These are searched in the order they are given, and then the defaults or channels from .condarc (unless --override-channels is given). You can use 'defaults' to get the default packages for conda, and 'system' to get the system packages, which also takes .condarc into account.
--override-channels Do not search default or .condarc channels. Requires --channel.
-n NAME, --name NAME name of environment (directory in ROOT_DIR/envs)
-p PREFIX, --prefix PREFIX
full path to environment prefix (default: ROOT_DIR)
Expand Down
2 changes: 1 addition & 1 deletion docs/source/commands/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Updates repodata.json in channel directories. (ADVANCED)
**usage**: ``conda index [-h] [-f] [-q] [DIRECTORIES [DIRECTORIES ...]]``

*DIRECTORIES*
optional arguments:
optional arguments:

optional arguments:
-h, --help show this help message and exit
Expand Down
12 changes: 6 additions & 6 deletions docs/source/commands/install.txt
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
Install a list of packages into a specified conda environment.
The arguments may be packages specifications (e.g. bitarray=0.8),

**usage**: ``conda install [-h] [--yes] [--dry-run] [-f] [--file FILE] [--no-deps] [-n NAME | -p PREFIX] [-q] [package_spec [package_spec ...]]``
**usage**: ``conda install [-h] [--yes] [--dry-run] [-f] [--file FILE] [--no-deps] [-c CHANNEL] [--override-channels] [-n NAME | -p PREFIX] [-q] [package_spec [package_spec ...]]``

Install a list of packages into a specified conda environment.
The arguments may be packages specifications (e.g. bitarray=0.8),
or explicit conda packages filesnames (e.g. lxml-3.2.0-py27_0.tar.bz2) which
must exist on the local filesystem. The two types of arguments cannot be
mixed and the latter implied the --force and --no-deps options.
The arguments may be packages specifications (e.g. bitarray=0.8)

*package_spec*
package versions to install into conda environment
package versions to install into conda environment

optional arguments:
-h, --help show this help message and exit
Expand All @@ -19,6 +16,9 @@ optional arguments:
-f, --force force install (even when package already installed), implies --no-deps
--file FILE read package versions from FILE
--no-deps do not install dependencies
-c CHANNEL, --channel CHANNEL
additional channel to search for packages. These are searched in the order they are given, and then the defaults or channels from .condarc (unless --override-channels is given). You can use 'defaults' to get the default packages for conda, and 'system' to get the system packages, which also takes .condarc into account.
--override-channels Do not search default or .condarc channels. Requires --channel.
-n NAME, --name NAME name of environment (directory in ROOT_DIR/envs)
-p PREFIX, --prefix PREFIX
full path to environment prefix (default: ROOT_DIR)
Expand Down
2 changes: 1 addition & 1 deletion docs/source/commands/list.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ List linked packages in a conda environment.
**usage**: ``conda list [-h] [-n NAME | -p PREFIX] [-c] [regex]``

*regex*
list only packages matching this regular expression
list only packages matching this regular expression

optional arguments:
-h, --help show this help message and exit
Expand Down
8 changes: 5 additions & 3 deletions docs/source/commands/pip.txt
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
Call pip and create a conda package in an environment. (ADVANCED)
Call pip and create a conda package in an environment. (DEPRECATED)

**usage**: ``conda pip [-h] [-n NAME | -p PREFIX] name [name ...]``
**usage**: ``conda pip [-h] [-n NAME | -p PREFIX] [--yes] [--dry-run] name [name ...]``

*name*
name of package to pip install
name of package to pip install

optional arguments:
-h, --help show this help message and exit
-n NAME, --name NAME name of environment (directory in ROOT_DIR/envs)
-p PREFIX, --prefix PREFIX
full path to environment prefix (default: ROOT_DIR)
--yes do not ask for confirmation
--dry-run only display what would have been done
9 changes: 6 additions & 3 deletions docs/source/commands/remove.txt
Original file line number Diff line number Diff line change
@@ -1,20 +1,23 @@
Remove a list of packages from a specified conda environment.
Normally, only the specified package is removed, and not the packages

**usage**: ``conda remove [-h] [--yes] [--dry-run] [--all] [--features] [-n NAME | -p PREFIX] [-q] [package_name [package_name ...]]
**usage**: ``conda remove [-h] [--yes] [--dry-run] [--all] [--features] [-c CHANNEL] [--override-channels] [-n NAME | -p PREFIX] [-q] [package_name [package_name ...]]``

Remove a list of packages from a specified conda environment.
Normally, only the specified package is removed, and not the packages``
Normally, only the specified package is removed, and not the packages

*package_name*
package names to remove from environment
package names to remove from environment

optional arguments:
-h, --help show this help message and exit
--yes do not ask for confirmation
--dry-run only display what would have been done
--all remove all packages, i.e. the entire environment
--features remove features (instead of packages)
-c CHANNEL, --channel CHANNEL
additional channel to search for packages. These are searched in the order they are given, and then the defaults or channels from .condarc (unless --override-channels is given). You can use 'defaults' to get the default packages for conda, and 'system' to get the system packages, which also takes .condarc into account.
--override-channels Do not search default or .condarc channels. Requires --channel.
-n NAME, --name NAME name of environment (directory in ROOT_DIR/envs)
-p PREFIX, --prefix PREFIX
full path to environment prefix (default: ROOT_DIR)
Expand Down
6 changes: 4 additions & 2 deletions docs/source/commands/search.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Search for packages and display their information.

**usage**: ``conda search [-h] [-n NAME | -p PREFIX] [-c] [-v] [regex]``
**usage**: ``conda search [-h] [-n NAME | -p PREFIX] [-c] [-v] [--channel CHANNEL] [--override-channels] [regex]``

*regex*
package specification or regular expression to search for (default: display all packages)
package specification or regular expression to search for (default: display all packages)

optional arguments:
-h, --help show this help message and exit
Expand All @@ -12,6 +12,8 @@ optional arguments:
full path to environment prefix (default: ROOT_DIR)
-c, --canonical output canonical names of packages only
-v, --verbose Show available packages as blocks of data
--channel CHANNEL additional channel to search for packages. These are searched in the order they are given, and then the defaults or channels from .condarc (unless --override-channels is given). You can use 'defaults' to get the default packages for conda, and 'system' to get the system packages, which also takes .condarc into account.
--override-channels Do not search default or .condarc channels. Requires --channel.

examples:
conda search -p ~/anaconda/envs/myenv/ scipy
9 changes: 6 additions & 3 deletions docs/source/commands/update.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Update conda packages.

**usage**: ``conda update [-h] [--yes] [--dry-run] [-n NAME | -p PREFIX] [-q] [package_names [package_names ...]]``
**usage**: ``conda update [-h] [--yes] [--dry-run] [-n NAME | -p PREFIX] [-q] [-c CHANNEL] [--override-channels] package_name [package_name ...]``

*package_names*
names of packages to update (default: anaconda)
*package_name*
names of packages to update

optional arguments:
-h, --help show this help message and exit
Expand All @@ -13,6 +13,9 @@ optional arguments:
-p PREFIX, --prefix PREFIX
full path to environment prefix (default: ROOT_DIR)
-q, --quiet do not display progress bar
-c CHANNEL, --channel CHANNEL
additional channel to search for packages. These are searched in the order they are given, and then the defaults or channels from .condarc (unless --override-channels is given). You can use 'defaults' to get the default packages for conda, and 'system' to get the system packages, which also takes .condarc into account.
--override-channels Do not search default or .condarc channels. Requires --channel.

examples:
conda update -p ~/anaconda/envs/myenv scipy

0 comments on commit 3520b8c

Please sign in to comment.