Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add man page #56

Merged
merged 13 commits into from
Mar 7, 2024
13 changes: 10 additions & 3 deletions Makefile.in
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ PREFIX ?= /usr
BINDIR := $(PREFIX)/bin
LIBDIR := $(PREFIX)/lib
DATADIR := $(PREFIX)/share
MANDIR ?= $(PREFIX)/share/man

DESTDIR ?=
USERINSTALL ?= xfalse
Expand Down Expand Up @@ -109,12 +110,18 @@ user-install:
$(info :: Installed under user-only location "$(DATADIR)/$(INSTALLDIR)")
$(info :: To run you need to make sure "$(BINDIR)" is in your PATH)

.PHONY: docs
ulwgl-docs-install:
$(info :: Installing man pages)
@mkdir -p $(DESTDIR)$(MANDIR)/man1
scdoc < docs/ulwgl.1.scd > $(OBJDIR)/ulwgl.1
install -m644 $(OBJDIR)/ulwgl.1 $(DESTDIR)$(MANDIR)/man1/ulwgl.1

.PHONY: install
ifeq ($(USERINSTALL), xtrue)
install: reaper-install ulwgl-install ulwgl-launcher-install user-install
install: reaper-install ulwgl-install ulwgl-launcher-install user-install ulwgl-docs-install
else
install: reaper-install ulwgl-install ulwgl-launcher-install
install: reaper-install ulwgl-install ulwgl-launcher-install ulwgl-docs-install
endif

# vim: ft=make
# vim: ft=make
71 changes: 71 additions & 0 deletions docs/ulwgl.1.scd
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.
Loading