Mercurial > octave

annotate scripts/pkg/pkg.m @ 28715:0fcbb0faf7de

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: merge stable to default.
author Rik <rik@octave.org>
date Thu, 10 Sep 2020 14:59:10 -0700
parents b263a8bf5ec3 d8dcb36bb904
children cd2178d0e43b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
1 ########################################################################
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
2 ##
27919
1891570abac8 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 27918
diff changeset
3 ## Copyright (C) 2005-2020 The Octave Project Developers
27918
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 27794
diff changeset
4 ##
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
5 ## See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
6 ## distribution or <https://octave.org/copyright/>.
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11547
diff changeset
7 ##
6440
98ee80702bca [project @ 2007-03-23 15:13:19 by jwe]
jwe
parents: 6378
diff changeset
8 ## This file is part of Octave.
98ee80702bca [project @ 2007-03-23 15:13:19 by jwe]
jwe
parents: 6378
diff changeset
9 ##
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
10 ## Octave is free software: you can redistribute it and/or modify it
6440
98ee80702bca [project @ 2007-03-23 15:13:19 by jwe]
jwe
parents: 6378
diff changeset
11 ## under the terms of the GNU General Public License as published by
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
12 ## the Free Software Foundation, either version 3 of the License, or
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22529
diff changeset
13 ## (at your option) any later version.
6440
98ee80702bca [project @ 2007-03-23 15:13:19 by jwe]
jwe
parents: 6378
diff changeset
14 ##
98ee80702bca [project @ 2007-03-23 15:13:19 by jwe]
jwe
parents: 6378
diff changeset
15 ## Octave is distributed in the hope that it will be useful, but
98ee80702bca [project @ 2007-03-23 15:13:19 by jwe]
jwe
parents: 6378
diff changeset
16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22529
diff changeset
17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22529
diff changeset
18 ## GNU General Public License for more details.
6440
98ee80702bca [project @ 2007-03-23 15:13:19 by jwe]
jwe
parents: 6378
diff changeset
19 ##
5801
70013c9f3ccc [project @ 2006-05-10 16:53:03 by jwe]
jwe
parents:
diff changeset
20 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6950
diff changeset
21 ## along with Octave; see the file COPYING. If not, see
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
22 ## <https://www.gnu.org/licenses/>.
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
23 ##
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
24 ########################################################################
5801
70013c9f3ccc [project @ 2006-05-10 16:53:03 by jwe]
jwe
parents:
diff changeset
25
70013c9f3ccc [project @ 2006-05-10 16:53:03 by jwe]
jwe
parents:
diff changeset
26 ## -*- texinfo -*-
20852
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20727
diff changeset
27 ## @deftypefn {} {} pkg @var{command} @var{pkg_name}
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20727
diff changeset
28 ## @deftypefnx {} {} pkg @var{command} @var{option} @var{pkg_name}
22529
640c1b476860 pkg.m: more clearly document package querying options (bug #49156)
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 22323
diff changeset
29 ## @deftypefnx {} {[@var{out1}, @dots{}] =} pkg (@var{command}, @dots{} )
640c1b476860 pkg.m: more clearly document package querying options (bug #49156)
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 22323
diff changeset
30 ## Manage or query packages (groups of add-on functions) for Octave.
19187
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
31 ##
28713
28d2511f2af2 maint: grammarcheck documentation ahead of 6.1 release.
Rik <rik@octave.org>
parents: 28666
diff changeset
32 ## Packages can be installed globally (i.e., for all users of the system) or
28d2511f2af2 maint: grammarcheck documentation ahead of 6.1 release.
Rik <rik@octave.org>
parents: 28666
diff changeset
33 ## locally (i.e., for the current user only).
28343
8b71a6cec9bf pkg.m: Add introduction to packages to doc string (bug #58225).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 28278
diff changeset
34 ##
28713
28d2511f2af2 maint: grammarcheck documentation ahead of 6.1 release.
Rik <rik@octave.org>
parents: 28666
diff changeset
35 ## Global packages are installed by default in a system-wide location. This is
28d2511f2af2 maint: grammarcheck documentation ahead of 6.1 release.
Rik <rik@octave.org>
parents: 28666
diff changeset
36 ## usually a subdirectory of the folder where Octave itself is installed.
28d2511f2af2 maint: grammarcheck documentation ahead of 6.1 release.
Rik <rik@octave.org>
parents: 28666
diff changeset
37 ## Therefore, Octave needs write access to this folder to install global
28d2511f2af2 maint: grammarcheck documentation ahead of 6.1 release.
Rik <rik@octave.org>
parents: 28666
diff changeset
38 ## packages. That usually means that Octave has to run with root access (or
28d2511f2af2 maint: grammarcheck documentation ahead of 6.1 release.
Rik <rik@octave.org>
parents: 28666
diff changeset
39 ## "Run as administrator" on Windows) to be able to install packages globally.
28343
8b71a6cec9bf pkg.m: Add introduction to packages to doc string (bug #58225).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 28278
diff changeset
40 ##
28713
28d2511f2af2 maint: grammarcheck documentation ahead of 6.1 release.
Rik <rik@octave.org>
parents: 28666
diff changeset
41 ## In contrast, local packages are installed by default in the user's
28d2511f2af2 maint: grammarcheck documentation ahead of 6.1 release.
Rik <rik@octave.org>
parents: 28666
diff changeset
42 ## home directory (profile on Windows) and are only available to that specific
28d2511f2af2 maint: grammarcheck documentation ahead of 6.1 release.
Rik <rik@octave.org>
parents: 28666
diff changeset
43 ## user. Usually, they can be installed without root access (or administrative
28d2511f2af2 maint: grammarcheck documentation ahead of 6.1 release.
Rik <rik@octave.org>
parents: 28666
diff changeset
44 ## privileges).
28343
8b71a6cec9bf pkg.m: Add introduction to packages to doc string (bug #58225).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 28278
diff changeset
45 ##
8b71a6cec9bf pkg.m: Add introduction to packages to doc string (bug #58225).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 28278
diff changeset
46 ## For global and local packages, there are separate databases holding the
8b71a6cec9bf pkg.m: Add introduction to packages to doc string (bug #58225).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 28278
diff changeset
47 ## information about the installed packages. If some package is installed
8b71a6cec9bf pkg.m: Add introduction to packages to doc string (bug #58225).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 28278
diff changeset
48 ## globally as well as locally, the local installation takes precedence over
8b71a6cec9bf pkg.m: Add introduction to packages to doc string (bug #58225).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 28278
diff changeset
49 ## ("shadows") the global one. Which package installation (global or local) is
8b71a6cec9bf pkg.m: Add introduction to packages to doc string (bug #58225).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 28278
diff changeset
50 ## used can also be manipulated by using prefixes and/or using the
8b71a6cec9bf pkg.m: Add introduction to packages to doc string (bug #58225).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 28278
diff changeset
51 ## @samp{local_list} input argument. Using these mechanisms, several different
8b71a6cec9bf pkg.m: Add introduction to packages to doc string (bug #58225).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 28278
diff changeset
52 ## releases of one and the same package can be installed side by side as well
28714
d8dcb36bb904 maint: spellcheck documentation ahead of 6.1 release.
Rik <rik@octave.org>
parents: 28713
diff changeset
53 ## (but cannot be loaded simultaneously).
12779
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
54 ##
28714
d8dcb36bb904 maint: spellcheck documentation ahead of 6.1 release.
Rik <rik@octave.org>
parents: 28713
diff changeset
55 ## Packages might depend on external software and/or other packages. To be
28343
8b71a6cec9bf pkg.m: Add introduction to packages to doc string (bug #58225).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 28278
diff changeset
56 ## able to install such packages, these dependencies should be installed
8b71a6cec9bf pkg.m: Add introduction to packages to doc string (bug #58225).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 28278
diff changeset
57 ## beforehand. A package that depends on other package(s) can still be
28714
d8dcb36bb904 maint: spellcheck documentation ahead of 6.1 release.
Rik <rik@octave.org>
parents: 28713
diff changeset
58 ## installed using the @option{-nodeps} flag. The effects of unsatisfied
d8dcb36bb904 maint: spellcheck documentation ahead of 6.1 release.
Rik <rik@octave.org>
parents: 28713
diff changeset
59 ## dependencies on external software---like libraries---depends on the
28343
8b71a6cec9bf pkg.m: Add introduction to packages to doc string (bug #58225).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 28278
diff changeset
60 ## individual package.
8b71a6cec9bf pkg.m: Add introduction to packages to doc string (bug #58225).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 28278
diff changeset
61 ##
8b71a6cec9bf pkg.m: Add introduction to packages to doc string (bug #58225).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 28278
diff changeset
62 ## Packages must be loaded before they can be used. When loading a package,
8b71a6cec9bf pkg.m: Add introduction to packages to doc string (bug #58225).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 28278
diff changeset
63 ## Octave performs the following tasks:
8b71a6cec9bf pkg.m: Add introduction to packages to doc string (bug #58225).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 28278
diff changeset
64 ## @enumerate
8b71a6cec9bf pkg.m: Add introduction to packages to doc string (bug #58225).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 28278
diff changeset
65 ## @item
8b71a6cec9bf pkg.m: Add introduction to packages to doc string (bug #58225).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 28278
diff changeset
66 ## If the package depends on other packages (and @code{pkg load} is called
28714
d8dcb36bb904 maint: spellcheck documentation ahead of 6.1 release.
Rik <rik@octave.org>
parents: 28713
diff changeset
67 ## without the @option{-nodeps} option), the package is not loaded
28713
28d2511f2af2 maint: grammarcheck documentation ahead of 6.1 release.
Rik <rik@octave.org>
parents: 28666
diff changeset
68 ## immediately. Instead, those dependencies are loaded first (recursively if
28d2511f2af2 maint: grammarcheck documentation ahead of 6.1 release.
Rik <rik@octave.org>
parents: 28666
diff changeset
69 ## needed).
28343
8b71a6cec9bf pkg.m: Add introduction to packages to doc string (bug #58225).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 28278
diff changeset
70 ##
8b71a6cec9bf pkg.m: Add introduction to packages to doc string (bug #58225).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 28278
diff changeset
71 ## @item
28714
d8dcb36bb904 maint: spellcheck documentation ahead of 6.1 release.
Rik <rik@octave.org>
parents: 28713
diff changeset
72 ## When all dependencies are satisfied, the package's subdirectories are
28713
28d2511f2af2 maint: grammarcheck documentation ahead of 6.1 release.
Rik <rik@octave.org>
parents: 28666
diff changeset
73 ## added to the search path.
28343
8b71a6cec9bf pkg.m: Add introduction to packages to doc string (bug #58225).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 28278
diff changeset
74 ## @end enumerate
8b71a6cec9bf pkg.m: Add introduction to packages to doc string (bug #58225).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 28278
diff changeset
75 ##
8b71a6cec9bf pkg.m: Add introduction to packages to doc string (bug #58225).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 28278
diff changeset
76 ## This load order leads to functions that are provided by dependencies being
8b71a6cec9bf pkg.m: Add introduction to packages to doc string (bug #58225).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 28278
diff changeset
77 ## potentially shadowed by functions of the same name that are provided by
28714
d8dcb36bb904 maint: spellcheck documentation ahead of 6.1 release.
Rik <rik@octave.org>
parents: 28713
diff changeset
78 ## top-level packages.
28343
8b71a6cec9bf pkg.m: Add introduction to packages to doc string (bug #58225).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 28278
diff changeset
79 ##
8b71a6cec9bf pkg.m: Add introduction to packages to doc string (bug #58225).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 28278
diff changeset
80 ## Each time, a package is added to the search path, initialization script(s)
8b71a6cec9bf pkg.m: Add introduction to packages to doc string (bug #58225).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 28278
diff changeset
81 ## for the package are automatically executed if they are provided by the
8b71a6cec9bf pkg.m: Add introduction to packages to doc string (bug #58225).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 28278
diff changeset
82 ## package.
8b71a6cec9bf pkg.m: Add introduction to packages to doc string (bug #58225).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 28278
diff changeset
83 ##
28713
28d2511f2af2 maint: grammarcheck documentation ahead of 6.1 release.
Rik <rik@octave.org>
parents: 28666
diff changeset
84 ## Depending on the value of @var{command} and on the number of requested
28d2511f2af2 maint: grammarcheck documentation ahead of 6.1 release.
Rik <rik@octave.org>
parents: 28666
diff changeset
85 ## return arguments, @code{pkg} can be used to perform several tasks.
28d2511f2af2 maint: grammarcheck documentation ahead of 6.1 release.
Rik <rik@octave.org>
parents: 28666
diff changeset
86 ## Possible values for @var{command} are:
6032
dcecca0396e6 [project @ 2006-10-04 17:35:15 by jwe]
jwe
parents: 6025
diff changeset
87 ##
dcecca0396e6 [project @ 2006-10-04 17:35:15 by jwe]
jwe
parents: 6025
diff changeset
88 ## @table @samp
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
89 ##
6032
dcecca0396e6 [project @ 2006-10-04 17:35:15 by jwe]
jwe
parents: 6025
diff changeset
90 ## @item install
6070
df821c22355c [project @ 2006-10-23 19:01:04 by jwe]
jwe
parents: 6055
diff changeset
91 ## Install named packages. For example,
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
92 ##
6070
df821c22355c [project @ 2006-10-23 19:01:04 by jwe]
jwe
parents: 6055
diff changeset
93 ## @example
df821c22355c [project @ 2006-10-23 19:01:04 by jwe]
jwe
parents: 6055
diff changeset
94 ## pkg install image-1.0.0.tar.gz
df821c22355c [project @ 2006-10-23 19:01:04 by jwe]
jwe
parents: 6055
diff changeset
95 ## @end example
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
96 ##
6070
df821c22355c [project @ 2006-10-23 19:01:04 by jwe]
jwe
parents: 6055
diff changeset
97 ## @noindent
24934
1db0b81efafe maint: strip trailing whitespace from source files
Mike Miller <mtmiller@octave.org>
parents: 24877
diff changeset
98 ## installs the package found in the file @file{image-1.0.0.tar.gz}. The
27574
c89a6f3eab69 pkg.m: Use uppercase URL in documentation and error messages.
Rik <rik@octave.org>
parents: 27573
diff changeset
99 ## file containing the package can be a URL, e.g.,
24872
a26f8c97df21 warning and yes_or_no for installing using url
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents: 24871
diff changeset
100 ##
a26f8c97df21 warning and yes_or_no for installing using url
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents: 24871
diff changeset
101 ## @example
a26f8c97df21 warning and yes_or_no for installing using url
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents: 24871
diff changeset
102 ## pkg install 'http://somewebsite.org/image-1.0.0.tar.gz'
a26f8c97df21 warning and yes_or_no for installing using url
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents: 24871
diff changeset
103 ## @end example
a26f8c97df21 warning and yes_or_no for installing using url
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents: 24871
diff changeset
104 ##
a26f8c97df21 warning and yes_or_no for installing using url
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents: 24871
diff changeset
105 ## @noindent
27794
45ad2127582b doc: grammarcheck scripts before 6.1 release.
Rik <rik@octave.org>
parents: 27707
diff changeset
106 ## installs the package found in the given URL@. This
24934
1db0b81efafe maint: strip trailing whitespace from source files
Mike Miller <mtmiller@octave.org>
parents: 24877
diff changeset
107 ## requires an internet connection and the cURL library.
24872
a26f8c97df21 warning and yes_or_no for installing using url
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents: 24871
diff changeset
108 ##
a26f8c97df21 warning and yes_or_no for installing using url
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents: 24871
diff changeset
109 ## @noindent
a26f8c97df21 warning and yes_or_no for installing using url
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents: 24871
diff changeset
110 ## @emph{Security risk}: no verification of the package is performed
a26f8c97df21 warning and yes_or_no for installing using url
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents: 24871
diff changeset
111 ## before the installation. It has the same security issues as manually
27574
c89a6f3eab69 pkg.m: Use uppercase URL in documentation and error messages.
Rik <rik@octave.org>
parents: 27573
diff changeset
112 ## downloading the package from the given URL and installing it.
24872
a26f8c97df21 warning and yes_or_no for installing using url
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents: 24871
diff changeset
113 ##
a26f8c97df21 warning and yes_or_no for installing using url
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents: 24871
diff changeset
114 ## @noindent
a26f8c97df21 warning and yes_or_no for installing using url
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents: 24871
diff changeset
115 ## @emph{No support}: the GNU Octave community is not responsible for
24934
1db0b81efafe maint: strip trailing whitespace from source files
Mike Miller <mtmiller@octave.org>
parents: 24877
diff changeset
116 ## packages installed from foreign sites. For support or for
1db0b81efafe maint: strip trailing whitespace from source files
Mike Miller <mtmiller@octave.org>
parents: 24877
diff changeset
117 ## reporting bugs you need to contact the maintainers of the installed
24872
a26f8c97df21 warning and yes_or_no for installing using url
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents: 24871
diff changeset
118 ## package directly (see the @file{DESCRIPTION} file of the package)
6070
df821c22355c [project @ 2006-10-23 19:01:04 by jwe]
jwe
parents: 6055
diff changeset
119 ##
6645
81eb28d50cee [project @ 2007-05-21 21:05:54 by dbateman]
dbateman
parents: 6634
diff changeset
120 ## The @var{option} variable can contain options that affect the manner
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8942
diff changeset
121 ## in which a package is installed. These options can be one or more of
6645
81eb28d50cee [project @ 2007-05-21 21:05:54 by dbateman]
dbateman
parents: 6634
diff changeset
122 ##
81eb28d50cee [project @ 2007-05-21 21:05:54 by dbateman]
dbateman
parents: 6634
diff changeset
123 ## @table @code
81eb28d50cee [project @ 2007-05-21 21:05:54 by dbateman]
dbateman
parents: 6634
diff changeset
124 ## @item -nodeps
12779
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
125 ## The package manager will disable dependency checking. With this option it
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
126 ## is possible to install a package even when it depends on another package
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
127 ## which is not installed on the system. @strong{Use this option with care.}
6645
81eb28d50cee [project @ 2007-05-21 21:05:54 by dbateman]
dbateman
parents: 6634
diff changeset
128 ##
81eb28d50cee [project @ 2007-05-21 21:05:54 by dbateman]
dbateman
parents: 6634
diff changeset
129 ## @item -local
13141
e81ddf9cacd5 maint: untabify and remove trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 12931
diff changeset
130 ## A local installation (package available only to current user) is forced,
12779
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
131 ## even if the user has system privileges.
6258
ea3a7e8469e9 [project @ 2007-01-30 20:17:19 by dbateman]
dbateman
parents: 6254
diff changeset
132 ##
6645
81eb28d50cee [project @ 2007-05-21 21:05:54 by dbateman]
dbateman
parents: 6634
diff changeset
133 ## @item -global
12779
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
134 ## A global installation (package available to all users) is forced, even if
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
135 ## the user doesn't normally have system privileges.
12642
f96b9b9f141b doc: Periodic grammarcheck and spellcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents: 12561
diff changeset
136 ##
12561
0ade5992e374 Add documentation for '-forge' option (bug #32464).
Rik <octave@nomad.inbox5.com>
parents: 12167
diff changeset
137 ## @item -forge
25836
07cb3e098c0a Use "Octave Forge" spelling in all files.
Rik <rik@octave.org>
parents: 25539
diff changeset
138 ## Install a package directly from the Octave Forge repository. This
12561
0ade5992e374 Add documentation for '-forge' option (bug #32464).
Rik <octave@nomad.inbox5.com>
parents: 12167
diff changeset
139 ## requires an internet connection and the cURL library.
6614
3a53d0f3e0e4 [project @ 2007-05-12 05:50:03 by dbateman]
dbateman
parents: 6500
diff changeset
140 ##
20708
453fca9ae397 pkg: add warning about security implications when using -forge.
Carnë Draug <carandraug@octave.org>
parents: 20480
diff changeset
141 ## @emph{Security risk}: no verification of the package is performed
453fca9ae397 pkg: add warning about security implications when using -forge.
Carnë Draug <carandraug@octave.org>
parents: 20480
diff changeset
142 ## before the installation. There are no signature for packages, or
453fca9ae397 pkg: add warning about security implications when using -forge.
Carnë Draug <carandraug@octave.org>
parents: 20480
diff changeset
143 ## checksums to confirm the correct file was downloaded. It has the
453fca9ae397 pkg: add warning about security implications when using -forge.
Carnë Draug <carandraug@octave.org>
parents: 20480
diff changeset
144 ## same security issues as manually downloading the package from the
453fca9ae397 pkg: add warning about security implications when using -forge.
Carnë Draug <carandraug@octave.org>
parents: 20480
diff changeset
145 ## Octave Forge repository and installing it.
453fca9ae397 pkg: add warning about security implications when using -forge.
Carnë Draug <carandraug@octave.org>
parents: 20480
diff changeset
146 ##
6645
81eb28d50cee [project @ 2007-05-21 21:05:54 by dbateman]
dbateman
parents: 6634
diff changeset
147 ## @item -verbose
12779
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
148 ## The package manager will print the output of all commands as
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
149 ## they are performed.
6645
81eb28d50cee [project @ 2007-05-21 21:05:54 by dbateman]
dbateman
parents: 6634
diff changeset
150 ## @end table
81eb28d50cee [project @ 2007-05-21 21:05:54 by dbateman]
dbateman
parents: 6634
diff changeset
151 ##
12779
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
152 ## @item update
25836
07cb3e098c0a Use "Octave Forge" spelling in all files.
Rik <rik@octave.org>
parents: 25539
diff changeset
153 ## Check installed Octave Forge packages against repository and update any
12779
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
154 ## outdated items. This requires an internet connection and the cURL library.
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
155 ## Usage:
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
156 ##
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
157 ## @example
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
158 ## pkg update
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
159 ## @end example
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
160 ##
24966
70490bb1f59d pkg.m: remove update of single package and update docstring
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents: 24965
diff changeset
161 ## @noindent
70490bb1f59d pkg.m: remove update of single package and update docstring
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents: 24965
diff changeset
162 ## To update a single package use @code{pkg install -forge}
70490bb1f59d pkg.m: remove update of single package and update docstring
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents: 24965
diff changeset
163 ##
6032
dcecca0396e6 [project @ 2006-10-04 17:35:15 by jwe]
jwe
parents: 6025
diff changeset
164 ## @item uninstall
6070
df821c22355c [project @ 2006-10-23 19:01:04 by jwe]
jwe
parents: 6055
diff changeset
165 ## Uninstall named packages. For example,
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
166 ##
6070
df821c22355c [project @ 2006-10-23 19:01:04 by jwe]
jwe
parents: 6055
diff changeset
167 ## @example
df821c22355c [project @ 2006-10-23 19:01:04 by jwe]
jwe
parents: 6055
diff changeset
168 ## pkg uninstall image
df821c22355c [project @ 2006-10-23 19:01:04 by jwe]
jwe
parents: 6055
diff changeset
169 ## @end example
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
170 ##
6070
df821c22355c [project @ 2006-10-23 19:01:04 by jwe]
jwe
parents: 6055
diff changeset
171 ## @noindent
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8942
diff changeset
172 ## removes the @code{image} package from the system. If another installed
6070
df821c22355c [project @ 2006-10-23 19:01:04 by jwe]
jwe
parents: 6055
diff changeset
173 ## package depends on the @code{image} package an error will be issued.
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 10685
diff changeset
174 ## The package can be uninstalled anyway by using the @option{-nodeps} option.
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
175 ##
6032
dcecca0396e6 [project @ 2006-10-04 17:35:15 by jwe]
jwe
parents: 6025
diff changeset
176 ## @item load
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8942
diff changeset
177 ## Add named packages to the path. After loading a package it is
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8942
diff changeset
178 ## possible to use the functions provided by the package. For example,
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
179 ##
6070
df821c22355c [project @ 2006-10-23 19:01:04 by jwe]
jwe
parents: 6055
diff changeset
180 ## @example
df821c22355c [project @ 2006-10-23 19:01:04 by jwe]
jwe
parents: 6055
diff changeset
181 ## pkg load image
df821c22355c [project @ 2006-10-23 19:01:04 by jwe]
jwe
parents: 6055
diff changeset
182 ## @end example
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
183 ##
6070
df821c22355c [project @ 2006-10-23 19:01:04 by jwe]
jwe
parents: 6055
diff changeset
184 ## @noindent
21954
6da01de4dd8a pkg: drop special usage of 'all' in load, unload, and describe (bug #40674)
Carnë Draug <carandraug@octave.org>
parents: 21634
diff changeset
185 ## adds the @code{image} package to the path.
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
186 ##
28023
915b3630eed0 pkg.m: Don't unload dependency packages when their dependers are loaded (bug #57522).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 27923
diff changeset
187 ## Note: When loading a package, @code{pkg} will automatically try to load
915b3630eed0 pkg.m: Don't unload dependency packages when their dependers are loaded (bug #57522).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 27923
diff changeset
188 ## any unloaded dependencies as well, unless the @option{-nodeps} flag has
915b3630eed0 pkg.m: Don't unload dependency packages when their dependers are loaded (bug #57522).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 27923
diff changeset
189 ## been specified. For example,
915b3630eed0 pkg.m: Don't unload dependency packages when their dependers are loaded (bug #57522).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 27923
diff changeset
190 ##
915b3630eed0 pkg.m: Don't unload dependency packages when their dependers are loaded (bug #57522).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 27923
diff changeset
191 ## @example
915b3630eed0 pkg.m: Don't unload dependency packages when their dependers are loaded (bug #57522).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 27923
diff changeset
192 ## pkg load signal
915b3630eed0 pkg.m: Don't unload dependency packages when their dependers are loaded (bug #57522).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 27923
diff changeset
193 ## @end example
915b3630eed0 pkg.m: Don't unload dependency packages when their dependers are loaded (bug #57522).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 27923
diff changeset
194 ##
915b3630eed0 pkg.m: Don't unload dependency packages when their dependers are loaded (bug #57522).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 27923
diff changeset
195 ## @noindent
915b3630eed0 pkg.m: Don't unload dependency packages when their dependers are loaded (bug #57522).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 27923
diff changeset
196 ## adds the @code{signal} package and also tries to load its dependency: the
915b3630eed0 pkg.m: Don't unload dependency packages when their dependers are loaded (bug #57522).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 27923
diff changeset
197 ## @code{control} package. Be aware that the functionality of package(s)
915b3630eed0 pkg.m: Don't unload dependency packages when their dependers are loaded (bug #57522).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 27923
diff changeset
198 ## loaded will probably be impacted by use of the @option{-nodeps} flag. Even
28714
d8dcb36bb904 maint: spellcheck documentation ahead of 6.1 release.
Rik <rik@octave.org>
parents: 28713
diff changeset
199 ## if necessary dependencies are loaded later, the functionality of top-level
d8dcb36bb904 maint: spellcheck documentation ahead of 6.1 release.
Rik <rik@octave.org>
parents: 28713
diff changeset
200 ## packages can still be affected because the optimal loading order may not
d8dcb36bb904 maint: spellcheck documentation ahead of 6.1 release.
Rik <rik@octave.org>
parents: 28713
diff changeset
201 ## have been followed.
28023
915b3630eed0 pkg.m: Don't unload dependency packages when their dependers are loaded (bug #57522).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 27923
diff changeset
202 ##
6203
512d72ee321f [project @ 2006-12-06 18:00:13 by jwe]
jwe
parents: 6189
diff changeset
203 ## @item unload
12779
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
204 ## Remove named packages from the path. After unloading a package it is
28023
915b3630eed0 pkg.m: Don't unload dependency packages when their dependers are loaded (bug #57522).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 27923
diff changeset
205 ## no longer possible to use the functions provided by the package. Trying
915b3630eed0 pkg.m: Don't unload dependency packages when their dependers are loaded (bug #57522).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 27923
diff changeset
206 ## to unload a package that other loaded packages still depend on will result
915b3630eed0 pkg.m: Don't unload dependency packages when their dependers are loaded (bug #57522).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 27923
diff changeset
207 ## in an error; no packages will be unloaded in this case. A package can
915b3630eed0 pkg.m: Don't unload dependency packages when their dependers are loaded (bug #57522).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 27923
diff changeset
208 ## be forcibly removed with the @option{-nodeps} flag, but be aware that the
28714
d8dcb36bb904 maint: spellcheck documentation ahead of 6.1 release.
Rik <rik@octave.org>
parents: 28713
diff changeset
209 ## functionality of dependent packages will likely be affected. As when
d8dcb36bb904 maint: spellcheck documentation ahead of 6.1 release.
Rik <rik@octave.org>
parents: 28713
diff changeset
210 ## loading packages, reloading dependencies after having unloaded them with the
d8dcb36bb904 maint: spellcheck documentation ahead of 6.1 release.
Rik <rik@octave.org>
parents: 28713
diff changeset
211 ## @option{-nodeps} flag may not restore all functionality of the dependent
28023
915b3630eed0 pkg.m: Don't unload dependency packages when their dependers are loaded (bug #57522).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 27923
diff changeset
212 ## packages as the required loading order may be incorrect.
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
213 ##
6032
dcecca0396e6 [project @ 2006-10-04 17:35:15 by jwe]
jwe
parents: 6025
diff changeset
214 ## @item list
12779
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
215 ## Show the list of currently installed packages. For example,
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
216 ##
6070
df821c22355c [project @ 2006-10-23 19:01:04 by jwe]
jwe
parents: 6055
diff changeset
217 ## @example
19187
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
218 ## pkg list
6070
df821c22355c [project @ 2006-10-23 19:01:04 by jwe]
jwe
parents: 6055
diff changeset
219 ## @end example
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
220 ##
6070
df821c22355c [project @ 2006-10-23 19:01:04 by jwe]
jwe
parents: 6055
diff changeset
221 ## @noindent
19187
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
222 ## will produce a short report with the package name, version, and installation
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19596
diff changeset
223 ## directory for each installed package. Supply a package name to limit
19187
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
224 ## reporting to a particular package. For example:
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
225 ##
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
226 ## @example
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
227 ## pkg list image
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
228 ## @end example
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
229 ##
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
230 ## If a single return argument is requested then @code{pkg} returns a cell
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
231 ## array where each element is a structure with information on a single
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
232 ## package.
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
233 ##
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
234 ## @example
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
235 ## installed_packages = pkg ("list")
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
236 ## @end example
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
237 ##
12779
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
238 ## If two output arguments are requested @code{pkg} splits the list of
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
239 ## installed packages into those which were installed by the current user,
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
240 ## and those which were installed by the system administrator.
13141
e81ddf9cacd5 maint: untabify and remove trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 12931
diff changeset
241 ##
6070
df821c22355c [project @ 2006-10-23 19:01:04 by jwe]
jwe
parents: 6055
diff changeset
242 ## @example
12779
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
243 ## [user_packages, system_packages] = pkg ("list")
6070
df821c22355c [project @ 2006-10-23 19:01:04 by jwe]
jwe
parents: 6055
diff changeset
244 ## @end example
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
245 ##
25836
07cb3e098c0a Use "Octave Forge" spelling in all files.
Rik <rik@octave.org>
parents: 25539
diff changeset
246 ## The @qcode{"-forge"} option lists packages available at the Octave Forge
19593
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
247 ## repository. This requires an internet connection and the cURL library.
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17243
diff changeset
248 ## For example:
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
249 ##
12779
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
250 ## @example
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
251 ## oct_forge_pkgs = pkg ("list", "-forge")
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
252 ## @end example
12561
0ade5992e374 Add documentation for '-forge' option (bug #32464).
Rik <octave@nomad.inbox5.com>
parents: 12167
diff changeset
253 ##
7497
bb7cc90cdc5e added describe command to pkg
carlo@guglielmo.local
parents: 7329
diff changeset
254 ## @item describe
21954
6da01de4dd8a pkg: drop special usage of 'all' in load, unload, and describe (bug #40674)
Carnë Draug <carandraug@octave.org>
parents: 21634
diff changeset
255 ## Show a short description of installed packages. With the option
21546
f7f97d7e9294 doc: Wrap m-file docstrings to 79 characters + newline (80 total).
Rik <rik@octave.org>
parents: 21518
diff changeset
256 ## @qcode{"-verbose"} also list functions provided by the package. For
f7f97d7e9294 doc: Wrap m-file docstrings to 79 characters + newline (80 total).
Rik <rik@octave.org>
parents: 21518
diff changeset
257 ## example,
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
258 ##
7497
bb7cc90cdc5e added describe command to pkg
carlo@guglielmo.local
parents: 7329
diff changeset
259 ## @example
21954
6da01de4dd8a pkg: drop special usage of 'all' in load, unload, and describe (bug #40674)
Carnë Draug <carandraug@octave.org>
parents: 21634
diff changeset
260 ## pkg describe -verbose
7497
bb7cc90cdc5e added describe command to pkg
carlo@guglielmo.local
parents: 7329
diff changeset
261 ## @end example
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
262 ##
7497
bb7cc90cdc5e added describe command to pkg
carlo@guglielmo.local
parents: 7329
diff changeset
263 ## @noindent
bb7cc90cdc5e added describe command to pkg
carlo@guglielmo.local
parents: 7329
diff changeset
264 ## will describe all installed packages and the functions they provide.
21954
6da01de4dd8a pkg: drop special usage of 'all' in load, unload, and describe (bug #40674)
Carnë Draug <carandraug@octave.org>
parents: 21634
diff changeset
265 ## Display can be limited to a set of packages:
6da01de4dd8a pkg: drop special usage of 'all' in load, unload, and describe (bug #40674)
Carnë Draug <carandraug@octave.org>
parents: 21634
diff changeset
266 ##
6da01de4dd8a pkg: drop special usage of 'all' in load, unload, and describe (bug #40674)
Carnë Draug <carandraug@octave.org>
parents: 21634
diff changeset
267 ## @example
27794
45ad2127582b doc: grammarcheck scripts before 6.1 release.
Rik <rik@octave.org>
parents: 27707
diff changeset
268 ## @group
26577
ae1542fb58ba documentation: Avoid some overfull lines in the PDF manual.
Markus Mützel <markus.muetzel@gmx.de>
parents: 26376
diff changeset
269 ## ## describe control and signal packages
ae1542fb58ba documentation: Avoid some overfull lines in the PDF manual.
Markus Mützel <markus.muetzel@gmx.de>
parents: 26376
diff changeset
270 ## pkg describe control signal
27794
45ad2127582b doc: grammarcheck scripts before 6.1 release.
Rik <rik@octave.org>
parents: 27707
diff changeset
271 ## @end group
21954
6da01de4dd8a pkg: drop special usage of 'all' in load, unload, and describe (bug #40674)
Carnë Draug <carandraug@octave.org>
parents: 21634
diff changeset
272 ## @end example
6da01de4dd8a pkg: drop special usage of 'all' in load, unload, and describe (bug #40674)
Carnë Draug <carandraug@octave.org>
parents: 21634
diff changeset
273 ##
7497
bb7cc90cdc5e added describe command to pkg
carlo@guglielmo.local
parents: 7329
diff changeset
274 ## If one output is requested a cell of structure containing the
bb7cc90cdc5e added describe command to pkg
carlo@guglielmo.local
parents: 7329
diff changeset
275 ## description and list of functions of each package is returned as
bb7cc90cdc5e added describe command to pkg
carlo@guglielmo.local
parents: 7329
diff changeset
276 ## output rather than printed on screen:
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
277 ##
7497
bb7cc90cdc5e added describe command to pkg
carlo@guglielmo.local
parents: 7329
diff changeset
278 ## @example
12779
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
279 ## desc = pkg ("describe", "secs1d", "image")
7497
bb7cc90cdc5e added describe command to pkg
carlo@guglielmo.local
parents: 7329
diff changeset
280 ## @end example
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
281 ##
7497
bb7cc90cdc5e added describe command to pkg
carlo@guglielmo.local
parents: 7329
diff changeset
282 ## @noindent
19187
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
283 ## If any of the requested packages is not installed, @code{pkg} returns an
7497
bb7cc90cdc5e added describe command to pkg
carlo@guglielmo.local
parents: 7329
diff changeset
284 ## error, unless a second output is requested:
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
285 ##
7497
bb7cc90cdc5e added describe command to pkg
carlo@guglielmo.local
parents: 7329
diff changeset
286 ## @example
12779
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
287 ## [desc, flag] = pkg ("describe", "secs1d", "image")
7497
bb7cc90cdc5e added describe command to pkg
carlo@guglielmo.local
parents: 7329
diff changeset
288 ## @end example
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
289 ##
7497
bb7cc90cdc5e added describe command to pkg
carlo@guglielmo.local
parents: 7329
diff changeset
290 ## @noindent
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17243
diff changeset
291 ## @var{flag} will take one of the values @qcode{"Not installed"},
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17243
diff changeset
292 ## @qcode{"Loaded"}, or
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17243
diff changeset
293 ## @qcode{"Not loaded"} for each of the named packages.
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
294 ##
6034
5cbbf96b52da [project @ 2006-10-04 18:45:43 by jwe]
jwe
parents: 6033
diff changeset
295 ## @item prefix
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8942
diff changeset
296 ## Set the installation prefix directory. For example,
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
297 ##
6070
df821c22355c [project @ 2006-10-23 19:01:04 by jwe]
jwe
parents: 6055
diff changeset
298 ## @example
df821c22355c [project @ 2006-10-23 19:01:04 by jwe]
jwe
parents: 6055
diff changeset
299 ## pkg prefix ~/my_octave_packages
df821c22355c [project @ 2006-10-23 19:01:04 by jwe]
jwe
parents: 6055
diff changeset
300 ## @end example
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
301 ##
6070
df821c22355c [project @ 2006-10-23 19:01:04 by jwe]
jwe
parents: 6055
diff changeset
302 ## @noindent
9307
c2923c27c877 Various documentation improvements
Rik <rdrider0-list@yahoo.com>
parents: 9258
diff changeset
303 ## sets the installation prefix to @file{~/my_octave_packages}.
6070
df821c22355c [project @ 2006-10-23 19:01:04 by jwe]
jwe
parents: 6055
diff changeset
304 ## Packages will be installed in this directory.
6034
5cbbf96b52da [project @ 2006-10-04 18:45:43 by jwe]
jwe
parents: 6033
diff changeset
305 ##
6070
df821c22355c [project @ 2006-10-23 19:01:04 by jwe]
jwe
parents: 6055
diff changeset
306 ## It is possible to get the current installation prefix by requesting an
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
307 ## output argument. For example:
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
308 ##
6070
df821c22355c [project @ 2006-10-23 19:01:04 by jwe]
jwe
parents: 6055
diff changeset
309 ## @example
12779
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
310 ## pfx = pkg ("prefix")
6070
df821c22355c [project @ 2006-10-23 19:01:04 by jwe]
jwe
parents: 6055
diff changeset
311 ## @end example
6925
1401a79af68c [project @ 2007-09-26 18:58:52 by dbateman]
dbateman
parents: 6820
diff changeset
312 ##
1401a79af68c [project @ 2007-09-26 18:58:52 by dbateman]
dbateman
parents: 6820
diff changeset
313 ## The location in which to install the architecture dependent files can be
12779
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
314 ## independently specified with an addition argument. For example:
6925
1401a79af68c [project @ 2007-09-26 18:58:52 by dbateman]
dbateman
parents: 6820
diff changeset
315 ##
1401a79af68c [project @ 2007-09-26 18:58:52 by dbateman]
dbateman
parents: 6820
diff changeset
316 ## @example
9153
5247e89688e1 Eliminate most overfull errors when running texi2pdf for generating pdf documentation
Rik <rdrider0-list@yahoo.com>
parents: 9079
diff changeset
317 ## pkg prefix ~/my_octave_packages ~/my_arch_dep_pkgs
6925
1401a79af68c [project @ 2007-09-26 18:58:52 by dbateman]
dbateman
parents: 6820
diff changeset
318 ## @end example
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
319 ##
6189
0d23b0c0ce1a [project @ 2006-11-29 21:01:05 by dbateman]
dbateman
parents: 6143
diff changeset
320 ## @item local_list
12779
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
321 ## Set the file in which to look for information on locally
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8942
diff changeset
322 ## installed packages. Locally installed packages are those that are
12779
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
323 ## available only to the current user. For example:
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
324 ##
6189
0d23b0c0ce1a [project @ 2006-11-29 21:01:05 by dbateman]
dbateman
parents: 6143
diff changeset
325 ## @example
0d23b0c0ce1a [project @ 2006-11-29 21:01:05 by dbateman]
dbateman
parents: 6143
diff changeset
326 ## pkg local_list ~/.octave_packages
0d23b0c0ce1a [project @ 2006-11-29 21:01:05 by dbateman]
dbateman
parents: 6143
diff changeset
327 ## @end example
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
328 ##
6189
0d23b0c0ce1a [project @ 2006-11-29 21:01:05 by dbateman]
dbateman
parents: 6143
diff changeset
329 ## It is possible to get the current value of local_list with the following
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
330 ##
6189
0d23b0c0ce1a [project @ 2006-11-29 21:01:05 by dbateman]
dbateman
parents: 6143
diff changeset
331 ## @example
0d23b0c0ce1a [project @ 2006-11-29 21:01:05 by dbateman]
dbateman
parents: 6143
diff changeset
332 ## pkg local_list
0d23b0c0ce1a [project @ 2006-11-29 21:01:05 by dbateman]
dbateman
parents: 6143
diff changeset
333 ## @end example
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
334 ##
6189
0d23b0c0ce1a [project @ 2006-11-29 21:01:05 by dbateman]
dbateman
parents: 6143
diff changeset
335 ## @item global_list
12779
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
336 ## Set the file in which to look for information on globally
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8942
diff changeset
337 ## installed packages. Globally installed packages are those that are
12779
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
338 ## available to all users. For example:
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
339 ##
6189
0d23b0c0ce1a [project @ 2006-11-29 21:01:05 by dbateman]
dbateman
parents: 6143
diff changeset
340 ## @example
0d23b0c0ce1a [project @ 2006-11-29 21:01:05 by dbateman]
dbateman
parents: 6143
diff changeset
341 ## pkg global_list /usr/share/octave/octave_packages
0d23b0c0ce1a [project @ 2006-11-29 21:01:05 by dbateman]
dbateman
parents: 6143
diff changeset
342 ## @end example
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
343 ##
6189
0d23b0c0ce1a [project @ 2006-11-29 21:01:05 by dbateman]
dbateman
parents: 6143
diff changeset
344 ## It is possible to get the current value of global_list with the following
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
345 ##
6189
0d23b0c0ce1a [project @ 2006-11-29 21:01:05 by dbateman]
dbateman
parents: 6143
diff changeset
346 ## @example
0d23b0c0ce1a [project @ 2006-11-29 21:01:05 by dbateman]
dbateman
parents: 6143
diff changeset
347 ## pkg global_list
0d23b0c0ce1a [project @ 2006-11-29 21:01:05 by dbateman]
dbateman
parents: 6143
diff changeset
348 ## @end example
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
349 ##
6675
f938c7018d28 [project @ 2007-05-31 19:31:14 by dbateman]
dbateman
parents: 6663
diff changeset
350 ## @item build
12779
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
351 ## Build a binary form of a package or packages. The binary file produced
6675
f938c7018d28 [project @ 2007-05-31 19:31:14 by dbateman]
dbateman
parents: 6663
diff changeset
352 ## will itself be an Octave package that can be installed normally with
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 8942
diff changeset
353 ## @code{pkg}. The form of the command to build a binary package is
6675
f938c7018d28 [project @ 2007-05-31 19:31:14 by dbateman]
dbateman
parents: 6663
diff changeset
354 ##
f938c7018d28 [project @ 2007-05-31 19:31:14 by dbateman]
dbateman
parents: 6663
diff changeset
355 ## @example
f938c7018d28 [project @ 2007-05-31 19:31:14 by dbateman]
dbateman
parents: 6663
diff changeset
356 ## pkg build builddir image-1.0.0.tar.gz @dots{}
f938c7018d28 [project @ 2007-05-31 19:31:14 by dbateman]
dbateman
parents: 6663
diff changeset
357 ## @end example
f938c7018d28 [project @ 2007-05-31 19:31:14 by dbateman]
dbateman
parents: 6663
diff changeset
358 ##
f938c7018d28 [project @ 2007-05-31 19:31:14 by dbateman]
dbateman
parents: 6663
diff changeset
359 ## @noindent
9079
4d610aba7347 Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents: 9051
diff changeset
360 ## where @code{builddir} is the name of a directory where the temporary
6675
f938c7018d28 [project @ 2007-05-31 19:31:14 by dbateman]
dbateman
parents: 6663
diff changeset
361 ## installation will be produced and the binary packages will be found.
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11547
diff changeset
362 ## The options @option{-verbose} and @option{-nodeps} are respected, while
12779
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
363 ## all other options are ignored.
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
364 ##
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
365 ## @item rebuild
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
366 ## Rebuild the package database from the installed directories. This can
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
367 ## be used in cases where the package database has been corrupted.
095fd5c8b7e1 doc: Update docstring for pkg()
Rik <octave@nomad.inbox5.com>
parents: 12778
diff changeset
368 ##
28064
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
369 ## @item test
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
370 ## Perform the built-in self tests contained in all functions provided by
28713
28d2511f2af2 maint: grammarcheck documentation ahead of 6.1 release.
Rik <rik@octave.org>
parents: 28666
diff changeset
371 ## the named packages. For example:
28064
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
372 ##
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
373 ## @example
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
374 ## pkg test image
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
375 ## @end example
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
376 ##
6032
dcecca0396e6 [project @ 2006-10-04 17:35:15 by jwe]
jwe
parents: 6025
diff changeset
377 ## @end table
19192
8a8a7bc2a09d Improve docstrings and mark documentation m-files as tested in miscellaneous/ dir.
Rik <rik@octave.org>
parents: 19187
diff changeset
378 ## @seealso{ver, news}
11547
e1851653d59c Eliminate @deffn macros.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
379 ## @end deftypefn
5947
009fa69b6182 [project @ 2006-08-21 16:15:20 by jwe]
jwe
parents: 5928
diff changeset
380
6496
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
381 function [local_packages, global_packages] = pkg (varargin)
19187
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
382
28133
baf16e6f498b pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28064
diff changeset
383 ## Installation prefix
6645
81eb28d50cee [project @ 2007-05-21 21:05:54 by dbateman]
dbateman
parents: 6634
diff changeset
384 persistent user_prefix = false;
16304
c8e1b0213e34 pkg.m: Fix str-to-num warnings (bug #37785)
Rik <rik@octave.org>
parents: 16173
diff changeset
385 persistent prefix = false;
6925
1401a79af68c [project @ 2007-09-26 18:58:52 by dbateman]
dbateman
parents: 6820
diff changeset
386 persistent archprefix = -1;
7498
a939fb03a137 pkg.m style fixes
John W. Eaton <jwe@octave.org>
parents: 7497
diff changeset
387 persistent local_list = tilde_expand (fullfile ("~", ".octave_packages"));
6496
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
388 persistent global_list = fullfile (OCTAVE_HOME (), "share", "octave",
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10401
diff changeset
389 "octave_packages");
14471
d2c095e45196 maint: Remove redundant private function from the package manager.
Carlo de Falco <kingcrimson@tiscali.it>
parents: 14466
diff changeset
390
28133
baf16e6f498b pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28064
diff changeset
391 ## If user is superuser (posix) or the process has elevated rights (Windows),
baf16e6f498b pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28064
diff changeset
392 ## set global_install to true.
baf16e6f498b pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28064
diff changeset
393 if (ispc () && ! isunix ())
baf16e6f498b pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28064
diff changeset
394 global_install = __is_elevated_process__ ();
baf16e6f498b pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28064
diff changeset
395 else
baf16e6f498b pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28064
diff changeset
396 global_install = (geteuid () == 0);
baf16e6f498b pkg.m: Install packages globally if process has elevated rights (bug #44548).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28064
diff changeset
397 endif
6683
a2f697dca2a4 [project @ 2007-06-01 23:10:24 by dbateman]
dbateman
parents: 6675
diff changeset
398
16304
c8e1b0213e34 pkg.m: Fix str-to-num warnings (bug #37785)
Rik <rik@octave.org>
parents: 16173
diff changeset
399 if (isbool (prefix))
18448
b26d6be1767a Move definifion of default package paths to separate function.
Carlo de Falco <cdf@users.sourceforge.net>
parents: 17744
diff changeset
400 [prefix, archprefix] = default_prefix (global_install);
6645
81eb28d50cee [project @ 2007-05-21 21:05:54 by dbateman]
dbateman
parents: 6634
diff changeset
401 prefix = tilde_expand (prefix);
6925
1401a79af68c [project @ 2007-09-26 18:58:52 by dbateman]
dbateman
parents: 6820
diff changeset
402 archprefix = tilde_expand (archprefix);
6496
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
403 endif
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
404
19187
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
405 mlock ();
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
406
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
407 confirm_recursive_rmdir (false, "local");
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
408
24965
0974a3649c81 pkg.m: alphabetic order of available_actions
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents: 24934
diff changeset
409 # valid actions in alphabetical order
0974a3649c81 pkg.m: alphabetic order of available_actions
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents: 24934
diff changeset
410 available_actions = {"build", "describe", "global_list", "install", ...
0974a3649c81 pkg.m: alphabetic order of available_actions
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents: 24934
diff changeset
411 "list", "load", "local_list", "prefix", "rebuild", ...
28064
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
412 "test", "uninstall", "unload", "update"};
19187
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
413
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
414 ## Parse input arguments
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
415 if (isempty (varargin) || ! iscellstr (varargin))
6496
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
416 print_usage ();
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
417 endif
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
418 files = {};
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
419 deps = true;
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
420 action = "none";
6614
3a53d0f3e0e4 [project @ 2007-05-12 05:50:03 by dbateman]
dbateman
parents: 6500
diff changeset
421 verbose = false;
10684
76aba4305f1f support pkg install -forge
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
422 octave_forge = false;
19187
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
423 for i = 1:numel (varargin)
6496
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
424 switch (varargin{i})
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
425 case "-nodeps"
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10401
diff changeset
426 deps = false;
21624
cf227735d5fd pkg: remove support for autoload (automatically loading package at start).
Carnë Draug <carandraug@octave.org>
parents: 21546
diff changeset
427 ## TODO completely remove these warnings after some releases.
6496
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
428 case "-noauto"
21624
cf227735d5fd pkg: remove support for autoload (automatically loading package at start).
Carnë Draug <carandraug@octave.org>
parents: 21546
diff changeset
429 warning ("Octave:deprecated-option",
cf227735d5fd pkg: remove support for autoload (automatically loading package at start).
Carnë Draug <carandraug@octave.org>
parents: 21546
diff changeset
430 ["pkg: autoload is no longer supported. The -noauto "...
cf227735d5fd pkg: remove support for autoload (automatically loading package at start).
Carnë Draug <carandraug@octave.org>
parents: 21546
diff changeset
431 "option is no longer required."]);
6496
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
432 case "-auto"
21624
cf227735d5fd pkg: remove support for autoload (automatically loading package at start).
Carnë Draug <carandraug@octave.org>
parents: 21546
diff changeset
433 warning ("Octave:deprecated-option",
cf227735d5fd pkg: remove support for autoload (automatically loading package at start).
Carnë Draug <carandraug@octave.org>
parents: 21546
diff changeset
434 ["pkg: autoload is no longer supported. Add a "...
cf227735d5fd pkg: remove support for autoload (automatically loading package at start).
Carnë Draug <carandraug@octave.org>
parents: 21546
diff changeset
435 "'pkg load ...' command to octaverc instead."]);
6614
3a53d0f3e0e4 [project @ 2007-05-12 05:50:03 by dbateman]
dbateman
parents: 6500
diff changeset
436 case "-verbose"
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10401
diff changeset
437 verbose = true;
13275
635db52feab4 pkg.m: Display verbose output immediately rather than buffering it.
Rik <octave@nomad.inbox5.com>
parents: 13141
diff changeset
438 ## Send verbose output to pager immediately. Change setting locally.
635db52feab4 pkg.m: Display verbose output immediately rather than buffering it.
Rik <octave@nomad.inbox5.com>
parents: 13141
diff changeset
439 page_output_immediately (true, "local");
10684
76aba4305f1f support pkg install -forge
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
440 case "-forge"
21434
1da428cbf401 deprecate octave_config_info
John W. Eaton <jwe@octave.org>
parents: 20852
diff changeset
441 if (! __octave_config_info__ ("CURL_LIBS"))
25841
0d4b88086f36 doc: use "Octave Forge" spelling in a few more instances
Mike Miller <mtmiller@octave.org>
parents: 25836
diff changeset
442 error ("pkg: can't download from Octave Forge without the cURL library");
15184
0b29c16a2645 pkg: check cURL library when using -forge
Carnë Draug <carandraug+dev@gmail.com>
parents: 15058
diff changeset
443 endif
10684
76aba4305f1f support pkg install -forge
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
444 octave_forge = true;
6645
81eb28d50cee [project @ 2007-05-21 21:05:54 by dbateman]
dbateman
parents: 6634
diff changeset
445 case "-local"
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10401
diff changeset
446 global_install = false;
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10401
diff changeset
447 if (! user_prefix)
18448
b26d6be1767a Move definifion of default package paths to separate function.
Carlo de Falco <cdf@users.sourceforge.net>
parents: 17744
diff changeset
448 [prefix, archprefix] = default_prefix (global_install);
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10401
diff changeset
449 endif
6645
81eb28d50cee [project @ 2007-05-21 21:05:54 by dbateman]
dbateman
parents: 6634
diff changeset
450 case "-global"
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10401
diff changeset
451 global_install = true;
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10401
diff changeset
452 if (! user_prefix)
18448
b26d6be1767a Move definifion of default package paths to separate function.
Carlo de Falco <cdf@users.sourceforge.net>
parents: 17744
diff changeset
453 [prefix, archprefix] = default_prefix (global_install);
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10401
diff changeset
454 endif
7497
bb7cc90cdc5e added describe command to pkg
carlo@guglielmo.local
parents: 7329
diff changeset
455 case available_actions
19187
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
456 if (! strcmp (action, "none"))
20726
25d676f9619c Preface error() messages with name of function when possible.
Rik <rik@octave.org>
parents: 20708
diff changeset
457 error ("pkg: more than one action specified");
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10401
diff changeset
458 endif
19187
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
459 action = varargin{i};
6496
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
460 otherwise
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10401
diff changeset
461 files{end+1} = varargin{i};
5801
70013c9f3ccc [project @ 2006-05-10 16:53:03 by jwe]
jwe
parents:
diff changeset
462 endswitch
6496
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
463 endfor
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
464
10685
81a43049dee2 support pkg list -forge
Jaroslav Hajek <highegg@gmail.com>
parents: 10684
diff changeset
465 if (octave_forge && ! any (strcmp (action, {"install", "list"})))
20726
25d676f9619c Preface error() messages with name of function when possible.
Rik <rik@octave.org>
parents: 20708
diff changeset
466 error ("pkg: '-forge' can only be used with install or list");
10684
76aba4305f1f support pkg install -forge
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
467 endif
76aba4305f1f support pkg install -forge
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
468
6496
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
469 ## Take action
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
470 switch (action)
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
471 case "list"
10685
81a43049dee2 support pkg list -forge
Jaroslav Hajek <highegg@gmail.com>
parents: 10684
diff changeset
472 if (octave_forge)
20475
7fa1970a655d pkg.m: drop check of nargout value, the interpreter already does that.
Carnë Draug <carandraug@octave.org>
parents: 19833
diff changeset
473 if (nargout)
10685
81a43049dee2 support pkg list -forge
Jaroslav Hajek <highegg@gmail.com>
parents: 10684
diff changeset
474 local_packages = list_forge_packages ();
81a43049dee2 support pkg list -forge
Jaroslav Hajek <highegg@gmail.com>
parents: 10684
diff changeset
475 else
81a43049dee2 support pkg list -forge
Jaroslav Hajek <highegg@gmail.com>
parents: 10684
diff changeset
476 list_forge_packages ();
81a43049dee2 support pkg list -forge
Jaroslav Hajek <highegg@gmail.com>
parents: 10684
diff changeset
477 endif
6496
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
478 else
20480
ad7fe3cb6fd2 pkg: fix regression on output of pkg list (bug #45873)
Carnë Draug <carandraug@octave.org>
parents: 20475
diff changeset
479 if (nargout == 1)
ad7fe3cb6fd2 pkg: fix regression on output of pkg list (bug #45873)
Carnë Draug <carandraug@octave.org>
parents: 20475
diff changeset
480 local_packages = installed_packages (local_list, global_list, files);
ad7fe3cb6fd2 pkg: fix regression on output of pkg list (bug #45873)
Carnë Draug <carandraug@octave.org>
parents: 20475
diff changeset
481 elseif (nargout > 1)
10685
81a43049dee2 support pkg list -forge
Jaroslav Hajek <highegg@gmail.com>
parents: 10684
diff changeset
482 [local_packages, global_packages] = installed_packages (local_list,
19187
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
483 global_list,
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
484 files);
10685
81a43049dee2 support pkg list -forge
Jaroslav Hajek <highegg@gmail.com>
parents: 10684
diff changeset
485 else
20475
7fa1970a655d pkg.m: drop check of nargout value, the interpreter already does that.
Carnë Draug <carandraug@octave.org>
parents: 19833
diff changeset
486 installed_packages (local_list, global_list, files);
10685
81a43049dee2 support pkg list -forge
Jaroslav Hajek <highegg@gmail.com>
parents: 10684
diff changeset
487 endif
6496
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
488 endif
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
489
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
490 case "install"
19187
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
491 if (isempty (files))
20726
25d676f9619c Preface error() messages with name of function when possible.
Rik <rik@octave.org>
parents: 20708
diff changeset
492 error ("pkg: install action requires at least one filename");
6496
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
493 endif
10684
76aba4305f1f support pkg install -forge
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
494
76aba4305f1f support pkg install -forge
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
495 local_files = {};
25140
ad6dce96cbca pkg.m: fix undefined variable error in install (bug #53567)
Mike Miller <mtmiller@octave.org>
parents: 25131
diff changeset
496 tmp_dir = tempname ();
10684
76aba4305f1f support pkg install -forge
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
497 unwind_protect
76aba4305f1f support pkg install -forge
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
498
76aba4305f1f support pkg install -forge
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
499 if (octave_forge)
19833
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
500 [urls, local_files] = cellfun ("get_forge_download", files,
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
501 "uniformoutput", false);
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
502 [files, succ] = cellfun ("urlwrite", urls, local_files,
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
503 "uniformoutput", false);
10684
76aba4305f1f support pkg install -forge
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
504 succ = [succ{:}];
76aba4305f1f support pkg install -forge
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
505 if (! all (succ))
76aba4305f1f support pkg install -forge
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
506 i = find (! succ, 1);
27574
c89a6f3eab69 pkg.m: Use uppercase URL in documentation and error messages.
Rik <rik@octave.org>
parents: 27573
diff changeset
507 error ("pkg: could not download file %s from URL %s",
19833
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
508 local_files{i}, urls{i});
10684
76aba4305f1f support pkg install -forge
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
509 endif
24871
ca43264971ea pkg: allow URI for external files (https/ftp/etc links) as install targets
Carnë Draug <carandraug@octave.org>
parents: 24534
diff changeset
510 else
ca43264971ea pkg: allow URI for external files (https/ftp/etc links) as install targets
Carnë Draug <carandraug@octave.org>
parents: 24534
diff changeset
511 ## If files do not exist, maybe they are not local files.
ca43264971ea pkg: allow URI for external files (https/ftp/etc links) as install targets
Carnë Draug <carandraug@octave.org>
parents: 24534
diff changeset
512 ## Try to download them.
26589
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
513 not_local_files = cellfun (@(x) isempty (glob (x)), files);
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
514 if (any (not_local_files))
25140
ad6dce96cbca pkg.m: fix undefined variable error in install (bug #53567)
Mike Miller <mtmiller@octave.org>
parents: 25131
diff changeset
515 [success, msg] = mkdir (tmp_dir);
24871
ca43264971ea pkg: allow URI for external files (https/ftp/etc links) as install targets
Carnë Draug <carandraug@octave.org>
parents: 24534
diff changeset
516 if (success != 1)
ca43264971ea pkg: allow URI for external files (https/ftp/etc links) as install targets
Carnë Draug <carandraug@octave.org>
parents: 24534
diff changeset
517 error ("pkg: failed to create temporary directory: %s", msg);
ca43264971ea pkg: allow URI for external files (https/ftp/etc links) as install targets
Carnë Draug <carandraug@octave.org>
parents: 24534
diff changeset
518 endif
24872
a26f8c97df21 warning and yes_or_no for installing using url
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents: 24871
diff changeset
519
26589
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
520 for file = files(not_local_files)
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
521 file = file{1};
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
522 [~, fname, fext] = fileparts (file);
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
523 tmp_file = fullfile (tmp_dir, [fname fext]);
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
524 local_files{end+1} = tmp_file;
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
525 looks_like_url = regexp (file, '^\w+://');
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
526 if (looks_like_url)
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
527 [~, success, msg] = urlwrite (file, local_files{end});
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
528 if (success != 1)
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
529 error ("pkg: failed downloading '%s': %s", file, msg);
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
530 endif
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
531 ## Verify that download is a tarball,
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
532 ## to protect against ISP DNS hijacking.
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
533 ## FIXME: Need a test which does not rely on external OS.
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
534 #{
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
535 if (isunix ())
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
536 [ok, file_descr] = ...
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
537 system (sprintf ('file "%s" | cut -d ":" -f 2', ...
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
538 local_files{end}));
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
539 if (! ok)
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
540 if (strfind (file_descr, "HTML"))
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
541 error (["pkg: Invalid package file downloaded from " ...
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
542 "%s\n" ...
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
543 "File is HTML, not a tar archive."], ...
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
544 file);
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
545 endif
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
546 else
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
547 ## Ignore: maybe something went wrong with the "file" call.
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
548 endif
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
549 endif
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
550 #}
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
551 else
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
552 looks_like_pkg_name = regexp (file, '^[\w-]+$');
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
553 if (looks_like_pkg_name)
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
554 error (["pkg: file not found: %s.\n" ...
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
555 "This looks like an Octave Forge package name." ...
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
556 " Did you mean:\n" ...
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
557 " pkg install -forge %s"], ...
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
558 file, file);
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
559 else
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
560 error ("pkg: file not found: %s", file);
5bfbcbec6826 pkg.m: Clearer error messages when file doesn't exist or -forge switch is forgotten (bug #55515).
Andrew Janke <andrew@apjanke.net>
parents: 26376
diff changeset
561 endif
25030
62186547b752 pkg.m: remove yes-no question when installing from URI.
Carnë Draug <carandraug@octave.org>
parents: 24934
diff changeset
562 endif
26856
65c036b78040 pkg.m: Fix regression installing pkgs from URL (bug #55843).
Rik <rik@octave.org>
parents: 26595
diff changeset
563 files{strcmp (files, file)} = local_files{end};
24872
a26f8c97df21 warning and yes_or_no for installing using url
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents: 24871
diff changeset
564
24871
ca43264971ea pkg: allow URI for external files (https/ftp/etc links) as install targets
Carnë Draug <carandraug@octave.org>
parents: 24534
diff changeset
565 endfor
ca43264971ea pkg: allow URI for external files (https/ftp/etc links) as install targets
Carnë Draug <carandraug@octave.org>
parents: 24534
diff changeset
566 endif
10684
76aba4305f1f support pkg install -forge
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
567 endif
21624
cf227735d5fd pkg: remove support for autoload (automatically loading package at start).
Carnë Draug <carandraug@octave.org>
parents: 21546
diff changeset
568 install (files, deps, prefix, archprefix, verbose, local_list,
10684
76aba4305f1f support pkg install -forge
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
569 global_list, global_install);
76aba4305f1f support pkg install -forge
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
570
76aba4305f1f support pkg install -forge
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
571 unwind_protect_cleanup
28503
f480103d8333 Fix unlink() calls in package m-files for new syntax (bug #57830)
Rik <rik@octave.org>
parents: 28501
diff changeset
572 [~] = cellfun ("unlink", local_files);
25131
0cd7076a97c8 pkg.m: Don't leave behind temporary directories if error occurs during install (bug #53567).
Rik <rik@octave.org>
parents: 25054
diff changeset
573 if (exist (tmp_dir, "file"))
0cd7076a97c8 pkg.m: Don't leave behind temporary directories if error occurs during install (bug #53567).
Rik <rik@octave.org>
parents: 25054
diff changeset
574 rmdir (tmp_dir, "s");
0cd7076a97c8 pkg.m: Don't leave behind temporary directories if error occurs during install (bug #53567).
Rik <rik@octave.org>
parents: 25054
diff changeset
575 endif
10684
76aba4305f1f support pkg install -forge
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
576 end_unwind_protect
6496
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
577
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
578 case "uninstall"
19187
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
579 if (isempty (files))
20726
25d676f9619c Preface error() messages with name of function when possible.
Rik <rik@octave.org>
parents: 20708
diff changeset
580 error ("pkg: uninstall action requires at least one package name");
6496
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
581 endif
19187
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
582 uninstall (files, deps, verbose, local_list, global_list, global_install);
6496
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
583
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
584 case "load"
19187
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
585 if (isempty (files))
21954
6da01de4dd8a pkg: drop special usage of 'all' in load, unload, and describe (bug #40674)
Carnë Draug <carandraug@octave.org>
parents: 21634
diff changeset
586 error ("pkg: load action requires at least one package name");
6496
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
587 endif
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
588 load_packages (files, deps, local_list, global_list);
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
589
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
590 case "unload"
19187
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
591 if (isempty (files))
21954
6da01de4dd8a pkg: drop special usage of 'all' in load, unload, and describe (bug #40674)
Carnë Draug <carandraug@octave.org>
parents: 21634
diff changeset
592 error ("pkg: unload action requires at least one package name");
6496
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
593 endif
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
594 unload_packages (files, deps, local_list, global_list);
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
595
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
596 case "prefix"
20475
7fa1970a655d pkg.m: drop check of nargout value, the interpreter already does that.
Carnë Draug <carandraug@octave.org>
parents: 19833
diff changeset
597 if (isempty (files) && ! nargout)
21634
96518f623c91 Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents: 21633
diff changeset
598 printf ("Installation prefix: %s\n", prefix);
96518f623c91 Backed out changeset dcf8922b724b
Mike Miller <mtmiller@octave.org>
parents: 21633
diff changeset
599 printf ("Architecture dependent prefix: %s\n", archprefix);
20475
7fa1970a655d pkg.m: drop check of nargout value, the interpreter already does that.
Carnë Draug <carandraug@octave.org>
parents: 19833
diff changeset
600 elseif (isempty (files) && nargout)
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10401
diff changeset
601 local_packages = prefix;
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10401
diff changeset
602 global_packages = archprefix;
20475
7fa1970a655d pkg.m: drop check of nargout value, the interpreter already does that.
Carnë Draug <carandraug@octave.org>
parents: 19833
diff changeset
603 elseif (numel (files) >= 1 && ischar (files{1}))
16173
40a9a4e0d12a pkg.m: Restore ability to use '~' in specifying prefix directories.
Rik <rik@octave.org>
parents: 15966
diff changeset
604 prefix = tilde_expand (files{1});
26100
7a8f895c8f15 pkg.m: Don't create 'prefix' directory until needed (bug #53577).
Rik <rik@octave.org>
parents: 25842
diff changeset
605 local_packages = prefix = make_absolute_filename (prefix);
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10401
diff changeset
606 user_prefix = true;
19187
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
607 if (numel (files) >= 2 && ischar (files{2}))
26100
7a8f895c8f15 pkg.m: Don't create 'prefix' directory until needed (bug #53577).
Rik <rik@octave.org>
parents: 25842
diff changeset
608 archprefix = make_absolute_filename (tilde_expand (files{2}));
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10401
diff changeset
609 endif
6496
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
610 else
20726
25d676f9619c Preface error() messages with name of function when possible.
Rik <rik@octave.org>
parents: 20708
diff changeset
611 error ("pkg: prefix action requires a directory input, or an output argument");
6496
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
612 endif
19593
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
613
6496
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
614 case "local_list"
20475
7fa1970a655d pkg.m: drop check of nargout value, the interpreter already does that.
Carnë Draug <carandraug@octave.org>
parents: 19833
diff changeset
615 if (isempty (files) && ! nargout)
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10401
diff changeset
616 disp (local_list);
20475
7fa1970a655d pkg.m: drop check of nargout value, the interpreter already does that.
Carnë Draug <carandraug@octave.org>
parents: 19833
diff changeset
617 elseif (isempty (files) && nargout)
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10401
diff changeset
618 local_packages = local_list;
20475
7fa1970a655d pkg.m: drop check of nargout value, the interpreter already does that.
Carnë Draug <carandraug@octave.org>
parents: 19833
diff changeset
619 elseif (numel (files) == 1 && ! nargout && ischar (files{1}))
28278
3cffb5c059b4 pkg.m: Perform tilde expansion on 'local_list' argument (bug #58332).
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 28133
diff changeset
620 local_list = tilde_expand (files{1});
19593
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
621 if (! exist (local_list, "file"))
15000
4c8ddf57fcda remove redundant private function absolute_pathname
Carlo de Falco <cdf@users.sourceforge.net>
parents: 14860
diff changeset
622 try
4c8ddf57fcda remove redundant private function absolute_pathname
Carlo de Falco <cdf@users.sourceforge.net>
parents: 14860
diff changeset
623 ## Force file to be created
4c8ddf57fcda remove redundant private function absolute_pathname
Carlo de Falco <cdf@users.sourceforge.net>
parents: 14860
diff changeset
624 fclose (fopen (local_list, "wt"));
4c8ddf57fcda remove redundant private function absolute_pathname
Carlo de Falco <cdf@users.sourceforge.net>
parents: 14860
diff changeset
625 catch
20726
25d676f9619c Preface error() messages with name of function when possible.
Rik <rik@octave.org>
parents: 20708
diff changeset
626 error ("pkg: cannot create file %s", local_list);
15000
4c8ddf57fcda remove redundant private function absolute_pathname
Carlo de Falco <cdf@users.sourceforge.net>
parents: 14860
diff changeset
627 end_try_catch
4c8ddf57fcda remove redundant private function absolute_pathname
Carlo de Falco <cdf@users.sourceforge.net>
parents: 14860
diff changeset
628 endif
4c8ddf57fcda remove redundant private function absolute_pathname
Carlo de Falco <cdf@users.sourceforge.net>
parents: 14860
diff changeset
629 local_list = canonicalize_file_name (local_list);
6496
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
630 else
20726
25d676f9619c Preface error() messages with name of function when possible.
Rik <rik@octave.org>
parents: 20708
diff changeset
631 error ("pkg: specify a local_list file, or request an output argument");
6496
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
632 endif
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
633
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
634 case "global_list"
20475
7fa1970a655d pkg.m: drop check of nargout value, the interpreter already does that.
Carnë Draug <carandraug@octave.org>
parents: 19833
diff changeset
635 if (isempty (files) && ! nargout)
19187
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
636 disp (global_list);
20475
7fa1970a655d pkg.m: drop check of nargout value, the interpreter already does that.
Carnë Draug <carandraug@octave.org>
parents: 19833
diff changeset
637 elseif (isempty (files) && nargout)
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10401
diff changeset
638 local_packages = global_list;
20475
7fa1970a655d pkg.m: drop check of nargout value, the interpreter already does that.
Carnë Draug <carandraug@octave.org>
parents: 19833
diff changeset
639 elseif (numel (files) == 1 && ! nargout && ischar (files{1}))
15000
4c8ddf57fcda remove redundant private function absolute_pathname
Carlo de Falco <cdf@users.sourceforge.net>
parents: 14860
diff changeset
640 global_list = files{1};
19593
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
641 if (! exist (global_list, "file"))
15000
4c8ddf57fcda remove redundant private function absolute_pathname
Carlo de Falco <cdf@users.sourceforge.net>
parents: 14860
diff changeset
642 try
4c8ddf57fcda remove redundant private function absolute_pathname
Carlo de Falco <cdf@users.sourceforge.net>
parents: 14860
diff changeset
643 ## Force file to be created
4c8ddf57fcda remove redundant private function absolute_pathname
Carlo de Falco <cdf@users.sourceforge.net>
parents: 14860
diff changeset
644 fclose (fopen (files{1}, "wt"));
4c8ddf57fcda remove redundant private function absolute_pathname
Carlo de Falco <cdf@users.sourceforge.net>
parents: 14860
diff changeset
645 catch
20726
25d676f9619c Preface error() messages with name of function when possible.
Rik <rik@octave.org>
parents: 20708
diff changeset
646 error ("pkg: cannot create file %s", global_list);
15000
4c8ddf57fcda remove redundant private function absolute_pathname
Carlo de Falco <cdf@users.sourceforge.net>
parents: 14860
diff changeset
647 end_try_catch
4c8ddf57fcda remove redundant private function absolute_pathname
Carlo de Falco <cdf@users.sourceforge.net>
parents: 14860
diff changeset
648 endif
4c8ddf57fcda remove redundant private function absolute_pathname
Carlo de Falco <cdf@users.sourceforge.net>
parents: 14860
diff changeset
649 global_list = canonicalize_file_name (global_list);
6496
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
650 else
20726
25d676f9619c Preface error() messages with name of function when possible.
Rik <rik@octave.org>
parents: 20708
diff changeset
651 error ("pkg: specify a global_list file, or request an output argument");
6496
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
652 endif
6645
81eb28d50cee [project @ 2007-05-21 21:05:54 by dbateman]
dbateman
parents: 6634
diff changeset
653
81eb28d50cee [project @ 2007-05-21 21:05:54 by dbateman]
dbateman
parents: 6634
diff changeset
654 case "rebuild"
81eb28d50cee [project @ 2007-05-21 21:05:54 by dbateman]
dbateman
parents: 6634
diff changeset
655 if (global_install)
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11547
diff changeset
656 global_packages = rebuild (prefix, archprefix, global_list, files,
21624
cf227735d5fd pkg: remove support for autoload (automatically loading package at start).
Carnë Draug <carandraug@octave.org>
parents: 21546
diff changeset
657 verbose);
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10401
diff changeset
658 global_packages = save_order (global_packages);
27573
0cedd1e23c1f Adapt path styles for pkg.m on Windows (bug #57083)
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 26856
diff changeset
659 if (ispc)
0cedd1e23c1f Adapt path styles for pkg.m on Windows (bug #57083)
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 26856
diff changeset
660 ## On Windows ensure LFN paths are saved rather than 8.3 style paths
0cedd1e23c1f Adapt path styles for pkg.m on Windows (bug #57083)
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 26856
diff changeset
661 global_packages = standardize_paths (global_packages);
0cedd1e23c1f Adapt path styles for pkg.m on Windows (bug #57083)
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 26856
diff changeset
662 endif
27707
377f069841c1 Make packages installation dirs in global octave_packages file relative
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 27574
diff changeset
663 global_packages = make_rel_paths (global_packages);
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10401
diff changeset
664 save (global_list, "global_packages");
20475
7fa1970a655d pkg.m: drop check of nargout value, the interpreter already does that.
Carnë Draug <carandraug@octave.org>
parents: 19833
diff changeset
665 if (nargout)
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10401
diff changeset
666 local_packages = global_packages;
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10401
diff changeset
667 endif
6645
81eb28d50cee [project @ 2007-05-21 21:05:54 by dbateman]
dbateman
parents: 6634
diff changeset
668 else
19187
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
669 local_packages = rebuild (prefix, archprefix, local_list, files,
21624
cf227735d5fd pkg: remove support for autoload (automatically loading package at start).
Carnë Draug <carandraug@octave.org>
parents: 21546
diff changeset
670 verbose);
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10401
diff changeset
671 local_packages = save_order (local_packages);
27573
0cedd1e23c1f Adapt path styles for pkg.m on Windows (bug #57083)
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 26856
diff changeset
672 if (ispc)
0cedd1e23c1f Adapt path styles for pkg.m on Windows (bug #57083)
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 26856
diff changeset
673 local_packages = standardize_paths (local_packages);
0cedd1e23c1f Adapt path styles for pkg.m on Windows (bug #57083)
Philip Nienhuis <prnienhuis@users.sf.net>
parents: 26856
diff changeset
674 endif
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10401
diff changeset
675 save (local_list, "local_packages");
20475
7fa1970a655d pkg.m: drop check of nargout value, the interpreter already does that.
Carnë Draug <carandraug@octave.org>
parents: 19833
diff changeset
676 if (! nargout)
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10401
diff changeset
677 clear ("local_packages");
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10401
diff changeset
678 endif
6645
81eb28d50cee [project @ 2007-05-21 21:05:54 by dbateman]
dbateman
parents: 6634
diff changeset
679 endif
81eb28d50cee [project @ 2007-05-21 21:05:54 by dbateman]
dbateman
parents: 6634
diff changeset
680
6675
f938c7018d28 [project @ 2007-05-31 19:31:14 by dbateman]
dbateman
parents: 6663
diff changeset
681 case "build"
19187
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
682 if (numel (files) < 2)
20726
25d676f9619c Preface error() messages with name of function when possible.
Rik <rik@octave.org>
parents: 20708
diff changeset
683 error ("pkg: build action requires build directory and at least one filename");
6675
f938c7018d28 [project @ 2007-05-31 19:31:14 by dbateman]
dbateman
parents: 6663
diff changeset
684 endif
21518
2ee20a290d61 pkg build: complete rewrite of the logic behind binary packages.
Carnë Draug <carandraug@octave.org>
parents: 21434
diff changeset
685 build (files{1}, files(2:end), verbose);
6675
f938c7018d28 [project @ 2007-05-31 19:31:14 by dbateman]
dbateman
parents: 6663
diff changeset
686
7497
bb7cc90cdc5e added describe command to pkg
carlo@guglielmo.local
parents: 7329
diff changeset
687 case "describe"
19187
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
688 ## FIXME: name of the output variables is inconsistent with their content
20475
7fa1970a655d pkg.m: drop check of nargout value, the interpreter already does that.
Carnë Draug <carandraug@octave.org>
parents: 19833
diff changeset
689 if (nargout)
7fa1970a655d pkg.m: drop check of nargout value, the interpreter already does that.
Carnë Draug <carandraug@octave.org>
parents: 19833
diff changeset
690 [local_packages, global_packages] = describe (files, verbose,
7fa1970a655d pkg.m: drop check of nargout value, the interpreter already does that.
Carnë Draug <carandraug@octave.org>
parents: 19833
diff changeset
691 local_list, global_list);
7fa1970a655d pkg.m: drop check of nargout value, the interpreter already does that.
Carnë Draug <carandraug@octave.org>
parents: 19833
diff changeset
692 else
7fa1970a655d pkg.m: drop check of nargout value, the interpreter already does that.
Carnë Draug <carandraug@octave.org>
parents: 19833
diff changeset
693 describe (files, verbose, local_list, global_list);
7fa1970a655d pkg.m: drop check of nargout value, the interpreter already does that.
Carnë Draug <carandraug@octave.org>
parents: 19833
diff changeset
694 endif
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11547
diff changeset
695
12778
0ca5672d5f1a Implement pkg update command
Lukas Reichlin <lukas.reichlin@gmail.com>
parents: 12710
diff changeset
696 case "update"
20475
7fa1970a655d pkg.m: drop check of nargout value, the interpreter already does that.
Carnë Draug <carandraug@octave.org>
parents: 19833
diff changeset
697 installed_pkgs_lst = installed_packages (local_list, global_list);
25031
f2f813a55eec pkg: remove update of listed packages (actually do 70490bb1f59d)
Carnë Draug <carandraug@octave.org>
parents: 24966
diff changeset
698
26207
b964092ad9f8 pkg.m: Allow updating a list of supplied packages, instead of all (bug #48151).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 26100
diff changeset
699 ## Explicit list of packages to update, rather than all packages
20475
7fa1970a655d pkg.m: drop check of nargout value, the interpreter already does that.
Carnë Draug <carandraug@octave.org>
parents: 19833
diff changeset
700 if (numel (files) > 0)
26207
b964092ad9f8 pkg.m: Allow updating a list of supplied packages, instead of all (bug #48151).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 26100
diff changeset
701 update_lst = {};
b964092ad9f8 pkg.m: Allow updating a list of supplied packages, instead of all (bug #48151).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 26100
diff changeset
702 installed_names = cellfun (@(idx) idx.name, installed_pkgs_lst,
b964092ad9f8 pkg.m: Allow updating a list of supplied packages, instead of all (bug #48151).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 26100
diff changeset
703 "UniformOutput", false);
b964092ad9f8 pkg.m: Allow updating a list of supplied packages, instead of all (bug #48151).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 26100
diff changeset
704 for i = 1:numel (files)
b964092ad9f8 pkg.m: Allow updating a list of supplied packages, instead of all (bug #48151).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 26100
diff changeset
705 idx = find (strcmp (files{i}, installed_names), 1);
b964092ad9f8 pkg.m: Allow updating a list of supplied packages, instead of all (bug #48151).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 26100
diff changeset
706 if (isempty (idx))
b964092ad9f8 pkg.m: Allow updating a list of supplied packages, instead of all (bug #48151).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 26100
diff changeset
707 warning ("pkg: package %s is not installed - skipping update",
b964092ad9f8 pkg.m: Allow updating a list of supplied packages, instead of all (bug #48151).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 26100
diff changeset
708 files{i});
b964092ad9f8 pkg.m: Allow updating a list of supplied packages, instead of all (bug #48151).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 26100
diff changeset
709 else
b964092ad9f8 pkg.m: Allow updating a list of supplied packages, instead of all (bug #48151).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 26100
diff changeset
710 update_lst = [ update_lst, installed_pkgs_lst(idx) ];
b964092ad9f8 pkg.m: Allow updating a list of supplied packages, instead of all (bug #48151).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 26100
diff changeset
711 endif
b964092ad9f8 pkg.m: Allow updating a list of supplied packages, instead of all (bug #48151).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 26100
diff changeset
712 endfor
b964092ad9f8 pkg.m: Allow updating a list of supplied packages, instead of all (bug #48151).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 26100
diff changeset
713 installed_pkgs_lst = update_lst;
20475
7fa1970a655d pkg.m: drop check of nargout value, the interpreter already does that.
Carnë Draug <carandraug@octave.org>
parents: 19833
diff changeset
714 endif
25031
f2f813a55eec pkg: remove update of listed packages (actually do 70490bb1f59d)
Carnë Draug <carandraug@octave.org>
parents: 24966
diff changeset
715
20475
7fa1970a655d pkg.m: drop check of nargout value, the interpreter already does that.
Carnë Draug <carandraug@octave.org>
parents: 19833
diff changeset
716 for i = 1:numel (installed_pkgs_lst)
7fa1970a655d pkg.m: drop check of nargout value, the interpreter already does that.
Carnë Draug <carandraug@octave.org>
parents: 19833
diff changeset
717 installed_pkg_name = installed_pkgs_lst{i}.name;
7fa1970a655d pkg.m: drop check of nargout value, the interpreter already does that.
Carnë Draug <carandraug@octave.org>
parents: 19833
diff changeset
718 installed_pkg_version = installed_pkgs_lst{i}.version;
21998
cf5db742f552 pkg: warn and continue updating on non-forge packages (bug #48294)
Mike Miller <mtmiller@octave.org>
parents: 21954
diff changeset
719 try
cf5db742f552 pkg: warn and continue updating on non-forge packages (bug #48294)
Mike Miller <mtmiller@octave.org>
parents: 21954
diff changeset
720 forge_pkg_version = get_forge_pkg (installed_pkg_name);
cf5db742f552 pkg: warn and continue updating on non-forge packages (bug #48294)
Mike Miller <mtmiller@octave.org>
parents: 21954
diff changeset
721 catch
25841
0d4b88086f36 doc: use "Octave Forge" spelling in a few more instances
Mike Miller <mtmiller@octave.org>
parents: 25836
diff changeset
722 warning ("pkg: package %s not found on Octave Forge - skipping update\n",
21998
cf5db742f552 pkg: warn and continue updating on non-forge packages (bug #48294)
Mike Miller <mtmiller@octave.org>
parents: 21954
diff changeset
723 installed_pkg_name);
cf5db742f552 pkg: warn and continue updating on non-forge packages (bug #48294)
Mike Miller <mtmiller@octave.org>
parents: 21954
diff changeset
724 forge_pkg_version = "0";
cf5db742f552 pkg: warn and continue updating on non-forge packages (bug #48294)
Mike Miller <mtmiller@octave.org>
parents: 21954
diff changeset
725 end_try_catch
20475
7fa1970a655d pkg.m: drop check of nargout value, the interpreter already does that.
Carnë Draug <carandraug@octave.org>
parents: 19833
diff changeset
726 if (compare_versions (forge_pkg_version, installed_pkg_version, ">"))
7fa1970a655d pkg.m: drop check of nargout value, the interpreter already does that.
Carnë Draug <carandraug@octave.org>
parents: 19833
diff changeset
727 feval (@pkg, "install", "-forge", installed_pkg_name);
18556
4daf647c86c3 Implement pkg update pkgnametoupdate (Bug #41732)
John Donoghue <john.donoghue@ieee.org>
parents: 17744
diff changeset
728 endif
20475
7fa1970a655d pkg.m: drop check of nargout value, the interpreter already does that.
Carnë Draug <carandraug@octave.org>
parents: 19833
diff changeset
729 endfor
12778
0ca5672d5f1a Implement pkg update command
Lukas Reichlin <lukas.reichlin@gmail.com>
parents: 12710
diff changeset
730
28064
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
731 case "test"
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
732 if (isempty (files))
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
733 error ("pkg: test action requires at least one package name");
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
734 endif
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
735 ## Make sure the requested packages are loaded
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
736 orig_path = path ();
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
737 load_packages (files, deps, local_list, global_list);
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
738 ## Test packages one by one
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
739 installed_pkgs_lst = installed_packages (local_list, global_list, files);
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
740 unwind_protect
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
741 for i = 1:numel (installed_pkgs_lst)
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
742 printf ("Testing functions in package '%s':\n", files{i});
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
743 installed_pkgs_dirs = {installed_pkgs_lst{i}.dir, ...
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
744 installed_pkgs_lst{i}.archprefix};
28666
6b964cf58ed4 Fix typos in commit f4426602b5f8.
Markus Mützel <markus.muetzel@gmx.de>
parents: 28664
diff changeset
745 installed_pkgs_dirs = ...
6b964cf58ed4 Fix typos in commit f4426602b5f8.
Markus Mützel <markus.muetzel@gmx.de>
parents: 28664
diff changeset
746 installed_pkgs_dirs (! cellfun (@isempty, installed_pkgs_dirs));
28064
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
747 ## For local installs installed_pkgs_dirs contains the same subdirs
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
748 installed_pkgs_dirs = unique (installed_pkgs_dirs);
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
749 if (! isempty (installed_pkgs_dirs))
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
750 ## FIXME invoke another test routine once that is available.
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
751 ## Until then __run_test_suite__.m will do the job fine enough
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
752 __run_test_suite__ ({installed_pkgs_dirs{:}}, {});
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
753 endif
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
754 endfor
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
755 unwind_protect_cleanup
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
756 ## Restore load path back to its original value before loading packages
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
757 path (orig_path);
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
758 end_unwind_protect
fbed279b7074 pkg: add "test" command to test all functions in a package (bug #41215)
Mike Miller <mtmiller@octave.org>
parents: 28023
diff changeset
759
6496
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
760 otherwise
20726
25d676f9619c Preface error() messages with name of function when possible.
Rik <rik@octave.org>
parents: 20708
diff changeset
761 error ("pkg: invalid action. See 'help pkg' for available actions");
6496
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
762 endswitch
19187
b54093acb8fe ver.m: Overhaul function.
Rik <rik@octave.org>
parents: 18576
diff changeset
763
6496
e0acfe7c3f7b [project @ 2007-04-05 17:19:30 by jwe]
jwe
parents: 6440
diff changeset
764 endfunction