.\" game-data-packager manpage; based on wtfm_example by branden robinson
.\" <http://people.debian.org/~branden/talks/wtfm/>
.\" 
.\" This program is free software; you can redistribute it and/or modify it
.\" under the terms of the GNU General Public License as published by the
.\" Free Software Foundation; version 2.
.\" 
.\" This program 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 library; if not, write to the Free Software Foundation, Inc.,
.\" 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
.\"
.\" See /usr/share/common-licenses/GPL-2
.\" 
.de URL
\\$2 \(laURL: \\$1 \(ra\\$3
..
.if \n[.g] .mso www.tmac
.TH game-data-packager 6 2008-07-14
.SH NAME
game\-data\-packager \- build a .deb of game data
.
.SH SYNOPSIS
.B game\-data\-packager
[
.I -i
]
[
.I -d
out-directory [
.I -n
] ]
[
.I -z | --no-compress
]
.I game
[
.I game\-options
]
.SH DESCRIPTION
Many open-source games require game data which is licensed
incompatibly with the Debian Free Software Guidelines.
.B game\-data\-packager
is a tool designed to help you locally assemble Debian packages containing
such game data from CD-ROMs, the Internet or elsewhere.
.SH OPTIONS
.TP
.B \-i
attempt to install the generated Debian package via
.BR dpkg (1)
or
.BR apt (8),
using
.BR pkexec (1),
.BR sudo (1)
or
.BR su (1)
to obtain suitable privileges.
\.
.TP
.B \-d out-directory
writes the generated Debian package to the specified directory.
.TP
.B \-n
Do not attempt to install the generated Debian package. This option must be
used in conjunction with
.B \-d.
.TP
.B \-z | --compress
Compress generated .deb (default unless \-i is used)
.TP
.B --no\-compress
Do not compress generated .deb (default with \-i)
.TP
.B game
The game being packaged. Running
.B game\-data\-packager
without arguments will display a list of valid games. Running
.B game\-data\-packager game \-\-help
will display a list of valid options for that game.

.SH ALTERNATIVE MODES
.B game\-data\-packager steam
[
.I \-i
]
[
.I \-d
out-directory [
.I \-n
] ]
[
.I \-z | --no\-compress
] [
.I --new
|
.I --all
]
.br
will package all your Steam game at once.
.br
Most games can only be downloaded with Windows Steam
running optionally through Wine.
.TP
.B --new
only package new games
.TP
.B --all
package all games available

.PP
.B game\-data\-packager gog
.br
will match all the GOG.com games you own against the games supported by this tool.
.br
Each games must then be packaged individually.

.SH ENVIRONMENT VARIABLES
.TP
.B LANGUAGE, LANG
These environment variables are used when a game is available in
various languages to choose the correct version.
.br
Those are normally set by your desktop environment.
.SH PATHS
game\-data\-packager will automatically locate applicable files in these directories:
.TP
.B ~/.steam/SteamApps/common/<game>/
.TP
.B ~/.wine/drive_c/Program Files/Steam/SteamApps/common/<game>/
and also the ~/.PlayOnLinux/wineprefix/Steam/drive_c/... variant
.TP
.B X:/Program Files/Steam/SteamApps/common/<game>/
where X:\\ is any mounted vfat or NTFS partition
.SH FILES
.TP
.B /etc/game-data-packager.conf
game-data-packager configuration file
.TP
.B ~/.scummvmrc
provides location information for game registered in ScummVM GUI
.TP
.B ~/.steam/config/loginusers.vdf
is used to detect user's SteamID, which is then used
to download a list of owned games
.TP
.B ~/.cache/lgogdownloader/gamedetails.json
holds a cached list of owned GOG.com games
.SH SEE ALSO
\fIpkexec\fP(1), \fIsudo\fP(8), \fIsu\fP(1), \fIlgogdownloader\fP(1)
.br
Project homepage:
.URL "https://wiki.debian.org/Games/GameDataPackager/"

.SH AUTHOR
Copyright \(co 2010-2013 Jonathan Dowland \fI<jmtd@debian.org>\fP
.br
Thanks to Branden Robinson for his \(oqWrite the Fine Manual\(cq presentation,
once found at
.URL "http://people.debian.org/~branden/talks/wtfm/"
.