1Quick Installation 2================== 3 4(Mac and Windows users please see README.Mac-Win.) 5 6 7If you just want to compile and install the binary in /usr/local/bin then: 8 9 (As normal user) 10 ./configure 11 make 12 13 (As root) 14 make install 15 16As of version 1.2 Whatmask supports locale setting for thousands grouping 17in the number of usable ip addresses display. (i.e. you can now get 18"65,534" instead of "65534"). To do this we use the built-in grouping present 19in most, but not all, printf functions. 20 21** TO USE THE THOUSANDS GROUPING you will almost definitely have to define 22one of the locale environment variables LANG or LC_NUMERIC. (You can define 23these in your .tcshrc or .profile, or wherever you like.) For US users who 24use the comma as their thousands separator use: 25setenv LC_NUMERIC 'en_US' (for tcsh) 26export LANG="en_US" (for bash) 27 28If this doesn't get you anywhere see the further (boilerplate) instructions 29below. Note the one configure option below as well. 30 31Some users have reported problems with pre-release versions of gcc. If you get 32"illegal instruction" errors please try compiling with an official full release 33of your compiler. You may also try disabling the optimizer by removing "-O2" 34from the Makefile after running configure. 35 36Basic Installation 37================== 38 39 These are generic installation instructions. 40 41 The `configure' shell script attempts to guess correct values for 42various system-dependent variables used during compilation. It uses 43those values to create a `Makefile' in each directory of the package. 44It may also create one or more `.h' files containing system-dependent 45definitions. Finally, it creates a shell script `config.status' that 46you can run in the future to recreate the current configuration, a file 47`config.cache' that saves the results of its tests to speed up 48reconfiguring, and a file `config.log' containing compiler output 49(useful mainly for debugging `configure'). 50 51 If you need to do unusual things to compile the package, please try 52to figure out how `configure' could check whether to do them, and mail 53diffs or instructions to the address given in the `README' so they can 54be considered for the next release. If at some point `config.cache' 55contains results you don't want to keep, you may remove or edit it. 56 57 The file `configure.in' is used to create `configure' by a program 58called `autoconf'. You only need `configure.in' if you want to change 59it or regenerate `configure' using a newer version of `autoconf'. 60 61The simplest way to compile this package is: 62 63 1. `cd' to the directory containing the package's source code and type 64 `./configure' to configure the package for your system. If you're 65 using `csh' on an old version of System V, you might need to type 66 `sh ./configure' instead to prevent `csh' from trying to execute 67 `configure' itself. 68 69 Running `configure' takes awhile. While running, it prints some 70 messages telling which features it is checking for. 71 72 2. Type `make' to compile the package. 73 74 3. Optionally, type `make check' to run any self-tests that come with 75 the package. 76 77 4. Type `make install' to install the programs and any data files and 78 documentation. 79 80 5. You can remove the program binaries and object files from the 81 source code directory by typing `make clean'. To also remove the 82 files that `configure' created (so you can compile the package for 83 a different kind of computer), type `make distclean'. There is 84 also a `make maintainer-clean' target, but that is intended mainly 85 for the package's developers. If you use it, you may have to get 86 all sorts of other programs in order to regenerate files that came 87 with the distribution. 88 89Compilers and Options 90===================== 91 92 Some systems require unusual options for compilation or linking that 93the `configure' script does not know about. You can give `configure' 94initial values for variables by setting them in the environment. Using 95a Bourne-compatible shell, you can do that on the command line like 96this: 97 CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure 98 99Or on systems that have the `env' program, you can do it like this: 100 env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure 101 102Compiling For Multiple Architectures 103==================================== 104 105 You can compile the package for more than one kind of computer at the 106same time, by placing the object files for each architecture in their 107own directory. To do this, you must use a version of `make' that 108supports the `VPATH' variable, such as GNU `make'. `cd' to the 109directory where you want the object files and executables to go and run 110the `configure' script. `configure' automatically checks for the 111source code in the directory that `configure' is in and in `..'. 112 113 If you have to use a `make' that does not supports the `VPATH' 114variable, you have to compile the package for one architecture at a time 115in the source code directory. After you have installed the package for 116one architecture, use `make distclean' before reconfiguring for another 117architecture. 118 119Installation Names 120================== 121 122 By default, `make install' will install the package's files in 123`/usr/local/bin', `/usr/local/man', etc. You can specify an 124installation prefix other than `/usr/local' by giving `configure' the 125option `--prefix=PATH'. 126 127 You can specify separate installation prefixes for 128architecture-specific files and architecture-independent files. If you 129give `configure' the option `--exec-prefix=PATH', the package will use 130PATH as the prefix for installing programs and libraries. 131Documentation and other data files will still use the regular prefix. 132 133 In addition, if you use an unusual directory layout you can give 134options like `--bindir=PATH' to specify different values for particular 135kinds of files. Run `configure --help' for a list of the directories 136you can set and what kinds of files go in them. 137 138 If the package supports it, you can cause programs to be installed 139with an extra prefix or suffix on their names by giving `configure' the 140option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. 141 142Optional Features 143================= 144 145--with-printheaders=<yes/no> (default yes) 146 147When this is disabled the header "TCP/IP NETWORK EQUIAVLENTS" will not be 148printed, and nor will the extra line feed at the end. 149 150Specifying the System Type 151========================== 152 153 There may be some features `configure' can not figure out 154automatically, but needs to determine by the type of host the package 155will run on. Usually `configure' can figure that out, but if it prints 156a message saying it can not guess the host type, give it the 157`--host=TYPE' option. TYPE can either be a short name for the system 158type, such as `sun4', or a canonical name with three fields: 159 CPU-COMPANY-SYSTEM 160 161See the file `config.sub' for the possible values of each field. If 162`config.sub' isn't included in this package, then this package doesn't 163need to know the host type. 164 165 If you are building compiler tools for cross-compiling, you can also 166use the `--target=TYPE' option to select the type of system they will 167produce code for and the `--build=TYPE' option to select the type of 168system on which you are compiling the package. 169 170Sharing Defaults 171================ 172 173 If you want to set default values for `configure' scripts to share, 174you can create a site shell script called `config.site' that gives 175default values for variables like `CC', `cache_file', and `prefix'. 176`configure' looks for `PREFIX/share/config.site' if it exists, then 177`PREFIX/etc/config.site' if it exists. Or, you can set the 178`CONFIG_SITE' environment variable to the location of the site script. 179A warning: not all `configure' scripts look for a site script. 180 181Operation Controls 182================== 183 184 `configure' recognizes the following options to control how it 185operates. 186 187`--cache-file=FILE' 188 Use and save the results of the tests in FILE instead of 189 `./config.cache'. Set FILE to `/dev/null' to disable caching, for 190 debugging `configure'. 191 192`--help' 193 Print a summary of the options to `configure', and exit. 194 195`--quiet' 196`--silent' 197`-q' 198 Do not print messages saying which checks are being made. To 199 suppress all normal output, redirect it to `/dev/null' (any error 200 messages will still be shown). 201 202`--srcdir=DIR' 203 Look for the package's source code in directory DIR. Usually 204 `configure' can determine that directory automatically. 205 206`--version' 207 Print the version of Autoconf used to generate the `configure' 208 script, and exit. 209 210`configure' also accepts some other, not widely useful, options. 211