docs/man/CMakeLists.txt

   1 #
   2 # This file is part of the GROMACS molecular simulation package.
   3 #
   4 # Copyright (c) 2012,2013,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(SOURCE_IS_SOURCE_DISTRIBUTION)
  36     # Make sure source package contains all man pages.
  37     if(NOT EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/man1/gmx-view.1")
  38         message(FATAL_ERROR "Man pages are missing from source package.")
  39     endif()
  40 endif()
  41
  42 add_custom_target(man
  43     ${CMAKE_COMMAND} -E make_directory man1
  44     COMMAND ${CMAKE_COMMAND} -E make_directory man7
  45     COMMAND ${CMAKE_COMMAND} -E copy "${CMAKE_CURRENT_SOURCE_DIR}/man7/gromacs.7.in" man7/
  46     COMMAND gmx -quiet help -export man
  47     WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
  48     COMMENT "Generating man pages"
  49     VERBATIM)
  50
  51 set(MAN_PAGE_DIR ${CMAKE_CURRENT_SOURCE_DIR})
  52 if (GMX_BUILD_HELP)
  53     set_target_properties(man PROPERTIES EXCLUDE_FROM_ALL OFF)
  54     set_directory_properties(PROPERTIES
  55         ADDITIONAL_MAKE_CLEAN_FILES "man1;man7/gromacs.7")
  56     set(MAN_PAGE_DIR ${CMAKE_CURRENT_BINARY_DIR})
  57 endif()
  58
  59 # man pages are only available if they are either build or this is a source archive
  60 if (SOURCE_IS_SOURCE_DISTRIBUTION OR GMX_BUILD_HELP)
  61     install(FILES ${MAN_PAGE_DIR}/man7/gromacs.7
  62         DESTINATION ${MAN_INSTALL_DIR}/man7
  63         COMPONENT man)
  64     install(DIRECTORY ${MAN_PAGE_DIR}/man1
  65         DESTINATION ${MAN_INSTALL_DIR}
  66         COMPONENT man)
  67 endif()