ShuriZma
/
pcsx2
mirror of https://github.com/PCSX2/pcsx2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

man-page: Update and use mdoc macros 

[skip ci]
This commit is contained in:
Jonathan Li 2017-01-10 22:05:18 +00:00 committed by Gregory Hainaut
parent 1d2ce62b2c
commit 1a5f01ca9f
1 changed files with 187 additions and 146 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

333
bin/docs/PCSX2.1
View File

@ -1,148 +1,189 @@
.TH "pcsx2" "1" .\" Copyright 2002-2017 PCSX2 Dev Team
.\"
.SH NAME .\" This is free documentation; you can redistribute it and/or
PCSX2 - PlayStation(R)2 console emulator .\" modify it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 3 of
.SH DESCRIPTION .\" the License, or (at your option) any later version.
PCSX2 is an emulator for the PlayStation(R)2 video game console. It is written mostly in C++, some part are in C and x86 assembly. .\"
There is still lot of on going work to improve compatibility & speed. .\" The GNU General Public License's references to "object code"
.\" and "executables" are to be interpreted as the output of any
Visit http://pcsx2.net & https://github.com/PCSX2/pcsx2 for the latest updates. .\" document formatting or typesetting system, including
.\" intermediate and printed output.
.SH Options .\"
Note: all options can also be updated in the GUI. .\" This manual is distributed in the hope that it will be useful,
.TP .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.SH GENERAL OPTIONS .\"
.TP .\" You should have received a copy of the GNU General Public
.\" License along with this manual; if not, see
.B IsoFile .\" http://www.gnu.org/licenses.
Optional ISO image to load and run on startup. It uses the PCSX2 internal ISO loader. .Dd January 10, 2017
.TP .Dt PCSX2 1
.Os
.B --cfg=file .Sh NAME
Specify a custom configuration file to use instead of PCSX2.ini. It does not affect plugins. .Nm PCSX2
.TP .Nd PlayStation(R)2 Console Emulator
.Sh SYNOPSIS
.B --cfgpath=directory .Nm
Specifies the config folder. It applies to pcsx2 + plugins. .Op Fl h
.TP .Op Fl \-cfg Ns = Ns Ar file
.Op Fl \-cfgpath Ns = Ns Ar path
.B --forcewiz .Op Fl \-console
forces running of the First-time Wizard. .Op Fl \-forcewiz
.TP .Op Fl \-portable
.Op Fl \-profiling
.B --profiling .Op Fl \-elf Ns = Ns Ar file
eases running from profiler tool such as Vtune .Op Fl \-irx Ns = Ns Ar file
.TP .Op Fl \-nogui
.Op Fl \-noguiprompt
.SH AUTO-RUN OPTIONS .Op Fl \-nodisc
.TP .Op Fl \-usecd
.Op Fl \-fullscreen
.B --elf=[file] .Op Fl \-windowed
Executes an ELF image. .Op Fl \-nohacks
.TP .Op Fl \-fullboot
.Op Fl \-gamefixes Ns = Ns Ar string
.B --nogui .Op Fl \-gs Ns = Ns Ar file
Disables display of the gui on exit (program auto-exits). .Op Fl \-pad Ns = Ns Ar file
.TP .Op Fl \-spu2 Ns = Ns Ar file
.Op Fl \-cdvd Ns = Ns Ar file
.B --nodisc .Op Fl \-usb Ns = Ns Ar file
Boots with an empty DVD tray. Use this to boot into the PS2 system menu. .Op Fl \-fw Ns = Ns Ar file
.TP .Op Fl \-dev9 Ns = Ns Ar file
.Op Ar iso
.B --usecd .Sh DESCRIPTION
Uses the configured CDVD plugin instead of IsoFile. .Nm
.TP is an open-source PlayStation 2 (AKA PS2) emulator.
Its purpose is to emulate the PS2 hardware, using a combination of MIPS CPU
.SH COMPATIBILITY OPTIONS interpreters, recompilers and a virtual machine that manages hardware states and
.TP PS2 memory.
This allows you to play PS2 games on your PC, with many additional features and
.B --nohacks benefits.
.Sh GENERAL OPTIONS
.Bl -tag -width Ds
.It Fl h, Fl \-help
Displays the list of available command line options.
.It Fl \-cfg Ns = Ns Ar file
Uses
.Ar file
instead of PCSX2_vm.ini as the configuration file.
It does not affect plugins.
.It Fl \-cfgpath Ns = Ns Ar path
Specifies
.Ar path
as the configuration file path.
It affects both
.Nm
and the plugins.
.It Fl \-console
Forces the program log to be visible.
.It Fl \-forcewiz
Forces the First-Time Wizard to run.
.It Fl \-portable
Runs
.Nm
in portable mode.
.It Fl \-profiling
Makes it easier to use profiling tools.
.El
.Sh AUTO-RUN OPTIONS
.Bl -tag -width Ds
.It Ar iso
Loads and runs
.Ar iso
at startup using the
.Nm
internal ISO loader.
.It Fl \-elf Ns = Ns Ar file
Executes
.Ar file
as an ELF image.
.It Fl \-irx Ns = Ns Ar file
Executes
.Ar file
as an IRX image.
.It Fl \-nogui
Disables display of the GUI while running games.
.Nm
will terminate when the game window is closed.
.It Fl \-noguiprompt
Prompt before exiting when
.Fl \-nogui
is used.
.It Fl \-nodisc
Boots with an empty DVD tray.
Use this to boot into the PS2 system menu.
.It Fl \-usecd
Boots using the configured CDVD plugin instead of booting
.Ar iso Ns .
.It Fl \-fullscreen
Runs the game in fullscreen mode.
.It Fl \-windowed
Runs the game in windowed mode.
.El
.Sh COMPATIBILITY OPTIONS
.Bl -tag -width Ds
.It Fl \-nohacks
Disables all speedhacks. Disables all speedhacks.
.TP .It Fl \-fullboot
Disables the fast boot feature.
.B --gamefixes=[fix1,fix2,...] .It Fl \-gamefixes= Ns Ar string
Enable specific gamefixes for this session. Enable specific gamefixes for this session.
Valid fixes in 0.9.7 are: VuAddSub, VuClipFlag, FpuCompare, FpuNegDiv, XGKick, IpuWait, EETiming, SkipMpeg. .Ar string
is a comma-separated list of gamefixes.
.TP .Pp
.B --fullboot Valid gamefixes: VuAddSub, VuClipFlag, FpuCompare, FpuMul, FpuNegDiv, XGKick,
Disables the quick boot feature, forcing you to sit through the PS2 startup splash screens. IpuWait, EETiming, SkipMpeg, OPHFlag, DMABusy,VIFFIFO, VIF1Stall, GIFFIFO,
.TP FMVinSoftware, GoemonTlb, ScarfaceIbit.
.El
.SH PLUGINS OVERRIDES .Sh PLUGIN OVERRIDES
.TP .Bl -tag -width Ds
.It Fl \-gs Ns = Ns Ar file
.B --cdvd=[libpath] Uses
Override for the CDVD plugin. .Ar file
.TP as the GS plugin.
.It Fl \-pad Ns = Ns Ar file
.B --gs=[libpath] Uses
Override for the GS plugin. .Ar file
as the PAD plugin.
.TP .It Fl \-spu2 Ns = Ns Ar file
.B --spu=[libpath] Uses
Override for the SPU2 plugin. .Ar file
.TP as the SPU2 plugin.
.It Fl \-cdvd Ns = Ns Ar file
.B --pad=[libpath] Uses
Override for the PAD plugin. .Ar file
.TP as the CDVD plugin.
.It Fl \-usb Ns = Ns Ar file
.B --dev9=[libpath] Uses
Override for the DEV9 plugin. .Ar file
.TP as the USB plugin.
.It Fl \-fw Ns = Ns Ar file
.B --usb=[libpath] Uses
Override for the USB plugin only. .Ar file
as the FW plugin.
.It Fl \-dev9 Ns = Ns Ar file
.SH FILES AND DIRECTORIES Uses
$XDG_HOME_DIR/pcsx2 or $HOME/.config/pcsx2 .Ar file
All pcsx2 configurations and user datas. as the DEV9 plugin.
.El
.SH "REPORTING BUGS" .Sh FILES
You can report bugs by submitting an issue at the pcsx2 GitHub issue tracker, located at .Bl -tag -width Ds
.It $XDG_CONFIG_DIR/PCSX2 or $HOME/PCSX2
https://github.com/PCSX2/pcsx2/issues User configuration and data directory.
.El
.Sh AUTHORS
.SH AUTHORS .An PCSX2 Dev Team and many other contributors
Please refer to the "About" section of the gui interface or the documentation. .Sh BUGS
Bugs can be reported by submitting an issue at the
.SH PCSX2 RELATED WEBSITES .Lk https://github.com/PCSX2/pcsx2/issues "PCSX2 Github issue tracker" Ns .
.TP .Sh PCSX2 RELATED WEBSITES
PCSX2 google project: .Bl -bullet
http://code.google.com/p/pcsx2 .It
.Lk http://github.com/PCSX2/pcsx2 "PCSX2 git repository"
.TP .It
PCSX2 web site: .Lk http://pcsx2.net "PCSX2 website"
http://pcsx2.net .It
.Lk http://forums.pcsx2.net "PCSX2 forums"
.TP .El
PCSX2 forum
http://forums.pcsx2.net
.SH "COPYRIGHT NOTICE"
Copyright \(co 2002-2010 PCSX2 Dev Team
This is free documentation; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 3 of
the License, or (at your option) any later version.
The GNU General Public License's references to "object code"
and "executables" are to be interpreted as the output of any
document formatting or typesetting system, including
intermediate and printed output.
This manual is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public
License along with this manual; if not, see
<http://www.gnu.org/licenses/>.