mirror of
				https://github.com/PabloMK7/citra.git
				synced 2025-10-30 13:20:03 +00:00 
			
		
		
		
	Add man documentation
Includes both SDL and QT frontends
This commit is contained in:
		
							parent
							
								
									ed2ff8df85
								
							
						
					
					
						commit
						e5f8df8088
					
				
					 3 changed files with 101 additions and 0 deletions
				
			
		|  | @ -286,3 +286,15 @@ if(ENABLE_QT AND UNIX AND NOT APPLE) | |||
|     install(FILES "${CMAKE_SOURCE_DIR}/dist/citra.xml" | ||||
|             DESTINATION "${CMAKE_INSTALL_PREFIX}/share/mime/packages") | ||||
| endif() | ||||
| 
 | ||||
| if(UNIX) | ||||
|     if(ENABLE_SDL2) | ||||
|         install(FILES "${CMAKE_SOURCE_DIR}/dist/citra.6" | ||||
|                 DESTINATION "${CMAKE_INSTALL_PREFIX}/share/man/man6") | ||||
|     endif() | ||||
| 
 | ||||
|     if (ENABLE_QT) | ||||
|         install(FILES "${CMAKE_SOURCE_DIR}/dist/citra-qt.6" | ||||
|                 DESTINATION "${CMAKE_INSTALL_PREFIX}/share/man/man6") | ||||
|     endif() | ||||
| endif() | ||||
|  |  | |||
							
								
								
									
										40
									
								
								dist/citra-qt.6
									
										
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										40
									
								
								dist/citra-qt.6
									
										
									
									
										vendored
									
									
										Normal file
									
								
							|  | @ -0,0 +1,40 @@ | |||
| .Dd November 22 2016 | ||||
| .Dt citra-qt 6 | ||||
| .Os | ||||
| .Sh NAME | ||||
| .Nm Citra-Qt | ||||
| .Nd Nintendo 3DS Emulator/Debugger (Qt) | ||||
| .Sh SYNOPSIS | ||||
| .Nm citra-qt | ||||
| .Op Ar file | ||||
| .Sh DESCRIPTION | ||||
| Citra is an experimental open-source Nintendo 3DS emulator/debugger. | ||||
| .Pp | ||||
| .Nm citra-qt | ||||
| is the Qt implementation. | ||||
| .Sh FILES | ||||
| .Bl -tag -width Ds | ||||
| .It Pa $XDG_DATA_HOME/citra-emu | ||||
| Emulator storage. | ||||
| .It Pa $XDG_CONFIG_HOME/citra-emu | ||||
| Configuration files. | ||||
| .El | ||||
| .Sh AUTHORS | ||||
| This document is made available to you under the CC-BY license. | ||||
| .Pp | ||||
| Citra is made by a team of volunteers. These contributors are listed | ||||
|  at <\fBhttps://github.com/citra-emu/citra/contributors\fR>. | ||||
| .Pp | ||||
| .Sh SEE ALSO | ||||
| .Bl -tag -width Ds | ||||
| .It Xr citra 6 | ||||
| The SDL frontend of the application | ||||
| .El | ||||
| .Pp | ||||
| Resources are available for this project: | ||||
| .Bl -tag -width Ds | ||||
| .It <\fBhttps://citra-emu.org\fR> | ||||
| The main homepage of the project. | ||||
| .It <\fBhttps://github.com/citra-emu/citra\fR> | ||||
| The main source code repository for the Citra emulator. | ||||
| .Pp | ||||
							
								
								
									
										49
									
								
								dist/citra.6
									
										
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										49
									
								
								dist/citra.6
									
										
									
									
										vendored
									
									
										Normal file
									
								
							|  | @ -0,0 +1,49 @@ | |||
| .Dd November 22 2016 | ||||
| .Dt citra 6 | ||||
| .Os | ||||
| .Sh NAME | ||||
| .Nm Citra | ||||
| .Nd Nintendo 3DS Emulator/Debugger (SDL) | ||||
| .Sh SYNOPSIS | ||||
| .Nm citra | ||||
| .Op Ar options | ||||
| .Op Ar file | ||||
| .Sh OPTIONS | ||||
| .Bl -tag -width Ds | ||||
| .It Fl g Ar port , Fl Fl gdbport Ar port | ||||
| Starts the GDB stub on the specified port | ||||
| .It Fl h , Fl Fl help | ||||
| Shows syntax help and exits | ||||
| .It Fl v , Fl Fl version | ||||
| Describes the installed version and exits | ||||
| .Sh DESCRIPTION | ||||
| Citra is an experimental open-source Nintendo 3DS emulator/debugger. | ||||
| .Pp | ||||
| .Nm citra | ||||
| is the Simple DirectMedia Layer (SDL) implementation. | ||||
| .Sh FILES | ||||
| .Bl -tag -width Ds | ||||
| .It Pa $XDG_DATA_HOME/citra-emu | ||||
| Emulator storage. | ||||
| .It Pa $XDG_CONFIG_HOME/citra-emu | ||||
| Configuration files. | ||||
| .El | ||||
| .Sh AUTHORS | ||||
| This document is made available to you under the CC-BY license. | ||||
| .Pp | ||||
| Citra is made by a team of volunteers. These contributors are listed | ||||
|  at <\fBhttps://github.com/citra-emu/citra/contributors\fR>. | ||||
| .Pp | ||||
| .Sh SEE ALSO | ||||
| .Bl -tag -width Ds | ||||
| .It Xr citra-qt 6 | ||||
| The Qt frontend of the application | ||||
| .El | ||||
| .Pp | ||||
| Resources are available for this project: | ||||
| .Bl -tag -width Ds | ||||
| .It <\fBhttps://citra-emu.org\fR> | ||||
| The main homepage of the project. | ||||
| .It <\fBhttps://github.com/citra-emu/citra\fR> | ||||
| The main source code repository for the Citra emulator. | ||||
| .Pp | ||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue