scripts/generate-man-page.sh

   1 #!/bin/bash
   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 command -v help2man > /dev/null
  13 if [ $? -eq 1 ]
  14 then
  15         echo "help2man not installed"
  16         exit
  17 fi
  18
  19 command -v doclifter > /dev/null
  20 if [ $? -eq 1 ]
  21 then
  22         echo "doclifter not installed"
  23         exit
  24 fi
  25
  26 options_file=$(mktemp)
  27
  28 echo "[NAME]
  29 Geeqie - GTK based multiformat image viewer
  30
  31 [DESCRIPTION]
  32 Geeqie is an interactive GTK based image viewer that supports multiple image formats,
  33 zooming, panning, thumbnails and sorting images into collections.
  34
  35 Generated for version:
  36
  37 [SEE ALSO]
  38 Full documentation: https://www.geeqie.org/help/GuideIndex.html
  39
  40 [BUGS]
  41 Please send bug reports and feedback to https://github.com/BestImageViewer/geeqie/issues
  42
  43 [COPYRIGHT]
  44 Copyright (C) 1999-2004 by John Ellis. Copyright (C) 2004-2021 by The Geeqie Team. Use this software  at  your
  45 own  risk! This  software released under the GNU General Public License. Please read the COPYING file for more
  46 information." > "$options_file"
  47
  48
  49 help2man --no-info --include="$options_file" src/geeqie > geeqie.1
  50
  51 doclifter geeqie.1
  52 mv geeqie.1.xml doc/docbook/CommandLineOptions.xml
  53
  54 rm "$options_file"