aboutsummaryrefslogtreecommitdiff
path: root/games/bstone/bstone.6
diff options
context:
space:
mode:
Diffstat (limited to 'games/bstone/bstone.6')
-rw-r--r--games/bstone/bstone.6311
1 files changed, 221 insertions, 90 deletions
diff --git a/games/bstone/bstone.6 b/games/bstone/bstone.6
index ae8b11d612b6a..c503ef91af02d 100644
--- a/games/bstone/bstone.6
+++ b/games/bstone/bstone.6
@@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
-.TH BSTONE 6 "2016-08-13" "1.1.7" "SlackBuilds.org"
-.SH NAME
-bstone \- source port of the Blake Stone games
.
.nr rst2man-indent-level 0
.
@@ -30,18 +27,15 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
+.TH "BSTONE" 6 "2023-01-11" "1.1.12" "SlackBuilds.org"
+.SH NAME
+bstone \- source port of the Blake Stone games
.\" RST source for bstone(6) man page. Convert with:
.
.\" rst2man.py bstone.rst > bstone.6
.
.\" rst2man.py comes from the SBo development/docutils package.
.
-.\" converting from pod:
-.
-.\" s/B<\([^>]*\)>/**\1**/g
-.
-.\" s/I<\([^>]*\)>/*\1*/g
-.
.SH SYNOPSIS
.sp
bstone [\fI\-options\fP]
@@ -80,108 +74,245 @@ Planet Strike v1.1
.UNINDENT
.sp
This man page only describes the command\-line options. For full documentation,
-see /usr/doc/bstone\-1.1.7/README.md
+see /usr/doc/bstone\-1.1.12/README.md
.SH OPTIONS
-.\" notice the **-opt** *param* stuff? rst's option recognition
-.
-.\" can't handle non-GNU-style options like -option (it thinks the
-.
-.\" option is -o, and the ption is the parameter). So we have to help
-.
-.\" it out a little.
-.
.INDENT 0.0
.TP
-.B \fI\-\-version\fP
-Outputs the port\(aqs version to standard output and
-into message box.
+.B \fB\-\-version\fP
+Outputs the port\(aqs version to standard output and into message box.
.TP
-.B \fI\-\-aog_sw\fP
-Switches the port to Blake Stone: Aliens of Gold (shareware, v3.0) mode.
-If appropriate data files will not be found the port will fail.
-Default switch strategy: AoG (full) \-> AoG (SW) \-> PS
+.B \fB\-\-aog_sw\fP
+Switches the port to "Blake Stone: Aliens Of Gold (shareware)" mode.
+If appropriate data files are not found, the port will fail.
.TP
-.B \fI\-\-aog_10\fP
-Switches the port to Blake Stone: Aliens of Gold (full, v1.0) mode.
-If appropriate data files will not be found the port will fail.
-Default switch strategy: AoG (full) \-> AoG (SW) \-> PS
+.B \fB\-\-aog\fP
+Switches the port to "Blake Stone: Aliens Of Gold" mode.
+If appropriate data files are not found, the port will fail.
.TP
-.B \fI\-\-aog_2x\fP
-Switches the port to Blake Stone: Aliens of Gold (full, v2.0/v2.1) mode.
-If appropriate data files will not be found the port will fail.
-Default switch strategy: AoG (full) \-> AoG (SW) \-> PS
+.B \fB\-\-ps\fP
+Switches the port to "Blake Stone: Planet Strike" mode.
+If appropriate data files are not found, the port will fail.
.TP
-.B \fI\-\-aog_30\fP
-Switches the port to Blake Stone: Aliens of Gold (full, v3.0) mode.
-If appropriate data files will not be found the port will fail.
-Default switch strategy: AoG (full) \-> AoG (SW) \-> PS
+.B \fB\-\-no_screens\fP
+Skips start\-up screens and the ending promo pages (AOG SW).
.TP
-.B \fI\-\-ps\fP
-Switches the port to Blake Stone: Planet Strike (full, v1.0/v1.1) mode.
-If appropriate data files will not be found the port will fail.
-Default switch strategy: AoG (full) \-> AoG (SW) \-> PS
+.B \fB\-\-cheats\fP
+Enables so called "debug mode" without much fuss.
.TP
-.B \fI\-\-no_screens\fP
-Skips start\-up screens (AoG/PS) and ending promo pages (AoG SW only).
+.B \fB\-\-data_dir\fP dir
+Specifies a directory with game\(aqs resource files.
+Default: \fI/usr/share/games/bstone\fP
.TP
-.B \fI\-\-cheats\fP
-Enables so called "debug mode" without much fuss.
+.B \fB\-\-mod_dir\fP dir
+Specifies a directory with mod\(aqs resource files.
+Default: undefined.
+.TP
+.B \fB\-\-profile_dir\fP dir
+Overrides default directory of the game\(aqs profile files.
+Default: \fI~/.local/share/bibendovsky/bstone/\fP
.TP
-.B \fI\-\-data_dir path_to_data\fP
-Specifies location to the game\(aqs data files.
-Default: /usr/share/games/bstone/
-.TP
-.B \fI\-\-profile_dir path\fP
-Overrides default location of the game\(aqs profile files. Config files
-and savegames are written here.
-Default: .local/share/bibendovsky/bstone/
-.TP
-.B \fI\-\-vid_renderer [soft|ogl]\fP
-Forces to use a specified renderer.
-"soft" selects a software renderer.
-"ogl" selects an OpenGL 2.x compatible renderer.
-Default order without this option: ogl, soft.
-.TP
-.B \fI\-\-vid_windowed\fP
-Runs the game in windowed mode.
-Default video mode: 640x480
-.TP
-.B \fI\-\-vid_mode width height\fP
-Selects the specified resolution for windowed mode.
-Without this option the game will use desktop\(aqs resolution.
-Minimum width: 640
-Minimum height: 480
-.TP
-.B \fI\-\-vid_scale factor\fP
-Refinement factor. The higher a value the greater internal resolution
-mode will be used to render a scene. The dimensions of the resolution mode
-are proportional to the original one (320x200) by \(aqfactor\(aq value.
-This option can greatly affect the performance of a renderer (especially a
-software one).
-Minimum factor: 1 (identical to the original game)
-Default factor: depends on the game\(aqs resolution mode.
-.TP
-.B \fI\-\-vid_window_x offset\fP
+.B \fB\-\-vid_renderer\fP value
+Select a renderer.
+Values:
+.INDENT 7.0
+.INDENT 3.5
+.INDENT 0.0
+.IP \(bu 2
+auto_detect \- tries to select the best renderer.
+.IP \(bu 2
+software \- the vanilla renderer.
+.IP \(bu 2
+gl_2_0 \- OpenGL 2.0 or higher.
+.IP \(bu 2
+gl_3_2_c \- OpenGL 3.2 core or higher.
+.IP \(bu 2
+gles_2_0 \- OpenGL ES 2.0 or higher.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.sp
+Default: auto_detect
+.TP
+.B \fB\-\-vid_width\fP width
+Specifies window width.
+Minimum width: 320
+Default width: 640
+.TP
+.B \fB\-\-vid_height\fP height
+Specifies window height.
+Minimum height: 240
+Default height: 480
+.TP
+.B \fB\-\-vid_x\fP offset
Sets a horizontal offset from the left side of the desktop screen.
-Applicable for windowed mode only.
+Applicable for positionable window only.
+Default: 0
.TP
-.B \fI\-\-vid_window_y offset\fP
+.B \fB\-\-vid_y\fP offset
Sets a vertical offset from the top side of the desktop screen.
-Applicable for windowed mode only.
+Applicable for positionable window only.
+Default: 0
+.TP
+.B \fB\-\-vid_is_positioned\fP value
+Centers a window on the desktop or moves it in the specified position.
+Values: 0 (centered) or 1 (positioned)
+Default: 0
.TP
-.B \fI\-\-snd_rate sampling_rate\fP
+.B \fB\-\-vid_is_vsync\fP value
+Enables or disables vertical synchronization.
+Values: 0 (disable) or 1 (enable)
+Default: 1
+.TP
+.B \fB\-\-vid_is_widescreen\fP value
+Enables or disables widescreen rendering.
+Values: 0 (disable) or 1 (enable)
+Default: 1
+.TP
+.B \fB\-\-vid_is_ui_stretched\fP value
+Stretches the UI or keeps it at 4x3 ratio otherwise.
+Values: 0 (non\-stretched) or 1 (stretched)
+Default: 0
+.TP
+.B \fB\-\-vid_2d_texture_filter\fP filter
+Sets texturing filter for UI.
+Applicable only for 3D\-rendering.
+Values: nearest or linear
+Default: nearest
+.TP
+.B \fB\-\-vid_3d_texture_image_filter\fP filter
+Sets texturing image filter for the scene.
+Applicable only for 3D\-rendering.
+Values: nearest or linear
+Default: nearest
+.TP
+.B \fB\-\-vid_3d_texture_mipmap_filter\fP filter
+Sets texturing mipmap filter for the scene.
+Applicable only for 3D\-rendering.
+Values: nearest or linear
+Default: nearest
+.TP
+.B \fB\-\-vid_3d_texture_anisotropy\fP value
+Sets anisotropy degree for the scene.
+Value 1 or lower disables the filter.
+Applicable only for 3D\-rendering.
+Values: [1..16]
+Default: 1
+.TP
+.B \fB\-\-vid_texture_upscale_filter\fP filter
+Sets texturing upscale filter.
+Applicable only for 3D\-rendering.
+Values: none or xbrz
+Default: none
+\fBWARNING\fP xbrz is a high resource usage filter!
+.TP
+.B \fB\-\-vid_texture_upscale_xbrz_degree\fP degree
+Sets a degree of xBRZ texturing upscale.
+Applicable only for 3D\-rendering.
+Values: [2..6]
+Default: 0
+.TP
+.B \fB\-\-vid_aa_kind\fP value
+Sets an anti\-aliasing mode.
+Applicable only for 3D\-rendering.
+Values: none or msaa
+Default: none
+.TP
+.B \fB\-\-vid_aa_degree\fP value
+Sets a degree of the anti\-aliasing.
+Applicable only for 3D\-rendering.
+Values: [2..32]
+Default: 1
+.TP
+.B \fB\-\-vid_filler_color_index\fP value
+Sets a color for screen bars.
+Values: [0..255]
+Default: 0
+.TP
+.B \fB\-\-vid_external_textures\fP value
+Toggles external textures.
+Values: 0 (disable), 1 (enable).
+Default: 0
+.TP
+.B \fB\-\-snd_is_disabled\fP value
+Enables or disables audio subsystem.
+Values: 0 (disable) or 1 (enable)
+Default: 0
+.TP
+.B \fB\-\-snd_rate\fP sampling_rate
Specifies sampling rate of mixer in hertz.
-Default: 44100 Hz
-Minimum: 11025 Hz
+Default: 44100
+Minimum: 11025
.TP
-.B \fI\-\-snd_mix_size duration\fP
+.B \fB\-\-snd_mix_size\fP duration
Specifies mix data size in milliseconds.
-Default: 40 ms
-Minimum: 20 ms
+Default: 40
+Minimum: 20
+.TP
+.B \fB\-\-snd_driver\fP value
+Specifies the audio driver to use.
+Values: auto\-detect, 2d_sdl (2D SDL), 3d_openal (3D OpenAL)
+Default: auto\-detect
+Auto\-detect order: 3d_openal, 2d_sdl
+.TP
+.B \fB\-\-snd_oal_library\fP value
+Specifies OpenAL driver\(aqs name.
+Default: "" (OpenAL32.dll on Windows and libopenal.so on non\-Windows system).
+.TP
+.B \fB\-\-snd_oal_device_name\fP value
+Specifies OpenAL device name.
+Default: ""
+.TP
+.B \fB\-\-snd_sfx_type\fP value
+Specifies SFX type.
+Values: adlib (AdLib) or pc_speaker (PC Speaker)
+Default: adlib
+.TP
+.B \fB\-\-snd_is_sfx_digitized\fP value
+Toggles SFX digitization.
+If enabled overrides AdLib / PC Speaker SFX audio chunk if such one is available in AUDIOT.* file.
+Values: 0 (disable) or 1 (enable)
+Default: 1
+.TP
+.B \fB\-\-snd_opl3_type\fP value
+Specifies OPL3 emulator type.
+Values: dbopl (DOSBox) or nuked (Nuked)
+Default: dbopl
+.TP
+.B \fB\-\-calculate_hashes\fP
+Calculates hashes (SHA\-1) of all resource files and outputs them into the log.
+.TP
+.B \fB\-\-extract_vga_palette\fP dir
+Extracts VGA palette into existing directory dir.
+Supported file format: \fB\&.bmp\fP
+.TP
+.B \fB\-\-extract_walls\fP dir
+Extracts graphics resources (wall, flooring, etc.) into existing directory dir.
+Supported file format: \fB\&.bmp\fP
+.TP
+.B \fB\-\-extract_sprites\fP dir
+Extracts graphics resources (actors, decorations, etc.) into existing directory dir.
+Supported file format: \fB\&.bmp\fP
+.TP
+.B \fB\-\-extract_music\fP dir
+Extracts music resources into existing directory dir.
+Supported file format: \fB\&.wav\fP
+Supported file format: data (unprocessed)
+.TP
+.B \fB\-\-extract_sfx\fP dir
+Extracts sfx resources into existing directory dir.
+Supported file format: \fB\&.wav\fP
+Supported file format: data (unprocessed)
+.TP
+.B \fB\-\-extract_texts\fP dir
+Extracts text resources into existing directory dir.
+Supported file format: \fB\&.txt\fP
+.TP
+.B \fB\-\-extract_all\fP dir
+Extracts all resources (walls, sprites, etc.) into existing directory dir.
.UNINDENT
.SH COPYRIGHT
.sp
-See the file /usr/doc/bstone\-1.1.7/LICENSE for license information.
+See the file /usr/doc/bstone\-1.1.12/LICENSE for license information.
.SH AUTHORS
.sp
bstone was written by Boris I. Bendovsky, based on an original