diff options
| author | Luke Shumaker <LukeShu@sbcglobal.net> | 2009-07-30 21:24:10 -0400 |
|---|---|---|
| committer | Luke Shumaker <lukeshu@sbcglobal.net> | 2015-06-26 00:30:13 -0600 |
| commit | f684fcc409532b95ad06087b85106616e915cf18 (patch) | |
| tree | 4fe04c684dc57dd58ed394076c31e0f2ef645074 /README | |
| parent | 87f0c8dec18eb50d1461d53bf1239c8dda73ed54 (diff) | |
update README and HACKING... a little bit
Diffstat (limited to 'README')
| -rw-r--r-- | README | 57 |
1 files changed, 30 insertions, 27 deletions
@@ -32,7 +32,7 @@ system requirements To my knowledge, this is the absolute requirements (all need to be in your PATH): - * GNU bash + * a POSIX shell (tested with dash, and GNU BASH) * cat (included in GNU Core Utils) * cp (included in GNU Core Utils) * cut (included in GNU Core Utils) @@ -60,35 +60,38 @@ building Configuration - There are several configuration variables that can be set. The - default values are kept in the file `Variables'. - - Variables is in the format `VAR_NAME<tab>VALUE'. You can modify - these configuration variables by editing the `Variables' file - directly, or by running ./configure such as: + There are several configuration variables that can be set. You can + modify these configuration variables by running ./configure such + as: $ ./configure --VAR_NAME=VALUE The different configuration variables are as follows: - VER value='0.6.3' - rvs's internal varsion number - SHELL value='/usr/bin/env bash' - the shell that scripts will be run in. - prefix value="$HOME" - where the files will be installed. For me the defualt is - `/home/luke'. Many of you will want to change this to '/usr' - bindir value='bin' - the binaries folder inside the prefix. If I leave the prefix - and bindir the same, for me rvs is installed in - `/home/luke/bin'. If I change prefix to '/usr', then rvs will - be installed in `/usr/bin' - libdir value='/etc/rvs/' - where the rvs libraries will be installed. In rvs almost - nothing is actually done in the execurable you call when you - type `rvs' ([$prefix]/[$bindir]/rvs) but option handling. All - the real work is done in modular sub-programs. I call them - libraries, even though they are independend programs that - communicate via pipes. Note that they probably should NOT be - located in your PATH. + name='rvs' + The name of the program. Note that unlike most + variables, you should NOT call this in Makefiles + (`$(name)'), but use $(rvs) instead. + RVS='$(bindir)/$(rvs)' + Where the exectuable will be. `$(rvs)' is the same as + `$(name)' (see above) + SHELL='/bin/sh' + The shell that will be used by make, and the shell + that scripts will run in. (Perhaps we should make + these separate variables?) + prefix='/usr/local' + Standard GNU variable. Many of you will want to + change this to `/usr', or `/home/USER_NAME' + exec_prefix='$(prefix)' + Standard GNU variable. + bindir='$(exec_prefix)/bin' + Standard GNU variable. + sbindir='$(exec_prefix)/sbin' + Standard GNU variable. + libexecdir='$(exec_prefix)/libexec' + Standard GNU variable. The plugins will be installed + at $(libexecdir)/$(name) + srcdir=$(readlink -f `dirname "$0"`) + Where the source code is. The default value evaluates + to the directory of the `configure' script. ~ Luke Shumaker <LukeShu@sbcglobal.net> Happy Hacking! |