Mercurial > hg > octave-lyh

comparison scripts/pkg/pkg.m @ 6070:df821c22355c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[project @ 2006-10-23 19:01:04 by jwe]
author jwe
date Mon, 23 Oct 2006 19:01:04 +0000
parents 060985c633d1
children 47f0cab13a02
comparison
equal deleted inserted replaced
6069:67b1a61a85ce 6070:df821c22355c
20 ## This command interacts with the package manager. Different actions will 20 ## This command interacts with the package manager. Different actions will
21 ## be taking depending on the value of @var{command}. 21 ## be taking depending on the value of @var{command}.
22 ## 22 ##
23 ## @table @samp 23 ## @table @samp
24 ## @item install 24 ## @item install
25 ## Install named packages. For example, 25 ## Install named packages. For example,
26 ## @example 26 ## @example
27 ## pkg install image-1.0.0.tar.gz 27 ## pkg install image-1.0.0.tar.gz
28 ## @end example 28 ## @end example
29 ## @noindent 29 ## @noindent
30 ## installs the package found in the file @code{image-1.0.0.tar.gz}. 30 ## installs the package found in the file @code{image-1.0.0.tar.gz}.
31 ## 31 ##
32 ## If @var{option} is @code{-nodeps} the package manager will disable the 32 ## If @var{option} is @code{-nodeps} the package manager will disable the
33 ## dependency checking. That way it is possible to install a package even 33 ## dependency checking. That way it is possible to install a package even
34 ## if it depends on another package that's not installed on the system. 34 ## if it depends on another package that's not installed on the system.
35 ## @strong{Use this option with care.} 35 ## @strong{Use this option with care.}
36 ## @item uninstall 36 ## @item uninstall
37 ## Uninstall named packages. For example, 37 ## Uninstall named packages. For example,
38 ## @example 38 ## @example
39 ## pkg uninstall image 39 ## pkg uninstall image
40 ## @end example 40 ## @end example
41 ## @noindent 41 ## @noindent
42 ## removes the @code{image} package from the system. If another installed 42 ## removes the @code{image} package from the system. If another installed
43 ## package depends on the @code{image} package an error will be issued. 43 ## package depends on the @code{image} package an error will be issued.
44 ## The package can be uninstalled anyway by using the @code{-nodeps} option. 44 ## The package can be uninstalled anyway by using the @code{-nodeps} option.
45 ## @item load 45 ## @item load
46 ## Add named packages to the path. After loading a package it is 46 ## Add named packages to the path. After loading a package it is
47 ## possible to use the functions provided by the package. For example, 47 ## possible to use the functions provided by the package. For example,
48 ## @example 48 ## @example
49 ## pkg load image 49 ## pkg load image
50 ## @end example 50 ## @end example
51 ## @noindent 51 ## @noindent
52 ## adds the @code{image} package to the path. It is possible to load all 52 ## adds the @code{image} package to the path. It is possible to load all
53 ## installed packages at once with the command 53 ## installed packages at once with the command
54 ## @example 54 ## @example
55 ## pkg load all 55 ## pkg load all
56 ## @end example 56 ## @end example
57 ## @item list 57 ## @item list
58 ## Show a list of the currently installed packages. By requesting one or two 58 ## Show a list of the currently installed packages. By requesting one or two
59 ## output argument it is possible to get a list of the currently installed 59 ## output argument it is possible to get a list of the currently installed
60 ## packages. For example, 60 ## packages. For example,
61 ## @example 61 ## @example
62 ## installed_packages = pkg list; 62 ## installed_packages = pkg list;
63 ## @end example 63 ## @end example
64 ## @noindent 64 ## @noindent
65 ## returns a cell array containing a structure for each installed package. 65 ## returns a cell array containing a structure for each installed package.
66 ## The command 66 ## The command
67 ## @example 67 ## @example
68 ## [@var{user_packages}, @var{system_packages}] = pkg list 68 ## [@var{user_packages}, @var{system_packages}] = pkg list
69 ## @end example 69 ## @end example
70 ## @noindent 70 ## @noindent
71 ## splits the list of installed packages into those who are installed by 71 ## splits the list of installed packages into those who are installed by
72 ## the current user, and those installed by the system administrator. 72 ## the current user, and those installed by the system administrator.
73 ## @item prefix 73 ## @item prefix
74 ## Set the installation prefix directory. For example, 74 ## Set the installation prefix directory. For example,
75 ## @example 75 ## @example
76 ## pkg prefix ~/my_octave_packages 76 ## pkg prefix ~/my_octave_packages
77 ## @end example 77 ## @end example
78 ## @noindent 78 ## @noindent
79 ## sets the installation prefix to @code{~/my_octave_packages}. 79 ## sets the installation prefix to @code{~/my_octave_packages}.
80 ## Packages will be installed in this directory. 80 ## Packages will be installed in this directory.
81 ## 81 ##
82 ## It is possible to get the current installation prefix by requesting an 82 ## It is possible to get the current installation prefix by requesting an
83 ## output argument. For example, 83 ## output argument. For example,
84 ## @example 84 ## @example
85 ## p = pkg prefix 85 ## p = pkg prefix
86 ## @end example 86 ## @end example
87 ## @end table 87 ## @end table
88 ## @end deftypefn 88 ## @end deftypefn
89 89
90 ## PKG_ADD: mark_as_command pkg 90 ## PKG_ADD: mark_as_command pkg
91 91