.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.46.4.
.TH LGOGDOWNLOADER "1" "October 2014" "LGOGDownloader 2.19" "User Commands"
.SH NAME
LGOGDownloader \- downloader for GOG.com games and other files
.SH SYNOPSIS
.B lgogdownloader
[\fIOPTION\fP]...
.SH DESCRIPTION
An open-source GOG.com downloader for Linux users which uses the same API as the official GOGDownloader.
.PP
LGOGDownloader can download purchased games, query GOG.com to see if game files have changed, as well as downloading extras such as artwork and manuals. It is capable of downloading language-specific installers for games where they exist.
.PP
These games are currently offered only for the Microsoft Windows\[rg] and Apple OS X\[rg] operating systems. To play these games under GNU/Linux will require a compatibility layer such as Wine. Usage of such a program is outside the scope of this document. 
.PP
LGOGDownloader 2.19
Options:
.TP
\fB\-h\fR [ \fB\-\-help\fR ]
Print help message
.TP
\fB\-\-version\fR
Print version information
.TP
\fB\-\-login\fR
Login
.TP
\fB\-\-list\fR
List games
.TP
\fB\-\-list\-details\fR
List games with detailed info
.TP
\fB\-\-download\fR
Download
.TP
\fB\-\-repair\fR
Repair downloaded files
Use \fB\-\-repair\fR \fB\-\-download\fR to redownload
files when filesizes don't match
(possibly different version).
Redownload will rename the old file
(appends .old to filename)
.TP
\fB\-\-game\fR arg
Set regular expression filter
for download/list/repair (Perl syntax)
Aliases: "all", "free"
.TP
\fB\-\-create\-xml\fR arg
Create GOG XML for file
"automatic" to enable automatic XML
creation
.TP
\fB\-\-update\-check\fR
Check for update notifications
.nf
.TP
\fB\-\-check\-orphans\fR arg
Check for orphaned files (files found
on local filesystem that are not found
on GOG servers). Sets regular
expression filter (Perl syntax) for
files to check. If no argument is given
then the regex defaults to
\&'.*\e.(zip|exe|bin|dmg|old|deb|tar\e.gz|p
kg)$'
.TP
\fB\-\-status\fR
Show status of files
.TP
Output format:
statuscode gamename filename filesize
filehash
.TP
Status codes:
OK \- File is OK
ND \- File is not downloaded
MD5 \- MD5 mismatch, different version
.nf
.TP
\fB\-\-save\-config\fR
Create config file with current
settings
.TP
\fB\-\-reset\-config\fR
Reset config settings to default
.TP
\fB\-\-report\fR [=arg(=lgogdownloader\-report.log)]
Save report of downloaded/repaired
files to specified file
Default filename: lgogdownloader\-report
\&.log
.TP
\fB\-\-no\-cover\fR
Don't download cover images. Overrides
\fB\-\-cover\fR option.
Useful for making exceptions when
"cover" is set to true in config file.
.TP
\fB\-\-update\-cache\fR
Update game details cache
.TP
\fB\-\-directory\fR arg (=.)
Set download directory
.TP
\fB\-\-limit\-rate\fR arg (=0)
Limit download rate to value in kB
0 = unlimited
.TP
\fB\-\-xml\-directory\fR arg
Set directory for GOG XML files
.TP
\fB\-\-chunk\-size\fR arg (=10)
Chunk size (in MB) when creating XML
.TP
\fB\-\-platform\fR arg (=5)
Select which installers are downloaded
1 = Windows
2 = Mac
4 = Linux
7 = All
.TP
\fB\-\-language\fR arg (=1)
Select which language installers are
downloaded
1 = English
2 = German
4 = French
8 = Polish
16 = Russian
32 = Chinese
64 = Czech
128 = Spanish
256 = Hungarian
512 = Italian
1024 = Japanese
2048 = Turkish
4096 = Portuguese
8192 = Korean
16384 = Dutch
32768 = Swedish
65536 = Norwegian
131072 = Danish
262144 = Finnish
Add the values to download multiple
languages
All = 524287
French + Polish = 4+8 = 12
.TP
\fB\-\-no\-installers\fR
Don't download/list/repair installers
.fi
.TP
\fB\-\-no\-extras\fR
Don't download/list/repair extras
.TP
\fB\-\-no\-patches\fR
Don't download/list/repair patches
.TP
\fB\-\-no\-language\-packs\fR
Don't download/list/repair language
packs
.TP
\fB\-\-no\-dlc\fR
Don't download/list/repair DLCs
.TP
\fB\-\-no\-deb\fR
Don't download/list/repair deb packages
.TP
\fB\-\-no\-targz\fR
Don't download/list/repair tarballs
.TP
\fB\-\-cover\fR
Download cover images
.TP
\fB\-\-no\-remote\-xml\fR
Don't use remote XML for repair
.TP
\fB\-\-no\-unicode\fR
Don't use Unicode in the progress bar
.TP
\fB\-\-no\-color\fR
Don't use coloring in the progress bar
.TP
\fB\-\-no\-duplicate\-handling\fR
Don't use duplicate handler for
installers
Duplicate installers from different
languages are handled separately
.TP
\fB\-\-no\-subdirectories\fR
Don't create subdirectories for extras,
patches and language packs
.TP
\fB\-\-verbose\fR
Print lots of information
.TP
\fB\-\-insecure\fR
Don't verify authenticity of SSL
certificates
.TP
\fB\-\-timeout\fR arg (=10)
Set timeout for connection
Maximum time in seconds that connection
phase is allowed to take
.TP
\fB\-\-retries\fR arg (=3)
Set maximum number of retries on failed
download
.TP
\fB\-\-wait\fR arg (=0)
Time to wait between requests
(milliseconds)
.TP
\fB\-\-cover\-list\fR arg (=https://sites.google.com/site/gogdownloader/covers.xml)
Set URL for cover list
.TP
\fB\-\-subdir\-installers\fR arg
Set subdirectory for extras
Templates:
\- %platform%
\- %gamename%
\- %dlcname%
.TP
\fB\-\-subdir\-extras\fR arg (=extras)
Set subdirectory for extras
Templates:
\- %platform%
\- %gamename%
\- %dlcname%
.TP
\fB\-\-subdir\-patches\fR arg (=patches)
Set subdirectory for patches
Templates:
\- %platform%
\- %gamename%
\- %dlcname%
.TP
\fB\-\-subdir\-language\-packs\fR arg (=languagepacks)
Set subdirectory for language packs
Templates:
\- %platform%
\- %gamename%
\- %dlcname%
.TP
\fB\-\-subdir\-dlc\fR arg (=dlc/%dlcname%)
Set subdirectory for dlc
Templates:
\- %platform%
\- %gamename%
\- %dlcname%
.TP
\fB\-\-subdir\-game\fR arg (=%gamename%)
Set subdirectory for game
Templates:
\- %platform%
\- %gamename%
\- %dlcname%
.TP
\fB\-\-use\-cache\fR
Use game details cache
.TP
\fB\-\-cache\-valid\fR arg (=2880)
Set how long cached game details are
valid (in minutes)
Default: 2880 minutes (48 hours)
.SH BLACKLIST
.fi
Allows user to specify individual files that should not be downloaded or mentioned as orphans.
.sp 1
Each line in the file specifies one blacklist expression, except for empty lines and lines starting with #.
First few characters specify blacklist item type and flags.
So far, only regular expression (perl variant) are supported, so each line must start with "Rp" characters.
After a space comes the expression itself. Expressions are matched against file path relative to what was specified as \fI--directory\fP.

\fIExample black list\fP
.br
# used to store manually downloaded mods/patches/maps/, don't mention it as orphans
.br
Rp ^[^/]*/manual/.*
.br
# included with every *divinity game, once is enough
.br
Rp beyond_divinity/extras/bd_ladymageknight\.zip
.br
Rp divinity_2_developers_cut/extras/divinity_2_ladymageknight\.zip
.sp
# extra 6GB is A LOT of space if you don't actually plan to mod your game
.br
Rp the_witcher_2/extras/the_witcher_2_redkit\.zip
.br
Rp the_witcher_2/extras/extras_pack_3_hu_pl_ru_tr_zh_\.zip
.br
Rp the_witcher_2/extras/extras_pack_2_fr_it_jp_\.zip
.SH AVAILABILITY
The latest version of this distribution is available from \fIhttps://github.com/Sude-/lgogdownloader\fP
.SH FILES
.fi
.TP
\fI$XDG_CONFIG_HOME/lgogdownloader/\fP
Storage for configuration files and cookies
.br
If \fB$XDG_CONFIG_HOME\fP is not set, it will use \fI$HOME/.config/lgogdownloader/\fP.

.TP
\fI$XDG_CACHE_HOME/lgogdownloader/xml/\fP
Storage for XML files
.br
If \fB$XDG_CACHE_HOME\fP is not set, it will use \fI$HOME/.cache/lgogdownloader/xml/\fP.

.TP
\fI$XDG_CONFIG_HOME/lgogdownloader/blacklist.txt\fP
Allows user to specify individual files that should not be downloaded or mentioned as orphans.
.br
It doesn't have to exist, but if it does exist, it must be readable to lgogdownloader.

.TP
\fI$XDG_CONFIG_HOME/lgogdownloader/gamename.conf\fP
JSON formatted file. Sets game specific settings for \fBgamename\fP.
.br
Allowed settings are \fBlanguage\fP, \fBplatform\fP and \fBdlc\fP.
.br
The \fBdlc\fP option is limited to disabling DLC for specific game. It can't enable DLC listing/downloading if \fB--no-dlc\fP option is used.
.br
Must be in the following format:
.br
{
    "language" : <int>,
    "platform" : <int>,
    "dlc" : <bool>
.br
}