1arxunpak(1) General Commands Manual arxunpak(1)
2
6 arxunpak - Extract the Arx Fatalis .pak files containing the game as‐
7 sets
8
10 arxunpak [options] [--] pakfiles ...
11 arxunpak [options] [--all]
13
15 arxunpak extracts the .pak files containing the game assets of Arx Fa‐
16 talis.
17 This is not required to run Arx Libertatis but can be useful for devel‐
19 opment.
20 All no-option arguments are interpreted as files to extract.
22 If no .pak files are specified on the command-line, the --all option is
24 enabled by default. In this case all files are extracted to the "un‐
25 packed" subdirectory of the user directory. Otherwise, output files are
26 written to the current working directory.
27
29 Here is a short summary of the options available in arxunpak. Please
30 refer to the detailed documentation below for a complete description.
31 Generic options:
33 -h --help Show supported options
34 -g --debug LEVELS Set debug output levels
35 -q --quiet Don't print log output
36 Search path options:
38 -n --no-data-dir Don't automatically detect data directories
39 -d --data-dir DIR Where to find the data files (can be repeated)
40 -u --user-dir DIR Where to store user-specific files
41 -c --config-dir DIR Where to store config files
42 -l --list-dirs List the searched user and data directories
43 Unpack options:
45 -a --all Process all game assets as seen by Arx
46 Libertatis
47 -e --extract Extract archive contents (default ac‐
48 tion)
49 --list List archive contents
50 -m --manifest Print archive manifest
51 -o --output-dir DIR Directory to extract files to
52
54 -- Treat all arguments after this one as files, even if they begin
55 with a dash.
56 -a, --all
58 Extract or list all resources seen by the game.
59 If no .pak files are specified on the command-line, this option
61 is enabled by default. In this case all files are extracted to
62 the "unpacked" subdirectory of the user directory instead of the
63 current directory, unless the --output-dir option is used to
64 override the output directory.
65 -c, --config-dir=DIR
67 By default arx will store configuration files in directories
68 specified by the XDG Base Directory Specification. This option
69 overrides the directory where config files are loaded from and
70 saved to.
71 -d, --data-dir=DIR
73 Arx Libertatis will look for data files in directories specified
74 by the XDG Base Directory Specification and in the directory
75 containing the game executable. Besides the system-wide data di‐
76 rectory, data files are also loaded from the user directory,
77 which can be set by the --user-dir option.
78 This option adds additional directories to search for data files
80 before the detected system-wide directories, but after the user
81 directory. To override the detected data directories combine it
82 with the --no-data-dir option.
83 The --data-dir option can be repeated to add multiple data di‐
85 rectories, in which case they are searched in the order pro‐
86 vided.
87 See https://arx.vg/paths, the --list-dirs output and the arx(6)
89 documentation for more details.
90 This option only affects which archives are loaded when using
92 the --all option -- it has no effect on .pak archives specified
93 on the command-line.
94 -g, --debug=LEVELS
96 This option can be used to enable debug output for debug builds
97 of Arx Libertatis. For non-debug build, this option is not very
98 useful but recognized for convenience.
99 -e, --extract
101 Extract files from the processed archives. This is the default
102 action unless the --list or --manifest options are used.
103 By default, files are extracted to the current directory unless
105 neither explicit .pak files nor the --all option were specified
106 on the command-line, in which case files are extracted to the
107 "unpacked" subdirectory of the user directory. The --output-dir
108 option can be used to override where files are extracted to.
109 -h, --help
111 Show a list of the supported options.
112 --list List all files and directories in the processed archives.
114 Each file or directory is printed on a separate line. Directo‐
116 ries are indicated using a trailing slash.
117 -l, --list-dirs
119 Show the data, user and config search directories and how they
120 were determined. To adjust the search directories, use the
121 --no-data-dir, --data-dir, --user-dir and --config-dir options.
122 -m, --manifest
124 Print checksums of files and list directories in the processed
125 archives.
126 Each file or directory is printed on a separate line. Directo‐
128 ries are indicated using a trailing slash and are preceded by 34
129 spaces. Files are preceded by a 32-character MD5 checksum, one
130 space and one asterisk ("*"). This format is compatible with the
131 --check option of md5sum(1), which will simply ignore directory
132 lines.
133 -n, --no-data-dir
135 Disables looking for default data directories. Default user and
136 config directories and data directories provided using the
137 --data-dir option are still searched.
138 This option only affects which archives are loaded when using
140 the --all option -- it has no effect on .pak archives specified
141 on the command-line.
142 -o, --output-dir DIR
144 Extract all files into the given directory. By default, arxunpak
145 will extract all files to the current directory unless neither
146 explicit .pak files nor the --all option were specified on the
147 command-line, in which case files are extracted to the "un‐
148 packed" subdirectory of the user directory.
149 If the specified directory does not exist, it will be created.
151 -q, --quiet
153 This option disables all log output. Only the archive type and
154 extracted files and directories (or manifest) are still printed.
155 -u, --user-dir=DIR
157 By default arx will store user files (saves, etc.) in directo‐
158 ries specified by the XDG Base Directory Specification. This
159 option overrides the directory where user files are loaded from.
160 The user directory will be used to load data, overwriting re‐
162 sources from the system-wide data directories amd from directo‐
163 ries specified by the --data-dir option.
164 This option only affects which archives are loaded when using
166 the --all option -- it has no effect on .pak archives specified
167 on the command-line.
168
170 arx(6), arxsavetool(1)
171
173 No known bugs.
1741.2.1 2022-04-10 arxunpak(1)