diff --git a/INSTALL b/INSTALL index 23e5f25..2ff81d3 100755 --- a/INSTALL +++ b/INSTALL @@ -1,236 +1,136 @@ -Installation Instructions -************************* - -Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005 Free -Software Foundation, Inc. - -This file is free documentation; the Free Software Foundation gives -unlimited permission to copy, distribute and modify it. - -Basic Installation -================== - -These are generic installation instructions. - - The `configure' shell script attempts to guess correct values for -various system-dependent variables used during compilation. It uses -those values to create a `Makefile' in each directory of the package. -It may also create one or more `.h' files containing system-dependent -definitions. Finally, it creates a shell script `config.status' that -you can run in the future to recreate the current configuration, and a -file `config.log' containing compiler output (useful mainly for -debugging `configure'). - - It can also use an optional file (typically called `config.cache' -and enabled with `--cache-file=config.cache' or simply `-C') that saves -the results of its tests to speed up reconfiguring. (Caching is -disabled by default to prevent problems with accidental use of stale -cache files.) - - If you need to do unusual things to compile the package, please try -to figure out how `configure' could check whether to do them, and mail -diffs or instructions to the address given in the `README' so they can -be considered for the next release. If you are using the cache, and at -some point `config.cache' contains results you don't want to keep, you -may remove or edit it. - - The file `configure.ac' (or `configure.in') is used to create -`configure' by a program called `autoconf'. You only need -`configure.ac' if you want to change it or regenerate `configure' using -a newer version of `autoconf'. - -The simplest way to compile this package is: - - 1. `cd' to the directory containing the package's source code and type - `./configure' to configure the package for your system. If you're - using `csh' on an old version of System V, you might need to type - `sh ./configure' instead to prevent `csh' from trying to execute - `configure' itself. - - Running `configure' takes awhile. While running, it prints some - messages telling which features it is checking for. - - 2. Type `make' to compile the package. - - 3. Optionally, type `make check' to run any self-tests that come with - the package. - - 4. Type `make install' to install the programs and any data files and - documentation. - - 5. You can remove the program binaries and object files from the - source code directory by typing `make clean'. To also remove the - files that `configure' created (so you can compile the package for - a different kind of computer), type `make distclean'. There is - also a `make maintainer-clean' target, but that is intended mainly - for the package's developers. If you use it, you may have to get - all sorts of other programs in order to regenerate files that came - with the distribution. - -Compilers and Options -===================== - -Some systems require unusual options for compilation or linking that the -`configure' script does not know about. Run `./configure --help' for -details on some of the pertinent environment variables. - - You can give `configure' initial values for configuration parameters -by setting variables in the command line or in the environment. Here -is an example: - - ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix - - *Note Defining Variables::, for more details. - -Compiling For Multiple Architectures -==================================== - -You can compile the package for more than one kind of computer at the -same time, by placing the object files for each architecture in their -own directory. To do this, you must use a version of `make' that -supports the `VPATH' variable, such as GNU `make'. `cd' to the -directory where you want the object files and executables to go and run -the `configure' script. `configure' automatically checks for the -source code in the directory that `configure' is in and in `..'. - - If you have to use a `make' that does not support the `VPATH' -variable, you have to compile the package for one architecture at a -time in the source code directory. After you have installed the -package for one architecture, use `make distclean' before reconfiguring -for another architecture. - -Installation Names -================== - -By default, `make install' installs the package's commands under -`/usr/local/bin', include files under `/usr/local/include', etc. You -can specify an installation prefix other than `/usr/local' by giving -`configure' the option `--prefix=PREFIX'. - - You can specify separate installation prefixes for -architecture-specific files and architecture-independent files. If you -pass the option `--exec-prefix=PREFIX' to `configure', the package uses -PREFIX as the prefix for installing programs and libraries. -Documentation and other data files still use the regular prefix. - - In addition, if you use an unusual directory layout you can give -options like `--bindir=DIR' to specify different values for particular -kinds of files. Run `configure --help' for a list of the directories -you can set and what kinds of files go in them. - - If the package supports it, you can cause programs to be installed -with an extra prefix or suffix on their names by giving `configure' the -option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. - -Optional Features -================= - -Some packages pay attention to `--enable-FEATURE' options to -`configure', where FEATURE indicates an optional part of the package. -They may also pay attention to `--with-PACKAGE' options, where PACKAGE -is something like `gnu-as' or `x' (for the X Window System). The -`README' should mention any `--enable-' and `--with-' options that the -package recognizes. - - For packages that use the X Window System, `configure' can usually -find the X include and library files automatically, but if it doesn't, -you can use the `configure' options `--x-includes=DIR' and -`--x-libraries=DIR' to specify their locations. - -Specifying the System Type -========================== - -There may be some features `configure' cannot figure out automatically, -but needs to determine by the type of machine the package will run on. -Usually, assuming the package is built to be run on the _same_ -architectures, `configure' can figure that out, but if it prints a -message saying it cannot guess the machine type, give it the -`--build=TYPE' option. TYPE can either be a short name for the system -type, such as `sun4', or a canonical name which has the form: - - CPU-COMPANY-SYSTEM +Install Software +================ -where SYSTEM can have one of these forms: - - OS KERNEL-OS - - See the file `config.sub' for the possible values of each field. If -`config.sub' isn't included in this package, then this package doesn't -need to know the machine type. - - If you are _building_ compiler tools for cross-compiling, you should -use the option `--target=TYPE' to select the type of system they will -produce code for. - - If you want to _use_ a cross compiler, that generates code for a -platform different from the build platform, you should specify the -"host" platform (i.e., that on which the generated programs will -eventually be run) with `--host=TYPE'. +There are prebuilt software packages in the repositories, look in +https://repository.mrw.sh for your operating system. -Sharing Defaults -================ +Note: PublicKey has changed on Novmber 1st 2015, please import the new +key. + +Linux +----- + +There are package repositories for most distributions at https://repository.mrw.sh. + +### Ubuntu and Debian + +To accept my signature, install my key: + + wget -O- https://repository.mrw.sh/PublicKey \ + | sudo apt-key add - + +You can install all software using your package manager (`apt`), first install the repository: + + sudo apt-get install -y wget software-properties-common apt-transport-https + sudo apt-add-repository https://repository.mrw.sh + sudo apt-get update -y +Then you can install any project you wish, e.g. [`webtester`](https://mrw.sh/development/webtester): + + sudo apt-get install webtester -y + +### OpenSUSE + +To accept my signature, install my key: + + wget https://repository.mrw.sh/PublicKey + rpm --import PublicKey + +You can use your packagemanager (`zypper` or _YaST_). First install the repostitory: + + zypper ar https://repository.mrw.sh/opensuse/marc-waeckerlin.repo + +Then install packages from the repository, e.g. [`webtester`](https://mrw.sh/development/webtester): + + zypper install webtester + +In case of trouble: Check if your version of OpenSUSE is supported, +use `lsb_release -rs` to get the version of your OpenSUSE: +https://drepository.mrw.sh/opensuse + +### Fedora + +To accept my signature, install my key: + + wget https://repository.mrw.sh/PublicKey + rpm --import PublicKey + +You can use your packagemanager (`dnf`). First install the repository: + + dnf install 'dnf-command(config-manager)' + dnf config-manager --add-repo https://repository.mrw.sh/fedora/marc-waeckerlin.repo + +Then install packages from the repository, e.g. [`webtester`](https://mrw.sh/development/webtester): + + dnf install webtester + +In case of trouble: Check if your version of Fedora is supported, use `lsb_release -rs` to get the version of your Fedora: https://repository.mrw.sh/fedora + +### CentOS + +To accept my signature, install my key: + + wget https://repository.mrw.sh/PublicKey + rpm --import PublicKey + +You can use your packagemanager (`yum`). First install the repository: + + yum install wget + wget -O/etc/yum.repos.d/marc-waeckerlin.repo https://repository.mrw.sh/centos/marc-waeckerlin.repo + +Then install packages from the repository, e.g. [`webtester`](https://mrw.sh/development/webtester): + + yum install webtester + +In case of trouble: Check if your version of CentOS is supported, use lsb_release -rs to get the version of your CentOS: https://repository.mrw.sh/centos + +### Mageia + +To accept my signature, install my key: + + wget https://repository.mrw.sh/PublicKey + rpm --import PublicKey + +You can use your packagemanager (`dnf`). First install the repository: -If you want to set default values for `configure' scripts to share, you -can create a site shell script called `config.site' that gives default -values for variables like `CC', `cache_file', and `prefix'. -`configure' looks for `PREFIX/share/config.site' if it exists, then -`PREFIX/etc/config.site' if it exists. Or, you can set the -`CONFIG_SITE' environment variable to the location of the site script. -A warning: not all `configure' scripts look for a site script. + dnf install 'dnf-command(config-manager)' + dnf config-manager --add-repo https://repository.mrw.sh/mageia/marc-waeckerlin.repo -Defining Variables -================== +Then install packages from the repository, e.g. [`webtester`](https://mrw.sh/development/webtester): -Variables not defined in a site shell script can be set in the -environment passed to `configure'. However, some packages may run -configure again during the build, and the customized values of these -variables may be lost. In order to avoid this problem, you should set -them in the `configure' command line, using `VAR=value'. For example: + dnf install webtester - ./configure CC=/usr/local2/bin/gcc +### Other Linux Distributions -causes the specified `gcc' to be used as the C compiler (unless it is -overridden in the site shell script). Here is a another example: +Either use the nearest possible distribution, or use alien to convert from another distribution to your preferred package format, or compile the project yourself (see below). - /bin/bash ./configure CONFIG_SHELL=/bin/bash +Windows +------- -Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent -configuration-related scripts to be executed by `/bin/bash'. +Download from https://repository.mrw.sh/windows -`configure' Invocation -====================== +MacOSX +------ -`configure' recognizes the following options to control how it operates. +You need e.g. Mac Ports to compile. Install the following dependencies: -`--help' -`-h' - Print a summary of the options to `configure', and exit. + sudo port install subversion svn2cl doxygen graphviz cppunit libtool boost log4cxx qt5-mac -`--version' -`-V' - Print the version of Autoconf used to generate the `configure' - script, and exit. +Fix libtool-bug: -`--cache-file=FILE' - Enable the cache: use and save the results of the tests in FILE, - traditionally `config.cache'. FILE defaults to `/dev/null' to - disable caching. + sudo ln -s /opt/local/bin/glibtoolize /opt/local/bin/libtoolize -`--config-cache' -`-C' - Alias for `--cache-file=config.cache'. +Compile from Source +------------------- -`--quiet' -`--silent' -`-q' - Do not print messages saying which checks are being made. To - suppress all normal output, redirect it to `/dev/null' (any error - messages will still be shown). +For all unsupported operating systems, including MacOSX. -`--srcdir=DIR' - Look for the package's source code in directory DIR. Usually - `configure' can determine that directory automatically. +To compile, please download the tar-sources from: https://repository.mrw.sh/sources -`configure' also accepts some other, not widely useful, options. Run -`configure --help' for more details. +Then untar the package and use the common commands, e.g. for version `1.0.2` of a project named project, that means: + tar xzf project-1.0.2.tar.gz + cd project-1.0.2 + ./bootstrap.sh + ./configure + make + sudo make install \ No newline at end of file diff --git a/README.md b/README.md index ce26ecd..48040fd 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,8 @@ Featureful C++ Library containing a lot of needful things. Everything, I often n I have paid attention to define simple and a nice to use interfaces. The library makes use of object orientation, operator overload and templates, where it makes sense. The library passes several module tests before each delivery. It is therefore stable and tested. +**Note:** All *links* below require the generated [Doxygen](https://doc.mrw.sh/mrw-c++) documentation. + Features -------- @@ -54,9 +56,10 @@ This library contains [modules](modules.html) for the following purposes: In the Web ---------- - - The official project page is on: https://mrw.sh/libraries/mrw-cxx - - The official documentation is on: https://doc.mrw.sh/mrw-c++ - - The official repositories are on: https://repository.mrw.sh + - [Official project page](https://mrw.sh/libraries/mrw-cxx) + - [Full Doxygen library documentation](https://doc.mrw.sh/mrw-c++) + - [Official repositories](https://repository.mrw.sh) + - [Download and installation instructions](https://mrw.sh/doc/mrw.sh/src/branch/master/installation.md) Supported Platforms diff --git a/ax_init_standard_project.m4 b/ax_init_standard_project.m4 index 134fabf..369f3b2 100644 --- a/ax_init_standard_project.m4 +++ b/ax_init_standard_project.m4 @@ -1,4 +1,4 @@ -## @id $Id$ +## @id $Id: ax_init_standard_project.m4 204 2016-09-29 18:29:53Z marc $ ## 1 2 3 4 5 6 7 8 ## 45678901234567890123456789012345678901234567890123456789012345678901234567890 @@ -651,7 +651,6 @@ AC_DEFUN([AX_USE_DOXYGEN], [ AC_CHECK_PROG(have_doxygen, doxygen, yes, no) AC_CHECK_PROG(have_dot, dot, yes, no) AC_CHECK_PROG(have_mscgen, mscgen, yes, no) - AM_CONDITIONAL(NEED_PLANTUML, test "$have_doxygen" = "yes" -a "1.8.11" != $((echo "1.8.11"; doxygen -v 2>/dev/null) | sort -V | head -1)) PDF_DOC=${PACKAGE_NAME}-${PACKAGE_VERSION}.pdf AC_SUBST(PDF_DOC) if test "$have_doxygen" = "no"; then @@ -676,28 +675,12 @@ AC_DEFUN([AX_USE_DOXYGEN], [ AX_ADD_MAKEFILE_TARGET_DEP([.PHONY], [pdf gen-uml-images], [doc/makefile.in]) test -f doc/makefile.in && cat >> doc/makefile.in <COPYING @@ -41,7 +41,7 @@ while test $# -gt 0; do (--no-vcs|-n) novcs=1;; (--exclude-vcs|-x) shift; excludevcs+=("$1");; (--version|-v) - echo "$Id$"; + echo "$Id: bootstrap.sh 52 2015-11-03 15:38:21Z marc $"; exit;; (--help|-h) less <&2 - exit 1 - ;; - esac + if test -z "$img"; then + case "$mode" in + (deb|apt) img="mwaeckerlin/debbuildenv";; + (rpm|zypper) img="opensuse:latest";; + (yum) img="centos:latest";; + (dnf) img="fedora:latest";; + (win) + img="mwaeckerlin/debbuildenv"; host="${host:---host=i686-w64-mingw32}" + targets="all install" + flags+=("--prefix=/workdir/usr") + packages+=("mingw-w64") + ;; + (*) + echo "**** ERROR: unknown mode '$1', try --help" 1>&2 + exit 1 + ;; + esac + fi ;; (-i|--image) shift; img="$1" @@ -243,6 +246,9 @@ function ifthenelse() { set -x +if test -z "$img"; then + img="mwaeckerlin/debbuildenv" +fi docker pull $img DOCKER_ID=$(docker create ${dns[@]} ${dirs[@]} ${envs[@]} -w /workdir $img sleep infinity) trap 'traperror '"${DOCKER_ID}"' "$? ${PIPESTATUS[@]}" $LINENO $BASH_LINENO "$BASH_COMMAND" "${FUNCNAME[@]}" "${FUNCTION}"' SIGINT INT TERM EXIT @@ -262,8 +268,8 @@ if test -z "$mode"; then (*deb*) mode=deb;; (*rpm*) mode=rpm;; (*) case "$img" in - (*ubuntu*|*debian*|*mint*) mode=deb;; - (*fedora*|*centos*|*mageia*) mode=rpm;; + (*deb*|*ubuntu*|*debian*|*mint*) mode=deb;; + (*rpm*|*fedora*|*centos*|*mageia*) mode=rpm;; (*mingw*|*win*) mode=win;; (*) mode=deb;; esac;; @@ -289,7 +295,7 @@ case "$mode" in docker exec ${DOCKER_ID} bash -c "echo 'Pin-Priority: -100' >> /etc/apt/preferences" docker exec ${DOCKER_ID} bash -c "echo >> /etc/apt/preferences" done - if test -n "${keys[@]}"; then # fix dependency bug in cosmic and stretch + if test -n "${keys[*]}"; then # fix dependency bug in cosmic and stretch docker exec ${DOCKER_ID} apt-get install ${OPTIONS} ${PREVENT// /- }- gnupg for key in "${keys[@]}"; do wget -O- "$key" \ diff --git a/doc/plantuml.jar b/doc/plantuml.jar index 9502c23..2fcafa0 100644 Binary files a/doc/plantuml.jar and b/doc/plantuml.jar differ