mirror of
https://github.com/libretro/RetroArch
synced 2025-03-30 16:20:27 +00:00
Fixups in manpages.
This commit is contained in:
Themaister
parent
5e032d2677
commit
58bf26caad
@ -1,18 +1,18 @@
|
||||
.\" ssnes-joyconfig.1:
|
||||
.\" retroarch-joyconfig.1:
|
||||
|
||||
.TH "SSNES-JOYCONFIG" "1" "October 2011" "SSNES-JOYCONFIG" "System Manager's Manual: ssnes-joyconfig"
|
||||
.TH "RETROARCH-JOYCONFIG" "1" "October 2011" "RETROARCH-JOYCONFIG" "System Manager's Manual: retroarch-joyconfig"
|
||||
|
||||
.SH NAME
|
||||
|
||||
ssnes-joyconfig \- Tool to configure joypad bindings for \fBssnes\fR.
|
||||
retroarch-joyconfig \- Tool to configure joypad bindings for \fBretroarch\fR.
|
||||
|
||||
.SH SYNOPSIS
|
||||
|
||||
\fBssnes-joyconfig\fR [OPTIONS]...
|
||||
\fBretroarch-joyconfig\fR [OPTIONS]...
|
||||
|
||||
.SH "DESCRIPTION"
|
||||
|
||||
\fBssnes-joyconfig is a simple tool that allows updating or creating a configuration file for \fBssnes\fR.
|
||||
\fBretroarch-joyconfig is a simple tool that allows updating or creating a configuration file for \fBretroarch\fR.
|
||||
It reads in necessary joypad bindings for a certain player and joypad.
|
||||
|
||||
.SH "GENERAL OPTIONS"
|
||||
@ -43,6 +43,6 @@ Also configure some binds that aren't directly related to SNES emulation, such a
|
||||
Prints help message.
|
||||
|
||||
.SH "SEE ALSO"
|
||||
\fBssnes\fR(1)
|
||||
\fBretroarch\fR(1)
|
||||
|
||||
.\"
|
||||
|
||||
@ -1,27 +1,27 @@
|
||||
.\" ssnes.1:
|
||||
.\" retroarch.1:
|
||||
|
||||
.TH "SSNES" "1" "November 2011" "SSNES" "System Manager's Manual: ssnes"
|
||||
.TH "RetroArch" "1" "November 2011" "RetroArch" "System Manager's Manual: retroarch"
|
||||
|
||||
.SH NAME
|
||||
|
||||
ssnes \- Simple Super Nintendo Emulator System
|
||||
retroarch \- A simple frontend for the libretro API.
|
||||
|
||||
.SH SYNOPSIS
|
||||
|
||||
\fBssnes\fR [rom file] [OPTIONS]...
|
||||
\fBretroarch\fR [rom file] [OPTIONS]...
|
||||
|
||||
.SH "DESCRIPTION"
|
||||
|
||||
\fBssnes\fR is an emulator frontend for the libsnes API.
|
||||
\fBretroarch\fR is an emulator frontend for the libsnes API.
|
||||
libsnes provides emulation of a Super Nintendo system, and can be implemented by any SNES emulator.
|
||||
\fBssnes\fR focuses on exposing needed functionality through the use of command line and configuration files.
|
||||
\fBretroarch\fR focuses on exposing needed functionality through the use of command line and configuration files.
|
||||
|
||||
.SH "GENERAL OPTIONS"
|
||||
|
||||
.TP
|
||||
\fB[rom file]\fR
|
||||
If no rom file path is defined on the command line, \fBssnes\fR will try to load a rom from \fBstdin\fR.
|
||||
\fBssnes\fR only supports loading of \fBuncompressed\fR roms, such as *.sfc or *.smc.
|
||||
If no rom file path is defined on the command line, \fBretroarch\fR will try to load a rom from \fBstdin\fR.
|
||||
\fBretroarch\fR only supports loading of \fBuncompressed\fR roms, such as *.sfc or *.smc.
|
||||
|
||||
.TP
|
||||
\fB--help, -h\fR
|
||||
@ -29,20 +29,20 @@ Prints help text.
|
||||
|
||||
.TP
|
||||
\fB--features\fR
|
||||
Prints available features compiled into SSNES, then exits.
|
||||
Prints available features compiled into RetroArch, then exits.
|
||||
|
||||
.TP
|
||||
\fB-L PATH, --libsnes PATH\fR
|
||||
Path to a libsnes implementation which is to be used.
|
||||
This option will override any setting in a config file.
|
||||
This option is only available if SSNES is compiled with dynamic libsnes loading.
|
||||
This option is only available if RetroArch is compiled with dynamic libsnes loading.
|
||||
|
||||
.TP
|
||||
\fB--save PATH, -s PATH\fR
|
||||
Overrides the path used for save ram (*.srm).
|
||||
Without this flag, the save ram path will be inferred from the rom path name, and put in the same directory as the rom file with the extention replaced with '.srm'.
|
||||
When rom is loaded from \fBstdin\fR, this flag is mandatory to define as no path can be inferred.
|
||||
If PATH is a directory, SSNES will treat this as the save file directory, where the save file name will be inferred from the rom name.
|
||||
If PATH is a directory, RetroArch will treat this as the save file directory, where the save file name will be inferred from the rom name.
|
||||
When loading a rom from stdin, the path must be a full path, however.
|
||||
|
||||
.TP
|
||||
@ -50,28 +50,28 @@ When loading a rom from stdin, the path must be a full path, however.
|
||||
Overrides the path used for save states.
|
||||
Without this flag, the save state path will be inferred from the rom path name, and put in the same directory as the rom file with the extention replace with '.state'.
|
||||
When rom is loaded from \fBstdin\fR, this flag is mandatory to define as no path can be inferred.
|
||||
If PATH is a directory, SSNES will treat this as the save state directory, where the state file name will be inferred from the rom name.
|
||||
If PATH is a directory, RetroArch will treat this as the save state directory, where the state file name will be inferred from the rom name.
|
||||
When loading a rom from stdin, the path must be a full path, however.
|
||||
Do note that save states are bound to the libsnes implementation being used. Using a different libsnes could invalidate the save state file.
|
||||
|
||||
.TP
|
||||
\fB--fullscreen, -f\fR
|
||||
Always starts SSNES in fullscreen. Disregards settings in configuration file.
|
||||
Always starts RetroArch in fullscreen. Disregards settings in configuration file.
|
||||
|
||||
.TP
|
||||
\fB--config PATH, -c PATH\fR
|
||||
Sets the configuration file path. \fBssnes\fR will use this path to load the configuration file.
|
||||
Should this not be defined, \fBssnes\fR will look in platform specific paths to attempt finding the config file.
|
||||
/etc/ssnes.cfg (when installed), or ssnes.cfg in the source tarball serves as a skeleton configuration file.
|
||||
If PATH is a directory, SSNES will treat this as the config file directory, where the state file name will be inferred from the rom name (*.cfg).
|
||||
Sets the configuration file path. \fBretroarch\fR will use this path to load the configuration file.
|
||||
Should this not be defined, \fBretroarch\fR will look in platform specific paths to attempt finding the config file.
|
||||
/etc/retroarch.cfg (when installed), or retroarch.cfg in the source tarball serves as a skeleton configuration file.
|
||||
If PATH is a directory, RetroArch will treat this as the config file directory, where the state file name will be inferred from the rom name (*.cfg).
|
||||
When loading a rom from stdin, the path must be a full path, however.
|
||||
If a config cannot be found when using directory path, the default config path will be used instead.
|
||||
|
||||
.IP
|
||||
Unix-like systems will look in $XDG_CONFIG_HOME/ssnes/ssnes.cfg first. Then it will try $HOME/.ssnes.cfg. Last, it will try /etc/ssnes.cfg. If no configuration is found, default settings will be assumed. A configuration file does not need to define every possible option, only those that should be overridden.
|
||||
Unix-like systems will look in $XDG_CONFIG_HOME/retroarch/retroarch.cfg first. Then it will try $HOME/.retroarch.cfg. Last, it will try /etc/retroarch.cfg. If no configuration is found, default settings will be assumed. A configuration file does not need to define every possible option, only those that should be overridden.
|
||||
|
||||
.IP
|
||||
Windows will look in ssnes.cfg in same folder where ssnes.exe resides.
|
||||
Windows will look in retroarch.cfg in same folder where retroarch.exe resides.
|
||||
|
||||
.TP
|
||||
\fB--gameboy PATH, -g PATH\fR
|
||||
@ -185,18 +185,18 @@ This is purely cosmetic, and only serves to help players identify each other.
|
||||
.TP
|
||||
\fB--ups PATCH, -U PATCH\fR
|
||||
Attempts to apply an UPS patch to the current ROM image. No files are altered.
|
||||
If this flag is not specified, SSNES will look for a .ups file with same basename as ROM specified.
|
||||
If this flag is not specified, RetroArch will look for a .ups file with same basename as ROM specified.
|
||||
|
||||
.TP
|
||||
\fB--bps PATCH\fR
|
||||
Attempts to apply a BPS patch to the current ROM image. No files are altered.
|
||||
If this flag is not specified, SSNES will look for a .bps file with same basename as ROM specified.
|
||||
If this flag is not specified, RetroArch will look for a .bps file with same basename as ROM specified.
|
||||
|
||||
.TP
|
||||
\fB--ips PATCH\fR
|
||||
Attempts to apply a IPS patch to the current ROM image. No files are altered.
|
||||
If this flag is not specified, SSNES will look for a .ips file with same basename as ROM specified.
|
||||
Note that SSNES cannot perform any error checking if patching was successful due to how IPS works.
|
||||
If this flag is not specified, RetroArch will look for a .ips file with same basename as ROM specified.
|
||||
Note that RetroArch cannot perform any error checking if patching was successful due to how IPS works.
|
||||
|
||||
.TP
|
||||
\fB--no-patch\fR
|
||||
@ -205,11 +205,11 @@ Disables all kinds of ROM patching.
|
||||
.TP
|
||||
\fB--xml MAP, -X MAP\fR
|
||||
Specifies path to XML memory map for the given ROM.
|
||||
If this flag is not specified, SSNES will look for a .xml file with same basename as ROM specified.
|
||||
If this flag is not specified, RetroArch will look for a .xml file with same basename as ROM specified.
|
||||
|
||||
.TP
|
||||
\fB-D, --detach\fR
|
||||
Detach from the current console. This is currently only relevant for Microsoft Windows.
|
||||
|
||||
.SH "SEE ALSO"
|
||||
\fBssnes-joyconfig\fR(1)
|
||||
\fBretroarch-joyconfig\fR(1)
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user