cmake.1

   1 .\"                                      Hey, EMACS: -*- nroff -*-
   2 .\" First parameter, NAME, should be all caps
   3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
   4 .\" other parameters are allowed: see man(7), man(1)
   5 .TH CMAKE 1 "August 8, 2002"
   6 .\" Please adjust this date whenever revising the manpage.
   7 .\"
   8 .\" Some roff macros, for reference:
   9 .\" .nh        disable hyphenation
  10 .\" .hy        enable hyphenation
  11 .\" .ad l      left justify
  12 .\" .ad b      justify to both left and right margins
  13 .\" .nf        disable filling
  14 .\" .fi        enable filling
  15 .\" .br        insert line break
  16 .\" .sp <n>    insert n+1 empty lines
  17 .\" for manpage-specific macros, see man(7)
  18 .SH NAME
  19 cmake \- Cross-platform Makefile generator.
  20 .SH SYNOPSIS
  21 .B cmake
  22 .RI < path-to-source > " " [ options ]
  23 .br
  24 .B ccmake
  25 .RI < path-to-source >
  26 .br
  27 .B ctest
  28 .RI [ -R " " < regex > ]
  29 .br
  30 .B cmaketest
  31 .RI < test-src-dir > " " < test-bin-dir > " " < test-executable >
  32 .SH DESCRIPTION
  33
  34 This manual page documents briefly the \fBcmake\fP, \fBccmake\fP,
  35 \fBctest\fP and \fBcmaketest\fP commands.  It is not intended to aid
  36 authors of CMakeLists.txt files or to describe all advanced options
  37 available.  For full documentation, please visit
  38 \fBhttp://www.cmake.org\fP.
  39
  40 .PP
  41 .\" TeX users may be more comfortable with the \fB<whatever>\fP and
  42 .\" \fI<whatever>\fP escape sequences to invode bold face and italics,
  43 .\" respectively.
  44
  45 CMake provides developers with a means of building their project on
  46 multiple platforms while writing only one build system configuration.
  47 The developer writes a set of CMakeLists.txt files that are read by
  48 CMake and used to generate a native build system for the current
  49 environment.  On unix platforms, Makefiles are generated.
  50
  51 .PP
  52
  53 \fBcmake\fP is used to generate the makefiles for a project from its
  54 source.  The first argument should specify a path to the source tree.
  55 The current directory will be used as the build tree for the project.
  56 Both in-source and out-of-source builds are supported, but
  57 out-of-source builds are preferred.  CMake provides functionality for
  58 tailoring the build to user preferences through settings in the cmake
  59 cache.  Options may be set interactively using the -i option (or
  60 \fBccmake\fP).  Once CMake has generated the makefiles in the build
  61 tree, one may use the standard \fBmake\fP tool to build the project.
  62
  63 .PP
  64
  65 \fBccmake\fP provides a curses interface front-end for \fBcmake\fP.
  66 The interface allows users to interactively configure the build
  67 options stored in the cmake cache.  This is the preferred interface
  68 for interactive builds.  Build scripts should use \fBcmake\fP
  69 directly.
  70
  71 .PP
  72
  73 \fBctest\fP runs tests found in the project's build tree after it has
  74 been compiled and displays a summary of test results.  Use the -R
  75 option to specify a regular expression of test names to match.
  76
  77 \fBcmaketest\fP is provided to simplify project testing scripts.  It
  78 allows a CMake project to be compiled and tested from a single command
  79 line.
  80
  81 .SH OPTIONS
  82
  83 .TP
  84 .B \-\-help
  85 Available for \fBcmake\fP , \fBccmake\fP and \fBcmaketest\fP.
  86 .br
  87 Show version number and summary of options.
  88
  89 .TP
  90 .B -R regex
  91 Available for \fBctest\fP.
  92 .br
  93 Run only tests matching the given regular expression.
  94
  95 .TP
  96 .B -i
  97 Available for \fBcmake\fP.
  98 .br
  99 Run cmake in an interactive wizard mode to configure the build.
 100
 101 .SH SEE ALSO
 102 .BR Dart (1),
 103 .BR VTK (1).
 104
 105 .SH MAILING LIST
 106 For help using cmake, a mailing list is provided at
 107 \fBcmake@www.cmake.org\fP.  Please first read the full documentation
 108 at \fBhttp://www.cmake.org\fP before posting questions to the list.
 109
 110 .SH AUTHOR
 111 This manual page was written by CMake authors at Kitware
 112 <kitware@kitware.com>.