Commit graph

56 commits

Author SHA1 Message Date
FeralChild64
6c2badb7ca Cleanup country support, add historic locales 2023-12-05 07:42:55 +01:00
Antti Peltola
00dbcb22bd Update man page descriptions against actual CLI output 2023-10-27 11:52:40 -07:00
Antti Peltola
2d0fcb92cd Sync man page with CLI descriptions 2023-10-26 18:28:17 -07:00
Torinde
5e3e2b43a7 Remove opencaptures 2023-10-06 11:20:07 +10:00
Antti Peltola
36c76e9d0e Update man page 2023-09-05 13:50:50 -07:00
kcgen
e6e4c5d68d Revert "Do not install outdated and unmaintained man page"
This reverts commit 693e040bdc.
2023-09-05 13:50:50 -07:00
FeralChild64
693e040bdc Do not install outdated and unmaintained man page 2023-09-05 08:10:00 -07:00
kcgen
30ca4beedc Deprecate the vgaonly machine-type by mapping it to svga_paradise
Justification for mapping it to svga_paradise is that it
provides sufficient "early" VGA compatibly without
regressions or loss of functionality.

Thanks to Jon Campbell for this recommendation and
explanation, as follows:

---

For Staging's purposes, it would be better to map vgaonly to
one of the older SVGA chipsets that lack VBE extensions, like
Tseng or Paradise emulation. Those are close enough to plain
VGA.

Fair warning though, Tseng ET4000 cards map the chained
256-color mode to planar differently from normal VGA/SVGA
cards. It can matter depending how the game accesses video
memory. One issue on DOSBox-X pointed to some Chinese made
game that appeared to chained and unchained 256-color memory
access as needed in a way that needed the Tseng ET4000 cards,
and it's possible other games need the plain VGA mapping the
same.

Maybe vgaonly could be mapped to svga_paradise instead.

---

Test cases showing that vga_paradise is sufficent and without
harm include:

1) from Jonathan Campbell:

   I know of a good test case, "Get Saddam" as seen on
   Shovelware Diggers that, despite supporting CGA or VGA
   graphics, uses a graphics library that will crash if
   VESA BIOS extensions are present. The technical
   explanation is the library was obviously written
   around really old VESA BIOS extensions that wrote the
   mode information into the buffer without zeroing all
   128 or 256 bytes of the structure. It doesn't allocate
   enough space on the stack for the full structure, so
   more modern code and DOSBox/DOSBox-X that does write
   all 256 bytes causes stack corruption and the game
   crashes. Notice when Shovelware Diggers covers it,
   he's using the CGA mode because the VGA option
   probably reliably crashed when he tried.

2) from NickNine:

   The Need for Speed (original not SE) makes two batch
   scripts NFS.BAT with NFSVESA.BAT with the second one
   calling univbe before running the game

   - under vgaonly it predictably does not run with
     either bat since there's no VESA support at all.

   - under svga_paradise it does not run from nfs.bat
     but does run from nfsvesa.bat.

Thank you for this testing help, NickNine!

---

In the event svga_paradise's set of
SVGA-detectable-features causes regressions in some
games or software, then additional handling would be
needed to re-instate vgaonly as strictly that - simply
a non-SVGA card, as Jonathan Campbell (once again!) explains:

   Perhaps machine=vgaonly could just be Paradise emulation
   but with any extended registers blocked off so DOS games
   can't detect it. Here's a collection of documentation on
   what Paradise cards have in their registers for your

   reference: http://hackipedia.org/browse.cgi/Computer/Platform/PC%2c%20IBM%20compatible/Video/VGA/SVGA/Paradise

   Paradise cards are close enough to VGA that if you
   prevent DOS games from detecting the SVGA chipset it
   should be a good enough substitute for vgaonly. In
   fact according to documentation at that URL there are
   registers you have to write magic values to them to
   "unlock" the extended registers. So then for
   machine=vgaonly just don't allow the guest to unlock
   those extended registers and remove any signature from
   the VGA BIOS that might suggest Paradise/Western
   Digital SVGA.

Thank you, Jonathan Campbell, for all the help -- both
in the current mapping decision and potential future
fix, if regressions due inface surface.

Co-authored-by: Jonathan Campbell <jonathan@castus.tv>
Co-authored-by: NicknineTheEagle <nik18.1995@gmail.com>
2023-04-19 12:36:34 -07:00
kcgen
6bb598e801 Add --list-glshaders command line flags 2022-05-09 18:17:08 -07:00
Wengier
45b0e23246 Address PR feedback as suggested 2022-02-17 23:09:24 -08:00
Wengier
2046b258a7 Add/restore documentation for SDL CD support 2022-02-17 23:09:24 -08:00
Christer Solskogen
5149a0c6d0
Fix typo in man-page regarding cycle adjustment 2021-11-05 13:46:54 -07:00
Patryk Obara
8bf4e8107b Use consistent style for key names
Various places in code used mix of uppercase and lowercase typography
for describing key combinations. Replace all those style with consistent
convention:

