q3map2/help: only read terminal columns using ioctl on Posix systems
[xonotic/netradiant.git] / tools / quake3 / q3map2 / help.c
1 /* -------------------------------------------------------------------------------
2
3    Copyright (C) 1999-2007 id Software, Inc. and contributors.
4    For a list of contributors, see the accompanying CONTRIBUTORS file.
5
6    This file is part of GtkRadiant.
7
8    GtkRadiant is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 2 of the License, or
11    (at your option) any later version.
12
13    GtkRadiant is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with GtkRadiant; if not, write to the Free Software
20    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
21
22    -------------------------------------------------------------------------------
23
24    This code has been altered significantly from its original form, to support
25    several games based on the Quake III Arena engine, in the form of "Q3Map2."
26
27    ------------------------------------------------------------------------------- */
28
29
30
31 /* dependencies */
32 #include "q3map2.h"
33
34 #if GDEF_OS_POSIX
35 #include <sys/ioctl.h>
36 #endif // GDEF_OS_POSIX
37
38 static unsigned terminalColumns = 80;
39
40 struct HelpOption
41 {
42         const char* name;
43         const char* description;
44 };
45
46 // FIXME: low column width cause an endless loop
47 void HelpOptions(const char* group_name, int indentation, int width, struct HelpOption* options, int count)
48 {
49         indentation *= 2;
50         char* indent = malloc(indentation+1);
51         memset(indent, ' ', indentation);
52         indent[indentation] = 0;
53         printf("%s%s:\n", indent, group_name);
54         indentation += 2;
55         indent = realloc(indent, indentation+1);
56         memset(indent, ' ', indentation);
57         indent[indentation] = 0;
58
59         int i;
60         for ( i = 0; i < count; i++ )
61         {
62                 int printed = printf("%s%-24s  ", indent, options[i].name);
63                 int descsz = strlen(options[i].description);
64                 int j = 0;
65                 while ( j < descsz && descsz-j > width - printed )
66                 {
67                         if ( j != 0 )
68                                 printf("%s%26c",indent,' ');
69                         int fragment = width - printed;
70                         while ( fragment > 0 && options[i].description[j+fragment-1] != ' ')
71                                         fragment--;
72                         j += fwrite(options[i].description+j, sizeof(char), fragment, stdout);
73                         putchar('\n');
74                         printed = indentation+26;
75                 }
76
77                 if ( j == 0 )
78                 {
79                         printf("%s\n",options[i].description+j);
80                 }
81                 else if ( j < descsz )
82                 {
83                         printf("%s%26c%s\n",indent,' ',options[i].description+j);
84                 }
85         }
86
87         putchar('\n');
88
89         free(indent);
90 }
91
92 void HelpBsp()
93 {
94         struct HelpOption bsp[] = {
95                 {"-bsp [options] <filename.map>", "Switch that enters this stage"},
96                 {"-altsplit", "Alternate BSP tree splitting weights (should give more fps)"},
97                 {"-bspfile <filename.bsp>", "BSP file to write"},
98                 {"-celshader <shadername>", "Sets a global cel shader name"},
99                 {"-custinfoparms", "Read scripts/custinfoparms.txt"},
100                 {"-debuginset", "Push all triangle vertexes towards the triangle center"},
101                 {"-debugportals", "Make BSP portals visible in the map"},
102                 {"-debugsurfaces", "Color the vertexes according to the index of the surface"},
103                 {"-deep", "Use detail brushes in the BSP tree, but at lowest priority (should give more fps)"},
104                 {"-de <F>", "Distance epsilon for plane snapping etc."},
105                 {"-fakemap", "Write fakemap.map containing all world brushes"},
106                 {"-fastmeta", "Use small lightmap/surface verts/number maximum numbers (like Q3A), to be used with `-meta`"},
107                 {"-flares", "Turn on support for flares"},
108                 {"-flat", "Enable flat shading (good for combining with -celshader)"},
109                 {"-fulldetail", "Treat detail brushes as structural ones"},
110                 {"-keeplights", "Keep light entities in the BSP file after compile"},
111                 {"-leaktest", "Abort if a leak was found"},
112                 {"-linfile <filename.lin>", "Line file to write"},
113                 {"-maxarea", "Use Max Area face surface generation"},
114                 {"-maxlightmapvertices <N>", "Sets the maximum number of vertices per lightmapped surface"},
115                 {"-maxsurfaceindexes <N>", "Sets the maximum number of indexes per surface"},
116                 {"-maxsurfacevertices <N>", "Sets the maximum number of vertices per surface"},
117                 {"-meta", "Combine adjacent triangles of the same texture to surfaces (ALWAYS USE THIS)"},
118                 {"-metaadequatescore <N>", "Adequate score for adding triangles to meta surfaces"},
119                 {"-metagoodscore <N>", "Good score for adding triangles to meta surfaces"},
120                 {"-metamaxbboxdistance <F>", "Maximum bounding box distance for meta surfaces"},
121                 {"-minsamplesize <N>", "Sets minimum lightmap resolution in luxels/qu"},
122                 {"-mi <N>", "Deprecated alias for `-maxsurfaceindexes`"},
123                 {"-mv <N>", "Deprecated alias for `-maxlightmapverts`"},
124                 {"-ne <F>", "Normal epsilon for plane snapping etc."},
125                 {"-nocurves", "Turn off support for patches"},
126                 {"-nodetail", "Leave out detail brushes"},
127                 {"-noflares", "Turn off support for flares"},
128                 {"-nofog", "Turn off support for fog volumes"},
129                 {"-nohint", "Turn off support for hint brushes"},
130                 {"-nosRGB", "Treat colors and textures as linear colorspace"},
131                 {"-nosRGBcolor", "Treat shader and light entity colors as linear colorspace"},
132                 {"-nosRGBtex", "Treat textures as linear colorspace"},
133                 {"-nosubdivide", "Turn off support for `q3map_tessSize` (breaks water vertex deforms)"},
134                 {"-notjunc", "Do not fix T-junctions (causes cracks between triangles, do not use)"},
135                 {"-nowater", "Turn off support for water, slime or lava (Stef, this is for you)"},
136                 {"-np <A>", "Force all surfaces to be nonplanar with a given shade angle"},
137                 {"-onlyents", "Only update entities in the BSP"},
138                 {"-patchmeta", "Turn patches into triangle meshes for display"},
139                 {"-prtfile <filename.prt>", "Portal file to write"},
140                 {"-rename", "Append suffix to miscmodel shaders (needed for SoF2)"},
141                 {"-samplesize <N>", "Sets default lightmap resolution in luxels/qu"},
142                 {"-skyfix", "Turn sky box into six surfaces to work around ATI problems"},
143                 {"-snap <N>", "Snap brush bevel planes to the given number of units"},
144                 {"-srffile <filename.srf>", "Surface file to write"},
145                 {"-sRGBcolor", "Treat shader and light entity colors as sRGB colorspace"},
146                 {"-sRGBtex", "Treat textures as sRGB colorspace"},
147                 {"-tempname <filename.map>", "Read the MAP file from the given file name"},
148                 {"-texrange <N>", "Limit per-surface texture range to the given number of units, and subdivide surfaces like with `q3map_tessSize` if this is not met"},
149                 {"-tmpout", "Write the BSP file to /tmp"},
150                 {"-verboseentities", "Enable `-v` only for map entities, not for the world"},
151         };
152
153         HelpOptions("BSP Stage", 0, terminalColumns, bsp, sizeof(bsp)/sizeof(struct HelpOption));
154 }
155
156 void HelpVis()
157 {
158         struct HelpOption vis[] = {
159                 {"-vis [options] <filename.map>", "Switch that enters this stage"},
160                 {"-fast", "Very fast and crude vis calculation"},
161                 {"-hint", "Merge all but hint portals"},
162                 {"-mergeportals", "The less crude half of `-merge`, makes vis sometimes much faster but doesn't hurt fps usually"},
163                 {"-merge", "Faster but still okay vis calculation"},
164                 {"-nopassage", "Just use PortalFlow vis (usually less fps)"},
165                 {"-nosort", "Do not sort the portals before calculating vis (usually slower)"},
166                 {"-passageOnly", "Just use PassageFlow vis (usually less fps)"},
167                 {"-prtfile <filename.prt>", "Portal file to read"},
168                 {"-saveprt", "Keep the Portal file after running vis (so you can run vis again)"},
169                 {"-tmpin", "Use /tmp folder for input"},
170                 {"-tmpout", "Use /tmp folder for output"},
171                 {"-v -v", "Extra verbose mode for cluster debug"}, // q3map2 common takes first -v
172         };
173
174         HelpOptions("VIS Stage", 0, terminalColumns, vis, sizeof(vis)/sizeof(struct HelpOption));
175 }
176
177 void HelpLight()
178 {
179         struct HelpOption light[] = {
180                 {"-light [options] <filename.map>", "Switch that enters this stage"},
181                 {"-vlight [options] <filename.map>", "Deprecated alias for `-light -fast` ... filename.map"},
182                 {"-approx <N>", "Vertex light approximation tolerance (never use in conjunction with deluxemapping)"},
183                 {"-areascale <F, `-area` F>", "Scaling factor for area lights (surfacelight)"},
184                 {"-border", "Add a red border to lightmaps for debugging"},
185                 {"-bouncegrid", "Also compute radiosity on the light grid"},
186                 {"-bounceonly", "Only compute radiosity"},
187                 {"-bouncescale <F>", "Scaling factor for radiosity"},
188                 {"-bounce <N>", "Number of bounces for radiosity"},
189                 {"-bspfile <filename.bsp>", "BSP file to write"},
190                 {"-cheapgrid", "Use `-cheap` style lighting for radiosity"},
191                 {"-cheap", "Abort vertex light calculations when white is reached"},
192                 {"-compensate <F>", "Lightmap compensate (darkening factor applied after everything else)"},
193                 {"-cpma", "CPMA vertex lighting mode"},
194                 {"-custinfoparms", "Read scripts/custinfoparms.txt"},
195                 {"-dark", "Darken lightmap seams"},
196                 {"-debugaxis", "Color the lightmaps according to the lightmap axis"},
197                 {"-debugcluster", "Color the lightmaps according to the index of the cluster"},
198                 {"-debugdeluxe", "Show deluxemaps on the lightmap"},
199                 {"-debugnormals", "Color the lightmaps according to the direction of the surface normal"},
200                 {"-debugorigin", "Color the lightmaps according to the origin of the luxels"},
201                 {"-debugsurfaces, -debugsurface", "Color the lightmaps according to the index of the surface"},
202                 {"-debugunused", "This option does nothing"},
203                 {"-debug", "Mark the lightmaps according to the cluster: unmapped clusters get yellow, occluded ones get pink, flooded ones get blue overlay color, otherwise red"},
204                 {"-deluxemode 0", "Use modelspace deluxemaps (DarkPlaces)"},
205                 {"-deluxemode 1", "Use tangentspace deluxemaps"},
206                 {"-deluxe, -deluxemap", "Enable deluxemapping (light direction maps)"},
207                 {"-dirtdebug, -debugdirt", "Store the dirtmaps as lightmaps for debugging"},
208                 {"-dirtdepth", "Dirtmapping depth"},
209                 {"-dirtgain", "Dirtmapping exponent"},
210                 {"-dirtmode 0", "Ordered direction dirtmapping"},
211                 {"-dirtmode 1", "Randomized direction dirtmapping"},
212                 {"-dirtscale", "Dirtmapping scaling factor"},
213                 {"-dirty", "Enable dirtmapping"},
214                 {"-dump", "Dump radiosity from `-bounce` into numbered MAP file prefabs"},
215                 {"-export", "Export lightmaps when compile finished (like `-export` mode)"},
216                 {"-exposure <F>", "Lightmap exposure to better support overbright spots"},
217                 {"-external", "Force external lightmaps even if at size of internal lightmaps"},
218                 {"-extradist <F>", "Extra distance for lights in map units"},
219                 {"-extravisnudge", "Broken feature to nudge the luxel origin to a better vis cluster"},
220                 {"-extrawide", "Deprecated alias for `-super 2 -filter`"},
221                 {"-extra", "Deprecated alias for `-super 2`"},
222                 {"-fastallocate",  "Trade lightmap size against packing time (useful with hi res lightmaps on large maps: reduce allocation time from days to minutes for only some extra bytes)"},
223                 {"-fastbounce", "Use `-fast` style lighting for radiosity"},
224                 {"-faster", "Use a faster falloff curve for lighting; also implies `-fast`"},
225                 {"-fastgrid", "Use `-fast` style lighting for the light grid"},
226                 {"-fastlightmapsearch", "Deprecated alias for `-fastallocate`"},
227                 {"-fast", "Ignore tiny light contributions"},
228                 {"-fill", "Fill lightmap colors from surrounding pixels to improve JPEG compression"},
229                 {"-filter", "Lightmap filtering, doesn't play nice with some other effects, don't use it, use `-samples` instead"},
230                 {"-floodlight", "Enable floodlight (zero-effort somewhat decent lighting)"},
231                 {"-gamma <F>", "Lightmap gamma"},
232                 {"-gridambientdirectionality <F>", "Ambient directional lighting received (default: 0.0)"},
233                 {"-gridambientscale <F>", "Scaling factor for the light grid ambient components only"},
234                 {"-griddirectionality <F>", "Directional lighting received (default: 1.0)"},
235                 {"-gridscale <F>", "Scaling factor for the light grid only"},
236                 {"-lightanglehl 0", "Disable half lambert light angle attenuation"},
237                 {"-lightanglehl 1", "Enable half lambert light angle attenuation"},
238                 {"-lightmapdir <directory>", "Directory to store external lightmaps (default: same as map name without extension)"},
239                 {"-lightmapsearchblocksize <N>", "Restrict lightmap search to block size <N>"},
240                 {"-lightmapsearchpower <N>", "Optimize for lightmap merge power <N>"},
241                 {"-lightmapsize <N>", "Size of lightmaps to generate (must be a power of two)"},
242                 {"-lightsubdiv <N>", "Size of light emitting shader subdivision"},
243                 {"-lomem", "Low memory but slower lighting mode"},
244                 {"-lowquality", "Low quality floodlight (appears to currently break floodlight)"},
245                 {"-minsamplesize <N>", "Sets minimum lightmap resolution in luxels/qu"},
246                 {"-nobouncestore", "Do not store BSP, lightmap and shader files between bounces"},
247                 {"-nocollapse", "Do not collapse identical lightmaps"},
248                 {"-nodeluxe, -nodeluxemap", "Disable deluxemapping"},
249                 {"-nofastpoint", "Disable fast point light calculation"},
250                 {"-nogrid", "Disable grid light calculation (makes all entities fullbright)"},
251                 {"-nolightmapsearch", "Do not optimize lightmap packing for GPU memory usage (as doing so costs fps)"},
252                 {"-normalmap", "Color the lightmaps according to the direction of the surface normal (TODO is this identical to `-debugnormals`?)"},
253                 {"-nosRGB", "Treat colors, textures, and lightmaps as linear colorspace"},
254                 {"-nosRGBcolor", "Treat shader and light entity colors as linear colorspace"},
255                 {"-nosRGBlight", "Write lightmaps as linear colorspace"},
256                 {"-nosRGBtex", "Treat textures as linear colorspace"},
257                 {"-nostyle, -nostyles", "Disable support for light styles"},
258                 {"-nosurf", "Disable tracing against surfaces (only uses BSP nodes then)"},
259                 {"-notrace", "Disable shadow occlusion"},
260                 {"-novertex", "Disable vertex lighting"},
261                 {"-patchshadows", "Cast shadows from patches"},
262                 {"-pointscale <F, `-point` F>", "Scaling factor for spherical and spot point lights (light entities)"},
263                 {"-q3", "Use nonlinear falloff curve by default (like Q3A)"},
264                 {"-randomsamples", "Use random sampling for lightmaps"},
265                 {"-rawlightmapsizelimit <N>", "Sets maximum lightmap resolution in luxels/qu (only affects patches if used -patchmeta in BSP stage)"},
266                 {"-samplescale <F>", "Scales all lightmap resolutions"},
267                 {"-samplesize <N>", "Sets default lightmap resolution in luxels/qu"},
268                 {"-samplessearchboxsize <N>", "Search box size (1 to 4) for lightmap adaptive supersampling"},
269                 {"-samples <N>", "Adaptive supersampling quality"},
270                 {"-scale <F>", "Scaling factor for all light types"},
271                 {"-shadeangle <A>", "Angle for phong shading"},
272                 {"-shade", "Enable phong shading at default shade angle"},
273                 {"-skyscale <F, `-sky` F>", "Scaling factor for sky and sun light"},
274                 {"-slowallocate", "Use old (a bit more careful, but much slower) lightmaps packing algorithm (default)"},
275                 {"-smooth", "Deprecated alias for `-samples 2`"},
276                 {"-sphericalscale <F, `-spherical` F>", "Scaling factor for spherical point light entities"},
277                 {"-spotscale <F, `-spot` F>", "Scaling factor for spot point light entities"},
278                 {"-srffile <filename.srf>", "Surface file to read"},
279                 {"-sRGB", "Treat colors, textures, and lightmaps as sRGB colorspace"},
280                 {"-sRGBcolor", "Treat shader and light entity colors as sRGB colorspace"},
281                 {"-sRGBlight", "Write lightmaps as sRGB colorspace"},
282                 {"-sRGBtex", "Treat textures as sRGB colorspace"},
283                 {"-style, -styles", "Enable support for light styles"},
284                 {"-sunonly", "Only compute sun light"},
285                 {"-super <N, `-supersample` N>", "Ordered grid supersampling quality, much slower than `-samples`"},
286                 {"-thresh <F>", "Triangle subdivision threshold"},
287                 {"-trianglecheck", "Broken check that should ensure luxels apply to the right triangle"},
288                 {"-trisoup", "Convert brush faces to triangle soup"},
289                 {"-wolf", "Use linear falloff curve by default (like W:ET)"},
290         };
291
292         HelpOptions("Light Stage", 0, terminalColumns, light, sizeof(light)/sizeof(struct HelpOption));
293 }
294
295 void HelpAnalyze()
296 {
297         struct HelpOption analyze[] = {
298                 {"-analyze [options] <filename.bsp>", "Switch that enters this mode"},
299                 {"-lumpswap", "Swap byte order in the lumps"},
300         };
301
302         HelpOptions("Analyzing BSP-like file structure", 0, terminalColumns, analyze, sizeof(analyze)/sizeof(struct HelpOption));
303 }
304
305 void HelpScale()
306 {
307         struct HelpOption scale[] = {
308                 {"-scale [options] <S filename.bsp>", "Scale uniformly"},
309                 {"-scale [options] <SX SY SZ filename.bsp>", "Scale non-uniformly"},
310                 {"-tex", "Scale without texture lock"},
311                 {"-spawn_ref <F>", "Vertical offset for info_player_* entities (adds spawn_ref, scales, subtracts spawn_ref)"},
312         };
313
314         HelpOptions("Scaling", 0, terminalColumns, scale, sizeof(scale)/sizeof(struct HelpOption));
315 }
316
317 void HelpConvert()
318 {
319         struct HelpOption convert[] = {
320                 {"-convert [options] <filename.bsp>", "Switch that enters this mode"},
321                 {"-deluxemapsastexcoord", "Save deluxemap names and texcoords instead of textures (only when writing ase and obj)"},
322                 {"-de <F>", "Distance epsilon for the conversion (only when reading map)"},
323                 {"-format <converter>", "Select the converter, default ase (available: map, map_bp, ase, obj, or game names)"},
324                 {"-lightmapsastexcoord", "Save lightmap names and texcoords instead of textures (only when writing ase and obj)"},
325                 {"-meta", "Combine adjacent triangles of the same texture to surfaces (only when reading map)"},
326                 {"-ne <F>", "Normal epsilon for the conversion (only when reading map)"},
327                 {"-patchmeta", "Turn patches into triangle meshes for display (only when reading map)"},
328                 {"-readbsp", "Force converting bsp to selected format"},
329                 {"-readmap", "Force converting map to selected format"},
330                 {"-shadersasbitmap", "Save shader names as bitmap names in the model so it works as a prefab (only when writing ase and obj)"},
331         };
332
333         HelpOptions("Converting & Decompiling", 0, terminalColumns, convert, sizeof(convert)/sizeof(struct HelpOption));
334 }
335
336 void HelpExport()
337 {
338         struct HelpOption exportl[] = {
339                 {"-export <filename.bsp>", "Copies lightmaps from the BSP to `filename/lightmap_0000.tga`"}
340         };
341
342         HelpOptions("Exporting lightmaps", 0, terminalColumns, exportl, sizeof(exportl)/sizeof(struct HelpOption));
343 }
344
345 void HelpExportEnts()
346 {
347         struct HelpOption exportents[] = {
348                 {"-exportents <filename.bsp>", "Exports the entities to a text file (.ent)"},
349         };
350         HelpOptions("ExportEnts Stage", 0, terminalColumns, exportents, sizeof(exportents)/sizeof(struct HelpOption));
351 }
352
353 void HelpFixaas()
354 {
355         struct HelpOption fixaas[] = {
356                 {"-fixaas <filename.bsp>", "Switch that enters this mode"},
357         };
358
359         HelpOptions("Fixing AAS checksum", 0, terminalColumns, fixaas, sizeof(fixaas)/sizeof(struct HelpOption));
360 }
361
362 void HelpInfo()
363 {
364         struct HelpOption info[] = {
365                 {"-info <filename.bsp>", "Switch that enters this mode"},
366         };
367
368         HelpOptions("Get info about BSP file", 0, terminalColumns, info, sizeof(info)/sizeof(struct HelpOption));
369 }
370
371 void HelpImport()
372 {
373         struct HelpOption import[] = {
374                 {"-import <filename.bsp>", "Copies lightmaps from `filename/lightmap_0000.tga` ff into the BSP"},
375         };
376
377         HelpOptions("Importing lightmaps", 0, terminalColumns, import, sizeof(import)/sizeof(struct HelpOption));
378 }
379
380 void HelpMinimap()
381 {
382         struct HelpOption minimap[] = {
383                 {"-minimap [options] <filename.bsp>", "Creates a minimap of the BSP, by default writes to `../gfx/filename_mini.tga`"},
384                 {"-autolevel", "Automatically level brightness and contrast"},
385                 {"-black", "Write the minimap as a black-on-transparency RGBA32 image"},
386                 {"-boost <F>", "Sets the contrast boost value (higher values make a brighter image); contrast boost is somewhat similar to gamma, but continuous even at zero"},
387                 {"-border <F>", "Sets the amount of border pixels relative to the total image size"},
388                 {"-brightness <F>", "Sets brightness value to add to minimap values"},
389                 {"-contrast <F>", "Sets contrast value to scale minimap values (doesn't affect brightness)"},
390                 {"-gray", "Write the minimap as a white-on-black GRAY8 image"},
391                 {"-keepaspect", "Ensure the aspect ratio is kept (the minimap is then letterboxed to keep aspect)"},
392                 {"-minmax <xmin ymin zmin xmax ymax zmax>", "Forces specific map dimensions (note: the minimap actually uses these dimensions, scaled to the target size while keeping aspect with centering, and 1/64 of border appended to all sides)"},
393                 {"-noautolevel", "Do not automatically level brightness and contrast"},
394                 {"-nokeepaspect", "Do not ensure the aspect ratio is kept (makes it easier to use the image in your code, but looks bad together with sharpening)"},
395                 {"-o <filename.tga>", "Sets the output file name"},
396                 {"-random <N>", "Sets the randomized supersampling count (cannot be combined with `-samples`)"},
397                 {"-samples <N>", "Sets the ordered supersampling count (cannot be combined with `-random`)"},
398                 {"-sharpen <F>", "Sets the sharpening coefficient"},
399                 {"-size <N>", "Sets the width and height of the output image"},
400                 {"-white", "Write the minimap as a white-on-transparency RGBA32 image"},
401         };
402
403         HelpOptions("MiniMap", 0, terminalColumns, minimap, sizeof(minimap)/sizeof(struct HelpOption));
404 }
405
406 void HelpCommon()
407 {
408         struct HelpOption common[] = {
409                 {"-connect <address>", "Talk to a " RADIANT_NAME " instance using a specific XML based protocol"},
410                 {"-force", "Allow reading some broken/unsupported BSP files e.g. when decompiling, may also crash"},
411                 {"-fs_basepath <path>", "Sets the given path as main directory of the game (can be used more than once to look in multiple paths)"},
412                 {"-fs_forbiddenpath <pattern>", "Pattern to ignore directories, pk3, and pk3dir; example pak?.pk3 (can be used more than once to look for multiple patterns)"},
413                 {"-fs_game <gamename>", "Sets a different game directory name (default for Q3A: baseq3, can be used more than once)"},
414                 {"-fs_home <dir>", "Specifies where the user home directory is on Linux"},
415                 {"-fs_homebase <dir>", "Specifies game home directory relative to user home directory on Linux (default for Q3A: .q3a)"},
416                 {"-fs_homepath <path>", "Sets the given path as the game home directory name (fs_home + fs_homebase)"},
417                 {"-fs_nobasepath", "Do not load base paths in VFS, imply -fs_nomagicpath"},
418                 {"-fs_nomagicpath", "Do not try to guess base path magically"},
419                 {"-fs_nohomepath", "Do not load home path in VFS"},
420                 {"-fs_pakpath <path>", "Specify a package directory (can be used more than once to look in multiple paths)"},
421                 {"-game <gamename>", "Load settings for the given game (default: quake3)"},
422                 {"-subdivisions <F>", "Multiplier for patch subdivisions quality"},
423                 {"-threads <N>", "Number of threads to use"},
424                 {"-v", "Verbose mode"},
425                 {"-werror", "Make all warnings into errors"}
426         };
427
428         HelpOptions("Common Options", 0, terminalColumns, common, sizeof(common)/sizeof(struct HelpOption));
429 }
430
431 void HelpGames()
432 {
433         printf("Games:\n");
434         qboolean begin = qtrue;
435
436         // TODO: sort alphabetically
437         for ( unsigned i = 0, length = 0; games[ i ].arg != NULL; i++ )
438         {
439                 // 3 for two whitespaces at the beginning and one (optional) comma a the end
440                 if ( length + 3 + strlen( games[ i ].arg ) > terminalColumns )
441                 {
442                         printf(",\n");
443                         length = 0;
444                         begin = qtrue;
445                 }
446
447                 if ( begin )
448                 {
449                         printf("  %s", games[ i ].arg );
450                         begin = qfalse;
451                 }
452                 else
453                 {
454                         printf(", %s", games[ i ].arg );
455                 }
456
457                 length += 2 + strlen( games[ i ].arg );
458         }
459
460         printf("\n\n");
461 }
462
463 void HelpMain(const char* arg)
464 {
465         printf("Usage: q3map2 [stage] [common options...] [stage options...] [stage source file]\n");
466         printf("       q3map2 -help [stage]\n");
467         printf("       q3map2 -help all\n\n");
468
469 #if GDEF_OS_POSIX
470         struct winsize ws;
471         ioctl(STDOUT_FILENO, TIOCGWINSZ, &ws);
472         if (ws.ws_col > 60) {
473                 terminalColumns = ws.ws_col;
474         }
475 #endif // GDEF_OS_POSIX
476
477         HelpCommon();
478
479         HelpGames();
480
481         struct HelpOption stages[] = {
482                 {"-bsp", "BSP Stage"},
483                 {"-vis", "VIS Stage"},
484                 {"-light", "Light Stage"},
485                 {"-analyze", "Analyzing BSP-like file structure"},
486                 {"-scale", "Scaling"},
487                 {"-convert", "Converting & Decompiling"},
488                 {"-export", "Exporting lightmaps"},
489                 {"-exportents", "Exporting entities"},
490                 {"-fixaas", "Fixing AAS checksum"},
491                 {"-info", "Get info about BSP file"},
492                 {"-import", "Importing lightmaps"},
493                 {"-minimap", "MiniMap"},
494         };
495
496         void(*help_funcs[])() = {
497                 HelpBsp,
498                 HelpVis,
499                 HelpLight,
500                 HelpAnalyze,
501                 HelpScale,
502                 HelpConvert,
503                 HelpExport,
504                 HelpExportEnts,
505                 HelpFixaas,
506                 HelpInfo,
507                 HelpImport,
508                 HelpMinimap,
509         };
510
511         if ( arg && strlen(arg) > 0 )
512         {
513                 if ( arg[0] == '-' )
514                 {
515                         arg++;
516                 }
517
518                 if ( strcmp(arg, "all") == 0 )
519                 {
520                         HelpOptions("Stages", 0, terminalColumns, stages, sizeof(stages)/sizeof(struct HelpOption));
521
522                         for ( unsigned i = 0; i < sizeof(stages)/sizeof(struct HelpOption); i++ )
523                         {
524                                 help_funcs[i]();
525                         }
526                         return;
527                 }
528
529                 for ( unsigned i = 0; i < sizeof(stages)/sizeof(struct HelpOption); i++ )
530                 {
531                         if ( strcmp(arg, stages[i].name+1) == 0 )
532                         {
533                                 help_funcs[i]();
534                                 return;
535                         }
536                 }
537         }
538
539         HelpOptions("Stages", 0, terminalColumns, stages, sizeof(stages)/sizeof(struct HelpOption));
540 }