libretro/RetroArch
1
0
Fork 0
mirror of https://github.com/libretro/RetroArch.git synced 2024-11-24 00:20:01 +00:00
Code Issues Actions 23 Packages Projects Releases Wiki Activity

Add some more example command lines to man-pages.

Browse Source
This commit is contained in:
Themaister 2013-10-01 12:35:20 +02:00
parent 7f299274df
commit 1a3d152ed2
2 changed files with 35 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/retroarch-joyconfig.1
View File

@ -16,8 +16,21 @@ retroarch-joyconfig \- Tool to configure joypad bindings for \fBretroarch\fR.
It reads in necessary joypad bindings for a certain player and joypad.
.SH "EXAMPLE COMMANDLINES"
.TP
\fBConfigure joypad for player 1, using first joypad. Configuration is dumped to a file.\fR
retroarch-joyconfig -p 1 -j 0 -o inputconfig.cfg
.TP
\fBConfigure joypad for player 1, using first joypad. Update retroarch.cfg directly.\fR
retroarch-joyconfig -p 1 -j 0 -i retroarch.cfg -o retroarch.cfg
.TP
\fBConfigure joypad for player 1, using first joypad. Configuration is dumped to stdout.\fR
retroarch-joyconfig -p 1 -j 0
.TP
\fBCreate an autoconfig file using first joypad.\fR
retroarch-joyconfig -j 0 -a ~/.config/retroarch/autoconfig/pad.cfg
.SH "GENERAL OPTIONS"

25
docs/retroarch.1
View File

@ -4,7 +4,7 @@
.SH NAME
retroarch \- A simple frontend for the libretro API.
retroarch \- The reference frontend for the libretro API.
.SH SYNOPSIS
@ -12,13 +12,32 @@ retroarch \- A simple frontend for the libretro API.
.SH "DESCRIPTION"
\fBretroarch\fR is an emulator frontend for the libretro API.
libretro provides emulation of a game system, and can be implemented by any frontend.
\fBretroarch\fR is the reference frontend for the libretro API.
libretro is an abstraction of a game system, and can be implemented by any frontend.
The libretro API is designed for games and emulators.
\fBretroarch\fR focuses on exposing needed functionality for the game system through the use of command line and configuration files.
It also features a simple built-in UI called RGUI.
.SH "EXAMPLE COMMANDLINE"
.TP
\fBLoad a ROM, using a specific libretro core and config file.\fR
retroarch --config ~/.config/retroarch/retroarch.cfg --libretro /path/to/libretro/core.so /path/to/rom.rom --verbose
.TP
\fBNo command line options will start RetroArch in RGUI mode.\fR
retroarch
.TP
\fBStart RetroArch in RGUI, with verbose logging.\fR
retroarch --menu --verbose
.SH "RGUI"
RGUI is the built-in GUI system for RetroArch. It is aimed at being controlled with a gamepad only.
.SH "DEFAULT CONTROLS"
By default, only keyboard input is accepted.
.SH "GENERAL OPTIONS"
.TP