pkgsrc-WIP-changes archive

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]

cannonball: Now adds a man page with instructions on how to configure the emulator.



Module Name:	pkgsrc-wip
Committed By:	Santhosh Raju <fox%NetBSD.org@localhost>
Pushed By:	fox
Date:		Mon Aug 12 15:33:16 2019 -0500
Changeset:	1961c51d34d8e7c319f581b52cf36ad46f954304

Modified Files:
	cannonball/Makefile
	cannonball/PLIST
Added Files:
	cannonball/files/cannonball.6

Log Message:
cannonball: Now adds a man page with instructions on how to configure the emulator.

To see a diff of this commit:
https://wip.pkgsrc.org/cgi-bin/gitweb.cgi?p=pkgsrc-wip.git;a=commitdiff;h=1961c51d34d8e7c319f581b52cf36ad46f954304

Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.

diffstat:
 cannonball/Makefile           |  4 +++-
 cannonball/PLIST              |  1 +
 cannonball/files/cannonball.6 | 50 +++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 54 insertions(+), 1 deletion(-)

diffs:
diff --git a/cannonball/Makefile b/cannonball/Makefile
index 652f9d2b8c..4b79a22702 100644
--- a/cannonball/Makefile
+++ b/cannonball/Makefile
@@ -19,7 +19,7 @@ CMAKE_ARG_PATH=		..
 BUILD_MAKE_FLAGS+=	VERBOSE=1
 
 INSTALLATION_DIRS+=	bin libexec share/cannonball share/cannonball/res \
-			share/cannonball/conf
+			share/cannonball/conf ${PKGMANDIR}/man6
 
 SUBST_CLASSES+=		prefix
 SUBST_STAGE.prefix=	pre-configure
@@ -48,6 +48,8 @@ do-install:
 	    ${DESTDIR}${PREFIX}/bin/cannonball
 	${INSTALL_PROGRAM} ${WRKSRC}/build/cannonball \
 	    ${DESTDIR}${PREFIX}/libexec
+	${INSTALL_MAN} ${FILESDIR}/cannonball.6 \
+	    ${DESTDIR}${PREFIX}/${PKGMANDIR}/man6
 
 .include "../../devel/boost-headers/buildlink3.mk"
 .include "../../devel/boost-libs/buildlink3.mk"
diff --git a/cannonball/PLIST b/cannonball/PLIST
index 0a21ac1814..f472cd4884 100644
--- a/cannonball/PLIST
+++ b/cannonball/PLIST
@@ -1,6 +1,7 @@
 @comment $NetBSD$
 bin/cannonball
 libexec/cannonball
+man/man6/cannonball.6
 share/cannonball/conf/config.xml
 share/cannonball/res/tilemap.bin
 share/cannonball/res/tilepatch.bin
diff --git a/cannonball/files/cannonball.6 b/cannonball/files/cannonball.6
new file mode 100644
index 0000000000..24d50f1119
--- /dev/null
+++ b/cannonball/files/cannonball.6
@@ -0,0 +1,50 @@
+.\" Manpage for cannonball
+.TH "cannonball" "6" "August 2019" "CannonBall 0.3" "CannonBall - Configuration Help"
+.SH NAME
+cannonball \- An Enhanced OutRun Engine
+.SH SYNOPSIS
+cannonball
+.SH DESCRIPTION
+CannonBall is a program which allows you to play an enhanced version
+of Yu Suzuki's seminal arcade racer, OutRun, on a variety of systems.
+.SH CONFIGURATION
+In order for CannonBall to work you need to provide a copy of the
+OutRun revision B romset to the roms subdirectory. Rename the files if
+necessary.
+
+The roms subdirectory can be found at $XDG_DATA_HOME/cannonball/roms
+which defaults to $HOME/.local/share/cannonball/roms
+
+Configuration can be found at $XDG_DATA_HOME/cannonball/config.xml
+which defaults to $HOME/.local/share/cannonball/config.xml
+
+NOTE: The directories will be created on the first run of Cannonball
+if they do not exist.
+.SH OPTIONS
+cannonball does not take any options.
+.SH SEE ALSO
+CannonBall Wiki <https://github.com/djyt/cannonball/wiki>
+
+CannonBall online manual
+<https://github.com/djyt/cannonball/wiki/Cannonball-Manual>
+.SH BUGS
+For known issues see <https://github.com/djyt/cannonball/issues>.
+.SH COPYRIGHT
+Copyright (c) 2012-2014 Chris White.
+
+Users of CannonBall are expected to own licensed copies of the ROM
+files that is intended to be used with this program. These ROMs may be
+subject to their copyright laws under their jurisdiction. Make sure
+you can legally transfer the ROMs to your system before using them
+with this program.
+
+OutRun ROMs may be subject to copyright laws. 
+
+OutRun is a trademark of the SEGA Corporation. This project is not
+affiliated with SEGA in any way.
+.SH AUTHOR
+Chris White <pointblnk%hotmail.com@localhost> - Project creator.
+
+Arun Horne - Cross platform work.
+
+Santhosh Raju <fox%NetBSD.org@localhost> - Man page.


Home | Main Index | Thread Index | Old Index