docs/man/BuildManPages.cmake

   1 #
   2 # This file is part of the GROMACS molecular simulation package.
   3 #
   4 # Copyright (c) 2014, by the GROMACS development team, led by
   5 # Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6 # and including many others, as listed in the AUTHORS file in the
   7 # top-level source directory and at http://www.gromacs.org.
   8 #
   9 # GROMACS is free software; you can redistribute it and/or
  10 # modify it under the terms of the GNU Lesser General Public License
  11 # as published by the Free Software Foundation; either version 2.1
  12 # of the License, or (at your option) any later version.
  13 #
  14 # GROMACS is distributed in the hope that it will be useful,
  15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17 # Lesser General Public License for more details.
  18 #
  19 # You should have received a copy of the GNU Lesser General Public
  20 # License along with GROMACS; if not, see
  21 # http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23 #
  24 # If you want to redistribute modifications to GROMACS, please
  25 # consider that scientific software is very special. Version
  26 # control is crucial - bugs must be traceable. We will be happy to
  27 # consider code for inclusion in the official distribution, but
  28 # derived work must not be called official GROMACS. Details are found
  29 # in the README & COPYING files - if they are missing, get the
  30 # official version at http://www.gromacs.org.
  31 #
  32 # To help us fund GROMACS development, we humbly ask that you cite
  33 # the research papers on the package. Check out http://www.gromacs.org.
  34
  35 if (NOT DEFINED GMX_EXECUTABLE OR NOT DEFINED SOURCE_DIR)
  36     message(FATAL_ERROR "Required input parameter not set")
  37 endif()
  38
  39 file(MAKE_DIRECTORY man1)
  40 file(MAKE_DIRECTORY man7)
  41 file(COPY ${SOURCE_DIR}/man7/gromacs.7.in DESTINATION man7/)
  42 execute_process(
  43     COMMAND ${GMX_EXECUTABLE} -quiet help -export man
  44     RESULT_VARIABLE exitcode)
  45 if (exitcode)
  46     # Ensure that no partial output is left behind.
  47     file(REMOVE_RECURSE man1)
  48     file(REMOVE man7/gromacs.7)
  49     if (ERRORS_ARE_FATAL)
  50         message(FATAL_ERROR
  51             "Failed to generate man pages. "
  52             "Set GMX_BUILD_HELP=OFF if you want to skip them.\n"
  53             "Error/exit code: ${exitcode}")
  54     else()
  55         message(
  56             "Failed to generate man pages, will build GROMACS without. "
  57             "Set GMX_BUILD_HELP=OFF if you want to skip this notification and "
  58             "warnings during installation.")
  59     endif()
  60 endif()