1 Mar 2005    caspar 20050301

1.  
2.  
3.  
4.  
5.  

NAME

caspar - Makefile snippets for common tasks

SYNOPSIS

In a Makefile, do either 
  include caspar/mk/caspar.mk
or 
  include caspar/mk/docbook.mk
or 
  include caspar/mk/pod.mk
.

DESCRIPTION

Caspar offers Makefile snippets for common tasks, like installing configuration files, or typesetting LaTeX, DocBook XML and DocBook SGML documents.

The typesetting functionality is delivered by docbook.mk and pod.mk. This is documented in caspar-typesetting(7).

The installing-stuff functionality functionality is delivered by caspar.mk. (That's what the rest of the manual will talk about.) It enables one to run 'make install' from within a tree which typically holds configuration files, managed using CVS (or Subversion or any other version control system, for that matter).

It is useful in cases like this: all configuration files of some host are under version control, and, after commiting a change to CVS, you want to be able to easily install the new configuration file on the host.

With caspar, all you have to do is specify the hostname in one place, and specify the name of the target directory in each CVS directory.

USAGE

Within a CVS tree, create a file include/install.mk, with contents like e.g. 
 csp_SUH = root@some.host.somewhere
 include caspar/mk/caspar.mk
. Within each other directory of the CVS tree which holds files, create a Makefile, which looks like e.g. 
 csp_SCPDIR = /some/dir/ectory/
 include ../../include/install.mk
. If you'd like to use the install-recursive target too, in directories which hold subdirectories (but not files), you'll have to create a Makefile which looks something like 
 include ../../include/install.mk
. From within the CVS tree, one can call: 
  make <filename>-install
  make install
  make load
  make
  make install-recursive
The install-recursive target descends down the tree, and calls make install in each subdirectory.

VARIABLES

The variables one can set in a calling Makefile are:
csp_CP
   
cp binary, just "cp" by default
csp_CPFLAGS
   
extra arguments to pass to cp invocation, none by default
csp_SCP
   
scp binary, just "scp" by default
csp_SCPFLAGS
   
extra arguments to pass to scp invocation, e.g. '-i .ssh/id_rsa-root'
csp_SUH
   
ssh-reachable user@host (Secure User at Host)
csp_SUHS
   
space separated list of ssh-reachable user@host items (Secure User at HostS)
csp_CPDIR
   
directory to which we can cp(1), instead of scp (CoPy DIRectory)
csp_CPDIRS
   
space separated list of directories to which we can copy (CoPy DIRectorieS)
csp_SCPDIR
   
directory on ssh reachable host, with trailing / (Secure CoPy DIRectory)
csp_SUHDIRS
   
this is the list $(csp_SUH):$(dir) for each $(dir) in $(csp_SUHS) (or where dir = $(csp_SCPDIR), in case csp_SUHS is not set). However, more items can get added to this list on the fly.
csp_LOAD
   
targets which should depend on the `load' target.
csp_TABOOFILES
   
files which should never be installed. set to