Mercurial > octave

comparison scripts/pkg/pkg.m @ 28713:28d2511f2af2 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: grammarcheck documentation ahead of 6.1 release. * basics.txi, external.txi, file-io.cc, audiodevinfo.cc, ode15i.m, ode15s.m, ode23.m, ode23s.m, ode45.m, pkg.m, get_inverse_dependencies.m, legend.m, gui_mainfcn.m, hgtransform.m, __debug_octave__.m: Grammarcheck documentation ahead of 6.1 release.
author Rik <rik@octave.org>
date Thu, 10 Sep 2020 14:28:33 -0700
parents 6b964cf58ed4
children d8dcb36bb904
comparison
equal deleted inserted replaced
28711:29b627624aaa 28713:28d2511f2af2
27 ## @deftypefn {} {} pkg @var{command} @var{pkg_name} 27 ## @deftypefn {} {} pkg @var{command} @var{pkg_name}
28 ## @deftypefnx {} {} pkg @var{command} @var{option} @var{pkg_name} 28 ## @deftypefnx {} {} pkg @var{command} @var{option} @var{pkg_name}
29 ## @deftypefnx {} {[@var{out1}, @dots{}] =} pkg (@var{command}, @dots{} ) 29 ## @deftypefnx {} {[@var{out1}, @dots{}] =} pkg (@var{command}, @dots{} )
30 ## Manage or query packages (groups of add-on functions) for Octave. 30 ## Manage or query packages (groups of add-on functions) for Octave.
31 ## 31 ##
32 ## Packages can be installed globally (i.e. for all users of the system) or 32 ## Packages can be installed globally (i.e., for all users of the system) or
33 ## locally (i.e. for the current user only). 33 ## locally (i.e., for the current user only).
34 ## 34 ##
35 ## Global packages are by default installed in the "global packages store". 35 ## Global packages are installed by default in a system-wide location. This is
36 ## That is usually located in a subdirectory of the folder where Octave itself 36 ## usually a subdirectory of the folder where Octave itself is installed.
37 ## is installed in. Therefore, Octave needs write access to this folder to 37 ## Therefore, Octave needs write access to this folder to install global
38 ## install global packages. That usually means that Octave has to run with root 38 ## packages. That usually means that Octave has to run with root access (or
39 ## access (or "Run as administrator") to be able to install packages globally. 39 ## "Run as administrator" on Windows) to be able to install packages globally.
40 ## 40 ##
41 ## In contrast, local packages are by default installed in the user's profile 41 ## In contrast, local packages are installed by default in the user's
42 ## and are only available to that specific user. Usually, they can be installed 42 ## home directory (profile on Windows) and are only available to that specific
43 ## without root access (or administrative privileges). 43 ## user. Usually, they can be installed without root access (or administrative
44 ## privileges).
44 ## 45 ##
45 ## For global and local packages, there are separate databases holding the 46 ## For global and local packages, there are separate databases holding the
46 ## information about the installed packages. If some package is installed 47 ## information about the installed packages. If some package is installed
47 ## globally as well as locally, the local installation takes precedence over 48 ## globally as well as locally, the local installation takes precedence over
48 ## ("shadows") the global one. Which package installation (global or local) is 49 ## ("shadows") the global one. Which package installation (global or local) is
61 ## Packages must be loaded before they can be used. When loading a package, 62 ## Packages must be loaded before they can be used. When loading a package,
62 ## Octave performs the following tasks: 63 ## Octave performs the following tasks:
63 ## @enumerate 64 ## @enumerate
64 ## @item 65 ## @item
65 ## If the package depends on other packages (and @code{pkg load} is called 66 ## If the package depends on other packages (and @code{pkg load} is called
66 ## without the @qcode{"-nodeps"} option), the package is not loaded immediately. 67 ## without the @qcode{"-nodeps"} option), the package is not loaded
67 ## Instead, those dependencies are loaded first (recursively if needed). 68 ## immediately. Instead, those dependencies are loaded first (recursively if
69 ## needed).
68 ## 70 ##
69 ## @item 71 ## @item
70 ## When all dependencies are satified, the package's subdirectories are added to 72 ## When all dependencies are satified, the package's subdirectories are
71 ## the search path. 73 ## added to the search path.
72 ## @end enumerate 74 ## @end enumerate
73 ## 75 ##
74 ## This load order leads to functions that are provided by dependencies being 76 ## This load order leads to functions that are provided by dependencies being
75 ## potentially shadowed by functions of the same name that are provided by 77 ## potentially shadowed by functions of the same name that are provided by
76 ## dependers. 78 ## dependers.
77 ## 79 ##
78 ## Each time, a package is added to the search path, initialization script(s) 80 ## Each time, a package is added to the search path, initialization script(s)
79 ## for the package are automatically executed if they are provided by the 81 ## for the package are automatically executed if they are provided by the
80 ## package. 82 ## package.
81 ## 83 ##
82 ## Depending on the value of @var{command} and on the number of requested return 84 ## Depending on the value of @var{command} and on the number of requested
83 ## arguments, @code{pkg} can be used to perform several tasks. Possible values 85 ## return arguments, @code{pkg} can be used to perform several tasks.
84 ## for @var{command} are: 86 ## Possible values for @var{command} are:
85 ## 87 ##
86 ## @table @samp 88 ## @table @samp
87 ## 89 ##
88 ## @item install 90 ## @item install
89 ## Install named packages. For example, 91 ## Install named packages. For example,
364 ## Rebuild the package database from the installed directories. This can 366 ## Rebuild the package database from the installed directories. This can
365 ## be used in cases where the package database has been corrupted. 367 ## be used in cases where the package database has been corrupted.
366 ## 368 ##
367 ## @item test 369 ## @item test
368 ## Perform the built-in self tests contained in all functions provided by 370 ## Perform the built-in self tests contained in all functions provided by
369 ## the named packages. For example, 371 ## the named packages. For example:
370 ## 372 ##
371 ## @example 373 ## @example
372 ## pkg test image 374 ## pkg test image
373 ## @end example 375 ## @end example
374 ## 376 ##