Commit Graph

86 Commits

Author SHA1 Message Date
Donovan Watteau
6e0326dad4 DOCS: MAN: Sync with latest changes 2023-06-13 10:17:55 +02:00
elasota
6823514318 COMMON: Add Bulgarian language code 2023-05-29 23:50:15 +02:00
Donovan Watteau
a13662e86b DOCS: MAN: Sync with common/platform.cpp 2023-01-06 18:09:39 +01:00
Donovan Watteau
8f9965f754 DOCS: MAN: Document new --random-seed option 2023-01-06 18:03:12 +01:00
Cameron Cawley
749fd8b490 SDL: Allow selecting the audio channel count from the command line 2022-11-18 17:17:00 +01:00
Donovan Watteau
4e28498eab DOCS: MAN: Document some arguments as being optional 2022-09-17 12:06:40 +02:00
Donovan Watteau
6ae10828c2 DOCS: MAN: Fix missing equal sign for --speech-volume=NUM 2022-09-17 12:06:40 +02:00
Donovan Watteau
79a307ff53 DOCS: MAN: Only describe the difference between --md5mac and --md5 instead of repeating things 2022-09-17 12:06:40 +02:00
Donovan Watteau
5484cf56d8 DOCS: MAN: Describe the difference between filtered/unfiltered graphics 2022-09-17 12:06:40 +02:00
Donovan Watteau
4395a5a257 DOCS: MAN: Document Ctrl-Alt-d and tweak some shortcut descriptions 2022-09-17 12:06:40 +02:00
Donovan Watteau
e31d85d90d DOCS: MAN: Work around .Lk limitations in older Groff 2022-09-17 12:06:40 +02:00
Donovan Watteau
a1639b9e99 DOCS: MAN: Explicitly list most --no- options as well 2022-09-17 12:06:40 +02:00
Donovan Watteau
bcfc6d4c1a DOCS: MAN: Use en-dash for ranges 2022-09-17 12:06:40 +02:00
Donovan Watteau
76471089d9 DOCS: MAN: Document that --engine-speed is for 3D games 2022-09-17 12:06:40 +02:00
Donovan Watteau
10d331e10e DOCS: MAN: Don't give any default value for --talkspeed
It looks like many engines have a different default value, nowadays.
2022-09-17 12:06:40 +02:00
Donovan Watteau
e429bbf267 DOCS: MAN: Sort --renderer arguments alphabetically 2022-09-17 12:06:40 +02:00
Donovan Watteau
838c351a7e DOCS: MAN: Document that --dump-midi overwrites dump.mid
Since base/commandLine.cpp documents it.
2022-09-17 12:06:40 +02:00
Donovan Watteau
2e1a0fad39 DOCS: MAN: Mention the source of some lists for easier maintenance 2022-09-17 12:06:40 +02:00
Donovan Watteau
bde1a8952b DOCS: MAN: --window-size being about ScummVM looks obvious enough 2022-09-17 12:06:40 +02:00
Donovan Watteau
42bf78e231 DOCS: MAN: Take the --enable-gs description from gui/options.cpp
Looks more informative.
2022-09-17 12:06:40 +02:00
Donovan Watteau
149f7e8cec DOCS: MAN: Document that --boot-param uses the given number, and is only supported by some games 2022-09-17 12:06:40 +02:00
Donovan Watteau
ddd641ab2d DOCS: MAN: Rephrase --add description a bit, and let it breathe a bit more 2022-09-17 12:06:40 +02:00
Donovan Watteau
131b34aa53 DOCS: MAN: Minor word tweaks
Looks a bit better this way to me, but I'm not a native speaker...
2022-09-17 12:06:40 +02:00
Donovan Watteau
55548083bd DOCS: MAN: Replace "WORD" with more precise "PLATFORM" 2022-09-17 12:06:40 +02:00
Donovan Watteau
7ada3cd51c DOCS: MAN: Use parentheses for platform-specific options, as done below 2022-09-17 12:06:40 +02:00
Donovan Watteau
9f3c4fab62 DOCS: MAN: Document that these --list-XXX flags exit too
Also remove the "specified" word in --list-all-debugflags description,
it just looks more confusing than helpful, to me.
2022-09-17 12:06:40 +02:00
Donovan Watteau
125c308bea DOCS: MAN: Serial comma appears to be the standard for mdoc 2022-09-17 12:06:40 +02:00
Donovan Watteau
82475d9abf DOCS: MAN: Start (almost) all descriptions with verbs for consistency 2022-09-17 12:06:40 +02:00
Donovan Watteau
660bdaf1b0 DOCS: MAN: Remove a weird --game=ID copy-and-paste at the end --list-saves
There's no reason for --list-saves to document --add and --detect
again, so this is probably an old mistake.
2022-09-17 12:06:40 +02:00
Donovan Watteau
5e7f65bb19 DOCS: MAN: Reword --list-debugflags description for something simpler 2022-09-17 12:06:40 +02:00
Donovan Watteau
2f3754d06a DOCS: MAN: Sync --cdrom description with base/commandLine.cpp usage
--cdrom accepts more values than just numbers now.
2022-09-17 12:06:40 +02:00
Donovan Watteau
ae56288e33 DOCS: MAN: Negative numbers must be used for choosing the last --md5-length bytes 2022-09-17 12:06:40 +02:00
Donovan Watteau
14bf80710c DOCS: MAN: Use a user-configured target in one of the examples
So that we don't only mention the built-in gameids (I'm not even sure
that a lot of command-line users know about them?).

