1  Octave Lang

1.1 Minimal Package

For a minimal octave package the files

  • [package]/COPYING
  • [package]/DESCRIPTION
  • [package]/NEWS
  • [package]/inst
    • “inst contains the m-files”

are recommended.

1.2 Example

  • pkg-minimal/COPYING
  • pkg-minimal/DESCRIPTION
  • pkg-minimal/NEWS
  • pkg-minimal/inst
    • add.m
    • sub.m

1.2.1 Package - Files

name: pkg-minimal
version: 0.0.1
date: 2023-01-01
author: John Dow <john.dow@email.com>
maintainer: John Dow <john.dow@email.com>
title: A minimal octave package.
description: A package.
categories: package
depends: octave (>= 7.3.0)
MIT License

Copyright (c) 2023 John Dow

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Summary of important user-visible changes for pkg-minimal 0.0.1:
-------------------------------------------------------------------

 Important Notice: 1) pkg-minimal V0.0.1

1.2.1.1 “inst” Folder

function retval = add (a, b)
    retval = a + b
endfunction
function retval = sub (a, b)
    retval = a - b
endfunction

1.2.2 create [package].tar.gz

tar <package>.tar.gz "<package>/COPYING <package>/DESCRIPTION <package>/NEWS <package>/inst" ..
tar pkg-minimal.tar.gz "pkg-minimal/COPYING pkg-minimal/DESCRIPTION pkg-minimal/NEWS pkg-minimal/inst" ..

1.2.3 install [package].tar.gz

pkg install [package].tar.gz"
delete [package].tar.gz
pkg install "pkg-minimal.tar.gz"
delete pkg-minimal.tar.gz

1.2.4 uninstall [package].tar.gz

1.3 pkg command

1.3.1 pkg load [package]

1.3.2 pkg unload [package]

1.3.3 pkg list [package]

1.3.4 pkg describe [package]