diff options
Diffstat (limited to 'games/higan/higan.6')
| -rw-r--r-- | games/higan/higan.6 | 115 |
1 files changed, 115 insertions, 0 deletions
diff --git a/games/higan/higan.6 b/games/higan/higan.6 new file mode 100644 index 0000000000..ede823154b --- /dev/null +++ b/games/higan/higan.6 @@ -0,0 +1,115 @@ +.\" Man page generated from reStructuredText. +. +.TH HIGAN 6 "2018-12-12" "106" "SlackBuilds.org" +.SH NAME +higan \- multi-system console emulator +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.\" RST source for higan(6) man page. Convert with: +. +.\" rst2man.py higan.rst > higan.6 +. +.\" rst2man.py comes from the SBo development/docutils package. +. +.SH SYNOPSIS +.sp +higan [\-\-fullscreen] [GAME [SUBGAME1 [SUBGAME2]]] +.SH DESCRIPTION +.sp +When launched with \-\-fullscreen, higan will automatically enter fullscreen mode +when it starts, otherwise it starts in windowed mode. This is not much use +unless you also specify GAME, because you won\(aqt be able to load a game until you +exit fullscreen mode by pressing the "Toggle Fullscreen" hotkey. +.sp +When GAME is not given, higan starts with no game loaded. +.sp +When GAME is the path to an existing game folder for any supported console, that +game will automatically be loaded after higan starts. +.sp +When GAME is the path to a ROM file for any supported console, it will be +imported into a game folder in the Game Library, and loaded from there after +higan starts. +.sp +When GAME is of the form REGION|PATH (that is, a region code, a vertical bar +(|), and a path to a game folder or ROM file) higan will load the game at PATH +into the REGION variant of the appropriate console, rather than detecting which +variant the game expects. This is the command\-line equivalent of choosing a +region from the drop\-down in the bottom\-right of the filesystem browser window +when you load a game from the game library. The list of region codes differs +from console to console, so load a game from the library and check the list +before loading it from the command\-line. +.sp +When GAME refers to a game with a Satellaview memory pak slot, SUBGAME1 should +be the path to a game folder or ROM file representing the memory pak to insert +into the slot. If SUBGAME1 is not supplied, higan will prompt for one. SUBGAME2 +is ignored. +.sp +When GAME refers to the Super Game Boy or Super Game Boy 2, SUBGAME1 should be +the path to a game folder or ROM file representing a Game Boy game to insert +into the slot. If SUBGAME1 is not supplied, higan will prompt for one. SUBGAME2 +is ignored. +.sp +When GAME refers to the Sufami Turbo, then SUBGAME1 should be the path to a game +folder or ROM file representing the mini\-cartridge to be inserted into slot A of +the Sufami Turbo base cartridge, and SUBGAME2 is the same thing for slot B. +higan will prompt for any mini\-cartridges not supplied on the command\-line. +.sp +When GAME refers to any other game, both SUBGAME1 and SUBGAME2 are ignored. +.SH EXAMPLES +.sp +Play a previously\-imported copy of Super Mario World in fullscreen (assuming +Linux defaults): +.INDENT 0.0 +.INDENT 3.5 +higan \-\-fullscreen "$HOME/Emulation/Super Famicom/Super Mario World.sfc" +.UNINDENT +.UNINDENT +.sp +Play a previously\-imported copy of Sonic the Hedgehog 3, forcing higan to +emulate a Japanese Mega Drive: +.INDENT 0.0 +.INDENT 3.5 +higan "NTSC\-J|$HOME/Emulation/Mega Drive/Sonic the Hedgehog 3.md" +.UNINDENT +.UNINDENT +.SH AUTHORS +.sp +higan was written by byuu. +.sp +This man page created for the SlackBuilds.org project +by B. Watson, by copying and reformatting higan\-cli.md +from upstream\(aqs git. +.SH SEE ALSO +.sp +icarus(6) +.sp +The higan homepage: \fI\%https://byuu.org/emulation/higan/\fP +.sp +Full documentation: \fI\%https://higan.readthedocs.io/en/stable/\fP +.\" Generated by docutils manpage writer. +. |