- Key names are always capitalized: Alt, Ctrl, Shift, Cmd, …
- Key combinations are connected with '+': Alt+F1
2021-03-06 22:21:25 +01:00
Patryk Obara
0500392174 Describe machine types in README and man page
Add missing types to both lists (e.g. cga_mono was ommitted).
2021-01-25 15:47:56 +01:00
Patryk Obara
501d28d062 Document environment variables handling 2021-01-17 20:10:56 +01:00
Patryk Obara
0a36c37328 Adjust copyright statements for 2021
- Update DOSBox Staging Team copyright span to year 2021 (DOSBox Team
  copyrights left untouched).
- Add DOSBox Staging Team copyright line to files we extensively
  modified throughout 2020 (we add our copyright lines when number of
  non-trivially modified lines gets close to 50%).
- Change "dosbox-staging team" to "DOSBox Staging Team", in line with
  updated branding.
- Change MAME license identifiers to SPDX license identifiers.
- Cleanup some excessive whitespace around copyright statements.
- Do few adjustments to include order.
- Add few missing copyright identifiers (GPL-2.0-or-later,
  LGPL-2.1-or-later, BSD-3-Clause) as appropriate for specific file.
- Move SPDX identifiers to the top in scripts for consistency with other
  source files.
- Remove old copy of GPL2 license in italian from old translations.
2021-01-01 00:12:05 +01:00
Patryk Obara
b287afde62 Adjust descriptions for default keybindings 2020-11-09 03:20:24 +01:00
Patryk Obara
38e484c80a Change default keybind for video capture
Change Ctrl+Alt+F5 to Ctrl+F7. This way the action will work out of the
box on Linux.
2020-11-09 03:20:24 +01:00
Patryk Obara
36b997c001 Remove default keybinds for adjusting frameskips
These actions are not useful on modern hardware, as there are better
ways of adjusting emulation speed and VGA emulation is not as CPU
intensive as it was with old scalers.

On the other side, we can now reuse the Ctrl+F7/F8 keybinds for more
useful actions.
2020-11-09 03:20:24 +01:00
Patryk Obara
d6e5d1f71f Remove default keybind for recording MIDI commands
This action is useful mostly for development/debugging purposes, and
Ctrl+Alt+Fx key does not work on Linux.
2020-11-09 03:20:24 +01:00
Patryk Obara
3f9e33e7a0 Remove default keybind for recording OPL commands
This action is useful only for development purposes, and Ctrl+Alt+Fx key
does not work on Linux.
2020-11-09 03:20:24 +01:00
David Heidelberg
2cb5af5649 Fix man page appearance
Fixes lintian warning:

    I: dosbox-staging: acute-accent-in-manual-page usr/share/man/man1/dosbox.1.gz:198
    I: dosbox-staging: acute-accent-in-manual-page usr/share/man/man1/dosbox.1.gz:199

Ref: https://lintian.debian.org/tags/acute-accent-in-manual-page.html

Signed-off-by: David Heidelberg <david@ixit.cz>
2020-10-13 21:33:45 +02:00
Patryk Obara
de3e030a4d Update documentation for --printconf and --editconf
Also, use the same order of parameters listed in man page and README
manual file.
2020-04-29 04:08:00 +02:00
Patryk Obara
fe928af0cd Remove some outdated info and update manuals 2020-04-21 23:08:56 +02:00
Patryk Obara
c7281b1c48 Add platform-specific notes about config dir 2020-04-18 22:09:04 +02:00
Patryk Obara
44499e7f26 Update manuals regarding configuration path 2020-04-18 22:09:04 +02:00
Patryk Obara
82dcb47b3c Remove all physical CD-ROM references from manual 2019-12-18 22:31:19 +01:00
Patryk Obara
ddda555854 Remove MCI, DX, and DIO CD-ROM interfaces
Also, remove all traces of these interfaces from user manual (README
file) and man page (docs/dosbox.1).

MCI (Media Control Interface) was a primary Windows interface. Code
comments and documentation claimed, that it's only for "NT, 2000, XP"
but the code was enabled for Windows 2000 or later (version > 4.0).

DX (Digital audio eXtraction (?)) could be forced on any Windows with
autodetection working only on Vista and Windows 7 (code was disabled for
Windows 8 or later - probably unintentionally).

DIO used DeviceIoControl interface and Windows-specific ioctl calls.

