1
0
Fork 0

Update documentation for --printconf and --editconf

Also, use the same order of parameters listed in man page and README
manual file.
This commit is contained in:
Patryk Obara 2020-04-28 00:42:10 +02:00 committed by Patryk Obara
parent 4675596dcd
commit de3e030a4d
2 changed files with 48 additions and 42 deletions

57
README
View file

@ -297,30 +297,35 @@ See Section 13: "The configuration (options) file".
To be able to use Command Line Parameters:
(Windows) open cmd.exe or command.com or edit the shortcut to dosbox.exe
(Linux) use console
(Mac OS X) start terminal.app and navigate to:
/applications/dosbox.app/contents/macos/dosbox
(Linux) use any terminal emulator
(macOS) start terminal.app and navigate to:
/Applications/dosbox-staging.app/Contents/MacOS/dosbox
The options are valid for all operating systems unless noted in the option
description:
dosbox [name] [-exit] [-c command] [-fullscreen] [-userconf]
[-conf congfigfilelocation] [-lang languagefilelocation]
[-machine machine type] [-noconsole] [-startmapper] [-noautoexec]
[-securemode] [-scaler scaler | -forcescaler scaler] [-version]
[-socket socket]
dosbox -version
dosbox -editconf program
dosbox -opencaptures program
dosbox -printconf
dosbox [-fullscreen] [-startmapper] [-noautoexec] [-securemode] [-userconf]
[-scaler scaler | -forcescaler scaler] [-conf congfigfile]
[-lang langfile] [-machine machine-type] [-socket socketnumber]
[-c command] [-noconsole] [-exit] [NAME]
dosbox --version
dosbox --printconf
dosbox --editconf [editor]
dosbox -eraseconf
dosbox -erasemapper
name
If "name" is a directory it will mount that as the C: drive.
If "name" is an executable it will mount the directory of "name"
as the C: drive and execute "name".
dosbox -opencaptures program
NAME
If "NAME" is a directory it will mount that as the C: drive.
If "NAME" is an executable it will mount the directory of "NAME"
as the C: drive and execute "NAME".
-exit
DOSBox will close itself when the DOS application "name" ends.
@ -382,20 +387,20 @@ dosbox -erasemapper
Similar to the -scaler parameter, but tries to force usage of
the specified scaler even if it might not fit.
-version
output version information and exit. Useful for frontends.
--version
Output version information and exit. Useful for frontends.
-editconf program
calls program with as first parameter the configuration file.
You can specify this command more than once. In this case it will
move to second program if the first one fails to start.
--editconf [editor]
Open the default configuration file in a text editor. If no editor name
is given, then use the program from EDITOR environment variable,
otherwise DOSBox will try to guess the name.
-opencaptures program
calls program with as first parameter the location of the captures
folder.
-printconf
prints the location of the default configuration file.
--printconf
Print the location of the default configuration file.
-resetconf
removes the default configuration file.
@ -1540,6 +1545,8 @@ The default directories storing config file are:
(Linux) ~/.config/dosbox/
(macOS) ~/Library/Preferences/DOSBox/
You can quickly find exact path by running dosbox with parameter "--printconf".
Linux users:
The configuration's parent-directory can be customized by setting
the XDG_DATA_HOME environment variable, per the XDG Base Directory

View file

@ -10,23 +10,20 @@ dosbox \- an x86/DOS emulator with sound/graphics
.B [\-noautoexec]
.B [\-securemode]
.B [\-userconf]
.BI "[\-scaler " scaler ]
.BI "[\-forcescaler " scaler ]
.BI "[\-scaler " scaler | \-forcescaler " scaler]
.BI "[\-conf " configfile ]
.BI "[\-lang " langfile ]
.BI "[\-machine " machinetype ]
.BI "[\-socket " socketnumber ]
.BI "[\-c " command ]
.B [\-exit]
.B [file]
.B [NAME]
.LP
.B dosbox \-version
.B dosbox \-\-version
.LP
.BI "dosbox \-editconf" " program"
.B dosbox \-\-printconf
.LP
.BI "dosbox \-opencaptures" " program"
.LP
.B dosbox \-printconf
.BI "dosbox \-\-editconf ["editor ]
.LP
.B dosbox \-eraseconf
.LP
@ -35,11 +32,13 @@ dosbox \- an x86/DOS emulator with sound/graphics
.B dosbox \-erasemapper
.LP
.B dosbox \-resetmapper
.LP
.BI "dosbox \-opencaptures" " program"
.SH DESCRIPTION
This manual page briefly documents
.BR "dosbox" ", an x86/DOS emulator."
.BR "dosbox-staging" ", an x86/DOS emulator."
.LP
.RB "The optional " file " argument should be a DOS executable or a"
.RB "The optional " NAME " argument should be a DOS executable or a"
directory. If it is a dos executable (.com .exe .bat) the program will
run automatically. If it is a directory, a DOS session will run with
the directory mounted as C:\\.
@ -106,19 +105,19 @@ an Internal Program, a DOS command or an executable on a mounted drive.
.B "\-exit "
.BR "dosbox" " will close itself when the DOS program specified by "file " ends."
.TP
.B \-version
.B \-\-version
Output version information and exit. Useful for frontends.
.TP
.BI \-editconf " program"
.RI calls " program" " with as first parameter the configuration file."
You can specify this command more than once. In this case it will
.RI " move to second " program " if the first one fails to start."
.BI "\-\-editconf ["editor ]
.R Open the default configuration file in a text editor. If no editor name
is given, then use the program from EDITOR environment variable,
otherwise DOSBox will try to guess the name.
.TP
.BI \-opencaptures " program"
.RI "calls " program " with as first parameter the location of the captures folder."
.TP
.B \-printconf
prints the location of the default configuration file.
.B \-\-printconf
Prints the location of the default configuration file.
.TP
.B \-eraseconf, \-resetconf
removes the default configuration file.