-
Notifications
You must be signed in to change notification settings - Fork 40
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Loading status checks…
Add initial man page
- Add a simple man page (roff) to be generated by scdoc that contains example usages for users. Avoids the need to refer to the Github page for concrete examples, and is mostly relevant to users who decide to use ULWGL directly from the CLI instead from a client application.
Showing
1 changed file
with
71 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
ulwgl(1) | ||
|
||
# NAME | ||
|
||
ulwgl-run - Unified Launcher for Windows Games on Linux | ||
|
||
# SYNOPSIS | ||
|
||
*ulwgl-run* [_OPTIONS_...] [_FILE_ [_ARG_...] | _FILE_] | ||
|
||
# OPTIONS | ||
|
||
*-h, --help* | ||
Show this help message | ||
|
||
*--config* <config> | ||
Path to TOML configuration file (Requires Python 3.11+) | ||
|
||
# EXAMPLES | ||
|
||
``` | ||
# Play a game | ||
$ WINEPREFIX= GAMEID=0 PROTONPATH= ulwgl-run ~/foo.exe | ||
``` | ||
|
||
``` | ||
# Play a game and apply a GOG Protonfix | ||
# Can be a Steam or non-Steam game | ||
$ WINEPREFIX= GAMEID=ulwgl-1228964594 PROTONPATH= STORE=gog ulwgl-run ~/foo.exe | ||
``` | ||
|
||
``` | ||
# Play a non-Steam game by reading a configuration file | ||
[ulwgl] | ||
prefix = "~/.wine" | ||
proton = "~/GE-Proton30" | ||
game_id = "0" | ||
exe = "~/foo.exe" | ||
launch_args = "-opengl -SkipBuildPatchPrereq" | ||
store = "gog" | ||
$ ulwgl-run --config config.toml | ||
``` | ||
|
||
``` | ||
# Create a ULWGL WINE prefix | ||
$ WINEPREFIX=~/foo GAMEID=0 PROTONPATH= ulwgl-run "" | ||
``` | ||
|
||
``` | ||
# Play a game and download the latest ULWGL-Proton | ||
$ WINEPREFIX= GAMEID=0 ulwgl-run foo.exe | ||
``` | ||
|
||
``` | ||
# Play a game and automatically set Proton | ||
# Will first search ~/.local/share/Steam/compatibilitytools.d for latest | ||
# When a Proton cannot be found, ULWGL-Proton will be downloaded | ||
$ WINEPREFIX= GAMEID=0 ulwgl-run foo.exe | ||
``` | ||
|
||
``` | ||
# Play a game, download the latest Proton and create a prefix | ||
# This will create the prefix as ~/Games/ULWGL/<ulwgl-$GAMEID> | ||
$ GAMEID=0 ulwgl-run foo.exe | ||
``` | ||
|
||
# AUTHORS | ||
|
||
Maintained by Open Wine Components members, and assisted by other open source | ||
contributors. For more information about ULWGL development, see | ||
https://github.com/Open-Wine-Components/ULWGL-launcher. |