\: vim:syntax=tex
\: this is a manpage in zoem format.  see http://micans.org/zoem/ and man_zmm(7)
\: This file is maintained at http://git.mdcc.cx/caspar

\:  casparize script manpage
\:  Copyright (C) 2009  Jeroen Hoppenbrouwers
\:
\:  This program is free software: you can redistribute it and/or modify
\:  it under the terms of the GNU General Public License as published by
\:  the Free Software Foundation, either version 3 of the License, or
\:  (at your option) any later version.
\:
\:  This program 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.
\:
\:  You should have received a copy of the GNU General Public License
\:  along with this program.  If not, see <http://www.gnu.org/licenses/>.

\import{pud/man.zmm}
\import{./include.zmm}

\begin{pud::man}{
 {name}{casparize}
 {html_title}{casparize}
 {section}{1}
 \man_share
}

\${html}{\"pud::man::maketoc"}

\def{caspar}{\bf{caspar}}
\def{casparize}{\bf{casparize}}

\sec{name}{NAME}
\NAME{casparize}{Set up \caspar Makefile in a new directory}

\sec{synopsis}{SYNOPSIS}
\par{
  \casparize
    \synreqopt{dir}{/path/to/config/dir}
}
\par{
  \casparize
    \synreqopt{file}{/path/to/config/dir/file}
}

\sec{description}{DESCRIPTION}

\casparize creates a new configuration working directory in your current
working directory, sets up a Makefile for \sibref{caspar}{caspar(7)} in
this new directory,
and optionally copies an original configuration file from its original
system place to the newly created configuration working directory.

\sec{usage}{USAGE}

You typically use \casparize when you already have created the root
configuration working directory with its include directory and install.mk
Caspar include file. By analysing your current working directory and the
configuration directory path you give on the command line, casparize can
deduce the contents of the Makefile in the newly created configuration
working directory. It creates the new directory, creates the correct
Makefile, and optionally copies the given configuration file in the new
directory, ready for its first version commit.

\sec{examples}{EXAMPLES}

A typical example:

\verbatim{
  $ cd <svn>/etc
  $ casparize /etc/postfix/main.cf}

creates the directory <svn>/etc/postfix, creates <svn>/etc/postfix/Makefile
including the proper content, and copies /etc/postfix/main.cf into
<svn>/etc/postfix/main.cf. You can now directly add and commit the new
directory.

\sec{bugs}{BUGS}

Non known at this moment.

\sec{author}{AUTHOR}

Jeroen Hoppenbrouwers

\sec{seealso}{SEE ALSO}

\sibref{caspar}{caspar(7)}

The caspar homepage is at \httpref{http://mdcc.cx/caspar/} .

\end{pud::man}

