2020-07-16 12:24:48 +00:00
|
|
|
#!/usr/bin/bash
|
|
|
|
|
#
|
|
|
|
|
# generate_man_page.sh
|
|
|
|
|
# Generate a Unix manual page for EmulationStation Desktop Edition.
|
|
|
|
|
#
|
2020-12-30 13:13:53 +00:00
|
|
|
# The script takes no arguments and replaces the man page file es-app/assets/emulationstation.6.gz
|
|
|
|
|
# It has to be run from within the tools directory.
|
2020-07-16 12:24:48 +00:00
|
|
|
#
|
|
|
|
|
# The command help2man must be installed, or the script will fail.
|
|
|
|
|
#
|
2020-12-30 13:19:18 +00:00
|
|
|
# This script is intended to only be used on Linux systems.
|
|
|
|
|
#
|
2020-07-16 12:24:48 +00:00
|
|
|
# Leon Styhre
|
|
|
|
|
# 2020-07-16
|
|
|
|
|
#
|
|
|
|
|
|
2020-12-30 13:13:53 +00:00
|
|
|
if [ ! -f ../es-app/CMakeLists.txt ]; then
|
|
|
|
|
echo "You need to run this script from within the tools directory."
|
|
|
|
|
exit
|
2020-07-16 12:24:48 +00:00
|
|
|
fi
|
|
|
|
|
|
2020-12-30 13:13:53 +00:00
|
|
|
ESBINARY=../emulationstation
|
|
|
|
|
|
2020-07-16 12:24:48 +00:00
|
|
|
TEMPFILE_INPUT=tempfile_input_$(date +%H%M%S)
|
|
|
|
|
TEMPFILE_OUTPUT=tempfile_output_$(date +%H%M%S)
|
|
|
|
|
TARGET_FILENAME=emulationstation.6
|
|
|
|
|
|
|
|
|
|
MAN_INCLUDE="
|
|
|
|
|
[NAME]
|
|
|
|
|
emulationstation - EmulationStation Desktop Edition
|
|
|
|
|
|
|
|
|
|
[DESCRIPTION]
|
2021-05-04 15:11:18 +00:00
|
|
|
EmulationStation Desktop Edition (ES-DE) is a front-end for browsing and launching games from your multi-platform game collection.
|
2020-07-16 12:24:48 +00:00
|
|
|
|
|
|
|
|
It's intended to be used in conjunction with emulators such as the RetroArch cores.
|
|
|
|
|
|
|
|
|
|
[AUTHOR]
|
2021-03-14 20:35:19 +00:00
|
|
|
Leon Styhre (Desktop Edition fork) <https://es-de.org/>
|
2020-07-16 12:24:48 +00:00
|
|
|
|
2021-03-14 13:38:32 +00:00
|
|
|
RetroPie community (RetroPie fork)
|
2020-07-16 12:24:48 +00:00
|
|
|
|
2021-03-14 10:25:58 +00:00
|
|
|
Alec \"Aloshi\" Lofquist (original version)
|
2020-07-16 12:24:48 +00:00
|
|
|
|
|
|
|
|
[SEE ALSO]
|
|
|
|
|
Full documentation is available at: <https://gitlab.com/leonstyhre/emulationstation-de/>
|
|
|
|
|
"
|
|
|
|
|
|
|
|
|
|
echo "${MAN_INCLUDE}" > $TEMPFILE_INPUT
|
|
|
|
|
|
|
|
|
|
help2man --section 6 --no-info --include $TEMPFILE_INPUT $ESBINARY > $TEMPFILE_OUTPUT
|
|
|
|
|
|
|
|
|
|
# Manual string replacements, these may need to be modified if changes are made to the
|
|
|
|
|
# command line --help output.
|
|
|
|
|
cat $TEMPFILE_OUTPUT | sed s/"EmulationStation Desktop Edition, Emulator Front\\\-end"/""/g | \
|
|
|
|
|
sed s/"Set to at least"/".br\nSet to at least"/ > $TARGET_FILENAME
|
|
|
|
|
|
2021-04-02 07:46:31 +00:00
|
|
|
gzip -9 $TARGET_FILENAME
|
2020-12-30 13:13:53 +00:00
|
|
|
mv ${TARGET_FILENAME}.gz ../es-app/assets/
|
2020-07-16 12:24:48 +00:00
|
|
|
|
2021-03-14 20:35:19 +00:00
|
|
|
echo "The man page was generated and saved to ../es-app/assets/emulationstation.6.gz"
|
|
|
|
|
|
2020-07-16 12:24:48 +00:00
|
|
|
rm $TEMPFILE_INPUT
|
|
|
|
|
rm $TEMPFILE_OUTPUT
|
