diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/USAGE.md | 179 | ||||
| -rw-r--r-- | docs/box64.pod | 10 | ||||
| -rw-r--r-- | docs/gen/gen.py | 4 | ||||
| -rw-r--r-- | docs/gen/usage.json | 28 |
4 files changed, 134 insertions, 87 deletions
diff --git a/docs/USAGE.md b/docs/USAGE.md index d9a26546..f8caf164 100644 --- a/docs/USAGE.md +++ b/docs/USAGE.md @@ -217,91 +217,6 @@ Use hardware counter for rdtsc if available. * 0: Use hardware counter for rdtsc opcode if available. [Default] * 1: Use hardware counter for rdtsc if and only if precision is at least 1GHz. -## Libraries - -### BOX64_ADDLIBS - -Add extras to the needed libraries list, rarely needed. - - * XXXX: Add library XXXX to the needed libraries list. - * XXXX:YYYY:ZZZZ: Add library XXXX, YYYY and ZZZZ to the needed libraries list. - -### BOX64_ALLOWMISSINGLIBS - -Allow missing libraries to be ignored. - - * 0: Do not allow missing libraries. [Default] - * 1: Allow missing libraries. - -### BOX64_EMULATED_LIBS - -Force the use of emulated libraries. - - * XXXX: Force the use of emulated library XXXX. - * XXXX:YYYY:ZZZZ: Force the use of emulated libraries XXXX, YYYY and ZZZZ. - -### BOX64_LD_LIBRARY_PATH - -Path to look for x86_64 libraries. - - * XXXX: Add path XXXX to the library path. - -### BOX64_LD_PRELOAD - -Force loading libraries with the binary. - - * XXXX: Force the loading of library XXXX. - * XXXX:YYYY: Force the loading of libraries XXXX and YYYY. - -### BOX64_LIBGL - -Set the name for libGL. - - * libXXXX: Set the name for libGL to libXXXX. - * /path/to/libXXXX: Set the name and path for libGL to /path/to/libXXXX, you can also use SDL_VIDEO_GL_DRIVER. - -### BOX64_NOGTK - -Do not load wrapped GTK libraries. - - * 0: Load wrapped GTK libraries. [Default] - * 1: Do not load wrapped GTK libraries. - -### BOX64_NOPULSE - -Do not load PulseAudio libraries (both native and x86_64). - - * 0: Load PulseAudio libraries. [Default] - * 1: Do not load PulseAudio libraries. - -### BOX64_NOVULKAN - -Do not load Vulkan libraries. - - * 0: Load Vulkan libraries. [Default] - * 1: Do not load Vulkan libraries, both native and x86_64. - -### BOX64_PREFER_EMULATED - -Prefer emulated libraries over native ones. - - * 0: Prefer native libraries over emulated ones. [Default] - * 1: Prefer emulated libraries over native ones. - -### BOX64_PREFER_WRAPPED - -Prefer wrapped libs first even if the lib is specified with absolute path. - - * 0: Prefer libs with absolute path over wrapped ones. [Default] - * 1: Prefer wrapped libs first even if the lib is specified with absolute path. - -### BOX64_WRAP_EGL - -Prefer wrapped libs for EGL and GLESv2. - - * 0: Prefer emulated libs for EGL and GLESv2. [Default] - * 1: Prefer wrapped libs for EGL and GLESv2. - ## Arguments ### BOX64_ARGS @@ -348,6 +263,15 @@ Add --no-sandbox argument to the guest program. ## Compatibility +### BOX64_ARCH + +Specify the architecture in rcfiles to which the current entry applies. This option only takes effect when used inside rcfiles. + + * `arm64`: Only apply current entry for AArch64. + * `la64`: Only apply current entry for LoongArch64. + * `rv64`: Only apply current entry for RISC-V. + * `<empty>`: Apply current entry for all architectures, will be replaced by more specific entries. [Default] + ### BOX64_AVX Expose AVX extension to CPUID and cpuinfo file. Default value is 2 on Arm64 because it's fully implemented in DynaRec, 0 otherwise. Availble in WowBox64. @@ -766,3 +690,88 @@ Add an environment variable. * XXXX=yyyy: Add environment variable XXXX with value yyyy. +## Libraries + +### BOX64_ADDLIBS + +Add extras to the needed libraries list, rarely needed. + + * XXXX: Add library XXXX to the needed libraries list. + * XXXX:YYYY:ZZZZ: Add library XXXX, YYYY and ZZZZ to the needed libraries list. + +### BOX64_ALLOWMISSINGLIBS + +Allow missing libraries to be ignored. + + * 0: Do not allow missing libraries. [Default] + * 1: Allow missing libraries. + +### BOX64_EMULATED_LIBS + +Force the use of emulated libraries. + + * XXXX: Force the use of emulated library XXXX. + * XXXX:YYYY:ZZZZ: Force the use of emulated libraries XXXX, YYYY and ZZZZ. + +### BOX64_LD_LIBRARY_PATH + +Path to look for x86_64 libraries. + + * XXXX: Add path XXXX to the library path. + +### BOX64_LD_PRELOAD + +Force loading libraries with the binary. + + * XXXX: Force the loading of library XXXX. + * XXXX:YYYY: Force the loading of libraries XXXX and YYYY. + +### BOX64_LIBGL + +Set the name for libGL. + + * libXXXX: Set the name for libGL to libXXXX. + * /path/to/libXXXX: Set the name and path for libGL to /path/to/libXXXX, you can also use SDL_VIDEO_GL_DRIVER. + +### BOX64_NOGTK + +Do not load wrapped GTK libraries. + + * 0: Load wrapped GTK libraries. [Default] + * 1: Do not load wrapped GTK libraries. + +### BOX64_NOPULSE + +Do not load PulseAudio libraries (both native and x86_64). + + * 0: Load PulseAudio libraries. [Default] + * 1: Do not load PulseAudio libraries. + +### BOX64_NOVULKAN + +Do not load Vulkan libraries. + + * 0: Load Vulkan libraries. [Default] + * 1: Do not load Vulkan libraries, both native and x86_64. + +### BOX64_PREFER_EMULATED + +Prefer emulated libraries over native ones. + + * 0: Prefer native libraries over emulated ones. [Default] + * 1: Prefer emulated libraries over native ones. + +### BOX64_PREFER_WRAPPED + +Prefer wrapped libs first even if the lib is specified with absolute path. + + * 0: Prefer libs with absolute path over wrapped ones. [Default] + * 1: Prefer wrapped libs first even if the lib is specified with absolute path. + +### BOX64_WRAP_EGL + +Prefer wrapped libs for EGL and GLESv2. + + * 0: Prefer emulated libs for EGL and GLESv2. [Default] + * 1: Prefer wrapped libs for EGL and GLESv2. + diff --git a/docs/box64.pod b/docs/box64.pod index a95613a5..f20e9f9d 100644 --- a/docs/box64.pod +++ b/docs/box64.pod @@ -65,6 +65,16 @@ Allow missing libraries to be ignored. * 1 : Allow missing libraries. +=item B<BOX64_ARCH> =I<`arm64`|`la64`|`rv64`|`<empty>`> + +Specify the architecture in rcfiles to which the current entry applies. This option only takes effect when used inside rcfiles. + + * `arm64` : Only apply current entry for AArch64. + * `la64` : Only apply current entry for LoongArch64. + * `rv64` : Only apply current entry for RISC-V. + * `<empty>` : Apply current entry for all architectures, will be replaced by more specific entries. [Default] + + =item B<BOX64_ARGS> =I<XXXX|XXXX YYYY ZZZZ> Arguments to pass to the guest program, only valid if there is no existing arguments. diff --git a/docs/gen/gen.py b/docs/gen/gen.py index e17b67fc..6dd77d84 100644 --- a/docs/gen/gen.py +++ b/docs/gen/gen.py @@ -63,8 +63,8 @@ This configuration will apply the specified settings application-wide to any exe for entry in data: categories[entry["category"]].append(entry) - # Put "Performance" at the top - sorted_categories = sorted(categories.items(), key=lambda x: x[0] != "Performance") + # Put "Performance" at the top, then sort the rest alphabetically + sorted_categories = sorted(categories.items(), key=lambda x: (x[0] != "Performance", x[0])) for category, entries in sorted_categories: md_file.write(f"## {category}\n\n") for entry in entries: diff --git a/docs/gen/usage.json b/docs/gen/usage.json index 53cc74b5..f96bb1c5 100644 --- a/docs/gen/usage.json +++ b/docs/gen/usage.json @@ -36,6 +36,34 @@ ] }, { + "name": "BOX64_ARCH", + "description": "Specify the architecture in rcfiles to which the current entry applies. This option only takes effect when used inside rcfiles.", + "category": "Compatibility", + "wine": false, + "options": [ + { + "key": "`arm64`", + "description": "Only apply current entry for AArch64.", + "default": false + }, + { + "key": "`la64`", + "description": "Only apply current entry for LoongArch64.", + "default": false + }, + { + "key": "`rv64`", + "description": "Only apply current entry for RISC-V.", + "default": false + }, + { + "key": "`<empty>`", + "description": "Apply current entry for all architectures, will be replaced by more specific entries.", + "default": true + } + ] + }, + { "name": "BOX64_ARGS", "description": "Arguments to pass to the guest program, only valid if there is no existing arguments.", "category": "Arguments", |