Mercurial > octave-nkf
annotate doc/interpreter/package.txi @ 19627:446c46af4b42 stable
strip trailing whitespace from most source files
* Makefile.am, NEWS, build-aux/common.mk, configure.ac,
doc/Makefile.am, doc/doxyhtml/Makefile.am,
doc/interpreter/Makefile.am, doc/interpreter/arith.txi,
doc/interpreter/audio.txi, doc/interpreter/basics.txi,
doc/interpreter/bugs.txi, doc/interpreter/container.txi,
doc/interpreter/cp-idx.txi, doc/interpreter/data.txi,
doc/interpreter/debug.txi, doc/interpreter/diagperm.txi,
doc/interpreter/diffeq.txi, doc/interpreter/doccheck/README,
doc/interpreter/doccheck/spellcheck, doc/interpreter/emacs.txi,
doc/interpreter/errors.txi, doc/interpreter/eval.txi,
doc/interpreter/expr.txi, doc/interpreter/external.txi,
doc/interpreter/fn-idx.txi, doc/interpreter/func.txi,
doc/interpreter/geometry.txi, doc/interpreter/geometryimages.m,
doc/interpreter/gpl.txi, doc/interpreter/grammar.txi,
doc/interpreter/gui.txi, doc/interpreter/image.txi,
doc/interpreter/install.txi, doc/interpreter/interp.txi,
doc/interpreter/interpimages.m, doc/interpreter/intro.txi,
doc/interpreter/io.txi, doc/interpreter/java.txi,
doc/interpreter/linalg.txi, doc/interpreter/macros.texi,
doc/interpreter/matrix.txi, doc/interpreter/munge-texi.pl,
doc/interpreter/nonlin.txi, doc/interpreter/numbers.txi,
doc/interpreter/obsolete.txi, doc/interpreter/octave-config.1,
doc/interpreter/octave.texi, doc/interpreter/oop.txi,
doc/interpreter/op-idx.txi, doc/interpreter/optim.txi,
doc/interpreter/package.txi, doc/interpreter/plot.txi,
doc/interpreter/poly.txi, doc/interpreter/preface.txi,
doc/interpreter/quad.txi, doc/interpreter/set.txi,
doc/interpreter/signal.txi, doc/interpreter/sparse.txi,
doc/interpreter/sparseimages.m, doc/interpreter/splineimages.m,
doc/interpreter/stats.txi, doc/interpreter/stmt.txi,
doc/interpreter/strings.txi, doc/interpreter/system.txi,
doc/interpreter/testfun.txi, doc/interpreter/tips.txi,
doc/interpreter/var.txi, doc/interpreter/vectorize.txi,
doc/liboctave/Makefile.am, doc/liboctave/array.texi,
doc/liboctave/bugs.texi, doc/liboctave/cp-idx.texi,
doc/liboctave/dae.texi, doc/liboctave/diffeq.texi,
doc/liboctave/error.texi, doc/liboctave/factor.texi,
doc/liboctave/fn-idx.texi, doc/liboctave/gpl.texi,
doc/liboctave/install.texi, doc/liboctave/intro.texi,
doc/liboctave/liboctave.texi, doc/liboctave/matvec.texi,
doc/liboctave/nleqn.texi, doc/liboctave/nlfunc.texi,
doc/liboctave/ode.texi, doc/liboctave/optim.texi,
doc/liboctave/preface.texi, doc/liboctave/quad.texi,
doc/liboctave/range.texi, doc/refcard/Makefile.am,
doc/refcard/refcard.tex, etc/HACKING, etc/NEWS.1, etc/NEWS.2,
etc/NEWS.3, etc/OLD-ChangeLogs/ChangeLog,
etc/OLD-ChangeLogs/doc-ChangeLog,
etc/OLD-ChangeLogs/scripts-ChangeLog,
etc/OLD-ChangeLogs/src-ChangeLog, etc/OLD-ChangeLogs/test-ChangeLog,
etc/PROJECTS, etc/README.Cygwin, etc/README.MacOS, etc/README.MinGW,
etc/README.gnuplot, etc/gdbinit, etc/icons/Makefile.am,
examples/@polynomial/end.m, examples/@polynomial/subsasgn.m,
examples/Makefile.am, examples/standalonebuiltin.cc,
libgui/Makefile.am, libgui/qterminal/libqterminal/README,
libgui/qterminal/libqterminal/unix/BlockArray.cpp,
libgui/qterminal/libqterminal/unix/BlockArray.h,
libgui/qterminal/libqterminal/unix/Character.h,
libgui/qterminal/libqterminal/unix/CharacterColor.h,
libgui/qterminal/libqterminal/unix/Emulation.cpp,
libgui/qterminal/libqterminal/unix/Emulation.h,
libgui/qterminal/libqterminal/unix/Filter.cpp,
libgui/qterminal/libqterminal/unix/Filter.h,
libgui/qterminal/libqterminal/unix/History.cpp,
libgui/qterminal/libqterminal/unix/History.h,
libgui/qterminal/libqterminal/unix/KeyboardTranslator.cpp,
libgui/qterminal/libqterminal/unix/KeyboardTranslator.h,
libgui/qterminal/libqterminal/unix/LineFont.h,
libgui/qterminal/libqterminal/unix/QUnixTerminalImpl.cpp,
libgui/qterminal/libqterminal/unix/QUnixTerminalImpl.h,
libgui/qterminal/libqterminal/unix/Screen.cpp,
libgui/qterminal/libqterminal/unix/Screen.h,
libgui/qterminal/libqterminal/unix/ScreenWindow.cpp,
libgui/qterminal/libqterminal/unix/ScreenWindow.h,
libgui/qterminal/libqterminal/unix/TerminalCharacterDecoder.cpp,
libgui/qterminal/libqterminal/unix/TerminalCharacterDecoder.h,
libgui/qterminal/libqterminal/unix/Vt102Emulation.h,
libgui/qterminal/libqterminal/win32/QWinTerminalImpl.cpp,
libgui/qterminal/qterminal/main.cpp,
libgui/src/m-editor/file-editor-tab.cc, libgui/src/octave-gui.cc,
libgui/src/octave-qt-link.cc, libinterp/corefcn/data.cc,
libinterp/corefcn/defun-int.h, libinterp/corefcn/det.cc,
libinterp/corefcn/gl2ps-renderer.cc, libinterp/corefcn/graphics.cc,
libinterp/corefcn/graphics.in.h, libinterp/corefcn/ls-mat5.cc,
libinterp/corefcn/lu.cc, libinterp/corefcn/oct-tex-parser.yy,
libinterp/corefcn/oct-tex-symbols.in, libinterp/corefcn/quadcc.cc,
libinterp/corefcn/zfstream.cc, libinterp/dldfcn/__eigs__.cc,
libinterp/dldfcn/__voronoi__.cc, libinterp/gendoc.pl,
libinterp/genprops.awk, libinterp/mk-errno-list, libinterp/mk-pkg-add,
libinterp/mkbuiltins, libinterp/mkdefs, libinterp/mkdocs,
libinterp/mkops, libinterp/octave-value/ov-java.cc,
libinterp/parse-tree/lex.ll, libinterp/parse-tree/oct-parse.in.yy,
libinterp/parse-tree/octave.gperf, liboctave/Makefile.am,
liboctave/array/Array.cc, liboctave/array/module.mk,
liboctave/cruft/daspk/datv.f, liboctave/cruft/daspk/dcnst0.f,
liboctave/cruft/daspk/dcnstr.f, liboctave/cruft/daspk/ddasic.f,
liboctave/cruft/daspk/ddasid.f, liboctave/cruft/daspk/ddasik.f,
liboctave/cruft/daspk/ddaspk.f, liboctave/cruft/daspk/ddstp.f,
liboctave/cruft/daspk/ddwnrm.f, liboctave/cruft/daspk/dfnrmd.f,
liboctave/cruft/daspk/dfnrmk.f, liboctave/cruft/daspk/dhels.f,
liboctave/cruft/daspk/dheqr.f, liboctave/cruft/daspk/dinvwt.f,
liboctave/cruft/daspk/dlinsd.f, liboctave/cruft/daspk/dlinsk.f,
liboctave/cruft/daspk/dmatd.f, liboctave/cruft/daspk/dnedd.f,
liboctave/cruft/daspk/dnedk.f, liboctave/cruft/daspk/dnsd.f,
liboctave/cruft/daspk/dnsid.f, liboctave/cruft/daspk/dnsik.f,
liboctave/cruft/daspk/dnsk.f, liboctave/cruft/daspk/dorth.f,
liboctave/cruft/daspk/dslvd.f, liboctave/cruft/daspk/dslvk.f,
liboctave/cruft/daspk/dspigm.f, liboctave/cruft/daspk/dyypnw.f,
liboctave/cruft/dasrt/ddasrt.f, liboctave/cruft/dasrt/drchek.f,
liboctave/cruft/dassl/ddaslv.f, liboctave/cruft/dassl/ddassl.f,
liboctave/cruft/misc/blaswrap.c, liboctave/cruft/misc/module.mk,
liboctave/cruft/odepack/cfode.f, liboctave/cruft/odepack/dlsode.f,
liboctave/cruft/odepack/ewset.f, liboctave/cruft/odepack/intdy.f,
liboctave/cruft/odepack/prepj.f, liboctave/cruft/odepack/sintdy.f,
liboctave/cruft/odepack/slsode.f, liboctave/cruft/odepack/solsy.f,
liboctave/cruft/odepack/ssolsy.f, liboctave/cruft/odepack/stode.f,
liboctave/cruft/odepack/vnorm.f, liboctave/cruft/ranlib/Basegen.doc,
liboctave/cruft/ranlib/README, liboctave/cruft/ranlib/genbet.f,
liboctave/cruft/ranlib/genexp.f, liboctave/cruft/ranlib/gennch.f,
liboctave/cruft/ranlib/gennf.f, liboctave/cruft/ranlib/gennor.f,
liboctave/cruft/ranlib/getsd.f, liboctave/cruft/ranlib/initgn.f,
liboctave/cruft/ranlib/phrtsd.f, liboctave/cruft/ranlib/randlib.fdoc,
liboctave/cruft/ranlib/setsd.f, liboctave/cruft/ranlib/tstgmn.for,
liboctave/cruft/ranlib/tstmid.for, liboctave/cruft/slatec-fn/atanh.f,
liboctave/cruft/slatec-fn/datanh.f,
liboctave/cruft/slatec-fn/xgmainc.f,
liboctave/cruft/slatec-fn/xsgmainc.f, liboctave/numeric/module.mk,
liboctave/operators/mk-ops.awk, liboctave/operators/mx-ops,
liboctave/operators/sparse-mk-ops.awk,
liboctave/operators/sparse-mx-ops, liboctave/operators/vx-ops,
liboctave/util/module.mk, run-octave.in, scripts/@ftp/ftp.m,
scripts/audio/wavread.m, scripts/deprecated/java_convert_matrix.m,
scripts/deprecated/java_debug.m, scripts/deprecated/java_invoke.m,
scripts/deprecated/java_new.m,
scripts/deprecated/java_unsigned_conversion.m,
scripts/deprecated/javafields.m, scripts/deprecated/javamethods.m,
scripts/deprecated/shell_cmd.m, scripts/general/accumarray.m,
scripts/general/display.m, scripts/general/fieldnames.m,
scripts/general/interp1.m, scripts/general/interp2.m,
scripts/general/interp3.m, scripts/general/isa.m,
scripts/general/methods.m, scripts/general/sortrows.m,
scripts/geometry/convhull.m, scripts/geometry/delaunay.m,
scripts/geometry/delaunay3.m, scripts/geometry/delaunayn.m,
scripts/geometry/griddata.m, scripts/geometry/griddatan.m,
scripts/geometry/voronoi.m, scripts/geometry/voronoin.m,
scripts/gui/guihandles.m, scripts/gui/inputdlg.m,
scripts/gui/listdlg.m, scripts/gui/msgbox.m, scripts/gui/questdlg.m,
scripts/gui/uigetfile.m, scripts/gui/waitbar.m, scripts/gui/warndlg.m,
scripts/help/doc.m, scripts/help/help.m, scripts/help/type.m,
scripts/image/bone.m, scripts/image/cmpermute.m,
scripts/image/cmunique.m, scripts/image/colorcube.m,
scripts/image/colormap.m, scripts/image/contrast.m,
scripts/image/gray2ind.m, scripts/image/image.m,
scripts/image/imshow.m, scripts/image/ind2gray.m, scripts/image/jet.m,
scripts/image/rgb2ntsc.m, scripts/image/spinmap.m,
scripts/io/importdata.m, scripts/io/strread.m, scripts/io/textread.m,
scripts/io/textscan.m, scripts/java/java_get.m,
scripts/java/java_set.m, scripts/java/javaaddpath.m,
scripts/java/javaclasspath.m, scripts/java/javamem.m,
scripts/linear-algebra/linsolve.m, scripts/linear-algebra/qzhess.m,
scripts/miscellaneous/debug.m, scripts/miscellaneous/desktop.m,
scripts/miscellaneous/dir.m, scripts/miscellaneous/dos.m,
scripts/miscellaneous/edit.m, scripts/miscellaneous/fact.m,
scripts/miscellaneous/getappdata.m, scripts/miscellaneous/inputname.m,
scripts/miscellaneous/license.m, scripts/miscellaneous/ls_command.m,
scripts/miscellaneous/run.m, scripts/miscellaneous/setfield.m,
scripts/miscellaneous/unix.m, scripts/miscellaneous/ver.m,
scripts/mk-pkg-add, scripts/mkdoc.pl,
scripts/optimization/fminsearch.m, scripts/optimization/optimset.m,
scripts/optimization/sqp.m, scripts/pkg/pkg.m,
scripts/pkg/private/create_pkgadddel.m,
scripts/pkg/private/fix_depends.m, scripts/pkg/private/install.m,
scripts/plot/appearance/axis.m, scripts/plot/appearance/box.m,
scripts/plot/appearance/clabel.m, scripts/plot/appearance/daspect.m,
scripts/plot/appearance/datetick.m, scripts/plot/appearance/grid.m,
scripts/plot/appearance/legend.m, scripts/plot/appearance/orient.m,
scripts/plot/appearance/shading.m, scripts/plot/appearance/text.m,
scripts/plot/appearance/title.m, scripts/plot/appearance/xlabel.m,
scripts/plot/appearance/ylabel.m, scripts/plot/appearance/zlabel.m,
scripts/plot/draw/area.m, scripts/plot/draw/bar.m,
scripts/plot/draw/barh.m, scripts/plot/draw/colorbar.m,
scripts/plot/draw/contour.m, scripts/plot/draw/contour3.m,
scripts/plot/draw/contourf.m, scripts/plot/draw/ellipsoid.m,
scripts/plot/draw/errorbar.m, scripts/plot/draw/ezcontour.m,
scripts/plot/draw/ezcontourf.m, scripts/plot/draw/ezmesh.m,
scripts/plot/draw/ezpolar.m, scripts/plot/draw/fill.m,
scripts/plot/draw/fplot.m, scripts/plot/draw/hist.m,
scripts/plot/draw/meshc.m, scripts/plot/draw/meshz.m,
scripts/plot/draw/pareto.m, scripts/plot/draw/patch.m,
scripts/plot/draw/peaks.m, scripts/plot/draw/pie.m,
scripts/plot/draw/pie3.m, scripts/plot/draw/plot.m,
scripts/plot/draw/plotyy.m, scripts/plot/draw/private/__bar__.m,
scripts/plot/draw/private/__contour__.m,
scripts/plot/draw/private/__errplot__.m,
scripts/plot/draw/private/__ezplot__.m,
scripts/plot/draw/private/__patch__.m,
scripts/plot/draw/private/__stem__.m, scripts/plot/draw/rectangle.m,
scripts/plot/draw/ribbon.m, scripts/plot/draw/rose.m,
scripts/plot/draw/scatter.m, scripts/plot/draw/scatter3.m,
scripts/plot/draw/semilogx.m, scripts/plot/draw/shrinkfaces.m,
scripts/plot/draw/sombrero.m, scripts/plot/draw/sphere.m,
scripts/plot/draw/stairs.m, scripts/plot/draw/stem.m,
scripts/plot/draw/stemleaf.m, scripts/plot/draw/surf.m,
scripts/plot/draw/surface.m, scripts/plot/draw/surfc.m,
scripts/plot/draw/surfl.m, scripts/plot/draw/surfnorm.m,
scripts/plot/draw/tetramesh.m, scripts/plot/draw/trimesh.m,
scripts/plot/draw/triplot.m, scripts/plot/draw/trisurf.m,
scripts/plot/util/__gnuplot_drawnow__.m,
scripts/plot/util/__plt_get_axis_arg__.m, scripts/plot/util/axes.m,
scripts/plot/util/clf.m, scripts/plot/util/copyobj.m,
scripts/plot/util/figure.m, scripts/plot/util/gcbo.m,
scripts/plot/util/graphics_toolkit.m, scripts/plot/util/hggroup.m,
scripts/plot/util/meshgrid.m, scripts/plot/util/newplot.m,
scripts/plot/util/print.m,
scripts/plot/util/private/__add_default_menu__.m,
scripts/plot/util/private/__fltk_print__.m,
scripts/plot/util/private/__gnuplot_print__.m,
scripts/plot/util/private/__print_parse_opts__.m,
scripts/plot/util/refreshdata.m, scripts/plot/util/subplot.m,
scripts/polynomial/conv.m, scripts/polynomial/poly.m,
scripts/polynomial/polyeig.m, scripts/polynomial/polyfit.m,
scripts/polynomial/polyval.m,
scripts/polynomial/private/__splinefit__.m,
scripts/polynomial/spline.m, scripts/prefs/prefdir.m,
scripts/prefs/preferences.m, scripts/prefs/private/prefsfile.m,
scripts/prefs/rmpref.m, scripts/signal/freqz.m,
scripts/signal/module.mk, scripts/sparse/eigs.m, scripts/sparse/pcg.m,
scripts/sparse/private/__sprand_impl__.m, scripts/sparse/sprand.m,
scripts/sparse/sprandn.m, scripts/sparse/spy.m, scripts/sparse/svds.m,
scripts/specfun/expint.m, scripts/specfun/factor.m,
scripts/special-matrix/gallery.m, scripts/special-matrix/hankel.m,
scripts/special-matrix/toeplitz.m, scripts/startup/inputrc,
scripts/statistics/base/kurtosis.m, scripts/statistics/base/moment.m,
scripts/statistics/base/qqplot.m, scripts/statistics/base/var.m,
scripts/statistics/distributions/betarnd.m,
scripts/statistics/distributions/binoinv.m,
scripts/statistics/distributions/binopdf.m,
scripts/statistics/distributions/binornd.m,
scripts/statistics/distributions/cauchy_rnd.m,
scripts/statistics/distributions/chi2rnd.m,
scripts/statistics/distributions/discrete_pdf.m,
scripts/statistics/distributions/discrete_rnd.m,
scripts/statistics/distributions/empirical_rnd.m,
scripts/statistics/distributions/exprnd.m,
scripts/statistics/distributions/frnd.m,
scripts/statistics/distributions/gamrnd.m,
scripts/statistics/distributions/geornd.m,
scripts/statistics/distributions/hygernd.m,
scripts/statistics/distributions/kolmogorov_smirnov_cdf.m,
scripts/statistics/distributions/laplace_cdf.m,
scripts/statistics/distributions/laplace_pdf.m,
scripts/statistics/distributions/logistic_cdf.m,
scripts/statistics/distributions/logistic_pdf.m,
scripts/statistics/distributions/lognrnd.m,
scripts/statistics/distributions/nbincdf.m,
scripts/statistics/distributions/nbininv.m,
scripts/statistics/distributions/nbinpdf.m,
scripts/statistics/distributions/nbinrnd.m,
scripts/statistics/distributions/normrnd.m,
scripts/statistics/distributions/poissinv.m,
scripts/statistics/distributions/poissrnd.m,
scripts/statistics/distributions/tinv.m,
scripts/statistics/distributions/trnd.m,
scripts/statistics/distributions/unidcdf.m,
scripts/statistics/distributions/unidpdf.m,
scripts/statistics/distributions/unidrnd.m,
scripts/statistics/distributions/unifrnd.m,
scripts/statistics/distributions/wblrnd.m,
scripts/statistics/models/module.mk,
scripts/statistics/tests/kruskal_wallis_test.m,
scripts/strings/base2dec.m, scripts/strings/deblank.m,
scripts/strings/dec2base.m, scripts/strings/dec2bin.m,
scripts/strings/dec2hex.m, scripts/strings/mat2str.m,
scripts/strings/ostrsplit.m, scripts/strings/regexptranslate.m,
scripts/strings/str2num.m, scripts/strings/strcat.m,
scripts/strings/strjoin.m, scripts/strings/strsplit.m,
scripts/strings/strtok.m, scripts/strings/strtrim.m,
scripts/strings/strtrunc.m, scripts/strings/substr.m,
scripts/testfun/__run_test_suite__.m, scripts/testfun/speed.m,
scripts/testfun/test.m, scripts/time/asctime.m,
scripts/time/datenum.m, scripts/time/datevec.m,
scripts/time/weekday.m, src/Makefile.am, test/Makefile.am,
test/build-bc-overload-tests.sh, test/build-sparse-tests.sh,
test/jit.tst, test/line-continue.tst: Strip trailing whitespace.
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Tue, 20 Jan 2015 08:26:57 -0500 |
| parents | 1197f04eec09 |
| children | 4197fc428c7d |
| rev | line source |
|---|---|
|
17744
d63878346099
maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents:
17281
diff
changeset
|
1 @c Copyright (C) 2007-2013 Søren Hauberg |
| 7018 | 2 @c |
| 3 @c This file is part of Octave. | |
| 4 @c | |
| 5 @c Octave is free software; you can redistribute it and/or modify it | |
| 6 @c under the terms of the GNU General Public License as published by the | |
| 7 @c Free Software Foundation; either version 3 of the License, or (at | |
| 8 @c your option) any later version. | |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19018
diff
changeset
|
9 @c |
| 7018 | 10 @c Octave is distributed in the hope that it will be useful, but WITHOUT |
| 11 @c ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 12 @c FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 13 @c for more details. | |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19018
diff
changeset
|
14 @c |
| 7018 | 15 @c You should have received a copy of the GNU General Public License |
| 16 @c along with Octave; see the file COPYING. If not, see | |
| 17 @c <http://www.gnu.org/licenses/>. | |
| 6537 | 18 |
| 19 @node Packages | |
| 20 @chapter Packages | |
| 21 | |
| 22 Since Octave is Free Software users are encouraged to share their | |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
23 programs amongst each other. To aid this sharing Octave supports the |
|
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
24 installation of extra packages. The `Octave-Forge' project is a |
| 6537 | 25 community-maintained set of packages that can be downloaded and |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
26 installed in Octave. At the time of writing the `Octave-Forge' project |
|
16792
b157ba28f123
doc: Use Texinfo @url command consistently throughout documentation.
Rik <rik@octave.org>
parents:
16772
diff
changeset
|
27 can be found online at @url{http://octave.sourceforge.net}, but |
| 6537 | 28 since the Internet is an ever-changing place this may not be true at |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
29 the time of reading. Therefore it is recommended to see the Octave |
| 6537 | 30 website for an updated reference. |
| 31 | |
| 32 @menu | |
|
16852
0133f1634687
doc: packages are not loaded by default
Carnë Draug <carandraug+dev@gmail.com>
parents:
16846
diff
changeset
|
33 * Installing and Removing Packages:: |
|
0133f1634687
doc: packages are not loaded by default
Carnë Draug <carandraug+dev@gmail.com>
parents:
16846
diff
changeset
|
34 * Using Packages:: |
|
0133f1634687
doc: packages are not loaded by default
Carnë Draug <carandraug+dev@gmail.com>
parents:
16846
diff
changeset
|
35 * Administrating Packages:: |
|
0133f1634687
doc: packages are not loaded by default
Carnë Draug <carandraug+dev@gmail.com>
parents:
16846
diff
changeset
|
36 * Creating Packages:: |
| 6537 | 37 @end menu |
| 38 | |
| 6538 | 39 @findex pkg |
| 6537 | 40 @node Installing and Removing Packages |
| 41 @section Installing and Removing Packages | |
| 42 | |
|
9307
c2923c27c877
Various documentation improvements
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
43 Assuming a package is available in the file @file{image-1.0.0.tar.gz} |
| 8828 | 44 it can be installed from the Octave prompt with the command |
| 6537 | 45 |
| 46 @example | |
| 47 pkg install image-1.0.0.tar.gz | |
| 48 @end example | |
| 49 | |
| 50 @noindent | |
| 51 If the package is installed successfully nothing will be printed on | |
| 52 the prompt, but if an error occurred during installation it will be | |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
53 reported. It is possible to install several packages at once by |
| 6537 | 54 writing several package files after the @code{pkg install} command. |
| 55 If a different version of the package is already installed it will | |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
56 be removed prior to installing the new package. This makes it easy to |
| 6537 | 57 upgrade and downgrade the version of a package, but makes it |
| 58 impossible to have several versions of the same package installed at | |
| 59 once. | |
| 60 | |
| 61 To see which packages are installed type | |
| 62 | |
| 63 @example | |
| 64 @group | |
| 65 pkg list | |
| 7031 | 66 @print{} Package Name | Version | Installation directory |
| 67 @print{} --------------+---------+----------------------- | |
| 68 @print{} image *| 1.0.0 | /home/jwe/octave/image-1.0.0 | |
| 6537 | 69 @end group |
| 70 @end example | |
| 71 | |
| 72 @noindent | |
| 73 In this case only version 1.0.0 of the @code{image} package is | |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
74 installed. The @qcode{'*'} character next to the package name shows that the |
| 6616 | 75 image package is loaded and ready for use. |
| 6537 | 76 |
| 77 It is possible to remove a package from the system using the | |
| 78 @code{pkg uninstall} command like this | |
| 79 | |
| 80 @example | |
| 81 pkg uninstall image | |
| 82 @end example | |
| 83 | |
| 84 @noindent | |
| 85 If the package is removed successfully nothing will be printed in the | |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
86 prompt, but if an error occurred it will be reported. It should be |
| 6537 | 87 noted that the package file used for installation is not needed for |
| 88 removal, and that only the package name as reported by @code{pkg list} | |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
89 should be used when removing a package. It is possible to remove |
| 6537 | 90 several packages at once by writing several package names after the |
| 91 @code{pkg uninstall} command. | |
| 92 | |
| 93 To minimize the amount of code duplication between packages it is | |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
94 possible that one package depends on another one. If a package |
| 6537 | 95 depends on another, it will check if that package is installed |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
96 during installation. If it is not, an error will be reported and |
|
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
97 the package will not be installed. This behavior can be disabled |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10791
diff
changeset
|
98 by passing the @option{-nodeps} flag to the @code{pkg install} |
| 6537 | 99 command |
| 100 | |
| 101 @example | |
| 102 pkg install -nodeps my_package_with_dependencies.tar.gz | |
| 103 @end example | |
| 104 | |
| 105 @noindent | |
| 106 Since the installed package expects its dependencies to be installed | |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
107 it may not function correctly. Because of this it is not recommended |
| 6537 | 108 to disable dependency checking. |
| 109 | |
|
8540
1eb16d930f3c
package.txi: @DOCSTRING for pkg
John W. Eaton <jwe@octave.org>
parents:
8347
diff
changeset
|
110 @DOCSTRING(pkg) |
|
1eb16d930f3c
package.txi: @DOCSTRING for pkg
John W. Eaton <jwe@octave.org>
parents:
8347
diff
changeset
|
111 |
| 6537 | 112 @node Using Packages |
| 113 @section Using Packages | |
| 114 | |
|
16852
0133f1634687
doc: packages are not loaded by default
Carnë Draug <carandraug+dev@gmail.com>
parents:
16846
diff
changeset
|
115 By default installed packages are not available from the Octave prompt, |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19018
diff
changeset
|
116 but it is possible to control this using the @code{pkg load} and |
|
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19018
diff
changeset
|
117 @code{pkg unload} commands. The functions from a package can be |
|
16852
0133f1634687
doc: packages are not loaded by default
Carnë Draug <carandraug+dev@gmail.com>
parents:
16846
diff
changeset
|
118 added to the Octave path by typing |
|
0133f1634687
doc: packages are not loaded by default
Carnë Draug <carandraug+dev@gmail.com>
parents:
16846
diff
changeset
|
119 |
|
0133f1634687
doc: packages are not loaded by default
Carnë Draug <carandraug+dev@gmail.com>
parents:
16846
diff
changeset
|
120 @example |
|
0133f1634687
doc: packages are not loaded by default
Carnë Draug <carandraug+dev@gmail.com>
parents:
16846
diff
changeset
|
121 pkg load package_name |
|
0133f1634687
doc: packages are not loaded by default
Carnë Draug <carandraug+dev@gmail.com>
parents:
16846
diff
changeset
|
122 @end example |
|
0133f1634687
doc: packages are not loaded by default
Carnë Draug <carandraug+dev@gmail.com>
parents:
16846
diff
changeset
|
123 |
|
0133f1634687
doc: packages are not loaded by default
Carnë Draug <carandraug+dev@gmail.com>
parents:
16846
diff
changeset
|
124 @noindent |
|
0133f1634687
doc: packages are not loaded by default
Carnë Draug <carandraug+dev@gmail.com>
parents:
16846
diff
changeset
|
125 where @code{package_name} is the name of the package to be added |
|
0133f1634687
doc: packages are not loaded by default
Carnë Draug <carandraug+dev@gmail.com>
parents:
16846
diff
changeset
|
126 to the path. |
|
0133f1634687
doc: packages are not loaded by default
Carnë Draug <carandraug+dev@gmail.com>
parents:
16846
diff
changeset
|
127 |
|
0133f1634687
doc: packages are not loaded by default
Carnë Draug <carandraug+dev@gmail.com>
parents:
16846
diff
changeset
|
128 In much the same way a package can be removed from the Octave path by |
|
0133f1634687
doc: packages are not loaded by default
Carnë Draug <carandraug+dev@gmail.com>
parents:
16846
diff
changeset
|
129 typing |
| 6537 | 130 |
| 131 @example | |
| 132 pkg unload package_name | |
| 133 @end example | |
| 134 | |
| 135 @node Administrating Packages | |
| 136 @section Administrating Packages | |
| 137 | |
| 138 On UNIX-like systems it is possible to make both per-user and | |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
139 system-wide installations of a package. If the user performing the |
| 6537 | 140 installation is @code{root} the packages will be installed in a |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19018
diff
changeset
|
141 system-wide directory that defaults to |
|
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19018
diff
changeset
|
142 @file{OCTAVE_HOME/share/octave/packages/}. If the user is not |
| 6537 | 143 @code{root} the default installation directory is |
|
9307
c2923c27c877
Various documentation improvements
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
144 @file{~/octave/}. Packages will be installed in a subdirectory of the |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
145 installation directory that will be named after the package. It is |
| 6537 | 146 possible to change the installation directory by using the |
| 147 @code{pkg prefix} command | |
| 148 | |
| 149 @example | |
| 150 pkg prefix new_installation_directory | |
| 151 @end example | |
| 152 | |
| 153 @noindent | |
| 154 The current installation directory can be retrieved by typing | |
| 155 | |
| 156 @example | |
| 157 current_installation_directory = pkg prefix | |
| 158 @end example | |
| 159 | |
| 160 To function properly the package manager needs to keep some | |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
161 information about the installed packages. For per-user packages this |
|
9307
c2923c27c877
Various documentation improvements
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
162 information is by default stored in the file @file{~/.octave_packages} |
| 6537 | 163 and for system-wide installations it is stored in |
|
9307
c2923c27c877
Various documentation improvements
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
164 @file{OCTAVE_HOME/share/octave/octave_packages}. The path to the |
| 6537 | 165 per-user file can be changed with the @code{pkg local_list} command |
| 166 | |
| 167 @example | |
| 168 pkg local_list /path/to/new_file | |
| 169 @end example | |
| 170 | |
| 171 @noindent | |
| 172 For system-wide installations this can be changed in the same way | |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
173 using the @code{pkg global_list} command. If these commands are |
| 6537 | 174 called without a new path, the current path will be returned. |
| 175 | |
| 176 @node Creating Packages | |
| 177 @section Creating Packages | |
| 178 | |
| 179 Internally a package is simply a gzipped tar file that contains a | |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
180 top level directory of any given name. This directory will in the |
| 6537 | 181 following be referred to as @code{package} and may contain the |
|
13864
a03e96aa4977
NEWS file of packages now expected to be in the package root. Also support ONEWS file as per GNU the standards. Updated manual accordingly.
Carnë Draug <carandraug+dev@gmail.com>
parents:
12167
diff
changeset
|
182 following files: |
| 6537 | 183 |
| 184 @table @code | |
|
16178
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
15545
diff
changeset
|
185 @item package/CITATION |
|
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
15545
diff
changeset
|
186 This is am optional file describing instructions on how to cite |
|
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
15545
diff
changeset
|
187 the package for publication. It will be displayed verbatim by the |
|
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
15545
diff
changeset
|
188 function @code{citation}. |
|
3a93af21d206
New function citation() to display citation information (patch #7960)
Carnë Draug <carandraug@octave.org>
parents:
15545
diff
changeset
|
189 |
| 6537 | 190 @item package/COPYING |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
191 This is a required file containing the license of the package. No |
|
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
192 restrictions is made on the license in general. If however the |
| 6537 | 193 package contains dynamically linked functions the license must be |
| 194 compatible with the GNU General Public License. | |
| 195 | |
|
13864
a03e96aa4977
NEWS file of packages now expected to be in the package root. Also support ONEWS file as per GNU the standards. Updated manual accordingly.
Carnë Draug <carandraug+dev@gmail.com>
parents:
12167
diff
changeset
|
196 @item package/DESCRIPTION |
|
a03e96aa4977
NEWS file of packages now expected to be in the package root. Also support ONEWS file as per GNU the standards. Updated manual accordingly.
Carnë Draug <carandraug+dev@gmail.com>
parents:
12167
diff
changeset
|
197 This is a required file containing information about the package. |
|
a03e96aa4977
NEWS file of packages now expected to be in the package root. Also support ONEWS file as per GNU the standards. Updated manual accordingly.
Carnë Draug <carandraug+dev@gmail.com>
parents:
12167
diff
changeset
|
198 @xref{The DESCRIPTION File}, for details on this file. |
|
a03e96aa4977
NEWS file of packages now expected to be in the package root. Also support ONEWS file as per GNU the standards. Updated manual accordingly.
Carnë Draug <carandraug+dev@gmail.com>
parents:
12167
diff
changeset
|
199 |
|
a03e96aa4977
NEWS file of packages now expected to be in the package root. Also support ONEWS file as per GNU the standards. Updated manual accordingly.
Carnë Draug <carandraug+dev@gmail.com>
parents:
12167
diff
changeset
|
200 @item package/ChangeLog |
|
a03e96aa4977
NEWS file of packages now expected to be in the package root. Also support ONEWS file as per GNU the standards. Updated manual accordingly.
Carnë Draug <carandraug+dev@gmail.com>
parents:
12167
diff
changeset
|
201 This is an optional file describing all the changes made to the |
|
a03e96aa4977
NEWS file of packages now expected to be in the package root. Also support ONEWS file as per GNU the standards. Updated manual accordingly.
Carnë Draug <carandraug+dev@gmail.com>
parents:
12167
diff
changeset
|
202 package source files. |
|
a03e96aa4977
NEWS file of packages now expected to be in the package root. Also support ONEWS file as per GNU the standards. Updated manual accordingly.
Carnë Draug <carandraug+dev@gmail.com>
parents:
12167
diff
changeset
|
203 |
| 6537 | 204 @item package/INDEX |
| 205 This is an optional file describing the functions provided by the | |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
206 package. If this file is not given then one with be created |
| 6537 | 207 automatically from the functions in the package and the |
|
13864
a03e96aa4977
NEWS file of packages now expected to be in the package root. Also support ONEWS file as per GNU the standards. Updated manual accordingly.
Carnë Draug <carandraug+dev@gmail.com>
parents:
12167
diff
changeset
|
208 @code{Categories} keyword in the @file{DESCRIPTION} file. |
|
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
209 @xref{The INDEX File}, for details on this file. |
| 6537 | 210 |
|
13864
a03e96aa4977
NEWS file of packages now expected to be in the package root. Also support ONEWS file as per GNU the standards. Updated manual accordingly.
Carnë Draug <carandraug+dev@gmail.com>
parents:
12167
diff
changeset
|
211 @item package/NEWS |
|
a03e96aa4977
NEWS file of packages now expected to be in the package root. Also support ONEWS file as per GNU the standards. Updated manual accordingly.
Carnë Draug <carandraug+dev@gmail.com>
parents:
12167
diff
changeset
|
212 This is an optional file describing all user-visible changes worth |
|
14038
b0cdd60db5e5
doc: Grammarcheck documentation ahead of 3.6.0 release.
Rik <octave@nomad.inbox5.com>
parents:
13864
diff
changeset
|
213 mentioning. As this file increases on size, old entries can be moved |
|
13864
a03e96aa4977
NEWS file of packages now expected to be in the package root. Also support ONEWS file as per GNU the standards. Updated manual accordingly.
Carnë Draug <carandraug+dev@gmail.com>
parents:
12167
diff
changeset
|
214 into @file{package/ONEWS}. |
|
a03e96aa4977
NEWS file of packages now expected to be in the package root. Also support ONEWS file as per GNU the standards. Updated manual accordingly.
Carnë Draug <carandraug+dev@gmail.com>
parents:
12167
diff
changeset
|
215 |
|
a03e96aa4977
NEWS file of packages now expected to be in the package root. Also support ONEWS file as per GNU the standards. Updated manual accordingly.
Carnë Draug <carandraug+dev@gmail.com>
parents:
12167
diff
changeset
|
216 @item package/ONEWS |
|
a03e96aa4977
NEWS file of packages now expected to be in the package root. Also support ONEWS file as per GNU the standards. Updated manual accordingly.
Carnë Draug <carandraug+dev@gmail.com>
parents:
12167
diff
changeset
|
217 This is an optional file describing old entries from the @file{NEWS} file. |
|
a03e96aa4977
NEWS file of packages now expected to be in the package root. Also support ONEWS file as per GNU the standards. Updated manual accordingly.
Carnë Draug <carandraug+dev@gmail.com>
parents:
12167
diff
changeset
|
218 |
|
15288
92476462d01f
doc: index PKG_ADD and PKG_DEL
John W. Eaton <jwe@octave.org>
parents:
14859
diff
changeset
|
219 @cindex PKG_ADD |
|
17097
e7a059a9a644
doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents:
16852
diff
changeset
|
220 @anchor{XREFPKG_ADD} |
| 6537 | 221 @item package/PKG_ADD |
| 222 An optional file that includes commands that are run when the package | |
|
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9079
diff
changeset
|
223 is added to the users path. Note that @w{@code{PKG_ADD}} directives in the |
| 6537 | 224 source code of the package will also be added to this file by the |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
225 Octave package manager. Note that symbolic links are to be avoided in |
| 6537 | 226 packages, as symbolic links do not exist on some file systems, and so |
| 227 a typical use for this file is the replacement of the symbolic link | |
| 228 | |
| 229 @example | |
| 230 ln -s foo.oct bar.oct | |
| 231 @end example | |
| 232 | |
| 233 @noindent | |
| 234 with an autoload directive like | |
| 235 | |
| 236 @example | |
| 237 autoload ('bar', which ('foo')); | |
| 238 @end example | |
| 239 | |
| 240 @noindent | |
|
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
241 @xref{PKG_ADD and PKG_DEL Directives}, for details on @w{@code{PKG_ADD}} |
| 6537 | 242 directives. |
| 243 | |
|
15288
92476462d01f
doc: index PKG_ADD and PKG_DEL
John W. Eaton <jwe@octave.org>
parents:
14859
diff
changeset
|
244 @cindex PKG_DEL |
|
17097
e7a059a9a644
doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents:
16852
diff
changeset
|
245 @anchor{XREFPKG_DEL} |
| 6537 | 246 @item package/PKG_DEL |
| 247 An optional file that includes commands that are run when the package | |
|
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9079
diff
changeset
|
248 is removed from the users path. Note that @w{@code{PKG_DEL}} directives in |
| 6537 | 249 the source code of the package will also be added to this file by the |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19018
diff
changeset
|
250 Octave package manager. |
|
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
251 @xref{PKG_ADD and PKG_DEL Directives}, for details on @w{@code{PKG_DEL}} |
| 6537 | 252 directives. |
| 253 | |
| 254 @item package/pre_install.m | |
|
16846
e6401864d791
doc: fix documentation about packages.
Carnë Draug <carandraug+dev@gmail.com>
parents:
16792
diff
changeset
|
255 This is an optional function that is run prior to the installation of a |
|
e6401864d791
doc: fix documentation about packages.
Carnë Draug <carandraug+dev@gmail.com>
parents:
16792
diff
changeset
|
256 package. This function is called with a single argument, a struct with |
|
e6401864d791
doc: fix documentation about packages.
Carnë Draug <carandraug+dev@gmail.com>
parents:
16792
diff
changeset
|
257 fields names after the data in the @file{DESCRIPTION}, and the paths where |
|
e6401864d791
doc: fix documentation about packages.
Carnë Draug <carandraug+dev@gmail.com>
parents:
16792
diff
changeset
|
258 the package functions will be installed. |
| 6537 | 259 |
| 260 @item package/post_install.m | |
|
16846
e6401864d791
doc: fix documentation about packages.
Carnë Draug <carandraug+dev@gmail.com>
parents:
16792
diff
changeset
|
261 This is an optional function that is run after the installation of a |
|
e6401864d791
doc: fix documentation about packages.
Carnë Draug <carandraug+dev@gmail.com>
parents:
16792
diff
changeset
|
262 package. This function is called with a single argument, a struct with |
|
e6401864d791
doc: fix documentation about packages.
Carnë Draug <carandraug+dev@gmail.com>
parents:
16792
diff
changeset
|
263 fields names after the data in the @file{DESCRIPTION}, and the paths where |
|
e6401864d791
doc: fix documentation about packages.
Carnë Draug <carandraug+dev@gmail.com>
parents:
16792
diff
changeset
|
264 the package functions were installed. |
| 6537 | 265 |
| 266 @item package/on_uninstall.m | |
|
16846
e6401864d791
doc: fix documentation about packages.
Carnë Draug <carandraug+dev@gmail.com>
parents:
16792
diff
changeset
|
267 This is an optional function that is run prior to the removal of a |
|
e6401864d791
doc: fix documentation about packages.
Carnë Draug <carandraug+dev@gmail.com>
parents:
16792
diff
changeset
|
268 package. This function is called with a single argument, a struct with |
|
e6401864d791
doc: fix documentation about packages.
Carnë Draug <carandraug+dev@gmail.com>
parents:
16792
diff
changeset
|
269 fields names after the data in the @file{DESCRIPTION}, the paths where |
|
e6401864d791
doc: fix documentation about packages.
Carnë Draug <carandraug+dev@gmail.com>
parents:
16792
diff
changeset
|
270 the package functions are installed, and whether the package is currently |
|
e6401864d791
doc: fix documentation about packages.
Carnë Draug <carandraug+dev@gmail.com>
parents:
16792
diff
changeset
|
271 loaded. |
| 6537 | 272 @end table |
| 273 | |
|
19018
1197f04eec09
doc: minor typo fixes and copy-paste error.
Colin Macdonald <cbm@m.fsf.org>
parents:
17756
diff
changeset
|
274 Besides the above mentioned files, a package can also contain one or |
|
13864
a03e96aa4977
NEWS file of packages now expected to be in the package root. Also support ONEWS file as per GNU the standards. Updated manual accordingly.
Carnë Draug <carandraug+dev@gmail.com>
parents:
12167
diff
changeset
|
275 more of the following directories: |
| 6537 | 276 |
| 277 @table @code | |
| 278 @item package/inst | |
| 279 An optional directory containing any files that are directly installed | |
|
16852
0133f1634687
doc: packages are not loaded by default
Carnë Draug <carandraug+dev@gmail.com>
parents:
16846
diff
changeset
|
280 by the package. Typically this will include any @code{m}-files. |
| 6537 | 281 |
| 282 @item package/src | |
| 283 An optional directory containing code that must be built prior to the | |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
284 packages installation. The Octave package manager will execute |
|
9307
c2923c27c877
Various documentation improvements
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
285 @file{./configure} in this directory if this script exists, and will |
|
c2923c27c877
Various documentation improvements
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
286 then call @code{make} if a file @file{Makefile} exists in this |
|
12167
ad636c1f353b
Let pkg.m export environment variables MKOCTFILE, OCTAVE_CONFIG and OCTAVE.
Olaf Till <olaf.till@uni-jena.de>
parents:
11523
diff
changeset
|
287 directory. @code{make install} will however not be called. The |
|
ad636c1f353b
Let pkg.m export environment variables MKOCTFILE, OCTAVE_CONFIG and OCTAVE.
Olaf Till <olaf.till@uni-jena.de>
parents:
11523
diff
changeset
|
288 environment variables @env{MKOCTFILE}, @w{@env{OCTAVE_CONFIG}}, and |
|
ad636c1f353b
Let pkg.m export environment variables MKOCTFILE, OCTAVE_CONFIG and OCTAVE.
Olaf Till <olaf.till@uni-jena.de>
parents:
11523
diff
changeset
|
289 @env{OCTAVE} will be set to the full paths of the programs |
|
ad636c1f353b
Let pkg.m export environment variables MKOCTFILE, OCTAVE_CONFIG and OCTAVE.
Olaf Till <olaf.till@uni-jena.de>
parents:
11523
diff
changeset
|
290 @code{mkoctfile}, @code{octave-config}, and @code{octave}, respectively, |
|
ad636c1f353b
Let pkg.m export environment variables MKOCTFILE, OCTAVE_CONFIG and OCTAVE.
Olaf Till <olaf.till@uni-jena.de>
parents:
11523
diff
changeset
|
291 of the correct version when @code{configure} and @code{make} are |
|
ad636c1f353b
Let pkg.m export environment variables MKOCTFILE, OCTAVE_CONFIG and OCTAVE.
Olaf Till <olaf.till@uni-jena.de>
parents:
11523
diff
changeset
|
292 called. If a file called @code{FILES} exists all files listed there |
|
ad636c1f353b
Let pkg.m export environment variables MKOCTFILE, OCTAVE_CONFIG and OCTAVE.
Olaf Till <olaf.till@uni-jena.de>
parents:
11523
diff
changeset
|
293 will be copied to the @code{inst} directory, so they also will be |
|
ad636c1f353b
Let pkg.m export environment variables MKOCTFILE, OCTAVE_CONFIG and OCTAVE.
Olaf Till <olaf.till@uni-jena.de>
parents:
11523
diff
changeset
|
294 installed. If the @code{FILES} file doesn't exist, @file{src/*.m} and |
|
ad636c1f353b
Let pkg.m export environment variables MKOCTFILE, OCTAVE_CONFIG and OCTAVE.
Olaf Till <olaf.till@uni-jena.de>
parents:
11523
diff
changeset
|
295 @file{src/*.oct} will be copied to the @code{inst} directory. |
| 6537 | 296 |
| 297 @item package/doc | |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
298 An optional directory containing documentation for the package. The |
| 6537 | 299 files in this directory will be directly installed in a sub-directory |
| 300 of the installed package for future reference. | |
| 301 | |
| 302 @item package/bin | |
| 303 An optional directory containing files that will be added to the | |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10791
diff
changeset
|
304 Octave @w{@env{EXEC_PATH}} when the package is loaded. This might contain |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
305 external scripts, etc., called by functions within the package. |
| 6537 | 306 @end table |
| 307 | |
| 308 @menu | |
|
16852
0133f1634687
doc: packages are not loaded by default
Carnë Draug <carandraug+dev@gmail.com>
parents:
16846
diff
changeset
|
309 * The DESCRIPTION File:: |
|
0133f1634687
doc: packages are not loaded by default
Carnë Draug <carandraug+dev@gmail.com>
parents:
16846
diff
changeset
|
310 * The INDEX File:: |
|
0133f1634687
doc: packages are not loaded by default
Carnë Draug <carandraug+dev@gmail.com>
parents:
16846
diff
changeset
|
311 * PKG_ADD and PKG_DEL Directives:: |
|
17756
9aff1c9fd70f
doc: Add missing functions to manual.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
312 * Missing Components:: |
| 6537 | 313 @end menu |
| 314 | |
| 315 @node The DESCRIPTION File | |
| 316 @subsection The DESCRIPTION File | |
| 317 | |
|
13864
a03e96aa4977
NEWS file of packages now expected to be in the package root. Also support ONEWS file as per GNU the standards. Updated manual accordingly.
Carnë Draug <carandraug+dev@gmail.com>
parents:
12167
diff
changeset
|
318 The @file{DESCRIPTION} file contains various information about the |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
319 package, such as its name, author, and version. This file has a very |
| 6537 | 320 simple format |
| 321 | |
| 322 @itemize | |
| 323 @item | |
|
9307
c2923c27c877
Various documentation improvements
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
324 Lines starting with @samp{#} are comments. |
| 6537 | 325 |
| 326 @item | |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19018
diff
changeset
|
327 Lines starting with a blank character are continuations from the |
| 6537 | 328 previous line. |
| 329 | |
| 330 @item | |
| 331 Everything else is of the form @code{NameOfOption: ValueOfOption}. | |
| 332 @end itemize | |
| 333 | |
| 334 @noindent | |
|
13864
a03e96aa4977
NEWS file of packages now expected to be in the package root. Also support ONEWS file as per GNU the standards. Updated manual accordingly.
Carnë Draug <carandraug+dev@gmail.com>
parents:
12167
diff
changeset
|
335 The following is a simple example of a @file{DESCRIPTION} file |
| 6537 | 336 |
| 337 @example | |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
338 @group |
| 6537 | 339 Name: The name of my package |
| 340 Version: 1.0.0 | |
| 341 Date: 2007-18-04 | |
| 342 Author: The name (and possibly email) of the package author. | |
| 7031 | 343 Maintainer: The name (and possibly email) of the current |
| 344 package maintainer. | |
| 6537 | 345 Title: The title of the package |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
346 Description: A short description of the package. If this |
| 7031 | 347 description gets too long for one line it can continue |
| 348 on the next by adding a space to the beginning of the | |
| 349 following lines. | |
|
16852
0133f1634687
doc: packages are not loaded by default
Carnë Draug <carandraug+dev@gmail.com>
parents:
16846
diff
changeset
|
350 License: GPLv3+ |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
351 @end group |
| 6537 | 352 @end example |
| 353 | |
| 354 The package manager currently recognizes the following keywords | |
| 355 | |
| 356 @table @code | |
| 357 @item Name | |
| 358 Name of the package. | |
| 359 | |
| 360 @item Version | |
|
13864
a03e96aa4977
NEWS file of packages now expected to be in the package root. Also support ONEWS file as per GNU the standards. Updated manual accordingly.
Carnë Draug <carandraug+dev@gmail.com>
parents:
12167
diff
changeset
|
361 Version of the package. A package version must be 3 numbers separated |
|
19018
1197f04eec09
doc: minor typo fixes and copy-paste error.
Colin Macdonald <cbm@m.fsf.org>
parents:
17756
diff
changeset
|
362 by dots. |
| 6537 | 363 |
| 364 @item Date | |
| 365 Date of last update. | |
| 366 | |
| 367 @item Author | |
| 368 Original author of the package. | |
| 369 | |
| 370 @item Maintainer | |
| 371 Maintainer of the package. | |
| 372 | |
| 373 @item Title | |
| 374 A one line description of the package. | |
| 375 | |
| 376 @item Description | |
| 377 A one paragraph description of the package. | |
| 378 | |
| 379 @item Categories | |
|
13864
a03e96aa4977
NEWS file of packages now expected to be in the package root. Also support ONEWS file as per GNU the standards. Updated manual accordingly.
Carnë Draug <carandraug+dev@gmail.com>
parents:
12167
diff
changeset
|
380 Optional keyword describing the package (if no @file{INDEX} file is |
| 6537 | 381 given this is mandatory). |
| 382 | |
| 383 @item Problems | |
| 384 Optional list of known problems. | |
| 385 | |
| 386 @item Url | |
| 387 Optional list of homepages related to the package. | |
| 388 | |
| 389 @item Autoload | |
| 390 Optional field that sets the default loading behavior for the package. | |
| 391 If set to @code{yes}, @code{true} or @code{on}, then Octave will | |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
392 automatically load the package when starting. Otherwise the package |
|
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
393 must be manually loaded with the pkg load command. This default |
| 6537 | 394 behavior can be overridden when the package is installed. |
| 395 | |
| 396 @item Depends | |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
397 A list of other Octave packages that this package depends on. This can |
| 6537 | 398 include dependencies on particular versions, with a format |
| 399 | |
| 400 @example | |
| 401 Depends: package (>= 1.0.0) | |
| 402 @end example | |
| 403 | |
| 404 @noindent | |
| 405 Possible operators are @code{<}, @code{<=}, @code{==}, @code{>=} or | |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
406 @code{>}. If the part of the dependency in @code{()} is missing, any |
|
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
407 version of the package is acceptable. Multiple dependencies can be |
| 6537 | 408 defined either as a comma separated list or on separate @code{Depends} |
| 409 lines. | |
| 410 | |
| 411 @item License | |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
412 An optional short description of the used license (e.g., GPL version 3 |
|
13864
a03e96aa4977
NEWS file of packages now expected to be in the package root. Also support ONEWS file as per GNU the standards. Updated manual accordingly.
Carnë Draug <carandraug+dev@gmail.com>
parents:
12167
diff
changeset
|
413 or newer). This is optional since the file @file{COPYING} is mandatory. |
| 6537 | 414 |
| 415 @item SystemRequirements | |
| 416 These are the external install dependencies of the package and are not | |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
417 checked by the package manager. This is here as a hint to the |
|
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
418 distribution packager. They follow the same conventions as the |
| 6537 | 419 @code{Depends} keyword. |
| 420 | |
| 421 @item BuildRequires | |
| 422 These are the external build dependencies of the package and are not | |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
423 checked by the package manager. This is here as a hint to the |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19018
diff
changeset
|
424 distribution packager. They follow the same conventions as the |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
425 @code{Depends} keyword. Note that in general, packaging systems such |
| 6537 | 426 as @code{rpm} or @code{deb} and autoprobe the install dependencies |
| 427 from the build dependencies, and therefore the often a | |
| 428 @code{BuildRequires} dependency removes the need for a | |
| 429 @code{SystemRequirements} dependency. | |
| 430 | |
| 431 @end table | |
| 432 | |
| 433 @noindent | |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19018
diff
changeset
|
434 The developer is free to add additional arguments to the |
|
13864
a03e96aa4977
NEWS file of packages now expected to be in the package root. Also support ONEWS file as per GNU the standards. Updated manual accordingly.
Carnë Draug <carandraug+dev@gmail.com>
parents:
12167
diff
changeset
|
435 @file{DESCRIPTION} file for their own purposes. One further detail to |
|
8325
b93ac0586e4b
spelling corrections
Brian Gough<bjg@network-theory.co.uk>
parents:
8297
diff
changeset
|
436 aid the packager is that the @code{SystemRequirements} and |
|
8347
fa78cb8d8a5c
corrections for typos
Brian Gough<bjg@network-theory.co.uk>
parents:
8325
diff
changeset
|
437 @code{BuildRequires} keywords can have a distribution dependent section, |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
438 and the automatic build process will use these. An example of the |
| 6537 | 439 format of this is |
| 440 | |
| 441 @example | |
| 442 BuildRequires: libtermcap-devel [Mandriva] libtermcap2-devel | |
| 443 @end example | |
| 444 | |
| 445 @noindent | |
| 446 where the first package name will be used as a default and if the | |
| 447 RPMs are built on a Mandriva distribution, then the second package | |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19018
diff
changeset
|
448 name will be used instead. |
| 6537 | 449 |
|
11255
d682cd6669ac
Update info-based documentation menus to include new nodes.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
450 @node The INDEX File |
|
d682cd6669ac
Update info-based documentation menus to include new nodes.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
451 @subsection The INDEX File |
| 6537 | 452 |
|
13864
a03e96aa4977
NEWS file of packages now expected to be in the package root. Also support ONEWS file as per GNU the standards. Updated manual accordingly.
Carnë Draug <carandraug+dev@gmail.com>
parents:
12167
diff
changeset
|
453 The optional @file{INDEX} file provides a categorical view of the |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
454 functions in the package. This file has a very simple format |
| 6537 | 455 |
| 456 @itemize | |
|
9307
c2923c27c877
Various documentation improvements
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
457 @item Lines beginning with @samp{#} are comments. |
| 6537 | 458 |
| 459 @item The first non-comment line should look like this | |
| 460 | |
| 461 @example | |
| 462 toolbox >> Toolbox name | |
| 463 @end example | |
| 464 | |
| 465 @item Lines beginning with an alphabetical character indicates a new | |
| 466 category of functions. | |
| 467 | |
| 468 @item Lines starting with a white space character indicate that the | |
|
8347
fa78cb8d8a5c
corrections for typos
Brian Gough<bjg@network-theory.co.uk>
parents:
8325
diff
changeset
|
469 function names on the line belong to the last mentioned category. |
| 6537 | 470 @end itemize |
| 471 | |
| 472 @noindent | |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
473 The format can be summarized with the following example: |
| 6537 | 474 |
| 475 @example | |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
476 @group |
| 6537 | 477 # A comment |
| 478 toolbox >> Toolbox name | |
| 479 Category Name 1 | |
| 480 function1 function2 function3 | |
| 481 function4 | |
| 482 Category Name 2 | |
| 7007 | 483 function2 function5 |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
484 @end group |
| 6537 | 485 @end example |
| 486 | |
|
7496
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
487 If you wish to refer to a function that users might expect |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19018
diff
changeset
|
488 to find in your package but is not there, providing a work around or |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
489 pointing out that the function is available elsewhere, you can use: |
|
7496
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
490 |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
491 @example |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
492 fn = workaround description |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
493 @end example |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
494 |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
495 @noindent |
|
19627
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19018
diff
changeset
|
496 This workaround description will not appear when listing functions in the |
|
7496
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
497 package with @code{pkg describe} but they will be published |
|
10791
3140cb7a05a1
Add spellchecker scripts for Octave and run spellcheck of documentation
Rik <octave@nomad.inbox5.com>
parents:
9307
diff
changeset
|
498 in the HTML documentation online. |
|
3140cb7a05a1
Add spellchecker scripts for Octave and run spellcheck of documentation
Rik <octave@nomad.inbox5.com>
parents:
9307
diff
changeset
|
499 Workaround descriptions can use any HTML markup, but |
|
16852
0133f1634687
doc: packages are not loaded by default
Carnë Draug <carandraug+dev@gmail.com>
parents:
16846
diff
changeset
|
500 keep in mind that it will be enclosed in a bold-italic environment. |
|
7496
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
501 For the special case of: |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
502 |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
503 @example |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
504 fn = use <code>alternate expression</code> |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
505 @end example |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
506 |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
507 @noindent |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
508 the bold-italic is automatically suppressed. You will need |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
509 to use @code{<code>} even in references: |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
510 |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
511 @example |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
512 fn = use <a href="someothersite.html"><code>fn</code></a> |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
513 @end example |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
514 |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
515 @noindent |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
516 Sometimes functions are only partially compatible, in which |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
517 case you can list the non-compatible cases separately. To |
|
7496
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
518 refer to another function in the package, use @code{<f>fn</f>}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10791
diff
changeset
|
519 For example: |
|
7496
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
520 |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
521 @example |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
522 eig (a, b) = use <f>qz</f> |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
523 @end example |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
524 |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
525 @noindent |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
526 Since sites may have many missing functions, you can define |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
527 a macro rather than typing the same link over and again. |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
528 |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
529 @example |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
530 $id = expansion |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
531 @end example |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
532 |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
533 @noindent |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
534 defines the macro id. You can use @code{$id} anywhere in the |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10791
diff
changeset
|
535 description and it will be expanded. For example: |
|
7496
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
536 |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
537 @example |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
538 @group |
|
7496
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
539 $TSA = see <a href="link_to_spctools">SPC Tools</a> |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
540 arcov = $TSA <code>armcv</code> |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
541 @end group |
|
7496
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
542 @end example |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
543 |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
544 @noindent |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
545 id is any string of letters, numbers and @code{_}. |
|
e27f8afa99e5
better documentation on the INDEX file format
carlo@guglielmo.local
parents:
7031
diff
changeset
|
546 |
|
11255
d682cd6669ac
Update info-based documentation menus to include new nodes.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
547 @node PKG_ADD and PKG_DEL Directives |
|
d682cd6669ac
Update info-based documentation menus to include new nodes.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
548 @subsection PKG_ADD and PKG_DEL Directives |
| 6537 | 549 |
|
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9079
diff
changeset
|
550 If the package contains files called @w{@code{PKG_ADD}} or @w{@code{PKG_DEL}} |
| 6537 | 551 the commands in these files will be executed when the package is |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
552 added or removed from the users path. In some situations such files |
| 6537 | 553 are a bit cumbersome to maintain, so the package manager supports |
|
9079
4d610aba7347
Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
554 automatic creation of such files. If a source file in the package |
|
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9079
diff
changeset
|
555 contains a @w{@code{PKG_ADD}} or @w{@code{PKG_DEL}} directive they will be |
|
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9079
diff
changeset
|
556 added to either the @w{@code{PKG_ADD}} or @w{@code{PKG_DEL}} files. |
| 6537 | 557 |
|
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9079
diff
changeset
|
558 In @code{m}-files a @w{@code{PKG_ADD}} directive looks like this |
| 6537 | 559 |
| 560 @example | |
| 561 ## PKG_ADD: some_octave_command | |
| 562 @end example | |
| 563 | |
| 564 @noindent | |
| 565 Such lines should be added before the @code{function} keyword. | |
|
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9079
diff
changeset
|
566 In C++ files a @w{@code{PKG_ADD}} directive looks like this |
| 6537 | 567 |
| 568 @example | |
| 569 // PKG_ADD: some_octave_command | |
| 570 @end example | |
| 571 | |
| 572 @noindent | |
| 573 In both cases @code{some_octave_command} should be replaced by the | |
|
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9079
diff
changeset
|
574 command that should be placed in the @w{@code{PKG_ADD}} file. |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
575 @w{@code{PKG_DEL}} directives work in the same way, except the |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
576 @w{@code{PKG_ADD}} keyword is replaced with @w{@code{PKG_DEL}} and the commands |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
577 get added to the @w{@code{PKG_DEL}} file. |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
578 |
|
17756
9aff1c9fd70f
doc: Add missing functions to manual.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
579 @node Missing Components |
|
9aff1c9fd70f
doc: Add missing functions to manual.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
580 @subsection Missing Components |
|
9aff1c9fd70f
doc: Add missing functions to manual.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
581 |
|
9aff1c9fd70f
doc: Add missing functions to manual.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
582 If a package relies on a component, such as another Octave package, that may |
|
9aff1c9fd70f
doc: Add missing functions to manual.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
583 not be present it may be useful to install a function which informs users what |
|
9aff1c9fd70f
doc: Add missing functions to manual.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
584 to do when a particular component is missing. The function must be written by |
|
9aff1c9fd70f
doc: Add missing functions to manual.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
585 the package maintainer and registered with Octave using |
|
9aff1c9fd70f
doc: Add missing functions to manual.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
586 @code{missing_component_hook}. |
|
9aff1c9fd70f
doc: Add missing functions to manual.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
587 |
|
9aff1c9fd70f
doc: Add missing functions to manual.
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
588 @DOCSTRING(missing_component_hook) |