# OpenVAS
# $Id$
# Description: CMakefile for the OpenVAS CLI documentation
#
# Authors:
# Matthew Mundell <matt@mundell.ukfsn.org>
#
# Copyright:
# Copyright (C) 2009,2010, 2016 Greenbone Networks GmbH
#
# 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 2
# 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, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

# Howto update man pages:
# With "make man" and "make man-html", new files with ".8" and ".8.html" are
# created in the build/doc directory. These files need to be copied to the
# source doc directory and committed as "generated from .8.xml", see ChangeLog
# for examples.

## Find xml2man

message (STATUS "Looking for xmltoman...")

find_program (XMLTOMAN_EXECUTABLE xmltoman
  PATHS /bin /usr/bin /usr/local/bin/
  DOC "xmltoman location")

message (STATUS "Looking for xmltoman... ${XMLTOMAN_EXECUTABLE}")

find_program (XMLMANTOHTML_EXECUTABLE xmlmantohtml
  PATHS /bin /usr/bin /usr/local/bin/
  DOC "xmlmantohtml location")

message (STATUS "Looking for xmlmantohtml... ${XMLMANTOHTML_EXECUTABLE}")

# FIX find_program seems to follow symlink
if (XMLMANTOHTML_EXECUTABLE)
  set (XMLMANTOHTML_EXECUTABLE xmlmantohtml)
endif (XMLMANTOHTML_EXECUTABLE)

## build

include (FindDoxygen)

## Emit warning if Doxygen not found.
## Otherwise, create doc and doc-full targets.
if (NOT DOXYGEN_EXECUTABLE)
  message (STATUS "Doxygen is required to build the HTML docs.")
else (NOT DOXYGEN_EXECUTABLE)
  add_custom_target (doc COMMENT "Building documentation..."
                     DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/.built-html ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)

  add_custom_target (doc-full COMMENT "Building documentation..."
                     DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_full ${CMAKE_CURRENT_BINARY_DIR}/.built-html_full)
add_custom_command (OUTPUT .built-html
  COMMAND sh
  ARGS -c \"${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile && touch ${CMAKE_CURRENT_BINARY_DIR}/.built-html\;\"
  DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)

add_custom_command (OUTPUT .built-html_full
  COMMAND sh
  ARGS -c \"${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_full && touch ${CMAKE_CURRENT_BINARY_DIR}/.built-html_full\;\"
  DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_full)
endif (NOT DOXYGEN_EXECUTABLE)

if (XMLTOMAN_EXECUTABLE)
  add_custom_target (man COMMENT "Building manual page..."
    DEPENDS omp.8 check_omp.8 omp-dialog.8)

  add_custom_command (OUTPUT omp.8
    COMMAND sh
    ARGS -c \"${XMLTOMAN_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/omp.8.xml > ${CMAKE_CURRENT_BINARY_DIR}/omp.8\;\"
    DEPENDS omp.8.xml)

  add_custom_command (OUTPUT check_omp.8
    COMMAND sh
    ARGS -c \"${XMLTOMAN_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/check_omp.8.xml > ${CMAKE_CURRENT_BINARY_DIR}/check_omp.8\;\"
    DEPENDS check_omp.8.xml)

  add_custom_command (OUTPUT omp-dialog.8
    COMMAND sh
    ARGS -c \"${XMLTOMAN_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/omp-dialog.8.xml > ${CMAKE_CURRENT_BINARY_DIR}/omp-dialog.8\;\"
    DEPENDS omp-dialog.8.xml)
else (XMLTOMAN_EXECUTABLE)
  message (STATUS "WARNING: xmltoman is required to generate manpages.")
  add_custom_command (OUTPUT omp.8
    COMMAND echo "[Error: xmltoman required to see manpage here]" > omp.8)
  add_custom_command (OUTPUT check_omp.8
    COMMAND echo "[Error: xmltoman required to see manpage here]" > check_omp.8)
  add_custom_command (OUTPUT omp-dialog.8
    COMMAND echo "[Error: xmltoman required to see manpage here]" > omp-dialog.8)
endif (XMLTOMAN_EXECUTABLE)

if (XMLMANTOHTML_EXECUTABLE)
  add_custom_target (man-html COMMENT "Building manual page HTML..."
    DEPENDS omp.html check_omp.html omp-dialog.html)

  add_custom_command (OUTPUT omp.html
    COMMAND sh
    ARGS -c \"${XMLMANTOHTML_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/omp.8.xml > ${CMAKE_CURRENT_BINARY_DIR}/omp.html\;\"
    DEPENDS omp.8.xml)

  add_custom_command (OUTPUT check_omp.html
    COMMAND sh
    ARGS -c \"${XMLMANTOHTML_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/check_omp.8.xml > ${CMAKE_CURRENT_BINARY_DIR}/check_omp.html\;\"
    DEPENDS check_omp.8.xml)

  add_custom_command (OUTPUT omp-dialog.html
    COMMAND sh
    ARGS -c \"${XMLMANTOHTML_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/omp-dialog.8.xml > ${CMAKE_CURRENT_BINARY_DIR}/omp-dialog.html\;\"
    DEPENDS omp-dialog.8.xml)
else (XMLMANTOHTML_EXECUTABLE)
  message (STATUS "WARNING: xmlmantohtml is required for manpage in HTML docs.")
  add_custom_command (OUTPUT omp.html
    COMMAND echo "[Error: xmlmantohtml required to see manpage here]" > omp.html)
  add_custom_command (OUTPUT check_omp.html
    COMMAND echo "[Error: xmlmantohtml required to see manpage here]" > check_omp.html)
  add_custom_command (OUTPUT omp-dialog.html
    COMMAND echo "[Error: xmlmantohtml required to see manpage here]" > omp-dialog.html)
endif (XMLMANTOHTML_EXECUTABLE)

install (FILES omp.8 check_omp.8 omp-dialog.8
  DESTINATION ${DATADIR}/man/man8 )