All 3 interfaces depend on SDL and SDL_cdrom functionality to work.
SDL_cdrom 1.2 implementation uses MCI on Windows to provide the same
functionality.
2019-12-14 03:35:27 +01:00
Patryk Obara
e43f83a68a Remove ASPI CD-ROM interface
ASPI was supported by Microsoft only for Windows 95, 98 and, ME.
Adaptec supported this interface going forward for Windows NT, 2000,
and XP (32-bit only).
2019-12-09 21:36:27 +01:00
Peter Veenstra
96fb43a208 Slight reordering of the arguments. Add -socket
Imported-from: https://svn.code.sf.net/p/dosbox/code-0/dosbox/trunk@3933
2015-09-08 13:44:34 +00:00
Peter Veenstra
fd65f6f897 Typos reported by debian project
Imported-from: https://svn.code.sf.net/p/dosbox/code-0/dosbox/trunk@3762
2011-11-27 15:22:00 +00:00
Peter Veenstra
9df334048f Enchance RESCAN with drive paramater and -All flag
Imported-from: https://svn.code.sf.net/p/dosbox/code-0/dosbox/trunk@3742
2011-08-16 10:41:59 +00:00
Peter Veenstra
c2ba5b3639 Typo. (debian package)
Imported-from: https://svn.code.sf.net/p/dosbox/code-0/dosbox/trunk@3708
2011-05-05 15:40:53 +00:00
Peter Veenstra
6976225474 Spelling fix.
Imported-from: https://svn.code.sf.net/p/dosbox/code-0/dosbox/trunk@3612
2010-05-25 07:58:13 +00:00
Peter Veenstra
dd8b5b2772 Document -userconf
Imported-from: https://svn.code.sf.net/p/dosbox/code-0/dosbox/trunk@3601
2010-05-09 11:54:44 +00:00
Peter Veenstra
79f692235a Add some more descriptive texts, add aliases resetconf and resetmapper. Change titlebar to always include percentage. (rc3t2 changes)
Imported-from: https://svn.code.sf.net/p/dosbox/code-0/dosbox/trunk@3590
2010-05-04 14:40:11 +00:00
Peter Veenstra
e19e93e5c2 Add + document option to remove mapperfile used by a clean configuration.
Imported-from: https://svn.code.sf.net/p/dosbox/code-0/dosbox/trunk@3553
2010-02-26 15:18:56 +00:00
Peter Veenstra
984e627dd1 Include debian manpage fixes. Improve layout of the config -securemode option
Imported-from: https://svn.code.sf.net/p/dosbox/code-0/dosbox/trunk@3529
2010-01-11 09:35:32 +00:00
Peter Veenstra
fb86dbe837 Some documentation updates.
Imported-from: https://svn.code.sf.net/p/dosbox/code-0/dosbox/trunk@3411
2009-05-27 14:34:06 +00:00
Peter Veenstra
3f2e4fbd83 Allow longer commandlines in MOUNT and IMGMOUNT.
Fix crash reported by MiniMax (mount -u 0).
Fix bug reported by Tearex ("config -get" broken).
Add some protection that makes it harder to mount a directory from
within an executable.
Add some protection to make mounting from command /c much harder.
Add a securemode commandline switch to config and dosbox that should make it
impossible to mount a location when this isn't wanted by the user. (Addresses concerns of CVE-2007-6328)
Update documentation to reflect this.


Imported-from: https://svn.code.sf.net/p/dosbox/code-0/dosbox/trunk@3114
2008-03-02 11:13:47 +00:00
Peter Veenstra
7daaf72e2d Small update
Imported-from: https://svn.code.sf.net/p/dosbox/code-0/dosbox/trunk@2913
2007-07-03 18:17:45 +00:00
Peter Veenstra
54b29e831c Change configfile loading support. Introduce some sort of global configfile parsing and add some additional settings from local configuration files. Allow multiple configuration files to be specified at the commandline like patch 1513790.
Imported-from: https://svn.code.sf.net/p/dosbox/code-0/dosbox/trunk@2705
2006-10-08 19:26:04 +00:00
Peter Veenstra
1880321b6c Documentation corrections. Forwarded from the debian package.
Imported-from: https://svn.code.sf.net/p/dosbox/code-0/dosbox/trunk@2675
2006-07-22 08:34:30 +00:00
Peter Veenstra
06da2ec1db Time moves fast....
Imported-from: https://svn.code.sf.net/p/dosbox/code-0/dosbox/trunk@2570
2006-03-29 10:18:57 +00:00
Peter Veenstra
35107bd3a4 A few typos pointed out ykhwong
Imported-from: https://svn.code.sf.net/p/dosbox/code-0/dosbox/trunk@2568
2006-03-28 14:39:26 +00:00
Peter Veenstra
20bf2033ba mention all keys
Imported-from: https://svn.code.sf.net/p/dosbox/code-0/dosbox/trunk@2567
2006-03-28 12:00:18 +00:00
Peter Veenstra
97296864da Updates for 0.63
Imported-from: https://svn.code.sf.net/p/dosbox/code-0/dosbox/trunk@2066
2004-11-18 14:13:09 +00:00
Peter Veenstra
c68853a363 Document new label support
Imported-from: https://svn.code.sf.net/p/dosbox/code-0/dosbox/trunk@2051
2004-11-12 22:13:13 +00:00
Peter Veenstra
767a418daa Updated it.
Imported-from: https://svn.code.sf.net/p/dosbox/code-0/dosbox/trunk@2048
2004-11-09 20:11:20 +00:00
Peter Veenstra
4c8e0fe30c Poor mans update
Imported-from: https://svn.code.sf.net/p/dosbox/code-0/dosbox/trunk@1993
2004-09-23 19:22:28 +00:00