Application manual creation tools for RISC OS software.
ManTools are a collection of Perl scripts which are useful for building software manuals in formats including plain text, HTML and StrongHelp. They are required by RISC OS source code found amongst the adjacent repositories.
To install and use ManTools, it will be necessary to have suitable Linux system with a working installation of the GCCSDK.
It will also be necessary to ensure that the SFTOOLS_BIN and $SFTOOLS_MAKE variables are set to a suitable location within the current environment. For example
export SFTOOLS_BIN=/home/steve/sftools/bin
export SFTOOLS_MAKE=/home/steve/sftools/make
where the path is changed to suit your local settings and installation requirements. Finally, you will also need to have installed the Shared Makefiles.
To install ManTools, use
make install
from the root folder of the project, which will copy the necessary files in to the location indicated by $SFTOOLS_BIN. It will also be necessary to install the Tree::Simple Perl Module; if using a Debian-based Linux, this can be done with
apt install libtree-simple-perl
To build its manual, Mantools must have already been installed. Simply running
make install
again will cause the manual to be built if Mantools was installed correctly the first time around.
In order to build StrongHelp manuals, ManTools requires BindHelp from OSLib. OSlib will be required in its own right for building any C-based projects in these repositories, so the following steps could serve a dual purpose.
To build OSLib, and with it BindHelp, check the OSLib code out into a suitable location:
svn co https://svn.code.sf.net/p/ro-oslib/code/trunk/\!OSLib OSLib
It is now possible to drop into the OSLib folder and build the library:
cd OSLib
make ELFOBJECTTYPE=HARDFPU
If this completes successfully, it should now be possible to take a copy of the BindHelp executable and store it in the location indicated by $SFTOOLS_BIN:
mkdir -p $SFTOOLS_BIN
cp Bin/bindhelp $SFTOOLS_BIN
This will allow the Shared Makefiles to find it if a StrongHelp target needs to be built.
ManTools are licensed under the EUPL, Version 1.2 only (the "Licence"); you may not use this work except in compliance with the Licence.
You may obtain a copy of the Licence at http://joinup.ec.europa.eu/software/page/eupl.
Unless required by applicable law or agreed to in writing, software distributed under the Licence is distributed on an "as is"; basis, without warranties or conditions of any kind, either express or implied.
See the Licence for the specific language governing permissions and limitations under the Licence.