From 84483a1076710666109bea3b4254b01e9d9f6f6b Mon Sep 17 00:00:00 2001 From: Mystro256 Date: Thu, 3 Mar 2016 23:21:39 -0500 Subject: [PATCH] Add manpages for Linux and include them in spec file Note that the manpages are placed in Data --- CMakeLists.txt | 5 ++++ Data/dolphin-emu-nogui.6 | 56 ++++++++++++++++++++++++++++++++++++++ Data/dolphin-emu.6 | 56 ++++++++++++++++++++++++++++++++++++++ Installer/dolphin-emu.spec | 2 ++ 4 files changed, 119 insertions(+) create mode 100644 Data/dolphin-emu-nogui.6 create mode 100644 Data/dolphin-emu.6 diff --git a/CMakeLists.txt b/CMakeLists.txt index 13b8424be3..d28103cb45 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -960,6 +960,11 @@ if(${CMAKE_SYSTEM_NAME} STREQUAL "Linux") DESTINATION ${CMAKE_INSTALL_PREFIX}/share/icons/hicolor/48x48/apps) install(FILES Installer/dolphin-emu.desktop DESTINATION ${CMAKE_INSTALL_PREFIX}/share/applications) + # Install manpages + install(FILES Data/dolphin-emu.6 + DESTINATION ${CMAKE_INSTALL_PREFIX}/share/man/man6) + install(FILES Data/dolphin-emu-nogui.6 + DESTINATION ${CMAKE_INSTALL_PREFIX}/share/man/man6) endif() # packaging information diff --git a/Data/dolphin-emu-nogui.6 b/Data/dolphin-emu-nogui.6 new file mode 100644 index 0000000000..f73a3fd817 --- /dev/null +++ b/Data/dolphin-emu-nogui.6 @@ -0,0 +1,56 @@ +.TH DOLPHIN-EMU-NOGUI 6 "March 4, 2016" +.SH NAME +dolphin-emu-nogui - an emulator for running GameCube, Wii, and Triforce +games on +Windows, Linux, OS X, and recent Android devices. +.SH SYNOPSIS +.B dolphin-emu-nogui +[\fB-h\fR] [\fB-d\fR] [\fB-l\fR] [\fB-e \fIfile\fR] [\fB-b\fR] [\fB-c\fR] [\fB-V +\fIvideo\fR] [\fB-A \fIaudio\fR] [\fB-m +\fIfile\fR] [\fB-u \fIpath\fR] +.SH DESCRIPTION +Dolphin is an emulator for two recent Nintendo video game consoles: the +GameCube and the Wii. It allows PC gamers to enjoy games for these two consoles +in full HD (1080p) with several enhancements: compatibility with all PC +controllers, turbo speed, networked multiplayer, and even more! +.P +\fBdolphin-emu-nogui\fR does not have a graphical user interface. +.SH OPTIONS +.TP +.BR \-h ", " \-\-help +Show this help message +.TP +.BR \-d ", " \-\-debugger +Opens the debugger +.TP +.BR \-l ", " \-\-logger +Opens the logger +.TP +.BR \-e ", " \-\-exec =\fIfile\fR +Loads the specified file +(\fBDOL\fR,\fBELF\fR,\fBWAD\fR,\fBGCM\fR,\fBISO\fR) +.TP +.BR \-b ", " \-\-batch +Exit Dolphin with emulator +.TP +.BR \-c ", " \-\-confirm =\fItext\fR +Set Confirm on Stop +.TP +.BR \-V ", " \-\-video_backend =\fIvideo\fR +OpenGL (\fBOGL\fR) or \fBSoftware Renderer\fR video backend +.TP +.BR \-A ", " \-\-audio_emulation =\fIaudio\fR +Low level (\fBLLE\fR) or high level (\fBHLE\fR) audio +.TP +.BR \-m ", " \-\-movie =\fIfile\fR +Play a movie file +.TP +.BR \-u ", " \-\-user =\fIpath\fR +User folder path +.SH FILES +.TP +.I $HOME/.dolphin-emu +Default user configuration directory. +.SH AUTHOR +This manual page was written by Jeremy Newton, but may be distributed freely +using the CC BY license. diff --git a/Data/dolphin-emu.6 b/Data/dolphin-emu.6 new file mode 100644 index 0000000000..9fd7b3429d --- /dev/null +++ b/Data/dolphin-emu.6 @@ -0,0 +1,56 @@ +.TH DOLPHIN-EMU 6 "March 4, 2016" +.SH NAME +dolphin-emu - an emulator for running GameCube, Wii, and Triforce +games on +Windows, Linux, OS X, and recent Android devices. +.SH SYNOPSIS +.B dolphin-emu +[\fB-h\fR] [\fB-d\fR] [\fB-l\fR] [\fB-e \fIfile\fR] [\fB-b\fR] [\fB-c\fR] [\fB-V +\fIvideo\fR] [\fB-A \fIaudio\fR] [\fB-m +\fIfile\fR] [\fB-u \fIpath\fR] +.SH DESCRIPTION +Dolphin is an emulator for two recent Nintendo video game consoles: the +GameCube and the Wii. It allows PC gamers to enjoy games for these two consoles +in full HD (1080p) with several enhancements: compatibility with all PC +controllers, turbo speed, networked multiplayer, and even more! +.P +\fBdolphin-emu\fR features a graphical user interface made using wxWidgets. +.SH OPTIONS +.TP +.BR \-h ", " \-\-help +Show this help message +.TP +.BR \-d ", " \-\-debugger +Opens the debugger +.TP +.BR \-l ", " \-\-logger +Opens the logger +.TP +.BR \-e ", " \-\-exec =\fIfile\fR +Loads the specified file +(\fBDOL\fR,\fBELF\fR,\fBWAD\fR,\fBGCM\fR,\fBISO\fR) +.TP +.BR \-b ", " \-\-batch +Exit Dolphin with emulator +.TP +.BR \-c ", " \-\-confirm =\fItext\fR +Set Confirm on Stop +.TP +.BR \-V ", " \-\-video_backend =\fIvideo\fR +OpenGL (\fBOGL\fR) or \fBSoftware Renderer\fR video backend +.TP +.BR \-A ", " \-\-audio_emulation =\fIaudio\fR +Low level (\fBLLE\fR) or high level (\fBHLE\fR) audio +.TP +.BR \-m ", " \-\-movie =\fIfile\fR +Play a movie file +.TP +.BR \-u ", " \-\-user =\fIpath\fR +User folder path +.SH FILES +.TP +.I $HOME/.dolphin-emu +Default user configuration directory. +.SH AUTHOR +This manual page was written by Jeremy Newton, but may be distributed freely +using the CC BY license. diff --git a/Installer/dolphin-emu.spec b/Installer/dolphin-emu.spec index 6c2338b731..053ab92f86 100644 --- a/Installer/dolphin-emu.spec +++ b/Installer/dolphin-emu.spec @@ -111,6 +111,7 @@ Dolphin Emulator without a graphical user interface %files nogui %{_bindir}/%{name}-nogui +%{_mandir}/man6/%{name}-nogui.* # ------------------------------------------------------ @@ -139,6 +140,7 @@ make %{?_smp_mflags} install DESTDIR="%{?buildroot}" %{_datadir}/%{name} %{_datadir}/pixmaps/dolphin-emu.xpm %{_datadir}/applications/%{name}.desktop +%{_mandir}/man6/%{name}.* %clean rm -rf %{buildroot}