building(vii) building(vii) NAME vii - buffer and display output SITE CONFIGURATION The vii package is configured using the configure program included in this distribution. The configure shell script attempts to guess correct values for various system-dependent variables used during compilation, and creates the Makefile and common/config.h files. It also creates a shell script config.status that you can run in the future to recreate the current configuration. Normally, you just cd to the directory containing vii's source code and type % ./configure ...lots of output... % If you're using csh on an old version of System V, you might need to type % sh configure ...lots of output... % instead to prevent csh from trying to execute configure itself. Running configure takes a minute or two. While it is running, it prints some messages that tell what it is doing. If you don't want to see the messages, run configure with the --quiet option; for example, % ./configure --quiet % To compile the vii package in a different directory from the one containing the source code, 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 .. (the parent directory). If for some reason configure is not in the source code directory that you are configuring, then it will report that it can't find the source code. In that case, run configure with the option --srcdir=DIR, where DIR is the directory that contains the source code. By default, configure will arrange for the make install command to install the vii package's files in /usr/local/bin, /usr/local/man, etc. You can specify an installation prefix other than /usr/local by giving configure the option --prefix=PATH. You can specify separate installation prefixes for architecture- specific files and architecture-independent files. If you give configure the option --exec-prefix=PATH the vii package will use PATH as the prefix for installing programs and libraries. Data files and documentation will still use the regular prefix. Normally, all files are installed using the same prefix. configure ignores any other arguments that you give it. On systems that require unusual options for compilation or linking that the vii package's configure script does not know about, you can give configure initial values for variables by setting them in the environment. In Bourne-compatible shells, you can do that on the command line like this: $ CC='gcc -traditional' LIBS=-lposix ./configure ...lots of output... $ Here are the make variables that you might want to override with environment variables when running configure. Variable: CC C compiler program. The default is cc. Variable: INSTALL Program to use to install files. The default is install if you have it, cp otherwise. Variable: LIBS Libraries to link with, in the form -lfoo -lbar. The configure script will append to this, rather than replace it. If you need to do unusual things to compile the package, the author encourages you to figure out how configure could check whether to do them, and mail diffs or instructions to the author so that they can be included in the next release. BUILDING All you should need to do is use the % make ...lots of output... % command and wait. When this finishes you should see a directory called bin containing two files: vii and txt2c. vii vii program is a curses based output paginator. txt2c The txt2c program is a utility used to build the vii program; it is not intended for general use and should not be installed. You can remove the program binaries and object files from the source directory by using the % make clean ...lots of output... % command. To remove all of the above files, and also remove the Makefile and common/config.h and config.status files, use the % make distclean ...lots of output... % command. The file etc/configure.in is used to create configure by a GNU program called autoconf. You only need to know this if you want to regenerate configure using a newer version of autoconf. INSTALLING As explained in the SITE CONFIGURATION section, above, the vii package is installed under the /usr/local tree by default. Use the --prefix=PATH option to configure if you want some other path. All that is required to install the vii package is to use the % make install ...lots of output... % command. Control of the directories used may be found in the first few lines of the Makefile file if you want to bypass the configure script. GETTING HELP If you need assistance with the vii program, please do not hesitate to contact the author at Peter Miller Any and all feedback is welcome. When reporting problems, please include the version number given by the % vii -version vii version ...warranty disclaimer... % command. Please do not send this example; run the program for the exact version number. In the common/main.h file, there is a define of DEBUG in comments. If the comments are removed, extensive debugging is turned on. This causes some performance loss, but performs much run-time checking and adds the -TRace command line option. When the -TRace option is followed by one or more file names, it turns on execution traces in those source files. It is best to put this option on the end of the command, so that the names of the files to be traced are not confused with any other filenames or strings on the command line. COPYRIGHT vii version Copyright (C) Peter Miller The vii package is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. It should be in the LICENSE file included with this distribution. AUTHOR Peter Miller E-Mail: millerp@canb.auug.org.au /\/\* WWW: http://www.canb.auug.org.au/~millerp/ building(vii)