├── .gitignore ├── assets └── octave-logo-128.png ├── octave.docker ├── .github └── workflows │ ├── build_octave.yml │ └── octave.yml ├── README.md ├── install.sh └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .vscode/ -------------------------------------------------------------------------------- /assets/octave-logo-128.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/gnu-octave/docker/HEAD/assets/octave-logo-128.png -------------------------------------------------------------------------------- /octave.docker: -------------------------------------------------------------------------------- 1 | # gnuoctave/octave 2 | 3 | # Please follow docker best practices 4 | # https://docs.docker.com/engine/userguide/eng-image/dockerfile_best-practices/ 5 | 6 | # Docker images to build GNU Octave . 7 | 8 | ARG OCTAVE_VERSION_MAJOR 9 | FROM gnuoctave/octave-build:${OCTAVE_VERSION_MAJOR} 10 | LABEL maintainer="Kai T. Ohlhus " 11 | 12 | ENV LAST_UPDATED=2024-10-15 13 | 14 | 15 | # Update builder image with latest security updates 16 | RUN apt-get --yes update && \ 17 | apt-get --yes upgrade && \ 18 | apt-get --yes clean && \ 19 | apt-get --yes autoremove && \ 20 | rm -Rf /var/lib/apt/lists/* 21 | 22 | 23 | # Install Octave 24 | ARG OCTAVE_VERSION 25 | ARG GNU_MIRROR=https://ftpmirror.gnu.org/octave 26 | RUN mkdir -p /tmp/build \ 27 | && cd /tmp/build \ 28 | && wget -q "${GNU_MIRROR}/octave-${OCTAVE_VERSION}.tar.gz" \ 29 | && tar -xf octave-${OCTAVE_VERSION}.tar.gz \ 30 | && cd octave-${OCTAVE_VERSION} \ 31 | && ./configure ${OCTAVE_CONFIGURE_ARGS} \ 32 | F77_INTEGER_8_FLAG=${F77_INTEGER_8_FLAG} \ 33 | && make -j8 \ 34 | && make install \ 35 | && rm -rf /tmp/build 36 | 37 | 38 | WORKDIR /workdir 39 | 40 | CMD ["octave-cli"] 41 | -------------------------------------------------------------------------------- /.github/workflows/build_octave.yml: -------------------------------------------------------------------------------- 1 | name: Build Octave Builder container images 2 | 3 | on: 4 | # Allows you to run this workflow manually from the Actions tab 5 | workflow_dispatch: 6 | 7 | jobs: 8 | build_octave: 9 | runs-on: ubuntu-latest 10 | continue-on-error: true 11 | strategy: 12 | matrix: 13 | version: [4, 5, 6, 8, 9] 14 | steps: 15 | - 16 | name: Checkout 17 | uses: actions/checkout@v4 18 | - 19 | name: Set up QEMU 20 | uses: docker/setup-qemu-action@v3 21 | - 22 | name: Set up Docker Buildx 23 | uses: docker/setup-buildx-action@v3 24 | - 25 | name: Login to GitHub Container Registry 26 | uses: docker/login-action@v3 27 | with: 28 | registry: ghcr.io 29 | username: ${{ github.repository_owner }} 30 | password: ${{ secrets.GITHUB_TOKEN }} 31 | - 32 | name: Login to DockerHub 33 | uses: docker/login-action@v3 34 | with: 35 | username: ${{ secrets.DOCKERHUB_USERNAME }} 36 | password: ${{ secrets.DOCKERHUB_TOKEN }} 37 | - 38 | name: Build and push 39 | uses: docker/build-push-action@v5 40 | with: 41 | context: . 42 | file: build-octave-${{ matrix.version }}.docker 43 | build-args: | 44 | OCTAVE_VERSION=${{ matrix.version }} 45 | push: true 46 | tags: | 47 | gnuoctave/octave-build:${{ matrix.version }} 48 | ghcr.io/gnu-octave/octave-build:${{ matrix.version }} 49 | -------------------------------------------------------------------------------- /.github/workflows/octave.yml: -------------------------------------------------------------------------------- 1 | name: Build Octave container images 2 | 3 | on: 4 | # Allows you to run this workflow manually from the Actions tab 5 | workflow_dispatch: 6 | # Rebuild container images on every 1st of a month at 02:03 7 | schedule: 8 | - cron: "3 2 1 * *" 9 | 10 | env: 11 | OCTAVE_LATEST: 10.3.0 12 | 13 | jobs: 14 | octave: 15 | runs-on: ubuntu-latest 16 | continue-on-error: true 17 | strategy: 18 | fail-fast: false 19 | matrix: 20 | version: 21 | - 4.0.0 22 | - 4.0.1 23 | - 4.0.2 24 | - 4.0.3 25 | - 4.2.0 26 | - 4.2.1 27 | - 4.2.2 28 | - 4.4.0 29 | - 4.4.1 30 | - 5.1.0 31 | - 5.2.0 32 | - 6.1.0 33 | - 6.2.0 34 | - 6.3.0 35 | - 6.4.0 36 | - 7.1.0 37 | - 7.2.0 38 | - 7.3.0 39 | - 8.1.0 40 | - 8.2.0 41 | - 8.3.0 42 | - 8.4.0 43 | - 9.1.0 44 | - 9.2.0 45 | - 9.3.0 46 | - 9.4.0 47 | - 10.1.0 48 | - 10.2.0 49 | - 10.3.0 50 | steps: 51 | - 52 | name: Checkout 53 | uses: actions/checkout@v4 54 | - 55 | name: Set up QEMU 56 | uses: docker/setup-qemu-action@v3 57 | - 58 | name: Set up Docker Buildx 59 | uses: docker/setup-buildx-action@v3 60 | - 61 | name: Login to GitHub Container Registry 62 | uses: docker/login-action@v3 63 | with: 64 | registry: ghcr.io 65 | username: ${{ github.repository_owner }} 66 | password: ${{ secrets.GITHUB_TOKEN }} 67 | - 68 | name: Login to DockerHub 69 | uses: docker/login-action@v3 70 | with: 71 | username: ${{ secrets.DOCKERHUB_USERNAME }} 72 | password: ${{ secrets.DOCKERHUB_TOKEN }} 73 | - 74 | name: Determine build image version 75 | run: | 76 | VER=${{ matrix.version }} 77 | BUILD_VER=${VER%%.*} 78 | ## Exception, because of too old libraries. 79 | if [ "${VER:0:3}" = "4.4" ]; then 80 | BUILD_VER=5 81 | fi 82 | if [ "${VER:0:1}" = "7" ]; then 83 | BUILD_VER=6 84 | fi 85 | if [ "${VER:0:2}" = "10" ]; then 86 | BUILD_VER=9 87 | fi 88 | GNU_MIRROR=https://ftpmirror.gnu.org/octave 89 | echo "OCTAVE_VERSION_MAJOR=${BUILD_VER}" >> $GITHUB_ENV 90 | echo "GNU_MIRROR=${GNU_MIRROR}" >> $GITHUB_ENV 91 | - 92 | name: Set "latest" tag 93 | if: ${{ matrix.version == env.OCTAVE_LATEST }} 94 | run: | 95 | echo "DOCKER_LATEST_TAG=gnuoctave/octave:latest" >> $GITHUB_ENV 96 | echo "GHCR_LATEST_TAG=ghcr.io/gnu-octave/octave:latest" >> $GITHUB_ENV 97 | - 98 | name: Build and push 99 | uses: docker/build-push-action@v5 100 | with: 101 | context: . 102 | file: octave.docker 103 | build-args: | 104 | OCTAVE_VERSION=${{ matrix.version }} 105 | OCTAVE_VERSION_MAJOR=${{ env.OCTAVE_VERSION_MAJOR }} 106 | GNU_MIRROR=${{ env.GNU_MIRROR }} 107 | push: true 108 | tags: | 109 | gnuoctave/octave:${{ matrix.version }} 110 | ghcr.io/gnu-octave/octave:${{ matrix.version }} 111 | ${{ env.DOCKER_LATEST_TAG }} 112 | ${{ env.GHCR_LATEST_TAG }} 113 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Docker images of GNU Octave 2 | 3 | > - DockerHub: https://hub.docker.com/r/gnuoctave/octave 4 | > - GitHub: https://github.com/gnu-octave/docker 5 | 6 | The Octave images can be run by 7 | - [Docker](https://www.docker.com/): 8 | ```sh 9 | # Obtain image 10 | 11 | docker pull docker.io/gnuoctave/octave:10.3.0 12 | 13 | # Start container (command-line interface) 14 | 15 | docker run -it --rm gnuoctave/octave:10.3.0 octave 16 | ``` 17 | - [Podman](https://podman.io/): as before, replace `docker` with `podman`. 18 | - [Singularity](https://sylabs.io/singularity/): 19 | ```sh 20 | singularity pull docker://gnuoctave/octave:10.3.0 21 | 22 | # Start container (command-line interface) 23 | 24 | singularity run octave_10.3.0.sif 25 | ``` 26 | 27 | See below for starting Octave with GUI and advanced options, like mounting the host's user directory. 28 | 29 | 30 | ## Easy installation 31 | 32 | An installation script is provided, 33 | that can be called directly with this shell command: 34 | ```bash 35 | /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/gnu-octave/docker/main/install.sh)" -t docker 36 | ``` 37 | To remove the installation, type: 38 | ```bash 39 | /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/gnu-octave/docker/main/install.sh)" -u -f 40 | ``` 41 | It creates links in `$HOME/bin`, 42 | as well as a Desktop entry, 43 | to start the Octave as if it was installed by the Linux distribution. 44 | 45 | **Note:** The system must have either Docker (= Podman) or Singularity 46 | installed and the user account must be setup to use those tools properly. 47 | Please adapt the shell command after `-t` respectively. 48 | 49 | 50 | ## Starting the Octave GUI 51 | 52 | Using Docker or Podman run: 53 | ```sh 54 | docker run \ 55 | --rm \ 56 | --network=host \ 57 | --env="DISPLAY" \ 58 | --env="HOME=$HOME" \ 59 | --env="XDG_RUNTIME_DIR=$XDG_RUNTIME_DIR" \ 60 | --user $(id -u):$(id -g) \ 61 | --volume="$HOME:$HOME:rw" \ 62 | --volume="/dev:/dev:rw" \ 63 | --volume="/run/user:/run/user:rw" \ 64 | --workdir="$HOME" \ 65 | docker.io/gnuoctave/octave:10.3.0 octave --gui 66 | ``` 67 | 68 | For old Octave 4.x.x versions you might additionally pass the 69 | `--env=QT_GRAPHICSSYSTEM=native` environment variable. 70 | 71 | The following error results from a missing `$HOME/.Xauthority` file: 72 | ``` 73 | Authorization required, but no authorization protocol specified 74 | octave: unable to open X11 DISPLAY 75 | octave: disabling GUI features 76 | ``` 77 | Create this file via `ln -s -f "$XAUTHORITY" $HOME/.Xauthority`. 78 | 79 | > **Note:** The best experience was made with Singularity and Docker. 80 | > Podman had several flaws when run as unprivileged (non-root) user. 81 | 82 | > **Note:** The "Easy installation" described above does a few tweaks 83 | > to the `docker run` command to enable parallel usage of multiple Octave 84 | > versions and `sudo`-support for the non-root user. 85 | 86 | 87 | Using Singularity, start Octave with GUI with this command: 88 | ``` 89 | singularity exec --bind /run/user octave_10.3.0.sif octave --gui 90 | ``` 91 | 92 | 93 | ## Use qt graphics_toolkit in headless environments 94 | 95 | If the container image is not started or able to start as explained in the previous section, 96 | using the hosts graphics environment, only "gnuplot" is available: 97 | ``` 98 | docker run --rm -it gnuoctave/octave:9.4.0 bash 99 | 100 | root@03cb8555f83f:/workdir# octave --eval available_graphics_toolkits 101 | octave: X11 DISPLAY environment variable not set 102 | octave: disabling GUI features 103 | ans = 104 | { 105 | [1,1] = gnuplot 106 | } 107 | ``` 108 | 109 | To make advanced "qt" graphics available in headless environments, 110 | one potential solution is install the following packages at container image startup 111 | and start Octave using `xvfb-run`: 112 | ``` 113 | $ xvfb-run octave --eval available_graphics_toolkits 114 | QStandardPaths: XDG_RUNTIME_DIR not set, defaulting to '/tmp/runtime-root' 115 | ans = 116 | { 117 | [1,1] = fltk 118 | [1,2] = gnuplot 119 | [1,3] = qt 120 | } 121 | ``` 122 | 123 | For details, see [Xvfb](https://en.wikipedia.org/wiki/Xvfb) 124 | and [#27](https://github.com/gnu-octave/docker/issues/27#issuecomment-2703629974) 125 | with thanks to [@ELC](https://github.com/ELC). 126 | 127 | 128 | ## Hierarchy of all available images 129 | 130 | ```mermaid 131 | graph LR 132 | U5[ubuntu:2404] --> b9[docker.io/gnuoctave/octave-build:9]; 133 | U4[ubuntu:2204] --> b8[docker.io/gnuoctave/octave-build:8]; 134 | U3[ubuntu:2004] --> b6[docker.io/gnuoctave/octave-build:6]; 135 | U2[ubuntu:1804] --> b5[docker.io/gnuoctave/octave-build:5]; 136 | U1[ubuntu:1604] --> b4[docker.io/gnuoctave/octave-build:4]; 137 | b9 --> v1030[docker.io/gnuoctave/octave:10.3.0]; 138 | b9 --> v1020[docker.io/gnuoctave/octave:10.2.0]; 139 | b9 --> v1010[docker.io/gnuoctave/octave:10.1.0]; 140 | b9 --> v940[docker.io/gnuoctave/octave:9.4.0]; 141 | b9 --> v930[docker.io/gnuoctave/octave:9.3.0]; 142 | b9 --> v920[docker.io/gnuoctave/octave:9.2.0]; 143 | b9 --> v910[docker.io/gnuoctave/octave:9.1.0]; 144 | b8 --> v840[docker.io/gnuoctave/octave:8.4.0]; 145 | b8 --> v830[docker.io/gnuoctave/octave:8.3.0]; 146 | b8 --> v820[docker.io/gnuoctave/octave:8.2.0]; 147 | b8 --> v810[docker.io/gnuoctave/octave:8.1.0]; 148 | b6 --> v730[docker.io/gnuoctave/octave:7.3.0]; 149 | b6 --> v720[docker.io/gnuoctave/octave:7.2.0]; 150 | b6 --> v710[docker.io/gnuoctave/octave:7.1.0]; 151 | b6 --> v640[docker.io/gnuoctave/octave:6.4.0]; 152 | b6 --> v630[docker.io/gnuoctave/octave:6.3.0]; 153 | b6 --> v620[docker.io/gnuoctave/octave:6.2.0]; 154 | b6 --> v610[docker.io/gnuoctave/octave:6.1.0]; 155 | b5 --> v520[docker.io/gnuoctave/octave:5.2.0]; 156 | b5 --> v510[docker.io/gnuoctave/octave:5.1.0]; 157 | b5 --> v441[docker.io/gnuoctave/octave:4.4.1]; 158 | b5 --> v440[docker.io/gnuoctave/octave:4.4.0]; 159 | b4 --> v422[docker.io/gnuoctave/octave:4.2.2]; 160 | b4 --> v421[docker.io/gnuoctave/octave:4.2.1]; 161 | b4 --> v420[docker.io/gnuoctave/octave:4.2.0]; 162 | b4 --> v403[docker.io/gnuoctave/octave:4.0.3]; 163 | b4 --> v402[docker.io/gnuoctave/octave:4.0.2]; 164 | b4 --> v401[docker.io/gnuoctave/octave:4.0.1]; 165 | b4 --> v400[docker.io/gnuoctave/octave:4.0.0]; 166 | classDef U fill:#ff7f24,stroke:#333,stroke-width:2px; 167 | class U1 U; 168 | class U2 U; 169 | class U3 U; 170 | class U4 U; 171 | class U5 U; 172 | classDef b fill:#ff0,stroke:#333,stroke-width:2px; 173 | class b4 b; 174 | class b5 b; 175 | class b6 b; 176 | class b8 b; 177 | class b9 b; 178 | classDef age1 fill:#9aff9a,stroke:#333,stroke-width:2px; 179 | classDef age2 fill:#7fffd4,stroke:#333,stroke-width:2px; 180 | classDef age3 fill:#fff68f,stroke:#333,stroke-width:2px; 181 | classDef age4 fill:#ffd700,stroke:#333,stroke-width:2px; 182 | classDef age5 fill:#ffa500,stroke:#333,stroke-width:2px; 183 | classDef age6 fill:#ff6a6a,stroke:#333,stroke-width:2px; 184 | class v1030 age1; 185 | class v1020 age1; 186 | class v1010 age1; 187 | class v940 age1; 188 | class v930 age1; 189 | class v920 age1; 190 | class v910 age1; 191 | class v840 age1; 192 | class v830 age1; 193 | class v820 age1; 194 | class v810 age1; 195 | class v730 age2; 196 | class v720 age2; 197 | class v710 age2; 198 | class v640 age2; 199 | class v630 age2; 200 | class v620 age2; 201 | class v610 age2; 202 | class v520 age3; 203 | class v510 age3; 204 | class v441 age4; 205 | class v440 age4; 206 | class v422 age5; 207 | class v421 age5; 208 | class v420 age5; 209 | class v403 age6; 210 | class v402 age6; 211 | class v401 age6; 212 | class v400 age6; 213 | ``` 214 | 215 | 216 | ## Further reading 217 | 218 | - 219 | A longer blog article about this project including descriptions how to use 220 | and customize these images for specific needs. 221 | -------------------------------------------------------------------------------- /install.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Make script agnostic of direct or `bash -c` calls. 4 | if [[ "$0" != *install.sh ]] 5 | then 6 | set -- "$0" "$@" 7 | fi 8 | 9 | ################ 10 | ## Configuration 11 | ################ 12 | 13 | # Default Octave Docker image to be used. 14 | OCTAVE_VERSION="10.3.0" 15 | OCTAVE_IMAGE="docker.io/gnuoctave/octave" 16 | 17 | # Choose default container tool in this order. 18 | CONTAINER_TOOL_HIERARCHY="docker, podman, singularity" 19 | 20 | ############# 21 | ## Path setup 22 | ############# 23 | 24 | # https://freedesktop.org/wiki/Specifications/menu-spec/ 25 | # Version 1.1 20 August 2016 26 | 27 | XDG_DATA_HOME=${XDG_DATA_HOME:-$HOME/.local/share} 28 | XDG_CONFIG_HOME=${XDG_CONFIG_HOME:-$HOME/.config} 29 | 30 | BIN_DIR=$HOME/bin 31 | APP_DIR=$XDG_DATA_HOME/applications 32 | ICON_DIR=$XDG_DATA_HOME/icons/hicolor/128x128/apps 33 | 34 | # Ensure directories to exist. 35 | mkdir -p $BIN_DIR 36 | mkdir -p $APP_DIR 37 | mkdir -p $ICON_DIR 38 | 39 | function usage() 40 | { 41 | if [ -n "$1" ] 42 | then 43 | echo -e "\nError: $1" 44 | fi 45 | echo -e "\nUsage: install.sh with options:\n" 46 | echo -e "\t-d --debug verbose debug output" 47 | echo -e "\t-f --force overwrite previous installations" 48 | echo -e "\t-h --help show this help" 49 | echo -e "\t-t --container-tool one of $CONTAINER_TOOL_HIERARCHY" 50 | echo -e "\t-u --uninstall only uninstall previous setups\n" 51 | exit 1 52 | } 53 | 54 | 55 | ################################### 56 | ## Command-line argument processing 57 | ################################### 58 | 59 | DEBUG=false 60 | FORCE=false 61 | QUIET_FLAG="--quiet" 62 | UNINSTALL_ONLY=false 63 | while [ "$1" != "" ] 64 | do 65 | case $1 in 66 | -d|--debug) 67 | DEBUG=true 68 | QUIET_FLAG="" 69 | shift 70 | ;; 71 | -f|--force) 72 | FORCE=true 73 | shift 74 | ;; 75 | -t|--container-tool) 76 | CONTAINER_TOOL="$2" 77 | shift 78 | shift 79 | ;; 80 | -u|--uninstall) 81 | UNINSTALL_ONLY=true 82 | shift 83 | ;; 84 | -h|--help) 85 | usage 86 | ;; 87 | *) 88 | usage "invalid input '$1'." 89 | ;; 90 | esac 91 | done 92 | 93 | 94 | # Debug output function. 95 | function DEBUG_MSG() 96 | { 97 | if $DEBUG 98 | then 99 | echo -e "\nDEBUG: $1\n" 100 | fi 101 | } 102 | 103 | 104 | ################################ 105 | ## Detect previous installations 106 | ################################ 107 | 108 | PREV_INSTALL="" 109 | 110 | INSTALLED_FILES=" \ 111 | $BIN_DIR/mkoctfile 112 | $BIN_DIR/octave 113 | $BIN_DIR/octave-config 114 | $BIN_DIR/octave-cli 115 | $BIN_DIR/octave-docker-entrypoint.sh 116 | $APP_DIR/octave-docker.desktop 117 | $ICON_DIR/octave-logo-128.png" 118 | for f in $INSTALLED_FILES 119 | do 120 | if [ -f "$f" ] 121 | then 122 | PREV_INSTALL+=" $f " 123 | fi 124 | done 125 | 126 | if [ -n "$PREV_INSTALL" ] 127 | then 128 | # Report previous installation. 129 | if $FORCE 130 | then 131 | echo -e "\nFound previous installation (will be overwritten):\n" 132 | else 133 | echo -e "\nFound previous installation:\n" 134 | fi 135 | for f in $PREV_INSTALL 136 | do 137 | echo " $f" 138 | done 139 | echo " " 140 | 141 | # Ask user for confirmation (regard -f --force). 142 | if ! $FORCE 143 | then 144 | while true; do 145 | read -p "Enter [c] to cancel and [d] to delete previous installations. " yn 146 | case $yn in 147 | [Cc]*) 148 | echo -e "\nInstallation canceled.\n" 149 | exit 1 150 | ;; 151 | [Dd]*) 152 | break 153 | ;; 154 | *) 155 | echo "Please answer [c] or [d]." 156 | ;; 157 | esac 158 | done 159 | fi 160 | 161 | for f in $PREV_INSTALL 162 | do 163 | rm -f "$f" 164 | done 165 | fi 166 | 167 | 168 | # Finish here if only uninstall was requested. 169 | 170 | if $UNINSTALL_ONLY 171 | then 172 | echo -e "\nUninstall finished.\n" 173 | echo -e " - Please delete Docker/Podman images (docker rmi ...)" \ 174 | " or any singularity SIF-files in ${BIN_DIR} manually.\n" 175 | exit 0 176 | fi 177 | 178 | 179 | ##################################### 180 | ## Container tool detection and setup 181 | ##################################### 182 | 183 | if [ -z $CONTAINER_TOOL ] 184 | then 185 | for t in $(echo $CONTAINER_TOOL_HIERARCHY | tr "," "\n") 186 | do 187 | # Use first existing tool 188 | if type "$t" &> /dev/null 189 | then 190 | CONTAINER_TOOL=$t 191 | break 192 | fi 193 | done 194 | if [ -z $CONTAINER_TOOL ] 195 | then 196 | usage "No container tool ($CONTAINER_TOOL_HIERARCHY) could be detected." \ 197 | "Please install one of them." 198 | fi 199 | else 200 | if ! type "$CONTAINER_TOOL" &> /dev/null 201 | then 202 | echo -e "\nError: '$CONTAINER_TOOL' cannot be found,"\ 203 | "please choose another container tool." 204 | usage 205 | fi 206 | fi 207 | DEBUG_MSG "use '$CONTAINER_TOOL' as container tool." 208 | 209 | # Setup for the container tool. 210 | case $CONTAINER_TOOL in 211 | "docker" | "podman") 212 | PULL_CMD="$CONTAINER_TOOL pull $QUIET_FLAG $OCTAVE_IMAGE:$OCTAVE_VERSION" 213 | RUN_CMD="$CONTAINER_TOOL run \$DOCKER_INTERACTIVE \\ 214 | --rm \\ 215 | --network=host \\ 216 | --env=\"DISPLAY\" \\ 217 | --env=\"HOME=\$HOME\" \\ 218 | --env=\"XDG_RUNTIME_DIR=\$XDG_RUNTIME_DIR\" \\ 219 | --volume=\"\$HOME:\$HOME:rw\" \\ 220 | --volume=\"\$OCTAVE_CONF_DIR_HOST:\$OCTAVE_CONF_DIR:rw\" \\ 221 | --volume=\"/dev:/dev:rw\" \\ 222 | --volume=\"/run/user:/run/user:rw\" \\ 223 | --volume=\"$BIN_DIR/octave-docker-entrypoint.sh:/entrypoint.sh:ro\" \\ 224 | --entrypoint=\"/entrypoint.sh\" \\ 225 | --workdir=\"\$HOME\" \\ 226 | $OCTAVE_IMAGE:\$OCTAVE_VERSION" 227 | ;; 228 | "singularity") 229 | SIF_FILE="$BIN_DIR/octave_${OCTAVE_VERSION}.sif" 230 | PULL_CMD="$CONTAINER_TOOL pull --disable-cache $SIF_FILE \ 231 | ${OCTAVE_IMAGE/docker.io/docker:/}:${OCTAVE_VERSION}" 232 | R_CMD="--bind /run/user,\$OCTAVE_CONF_DIR_HOST:\$OCTAVE_CONF_DIR $SIF_FILE" 233 | RUN_CMD="$CONTAINER_TOOL exec $R_CMD" 234 | ;; 235 | *) 236 | echo -e "\nError: invalid container tool '$CONTAINER_TOOL'." 237 | usage 238 | esac 239 | 240 | 241 | ################### 242 | ## New installation 243 | ################### 244 | 245 | # Get images 246 | 247 | echo -e "\nPull '$OCTAVE_IMAGE:$OCTAVE_VERSION' image with '$CONTAINER_TOOL'...\n" 248 | bash -c "$PULL_CMD" 249 | 250 | 251 | # Install start scripts. 252 | 253 | function get_docker_entrypoint() 254 | { 255 | echo "#!/bin/bash 256 | 257 | # User is resolved during installation. 258 | # Entrypoint is executed inside running container. 259 | groupadd -g $(id -g) $(id -gn) 2> /dev/null || groupmod -n $(id -gn) ubuntu 260 | useradd -g $(id -g) -u $(id -u) -G sudo $(id -un) 2> /dev/null || usermod -l $(id -un) ubuntu 261 | echo '%sudo ALL=(ALL) NOPASSWD:ALL' >> /etc/sudoers 262 | CMD=\${1##*/} 263 | shift 264 | sudo -E -u $(id -un) \${CMD} \$@ 265 | " 266 | } 267 | 268 | 269 | function get_Octave_start_script() 270 | { 271 | echo "#!/bin/bash 272 | 273 | OCTAVE_VERSION=\"\${OCTAVE_VERSION:-\"$OCTAVE_VERSION\"}\" 274 | 275 | DOCKER_INTERACTIVE=\"-it\" 276 | for arg in \"\$@\" 277 | do 278 | if [[ \"\$arg\" == \"--gui\" ]] 279 | then 280 | DOCKER_INTERACTIVE=\"\" 281 | fi 282 | # Old Octave qt4 builds 283 | if [[ \"\$arg\" == \"--force-gui\" ]] 284 | then 285 | DOCKER_INTERACTIVE=\"--env=QT_GRAPHICSSYSTEM=native\" 286 | fi 287 | done 288 | 289 | ## Avoid collisions with different 'OCTAVE_VERSION's 290 | XDG_CONFIG_HOME=\"\${XDG_CONFIG_HOME:-\$HOME/.config}\" 291 | OCTAVE_CONF_DIR=\"\$XDG_CONFIG_HOME/octave\" 292 | OCTAVE_CONF_DIR_HOST=\"\$OCTAVE_CONF_DIR/\$OCTAVE_VERSION\" 293 | mkdir -p \"\$OCTAVE_CONF_DIR_HOST\" 294 | 295 | $RUN_CMD \"\${0##*/}\" \"\$@\" 296 | " 297 | } 298 | 299 | 300 | get_docker_entrypoint > $BIN_DIR/octave-docker-entrypoint.sh 301 | get_Octave_start_script > $BIN_DIR/octave 302 | chmod u+x $BIN_DIR/octave-docker-entrypoint.sh 303 | chmod u+x $BIN_DIR/octave 304 | ln -sf $BIN_DIR/octave $BIN_DIR/mkoctfile 305 | ln -sf $BIN_DIR/octave $BIN_DIR/octave-config 306 | ln -sf $BIN_DIR/octave $BIN_DIR/octave-cli 307 | 308 | 309 | # Install desktop file icon. 310 | 311 | ICON_URL="https://raw.githubusercontent.com/gnu-octave/docker/main/assets" 312 | WGET_FLAGS="--directory-prefix=$ICON_DIR $QUIET_FLAG" 313 | if [ ! -f "$ICON_DIR/octave-logo-128.png" ] 314 | then 315 | wget $WGET_FLAGS $ICON_URL/octave-logo-128.png 316 | fi 317 | 318 | 319 | # Install desktop file. 320 | 321 | function get_Octave_desktop_file() 322 | { 323 | echo "#!/usr/bin/env xdg-open 324 | [Desktop Entry] 325 | Categories=Education;Science;Math; 326 | Comment=Interactive programming environment for numerical computations 327 | Comment[ca]=Entorn de programació interactiva per a càlculs numèrics 328 | Comment[de]=Interaktive Programmierumgebung für numerische Berechnungen 329 | Comment[es]=Entorno de programación interactiva para cálculos numéricos 330 | Comment[fr]=Environnement de programmation interactif pour le calcul numérique 331 | Comment[it]=Ambiente di programmazione interattivo per il calcolo numerico 332 | Comment[ja]=数値計算のための対話的なプログラミング環境 333 | Comment[nl]=Interactieve programmeeromgeving voor numerieke berekeningen 334 | Comment[pt]=Ambiente de programação interativo para computação numérica 335 | Comment[zh]=数值计算交互式编程环境 336 | Exec=$BIN_DIR/octave --gui -q %f 337 | GenericName=GNU Octave 338 | Icon=$ICON_DIR/octave-logo-128.png 339 | MimeType=text/x-octave;text/x-matlab; 340 | Name=GNU Octave 341 | StartupNotify=true 342 | Terminal=false 343 | Type=Application 344 | StartupWMClass=octave-gui 345 | Keywords=science;math;matrix;numerical computation;plotting;" 346 | } 347 | 348 | 349 | TMP_DESKTOP_FILE="$(mktemp -d)/octave-docker.desktop" 350 | 351 | get_Octave_desktop_file > ${TMP_DESKTOP_FILE} 352 | 353 | if $DEBUG 354 | then 355 | desktop-file-validate ${TMP_DESKTOP_FILE} 356 | fi 357 | 358 | desktop-file-install \ 359 | --dir=$APP_DIR \ 360 | --delete-original \ 361 | --rebuild-mime-info-cache \ 362 | ${TMP_DESKTOP_FILE} 363 | 364 | echo -e "\nInstallation was successful." 365 | echo -e "\n Run Octave with:\n\n\t$BIN_DIR/octave --gui" 366 | echo -e "\n Desktop launcher has been created.\n\n" 367 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------