scripts/generate-man-page.sh

   1 #!/bin/sh
   2
   3 ## @file
   4 ## @brief Create the man page from the output of the "geeqie--help" command
   5 ## and also create the xml file for Command Line Options
   6 ##
   7 ## This needs to be run only when the command line options change
   8 ##
   9 ## The programs help2man and doclifter are required - both are available as .deb packages.
  10 ##
  11
  12 if ! command -v help2man > /dev/null
  13 then
  14         printf '%s\n' "help2man not installed"
  15         exit 1
  16 fi
  17
  18 if ! command -v doclifter > /dev/null
  19 then
  20         printf '%s\n' "doclifter not installed"
  21         exit 1
  22 fi
  23
  24 options_file=$(mktemp "${TMPDIR:-/tmp}/geeqie.XXXXXXXXXX")
  25 year=$(date +"%Y")
  26
  27 printf '%s\n' "[NAME]
  28 Geeqie - GTK based multiformat image viewer
  29
  30 [DESCRIPTION]
  31 Geeqie is an interactive GTK based image viewer that supports multiple image formats,
  32 zooming, panning, thumbnails and sorting images into collections.
  33
  34 Generated for version:
  35
  36 [SEE ALSO]
  37 Full documentation: https://www.geeqie.org/help/GuideIndex.html
  38
  39 [BUGS]
  40 Please send bug reports and feedback to https://github.com/BestImageViewer/geeqie/issues
  41
  42 [COPYRIGHT]
  43 Copyright (C) 1999-2004 by John Ellis. Copyright (C) 2004-$year by The Geeqie Team. Use this software  at  your
  44 own  risk! This  software released under the GNU General Public License. Please read the COPYING file for more
  45 information." > "$options_file"
  46
  47 help2man --no-info --include="$options_file" src/geeqie > geeqie.1
  48
  49 doclifter geeqie.1
  50 mv geeqie.1.xml doc/docbook/CommandLineOptions.xml
  51
  52 rm "$options_file"