Also add a bit more context.
2022-09-17 12:06:40 +02:00
Donovan Watteau
410af0369a DOCS: MAN: Mention --list-games and --list-targets when introducing built-in gameids and user-configured targets
The example was nice, but it was only given for the first case,
leaving you wonder what the second one really meant.
2022-09-17 12:06:40 +02:00
Donovan Watteau
0a14985fcd DOCS: MAN: Don't mention the Alt-s shortcut being "SDL backend only'
It works in OpenGL graphics mode too. Technically, it still relies on
the SDL backend, but end-users care about usage, not code internals.
2022-09-17 12:06:40 +02:00
Donovan Watteau
bcb3a14913 DOCS: MAN: Unify punctuation usage 2022-09-17 12:06:40 +02:00
Donovan Watteau
c1d8e571b9 DOCS: MAN: New sentence new line is the rule for mdoc
Also use "available" instead of "enabled", since the latter is more of
a compile-time word, but we're in the usage documentation here.
2022-09-17 12:06:40 +02:00
Donovan Watteau
837fe73c5f DOCS: MAN: Use more specific words in some technical contexts 2022-09-17 12:06:40 +02:00
Donovan Watteau
73ff7f17fe DOCS: MAN: Use .Pa macro for /dev/sequencer; mention "some Unix" instead of "*nix"
People remembering the `*nix` name probably already know about
/dev/sequencer, so just use a simpler name. Moreover, /dev/sequencer
is only available on some Unix systems, but not all of them, nowadays.
2022-09-17 12:06:40 +02:00
Donovan Watteau
aa5b261b1b DOCS: MAN: Update the accepted values for stretch mode
From backends/graphics3d/openglsdl/openglsdl-graphics3d.cpp.
2022-09-17 12:06:40 +02:00
Donovan Watteau
8e32dc41a7 DOCS: MAN: Document scummvm.ini instead of .scummvmrc
$HOME/.scummvmrc is the obsolete value; just document the default one.
2022-09-17 12:06:40 +02:00
Donovan Watteau
1079911b6a DOCS: MAN: List the SCUMMVM_SAVEPATH environment variable 2022-09-17 12:06:40 +02:00
Donovan Watteau
ee1e8c6429 DOCS: MAN: Just mention docs.scummvm.org and don't mention it twice 2022-09-17 12:06:40 +02:00
Donovan Watteau
bc937ed7ba DOCS: MAN: ScummVM supports adventure and role-playing games 2022-09-17 12:06:40 +02:00
Jonathan Gray
1d318e1161 DOCS: MAN: adjust --md5 text for consistency
from Donovan Watteau
2022-08-02 20:52:03 +02:00
Jonathan Gray
1326643f02 DOCS: MAN: use Cm instead of Cy with no-
avoids an anchor in mandoc html output
from Donovan Watteau
2022-08-02 20:52:03 +02:00
Jonathan Gray
2cd11d3e62 DOCS: MAN: don't list themes as they are dynamic
from Donovan Watteau
2022-08-02 20:52:03 +02:00
Jonathan Gray
24d61c2482 DOCS: MAN: replace -g example that no longer works 2022-08-02 20:52:03 +02:00
Jonathan Gray
b06ed4d06f DOCS: MAN: sync language options with language.cpp
from Donovan Watteau
2022-08-02 20:52:03 +02:00
Jonathan Gray
55c970fa76 DOCS: MAN: sync -opl-driver options with commandLine.cpp 2022-08-02 20:52:03 +02:00