Annotation of embedaddon/lrzsz/INSTALL, revision 1.1
1.1 ! misho 1: To install:
! 2:
! 3: 0) if you are uncommon with configuration and installation of GNU/autoconf'd
! 4: software please read to generic install text at the end of this file.
! 5: 1) configure the package, possibly with
! 6: CFLAGS=-O2 ./configure
! 7: Use the following options if you need to:
! 8: --disble-timesync
! 9: this saves a few bytes. The timesync protocol allows to set the
! 10: receivers system time to the sender's time (see option S in
! 11: the manual pages). Including timesync support doesn't introduce
! 12: any incompatabilites (but *using* timesync does).
! 13: --enable-pubdir=/var/spool/uucppublic
! 14: if you want support for a public writeable directory.
! 15: --enable-syslog[=[[FACILITY,]level]]
! 16: to include syslog support. Not much will be written to syslog,
! 17: just one line per file.
! 18: Default facility is LOG_UUCP, but you can change that to whatever
! 19: your syslog.h supports.
! 20: Level defaults to "default", meaning syslog is on by default,
! 21: but is can be forced ("force"), meaning users will not be
! 22: allowed to turn it off, and it can be "optional", meaning users
! 23: have to turn it on for every transmission.
! 24: Example:
! 25: --enable-syslog=LOG_LOCAL0,force
! 26: every filetransfer will be logged to LOG_LOCAL0.
! 27: --enable-syslog=default and --enable-syslog
! 28: every filetransfer will be logged to LOG_UUCP, unless
! 29: the user turns this off with the "--syslog=off" runtime
! 30: option of lsz and lrz.
! 31: --enable-syslog=optional
! 32: no filetransfer will be logged, but syslogging can be
! 33: enabled with the "--syslog" runtime option of lsz and lrz.
! 34: --disable-mkdir
! 35: if rz shall never create directories (this option is only included
! 36: because disbaling the directory creation was possible with the
! 37: original sources).
! 38: --prefix=/usr/local
! 39: to install the programs and documentation under /usr/local instead
! 40: of /usr (default).
! 41: --program-transform-name=s/l//
! 42: to install the programs and manual pages under the traditional
! 43: names (sz, sz.1 instead of lsz, lsz.1).
! 44: 2) make
! 45: (please contact uwe@ohse.de if there are any problems. Sorry,
! 46: for the moment i only have access to linux machines)
! 47: 3) make check
! 48: will perform a selftest, sending some files in the distribution
! 49: through a nimed pipe.
! 50: ("make vcheck" will do the same as "make check" does, but prints
! 51: a progres report)
! 52: 4) please read COMPATABILITY
! 53: 5) make install
! 54: if everything is ok.
! 55:
! 56: -------------------- generic GNU INSTALL text -----------------------------
! 57: Basic Installation
! 58: ==================
! 59:
! 60: These are generic installation instructions.
! 61:
! 62: The `configure' shell script attempts to guess correct values for
! 63: various system-dependent variables used during compilation. It uses
! 64: those values to create a `Makefile' in each directory of the package.
! 65: It may also create one or more `.h' files containing system-dependent
! 66: definitions. Finally, it creates a shell script `config.status' that
! 67: you can run in the future to recreate the current configuration, a file
! 68: `config.cache' that saves the results of its tests to speed up
! 69: reconfiguring, and a file `config.log' containing compiler output
! 70: (useful mainly for debugging `configure').
! 71:
! 72: If you need to do unusual things to compile the package, please try
! 73: to figure out how `configure' could check whether to do them, and mail
! 74: diffs or instructions to the address given in the `README' so they can
! 75: be considered for the next release. If at some point `config.cache'
! 76: contains results you don't want to keep, you may remove or edit it.
! 77:
! 78: The file `configure.in' is used to create `configure' by a program
! 79: called `autoconf'. You only need `configure.in' if you want to change
! 80: it or regenerate `configure' using a newer version of `autoconf'.
! 81:
! 82: The simplest way to compile this package is:
! 83:
! 84: 1. `cd' to the directory containing the package's source code and type
! 85: `./configure' to configure the package for your system. If you're
! 86: using `csh' on an old version of System V, you might need to type
! 87: `sh ./configure' instead to prevent `csh' from trying to execute
! 88: `configure' itself.
! 89:
! 90: Running `configure' takes awhile. While running, it prints some
! 91: messages telling which features it is checking for.
! 92:
! 93: 2. Type `make' to compile the package.
! 94:
! 95: 3. Optionally, type `make check' to run any self-tests that come with
! 96: the package.
! 97:
! 98: 4. Type `make install' to install the programs and any data files and
! 99: documentation.
! 100:
! 101: 5. You can remove the program binaries and object files from the
! 102: source code directory by typing `make clean'. To also remove the
! 103: files that `configure' created (so you can compile the package for
! 104: a different kind of computer), type `make distclean'. There is
! 105: also a `make maintainer-clean' target, but that is intended mainly
! 106: for the package's developers. If you use it, you may have to get
! 107: all sorts of other programs in order to regenerate files that came
! 108: with the distribution.
! 109:
! 110: Compilers and Options
! 111: =====================
! 112:
! 113: Some systems require unusual options for compilation or linking that
! 114: the `configure' script does not know about. You can give `configure'
! 115: initial values for variables by setting them in the environment. Using
! 116: a Bourne-compatible shell, you can do that on the command line like
! 117: this:
! 118: CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
! 119:
! 120: Or on systems that have the `env' program, you can do it like this:
! 121: env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
! 122:
! 123: Compiling For Multiple Architectures
! 124: ====================================
! 125:
! 126: You can compile the package for more than one kind of computer at the
! 127: same time, by placing the object files for each architecture in their
! 128: own directory. To do this, you must use a version of `make' that
! 129: supports the `VPATH' variable, such as GNU `make'. `cd' to the
! 130: directory where you want the object files and executables to go and run
! 131: the `configure' script. `configure' automatically checks for the
! 132: source code in the directory that `configure' is in and in `..'.
! 133:
! 134: If you have to use a `make' that does not supports the `VPATH'
! 135: variable, you have to compile the package for one architecture at a time
! 136: in the source code directory. After you have installed the package for
! 137: one architecture, use `make distclean' before reconfiguring for another
! 138: architecture.
! 139:
! 140: Installation Names
! 141: ==================
! 142:
! 143: By default, `make install' will install the package's files in
! 144: `/usr/local/bin', `/usr/local/man', etc. You can specify an
! 145: installation prefix other than `/usr/local' by giving `configure' the
! 146: option `--prefix=PATH'.
! 147:
! 148: You can specify separate installation prefixes for
! 149: architecture-specific files and architecture-independent files. If you
! 150: give `configure' the option `--exec-prefix=PATH', the package will use
! 151: PATH as the prefix for installing programs and libraries.
! 152: Documentation and other data files will still use the regular prefix.
! 153:
! 154: In addition, if you use an unusual directory layout you can give
! 155: options like `--bindir=PATH' to specify different values for particular
! 156: kinds of files. Run `configure --help' for a list of the directories
! 157: you can set and what kinds of files go in them.
! 158:
! 159: If the package supports it, you can cause programs to be installed
! 160: with an extra prefix or suffix on their names by giving `configure' the
! 161: option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
! 162:
! 163: Optional Features
! 164: =================
! 165:
! 166: Some packages pay attention to `--enable-FEATURE' options to
! 167: `configure', where FEATURE indicates an optional part of the package.
! 168: They may also pay attention to `--with-PACKAGE' options, where PACKAGE
! 169: is something like `gnu-as' or `x' (for the X Window System). The
! 170: `README' should mention any `--enable-' and `--with-' options that the
! 171: package recognizes.
! 172:
! 173: For packages that use the X Window System, `configure' can usually
! 174: find the X include and library files automatically, but if it doesn't,
! 175: you can use the `configure' options `--x-includes=DIR' and
! 176: `--x-libraries=DIR' to specify their locations.
! 177:
! 178: Specifying the System Type
! 179: ==========================
! 180:
! 181: There may be some features `configure' can not figure out
! 182: automatically, but needs to determine by the type of host the package
! 183: will run on. Usually `configure' can figure that out, but if it prints
! 184: a message saying it can not guess the host type, give it the
! 185: `--host=TYPE' option. TYPE can either be a short name for the system
! 186: type, such as `sun4', or a canonical name with three fields:
! 187: CPU-COMPANY-SYSTEM
! 188:
! 189: See the file `config.sub' for the possible values of each field. If
! 190: `config.sub' isn't included in this package, then this package doesn't
! 191: need to know the host type.
! 192:
! 193: If you are building compiler tools for cross-compiling, you can also
! 194: use the `--target=TYPE' option to select the type of system they will
! 195: produce code for and the `--build=TYPE' option to select the type of
! 196: system on which you are compiling the package.
! 197:
! 198: Sharing Defaults
! 199: ================
! 200:
! 201: If you want to set default values for `configure' scripts to share,
! 202: you can create a site shell script called `config.site' that gives
! 203: default values for variables like `CC', `cache_file', and `prefix'.
! 204: `configure' looks for `PREFIX/share/config.site' if it exists, then
! 205: `PREFIX/etc/config.site' if it exists. Or, you can set the
! 206: `CONFIG_SITE' environment variable to the location of the site script.
! 207: A warning: not all `configure' scripts look for a site script.
! 208:
! 209: Operation Controls
! 210: ==================
! 211:
! 212: `configure' recognizes the following options to control how it
! 213: operates.
! 214:
! 215: `--cache-file=FILE'
! 216: Use and save the results of the tests in FILE instead of
! 217: `./config.cache'. Set FILE to `/dev/null' to disable caching, for
! 218: debugging `configure'.
! 219:
! 220: `--help'
! 221: Print a summary of the options to `configure', and exit.
! 222:
! 223: `--quiet'
! 224: `--silent'
! 225: `-q'
! 226: Do not print messages saying which checks are being made.
! 227:
! 228: `--srcdir=DIR'
! 229: Look for the package's source code in directory DIR. Usually
! 230: `configure' can determine that directory automatically.
! 231:
! 232: `--version'
! 233: Print the version of Autoconf used to generate the `configure'
! 234: script, and exit.
! 235:
! 236: `configure' also accepts some other, not widely useful, options.
! 237:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>