diff options
| author | 2016-11-22 15:30:22 +1100 | |
|---|---|---|
| committer | 2016-11-26 13:48:00 +1100 | |
| commit | e5f8df8088ef565dc1b06a1dde4daf8bb0133f31 (patch) | |
| tree | 47dbc7c41179b7d838c4ba82f91e0ed66a2fafa6 | |
| parent | Merge pull request #2210 from jroweboy/pagetables (diff) | |
| download | yuzu-e5f8df8088ef565dc1b06a1dde4daf8bb0133f31.tar.gz yuzu-e5f8df8088ef565dc1b06a1dde4daf8bb0133f31.tar.xz yuzu-e5f8df8088ef565dc1b06a1dde4daf8bb0133f31.zip | |
Add man documentation
Includes both SDL and QT frontends
| -rw-r--r-- | CMakeLists.txt | 12 | ||||
| -rw-r--r-- | dist/citra-qt.6 | 40 | ||||
| -rw-r--r-- | dist/citra.6 | 49 |
3 files changed, 101 insertions, 0 deletions
diff --git a/CMakeLists.txt b/CMakeLists.txt index 5c9b7f86a..f73be1739 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt | |||
| @@ -286,3 +286,15 @@ if(ENABLE_QT AND UNIX AND NOT APPLE) | |||
| 286 | install(FILES "${CMAKE_SOURCE_DIR}/dist/citra.xml" | 286 | install(FILES "${CMAKE_SOURCE_DIR}/dist/citra.xml" |
| 287 | DESTINATION "${CMAKE_INSTALL_PREFIX}/share/mime/packages") | 287 | DESTINATION "${CMAKE_INSTALL_PREFIX}/share/mime/packages") |
| 288 | endif() | 288 | endif() |
| 289 | |||
| 290 | if(UNIX) | ||
| 291 | if(ENABLE_SDL2) | ||
| 292 | install(FILES "${CMAKE_SOURCE_DIR}/dist/citra.6" | ||
| 293 | DESTINATION "${CMAKE_INSTALL_PREFIX}/share/man/man6") | ||
| 294 | endif() | ||
| 295 | |||
| 296 | if (ENABLE_QT) | ||
| 297 | install(FILES "${CMAKE_SOURCE_DIR}/dist/citra-qt.6" | ||
| 298 | DESTINATION "${CMAKE_INSTALL_PREFIX}/share/man/man6") | ||
| 299 | endif() | ||
| 300 | endif() | ||
diff --git a/dist/citra-qt.6 b/dist/citra-qt.6 new file mode 100644 index 000000000..d09e96b5d --- /dev/null +++ b/dist/citra-qt.6 | |||
| @@ -0,0 +1,40 @@ | |||
| 1 | .Dd November 22 2016 | ||
| 2 | .Dt citra-qt 6 | ||
| 3 | .Os | ||
| 4 | .Sh NAME | ||
| 5 | .Nm Citra-Qt | ||
| 6 | .Nd Nintendo 3DS Emulator/Debugger (Qt) | ||
| 7 | .Sh SYNOPSIS | ||
| 8 | .Nm citra-qt | ||
| 9 | .Op Ar file | ||
| 10 | .Sh DESCRIPTION | ||
| 11 | Citra is an experimental open-source Nintendo 3DS emulator/debugger. | ||
| 12 | .Pp | ||
| 13 | .Nm citra-qt | ||
| 14 | is the Qt implementation. | ||
| 15 | .Sh FILES | ||
| 16 | .Bl -tag -width Ds | ||
| 17 | .It Pa $XDG_DATA_HOME/citra-emu | ||
| 18 | Emulator storage. | ||
| 19 | .It Pa $XDG_CONFIG_HOME/citra-emu | ||
| 20 | Configuration files. | ||
| 21 | .El | ||
| 22 | .Sh AUTHORS | ||
| 23 | This document is made available to you under the CC-BY license. | ||
| 24 | .Pp | ||
| 25 | Citra is made by a team of volunteers. These contributors are listed | ||
| 26 | at <\fBhttps://github.com/citra-emu/citra/contributors\fR>. | ||
| 27 | .Pp | ||
| 28 | .Sh SEE ALSO | ||
| 29 | .Bl -tag -width Ds | ||
| 30 | .It Xr citra 6 | ||
| 31 | The SDL frontend of the application | ||
| 32 | .El | ||
| 33 | .Pp | ||
| 34 | Resources are available for this project: | ||
| 35 | .Bl -tag -width Ds | ||
| 36 | .It <\fBhttps://citra-emu.org\fR> | ||
| 37 | The main homepage of the project. | ||
| 38 | .It <\fBhttps://github.com/citra-emu/citra\fR> | ||
| 39 | The main source code repository for the Citra emulator. | ||
| 40 | .Pp | ||
diff --git a/dist/citra.6 b/dist/citra.6 new file mode 100644 index 000000000..72483b1dd --- /dev/null +++ b/dist/citra.6 | |||
| @@ -0,0 +1,49 @@ | |||
| 1 | .Dd November 22 2016 | ||
| 2 | .Dt citra 6 | ||
| 3 | .Os | ||
| 4 | .Sh NAME | ||
| 5 | .Nm Citra | ||
| 6 | .Nd Nintendo 3DS Emulator/Debugger (SDL) | ||
| 7 | .Sh SYNOPSIS | ||
| 8 | .Nm citra | ||
| 9 | .Op Ar options | ||
| 10 | .Op Ar file | ||
| 11 | .Sh OPTIONS | ||
| 12 | .Bl -tag -width Ds | ||
| 13 | .It Fl g Ar port , Fl Fl gdbport Ar port | ||
| 14 | Starts the GDB stub on the specified port | ||
| 15 | .It Fl h , Fl Fl help | ||
| 16 | Shows syntax help and exits | ||
| 17 | .It Fl v , Fl Fl version | ||
| 18 | Describes the installed version and exits | ||
| 19 | .Sh DESCRIPTION | ||
| 20 | Citra is an experimental open-source Nintendo 3DS emulator/debugger. | ||
| 21 | .Pp | ||
| 22 | .Nm citra | ||
| 23 | is the Simple DirectMedia Layer (SDL) implementation. | ||
| 24 | .Sh FILES | ||
| 25 | .Bl -tag -width Ds | ||
| 26 | .It Pa $XDG_DATA_HOME/citra-emu | ||
| 27 | Emulator storage. | ||
| 28 | .It Pa $XDG_CONFIG_HOME/citra-emu | ||
| 29 | Configuration files. | ||
| 30 | .El | ||
| 31 | .Sh AUTHORS | ||
| 32 | This document is made available to you under the CC-BY license. | ||
| 33 | .Pp | ||
| 34 | Citra is made by a team of volunteers. These contributors are listed | ||
| 35 | at <\fBhttps://github.com/citra-emu/citra/contributors\fR>. | ||
| 36 | .Pp | ||
| 37 | .Sh SEE ALSO | ||
| 38 | .Bl -tag -width Ds | ||
| 39 | .It Xr citra-qt 6 | ||
| 40 | The Qt frontend of the application | ||
| 41 | .El | ||
| 42 | .Pp | ||
| 43 | Resources are available for this project: | ||
| 44 | .Bl -tag -width Ds | ||
| 45 | .It <\fBhttps://citra-emu.org\fR> | ||
| 46 | The main homepage of the project. | ||
| 47 | .It <\fBhttps://github.com/citra-emu/citra\fR> | ||
| 48 | The main source code repository for the Citra emulator. | ||
| 49 | .Pp | ||