Mercurial > mxe-octave

annotate installer-files/README.html @ 7192:d001afec8e35 default tip @

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: Merge release to default.
author Markus Mützel <markus.muetzel@gmx.de>
date Tue, 07 May 2024 13:39:42 +0200
parents 17a8ff534f78
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3453
70b110956a4e nsis-installer: Use custom page for shortcuts and install for all users.
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
1 <html>
70b110956a4e nsis-installer: Use custom page for shortcuts and install for all users.
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
2 <head>
70b110956a4e nsis-installer: Use custom page for shortcuts and install for all users.
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
3 <title>GNU Octave</title>
70b110956a4e nsis-installer: Use custom page for shortcuts and install for all users.
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
4 </head>
70b110956a4e nsis-installer: Use custom page for shortcuts and install for all users.
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
5 <body>
5526
5b5a3b078ee4 * installer-files/README.html: Update for Octave 6.1 (bug #59020).
Markus Mützel <markus.muetzel@gmx.de>
parents: 5470
diff changeset
6 <h1>Welcome</h1>
5914
05a486e7e873 README.html: Prepare file ahead of 6.4 release.
Markus Mützel <markus.muetzel@gmx.de>
parents: 5913
diff changeset
7 <p>Thank you for installing GNU Octave!</p>
7150
cafa182c2afb README.html: Prepare file ahead of 9.2 release.
Markus Mützel <markus.muetzel@gmx.de>
parents: 7046
diff changeset
8 <p>Octave 9.2 is a minor release which mainly fixes bugs and regressions found
cafa182c2afb README.html: Prepare file ahead of 9.2 release.
Markus Mützel <markus.muetzel@gmx.de>
parents: 7046
diff changeset
9 since the release of version 9.1. It should be feature and API compatible to
cafa182c2afb README.html: Prepare file ahead of 9.2 release.
Markus Mützel <markus.muetzel@gmx.de>
parents: 7046
diff changeset
10 Octave 9.1.</p>
7046
eb1e4b5f908b README.html: Prepare file ahead of 9.1 release.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6937
diff changeset
11 <p>Octave 9 is not feature or ABI/API compatible with Octave 8 or earlier.
eb1e4b5f908b README.html: Prepare file ahead of 9.1 release.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6937
diff changeset
12 Binaries (<code>.oct</code> or <code>.mex</code> files) need to be re-built
eb1e4b5f908b README.html: Prepare file ahead of 9.1 release.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6937
diff changeset
13 when upgrading from Octave 8 or earlier to this version.</p>
7173
17a8ff534f78 README.html: Add note about switch to Qt6 for Octave 9.2.
Markus Mützel <markus.muetzel@gmx.de>
parents: 7150
diff changeset
14 <p>Octave for Windows 9.2 is built with Qt6. This should improve the user
17a8ff534f78 README.html: Add note about switch to Qt6 for Octave 9.2.
Markus Mützel <markus.muetzel@gmx.de>
parents: 7150
diff changeset
15 experience on screens with DPI scaling.</p>
6937
4799220fcf78 README.html: Prepare file ahead of 8.4 release.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6806
diff changeset
16 <p>Binaries are no longer distributed for Windows 32-bit (or WoW64) by the
4799220fcf78 README.html: Prepare file ahead of 8.4 release.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6806
diff changeset
17 Octave project. Please refer to other distributors if you still need them.
4799220fcf78 README.html: Prepare file ahead of 8.4 release.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6806
diff changeset
18 32-bit Windows binaries of Octave are still available from
4799220fcf78 README.html: Prepare file ahead of 8.4 release.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6806
diff changeset
19 <a href="https://wiki.octave.org/Octave_for_Microsoft_Windows#GNU_Octave_in_MSYS2">MSYS2</a>.
4799220fcf78 README.html: Prepare file ahead of 8.4 release.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6806
diff changeset
20 </p>
6569
f07d1a1f28b7 README.html: Prepare file ahead of 8.1 release.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6459
diff changeset
21 <p>Since Octave 7, the minimum required version of the Windows API is 6.1
f07d1a1f28b7 README.html: Prepare file ahead of 8.1 release.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6459
diff changeset
22 (Windows 7 or newer).</p>
5914
05a486e7e873 README.html: Prepare file ahead of 6.4 release.
Markus Mützel <markus.muetzel@gmx.de>
parents: 5913
diff changeset
23 <p>A full list of changes can be found in the Release Notes from the News
05a486e7e873 README.html: Prepare file ahead of 6.4 release.
Markus Mützel <markus.muetzel@gmx.de>
parents: 5913
diff changeset
24 menu or by typing <code>news</code> on the command prompt.</p>
5526
5b5a3b078ee4 * installer-files/README.html: Update for Octave 6.1 (bug #59020).
Markus Mützel <markus.muetzel@gmx.de>
parents: 5470
diff changeset
25
5b5a3b078ee4 * installer-files/README.html: Update for Octave 6.1 (bug #59020).
Markus Mützel <markus.muetzel@gmx.de>
parents: 5470
diff changeset
26 <h2>Changed default installation location</h2>
5666
cc0852b4811f * installer-files/README.html: Update for Octave 6.2.
Markus Mützel <markus.muetzel@gmx.de>
parents: 5526
diff changeset
27 <p>Since version 6.1, Octave installs to the system wide default program
cc0852b4811f * installer-files/README.html: Update for Octave 6.2.
Markus Mützel <markus.muetzel@gmx.de>
parents: 5526
diff changeset
28 installation location (likely inside <code>C:\Program Files\GNU Octave</code>)
cc0852b4811f * installer-files/README.html: Update for Octave 6.2.
Markus Mützel <markus.muetzel@gmx.de>
parents: 5526
diff changeset
29 by default.<br />
cc0852b4811f * installer-files/README.html: Update for Octave 6.2.
Markus Mützel <markus.muetzel@gmx.de>
parents: 5526
diff changeset
30 It is a known issue that some operations might fail if Octave is installed in
cc0852b4811f * installer-files/README.html: Update for Octave 6.2.
Markus Mützel <markus.muetzel@gmx.de>
parents: 5526
diff changeset
31 a location containing spaces if short file names have been disabled for the file
cc0852b4811f * installer-files/README.html: Update for Octave 6.2.
Markus Mützel <markus.muetzel@gmx.de>
parents: 5526
diff changeset
32 system of the installation folder. Some systems seem to have disabled that
cc0852b4811f * installer-files/README.html: Update for Octave 6.2.
Markus Mützel <markus.muetzel@gmx.de>
parents: 5526
diff changeset
33 feature for some partitions (e.g., on <code>D:</code>). If you are unsure
cc0852b4811f * installer-files/README.html: Update for Octave 6.2.
Markus Mützel <markus.muetzel@gmx.de>
parents: 5526
diff changeset
34 whether your file system supports short file names, chose an installation folder
cc0852b4811f * installer-files/README.html: Update for Octave 6.2.
Markus Mützel <markus.muetzel@gmx.de>
parents: 5526
diff changeset
35 that doesn't contain spaces.</p>
5526
5b5a3b078ee4 * installer-files/README.html: Update for Octave 6.1 (bug #59020).
Markus Mützel <markus.muetzel@gmx.de>
parents: 5470
diff changeset
36 <p>It is now also possible to install Octave without administrative privileges.
5666
cc0852b4811f * installer-files/README.html: Update for Octave 6.2.
Markus Mützel <markus.muetzel@gmx.de>
parents: 5526
diff changeset
37 <br />In that case (or if an admin choses to install for the "local user" only),
5526
5b5a3b078ee4 * installer-files/README.html: Update for Octave 6.1 (bug #59020).
Markus Mützel <markus.muetzel@gmx.de>
parents: 5470
diff changeset
38 the default installation location is inside
5b5a3b078ee4 * installer-files/README.html: Update for Octave 6.1 (bug #59020).
Markus Mützel <markus.muetzel@gmx.de>
parents: 5470
diff changeset
39 <code>%LOCALAPPDATA%\Programs\GNU Octave</code>.</p>
5b5a3b078ee4 * installer-files/README.html: Update for Octave 6.1 (bug #59020).
Markus Mützel <markus.muetzel@gmx.de>
parents: 5470
diff changeset
40
6598
2f615fe8f53e README.html: Change URL for Octave packages to https://packages.octave.org/
Markus Mützel <markus.muetzel@gmx.de>
parents: 6596
diff changeset
41 <h2>Included Octave Packages</h2>
5526
5b5a3b078ee4 * installer-files/README.html: Update for Octave 6.1 (bug #59020).
Markus Mützel <markus.muetzel@gmx.de>
parents: 5470
diff changeset
42 <p>A <a href="https://wiki.octave.org/Octave_for_Microsoft_Windows#Packages">
6598
2f615fe8f53e README.html: Change URL for Octave packages to https://packages.octave.org/
Markus Mützel <markus.muetzel@gmx.de>
parents: 6596
diff changeset
43 number of Octave packages</a> has been included with Octave for Windows.
5526
5b5a3b078ee4 * installer-files/README.html: Update for Octave 6.1 (bug #59020).
Markus Mützel <markus.muetzel@gmx.de>
parents: 5470
diff changeset
44 However, the packages must be loaded in order to use them.</p>
3453
70b110956a4e nsis-installer: Use custom page for shortcuts and install for all users.
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
45 <p>
70b110956a4e nsis-installer: Use custom page for shortcuts and install for all users.
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
46 <ul>
4077
d49726dd114a Update installer README for the installed packages
John Donoghue <john.donoghue@ieee.org>
parents: 3800
diff changeset
47 <li>To list the available installed packages, use the
5526
5b5a3b078ee4 * installer-files/README.html: Update for Octave 6.1 (bug #59020).
Markus Mützel <markus.muetzel@gmx.de>
parents: 5470
diff changeset
48 <code>pkg list</code> command.</li>
4077
d49726dd114a Update installer README for the installed packages
John Donoghue <john.donoghue@ieee.org>
parents: 3800
diff changeset
49 <li>To load a package in order to use its functions, use the
5526
5b5a3b078ee4 * installer-files/README.html: Update for Octave 6.1 (bug #59020).
Markus Mützel <markus.muetzel@gmx.de>
parents: 5470
diff changeset
50 <code>pkg load PACKAGENAME</code> command.</li>
3453
70b110956a4e nsis-installer: Use custom page for shortcuts and install for all users.
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
51 </ul>
70b110956a4e nsis-installer: Use custom page for shortcuts and install for all users.
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
52 </p>
6598
2f615fe8f53e README.html: Change URL for Octave packages to https://packages.octave.org/
Markus Mützel <markus.muetzel@gmx.de>
parents: 6596
diff changeset
53 <p>More packages are available from
2f615fe8f53e README.html: Change URL for Octave packages to https://packages.octave.org/
Markus Mützel <markus.muetzel@gmx.de>
parents: 6596
diff changeset
54 <a href="https://packages.octave.org/">Octave Packages</a>.</p>
5526
5b5a3b078ee4 * installer-files/README.html: Update for Octave 6.1 (bug #59020).
Markus Mützel <markus.muetzel@gmx.de>
parents: 5470
diff changeset
55
6596
a6de35a3ea42 README.html: Add note about OpenGL Switcher. Expand a bit on BLAS Switcher.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6569
diff changeset
56 <h2>BLAS Library Selection</h2>
a6de35a3ea42 README.html: Add note about OpenGL Switcher. Expand a bit on BLAS Switcher.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6569
diff changeset
57 <p>During the installation, a default BLAS library was selected. The installer
a6de35a3ea42 README.html: Add note about OpenGL Switcher. Expand a bit on BLAS Switcher.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6569
diff changeset
58 contains two BLAS implementations,
a6de35a3ea42 README.html: Add note about OpenGL Switcher. Expand a bit on BLAS Switcher.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6569
diff changeset
59 the <a href="http://www.netlib.org/blas/">NetLib reference BLAS</a>
a6de35a3ea42 README.html: Add note about OpenGL Switcher. Expand a bit on BLAS Switcher.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6569
diff changeset
60 and <a href="http://www.openblas.net/">OpenBLAS</a>.</p>
a6de35a3ea42 README.html: Add note about OpenGL Switcher. Expand a bit on BLAS Switcher.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6569
diff changeset
61 <p>The implementation by OpenBLAS tries to use the CPU features available on the
a6de35a3ea42 README.html: Add note about OpenGL Switcher. Expand a bit on BLAS Switcher.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6569
diff changeset
62 system. That means that it might perform faster than the reference
a6de35a3ea42 README.html: Add note about OpenGL Switcher. Expand a bit on BLAS Switcher.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6569
diff changeset
63 implementation. On the other hand, using it might result in higher round-off
a6de35a3ea42 README.html: Add note about OpenGL Switcher. Expand a bit on BLAS Switcher.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6569
diff changeset
64 errors.</p>
a6de35a3ea42 README.html: Add note about OpenGL Switcher. Expand a bit on BLAS Switcher.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6569
diff changeset
65 <p>The used implementation can be changed after installation with the "BLAS
a6de35a3ea42 README.html: Add note about OpenGL Switcher. Expand a bit on BLAS Switcher.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6569
diff changeset
66 Switcher" in the Start menu.</p>
a6de35a3ea42 README.html: Add note about OpenGL Switcher. Expand a bit on BLAS Switcher.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6569
diff changeset
67
a6de35a3ea42 README.html: Add note about OpenGL Switcher. Expand a bit on BLAS Switcher.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6569
diff changeset
68 <h2>OpenGL Renderer Selection</h2>
a6de35a3ea42 README.html: Add note about OpenGL Switcher. Expand a bit on BLAS Switcher.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6569
diff changeset
69 <p>During installation, an OpenGL renderer was selected. Octave for Windows
a6de35a3ea42 README.html: Add note about OpenGL Switcher. Expand a bit on BLAS Switcher.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6569
diff changeset
70 includes a software OpenGL renderer (llvmpipe by
a6de35a3ea42 README.html: Add note about OpenGL Switcher. Expand a bit on BLAS Switcher.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6569
diff changeset
71 <a href="https://www.mesa3d.org/">Mesa 3D</a>). That renderer can be used if the
a6de35a3ea42 README.html: Add note about OpenGL Switcher. Expand a bit on BLAS Switcher.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6569
diff changeset
72 OpenGL renderer drivers installed on the system aren't working as expected.</p>
a6de35a3ea42 README.html: Add note about OpenGL Switcher. Expand a bit on BLAS Switcher.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6569
diff changeset
73 <p>Note that the OpenGL renderer installed on the system might be hardware
a6de35a3ea42 README.html: Add note about OpenGL Switcher. Expand a bit on BLAS Switcher.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6569
diff changeset
74 accelerated. That means it might perform much faster than the software OpenGL
a6de35a3ea42 README.html: Add note about OpenGL Switcher. Expand a bit on BLAS Switcher.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6569
diff changeset
75 renderer.</p>
a6de35a3ea42 README.html: Add note about OpenGL Switcher. Expand a bit on BLAS Switcher.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6569
diff changeset
76 <p>The OpenGL renderer used by Octave can be changed after installation with the
a6de35a3ea42 README.html: Add note about OpenGL Switcher. Expand a bit on BLAS Switcher.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6569
diff changeset
77 "OpenGL Switcher" in the Start menu.</p>
a6de35a3ea42 README.html: Add note about OpenGL Switcher. Expand a bit on BLAS Switcher.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6569
diff changeset
78
5913
fa2337ae8097 README.html: Add some general comments wrt Octave on Windows (bug #61207).
Markus Mützel <markus.muetzel@gmx.de>
parents: 5771
diff changeset
79 <h2>General information for Octave on Windows</h2>
fa2337ae8097 README.html: Add some general comments wrt Octave on Windows (bug #61207).
Markus Mützel <markus.muetzel@gmx.de>
parents: 5771
diff changeset
80 <p>Octave is developed primarily on GNU/Linux. The programs and wrapper scripts
fa2337ae8097 README.html: Add some general comments wrt Octave on Windows (bug #61207).
Markus Mützel <markus.muetzel@gmx.de>
parents: 5771
diff changeset
81 bundled in this installer make a best effort to provide a seamless experience
fa2337ae8097 README.html: Add some general comments wrt Octave on Windows (bug #61207).
Markus Mützel <markus.muetzel@gmx.de>
parents: 5771
diff changeset
82 of Octave on Windows.<br />
fa2337ae8097 README.html: Add some general comments wrt Octave on Windows (bug #61207).
Markus Mützel <markus.muetzel@gmx.de>
parents: 5771
diff changeset
83 However, there are some (minor) limitations and idiosyncracies on that platform.
fa2337ae8097 README.html: Add some general comments wrt Octave on Windows (bug #61207).
Markus Mützel <markus.muetzel@gmx.de>
parents: 5771
diff changeset
84 Please, read the <a href="https://wiki.octave.org/Octave_for_Microsoft_Windows">
fa2337ae8097 README.html: Add some general comments wrt Octave on Windows (bug #61207).
Markus Mützel <markus.muetzel@gmx.de>
parents: 5771
diff changeset
85 corresponding article</a> for further information and possible work-arounds.</p>
6569
f07d1a1f28b7 README.html: Prepare file ahead of 8.1 release.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6459
diff changeset
86 <p>The Octave GUI is currently not compatible with the new Windows Terminal App.
f07d1a1f28b7 README.html: Prepare file ahead of 8.1 release.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6459
diff changeset
87 Please, switch the default to the (legacy) Windows Console Host for Octave to
f07d1a1f28b7 README.html: Prepare file ahead of 8.1 release.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6459
diff changeset
88 work correctly. See, e.g.,
f07d1a1f28b7 README.html: Prepare file ahead of 8.1 release.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6459
diff changeset
89 <a href="https://devblogs.microsoft.com/commandline/windows-terminal-as-your-default-command-line-experience/">
f07d1a1f28b7 README.html: Prepare file ahead of 8.1 release.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6459
diff changeset
90 these instructions by Microsoft</a> for how to change the default terminal and
7046
eb1e4b5f908b README.html: Prepare file ahead of 9.1 release.
Markus Mützel <markus.muetzel@gmx.de>
parents: 6937
diff changeset
91 select "Windows Console Host".</p>
5913
fa2337ae8097 README.html: Add some general comments wrt Octave on Windows (bug #61207).
Markus Mützel <markus.muetzel@gmx.de>
parents: 5771
diff changeset
92
5526
5b5a3b078ee4 * installer-files/README.html: Update for Octave 6.1 (bug #59020).
Markus Mützel <markus.muetzel@gmx.de>
parents: 5470
diff changeset
93 <h2>Contributing to Octave</h2>
5b5a3b078ee4 * installer-files/README.html: Update for Octave 6.1 (bug #59020).
Markus Mützel <markus.muetzel@gmx.de>
parents: 5470
diff changeset
94 <p>Octave has a community that lives from its users. You are welcome to share
5b5a3b078ee4 * installer-files/README.html: Update for Octave 6.1 (bug #59020).
Markus Mützel <markus.muetzel@gmx.de>
parents: 5470
diff changeset
95 with that community.</p>
5b5a3b078ee4 * installer-files/README.html: Update for Octave 6.1 (bug #59020).
Markus Mützel <markus.muetzel@gmx.de>
parents: 5470
diff changeset
96 <p>For help and support, visit the
5b5a3b078ee4 * installer-files/README.html: Update for Octave 6.1 (bug #59020).
Markus Mützel <markus.muetzel@gmx.de>
parents: 5470
diff changeset
97 <a href="https://octave.discourse.group/">Octave Discourse forum</a>.</p>
5b5a3b078ee4 * installer-files/README.html: Update for Octave 6.1 (bug #59020).
Markus Mützel <markus.muetzel@gmx.de>
parents: 5470
diff changeset
98 <p>Please, report any problems with Octave on the
5b5a3b078ee4 * installer-files/README.html: Update for Octave 6.1 (bug #59020).
Markus Mützel <markus.muetzel@gmx.de>
parents: 5470
diff changeset
99 <a href="https://octave.org/bugs.html">Octave website</a>.</p>
3453
70b110956a4e nsis-installer: Use custom page for shortcuts and install for all users.
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
100 </body>
70b110956a4e nsis-installer: Use custom page for shortcuts and install for all users.
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
101 </html>