From b77d3e047f0d1a17b85d996942d33cec678ff54d Mon Sep 17 00:00:00 2001 From: TerminalHash Date: Wed, 8 Mar 2023 15:45:30 +0300 Subject: [PATCH] man: more manuals for god of manuals! --- man/HOWTO | 22 +++- man/en/d2df.1.txt | 90 +++++++++++++++ man/en/d2df.2.txt | 272 ++++++++++++++++++++++++++++++++++++++++++++++ man/en/d2df.3.txt | 268 +++++++++++++++++++++++++++++++++++++++++++++ man/ru/d2df.1.txt | 90 +++++++++++++++ man/ru/d2df.2.txt | 272 ++++++++++++++++++++++++++++++++++++++++++++++ man/ru/d2df.3.txt | 268 +++++++++++++++++++++++++++++++++++++++++++++ 7 files changed, 1281 insertions(+), 1 deletion(-) create mode 100644 man/en/d2df.1.txt create mode 100644 man/en/d2df.2.txt create mode 100644 man/en/d2df.3.txt create mode 100644 man/ru/d2df.1.txt create mode 100644 man/ru/d2df.2.txt create mode 100644 man/ru/d2df.3.txt diff --git a/man/HOWTO b/man/HOWTO index 807530f..46f93ab 100644 --- a/man/HOWTO +++ b/man/HOWTO @@ -1,4 +1,24 @@ If you want to convert this txt to man, you need a k8ttman (see https://repo.or.cz/k8ttman.git). Build them, copy txt file to program directory and run: - ./ttman d2df.txt d2df.1 + ./ttman d2df.1.txt d2df.1 + ./ttman d2df.2.txt d2df.2 + ./ttman d2df.3.txt d2df.3 + +For the manual to be detectable by man/man-db, it must be packed into a .gz archive. We do this with the command: + + gzip -c d2df.1 > d2df.1.gz + gzip -c d2df.2 > d2df.2.gz + gzip -c d2df.3 > d2df.3.gz + +Then put them in directories based on the number in the name: + + d2df.1 = /usr/share/man/man1 + d2df.2 = /usr/share/man/man2 + d2df.3 = /usr/share/man/man3 + +For russian version, you must use txt from directory "ru" to convert/compression and put them to: + + d2df.1 = /usr/share/man/ru/man1 + d2df.2 = /usr/share/man/ru/man2 + d2df.3 = /usr/share/man/ru/man3 diff --git a/man/en/d2df.1.txt b/man/en/d2df.1.txt new file mode 100644 index 0000000..d4a12b4 --- /dev/null +++ b/man/en/d2df.1.txt @@ -0,0 +1,90 @@ +@title Doom2DF 1 08.03.2023 1 1 + +@h1 NAME +Doom2DF - main game binary.@br +Doom2DF_H - dedicated server binary. + +@h1 SYNOPSIS +Doom2DF [*ARGUMENTS*]... [*OPTION*]...@br +Doom2DF_H [*ARGUMENTS*]... [*OPTION*]... + + +@h1 DESCRIPTION +Doom 2D Forever is Doom-themed platformer game with network multiplayer support. This is the modern port of 1996 Doom 2D game by Prikol Software.@br +Note: documentation is not finished yet. + + +@h2 ARGUMENTS +-map WADFILE:\\MAPnn + Run the game with the map from the specified wad for the current game session.@br + All maps in the Doom 2D Forever must be packed to a .wad (incompatible with doom wads) or .dfz (renamed zip) archive.@br + These wads can have a lot of maps inside, usually named as MAPnn. + +-gm NAME [`DM`|`TDM`|`CTF`|`COOP`] + Use a specific gamemode for the current game session. Default is DM. + +-port PORTNUMBER [`25667`] + Use a specific port for the server. Default is 25667. + +-exec FILENAME.txt + You can also set a custom config for the game session. Good for maplists, etc. + +-connect IP:PORT + Connect to server, when game loads. + +-lims nnn + Set the goal limit for current game session. + +-lives nnn + Set the number of lives for the Survival mode. + +-limt nnnn + Set the time limit for current game session. + + +@h1 OPTIONS +--log-file FILENAME.log + Set custom name for the log file. + + +@h1 EXAMPLES +Run the dedicated server in DeathMatch mode, with custom maplist and custom log file. + + @pre + $ Doom2DF_H -map PrikolSoft.wad:\\MAP01 -gm DM -port 25667 -exec maplist_dm.txt --log-file dfserver_dm.log + @endpre + + +@h1 DIRECTORIES +By default, the game checks the entire disc for game files. (The editor can't search for files everywhere.) To follow a hierarchy, files can be located: + +~/.doom2df + in your home directory. + +/usr/share/doom2df + or in default directory. + +@h1 URLS +Our site:@br +https://doom2d.org + +Our forum:@br +https://doom2d.org/forum/index.php + +Our IRC:@br +irc.wenet.ru:6677 #doom2d + +Our Telegram:@br +https://t.me/doom2d_channel - Channel@br +https://t.me/doom2d - Chat + +Our Discord:@br +https://discord.gg/sGpJwMy + +@h1 SEE ALSO + +*d2df*(2), *d2df*(3) + +@h1 AUTHOR + +Written by Dmitry Lyashuk , Doom 2D: Forever Developers. diff --git a/man/en/d2df.2.txt b/man/en/d2df.2.txt new file mode 100644 index 0000000..2b4ea9a --- /dev/null +++ b/man/en/d2df.2.txt @@ -0,0 +1,272 @@ +@title Doom2DF 2 08.03.2023 2 2 + +@h1 NAME +Doom 2D Forever console commands. + + +@h1 CONTENTS + +1. System commands + +2. Binds + +3. Console commands + +4. Debug commands + +5. Game commands + +6. Cheats + + +@h1 1. System commands + +quit, exit + Exit from game. +r_reset + Reload render. +r_maxfps + Limiting the number of frames per second +g_language Russian/English + Change game language. + + +@h1 2. Binds + +bind + Bind a key behind a command. +bindrep + (?) +bindunrep + (?) +bindlist + Show a bind list. +unbind + Remove the bind from the key. +unbindall + Remove binds from all keys (not recommended). +togglemenu + Show or hide the main menu/game menu. +toggleconsole + Show or hide the console. +togglechat + Show or hide the chat. +toggleteamchat + Show or hide the team chat. + +@h2 For device with touchscreen +showkeyboard + Show virtual keyboard. +hidekeyboard + Hide virtual keyboard. + + +@h1 3. Console commands +clear + Clear console window. +clearhistory + Clear commands history. +showhistory + Show commands history +commands + Show command list. +time + Show current time. +date + Show current date. +echo "" + Output the typed characters to the console. +dump + Take a dump. +exec + Execute custom cfg. +writeconfig + Write to cfg. +alias "" + Set a sequence of commands to be executed after a certain name. +call + Execute alias. +ver, version + Show game version. + + +@h1 4. Debug commands + +d_window + Show window resolution. +d_sounds 1/0 + Sound debugging. +d_frames 1/0 + Show item, entities hitboxes. +d_winmsg 1/0 + (?) +d_monoff 1/0 + Switch the work of the AI monsters. +d_botoff 3/2/1/0 + Switch the work of the AI bots. +d_health 1/0 + Toggle the display of XP in numerical form. +d_player 1/0 + Toggle the display of player coordinates. +d_joy 1/0 + (?) +d_mem 1/0 + Toggle the heap status display. + +@h2 Monsters +d_monster + Spawn a monster with a specific behavior. If no behavior is specified, the default behavior is set (normal). + +ID: + 1 - Pinky + 2 - Imp + 3 - Zombie + 4 - Shotgun Guy + 5 - Cyberdemon + 6 - Chaingunner + 7 - Baron of Hell + 8 - Hell Knight + 9 - Cacodemon + 10 - Lost Soul + 11 - Pain Elemental + 12 - Spider Mastermind + 13 - Arachnotron + 14 - Mancubus + 15 - Revenant + 16 - Arch-vile + 17 - Fish + 18 - Barrrel + 19 - Robot + 20 - Prikolist + +Behavior: + 0 - killer + 1 - maniac + 2 - insane + 3 - cannibal, attacks both the player and monsters + 4 - good, player friendly, hostile to monsters + +@h1 5. Game commands + +pause + Pause the game. +endgame + End game (sends to the main menu). +restart + Restart map. +addbot, bot_add + Add bot to game session. +bot_addlist + Add bot to game session from list. If no name is specified, adds a random bot. +bot_addred + Add bot to red team. +bot_addblue + Add bot to blue team. +bot_removeall + Remove all bots from game session. +chat + Send text to chat. +teamchat + Send text to team chat +announce, an + Display the text in the middle of the screen. +game + Run the game on a certain map with a certain number of players (one to two). +host + To get the game at a certain address, with a certain port on some map with some number of players. +map + Change map immediately. +nextmap + Announce the next map. +endmap + Finish the round. +goodbye + Finish the megawad/campaing map. +suicide + Suicide. +spectate + Spectating the game. +ready + Declare readiness during Survival and derivative modes. +kick + Kick a player with a certain nickname. +kick_id + Kick a player with a certain id. +kick_pid + Kick a player with a certain pid. +ban + Ban a player with a certain nickname. +ban_id + Ban a player with a certain id. +ban_pid + Ban a player with a certain pid. +permban + Ban a player permanently with a certain nickname. +permban_id + Ban a player permanently with a certain id. +permban_pid + Ban a player permanently with a certain pid. +permban_ip + Ban a player permanently by ip. +unban + Unban a player. +connect <порт> <пароль> + Connect to the server. +disconnect + Disconnect from the server. +reconnect + Reconnect to the server where you were last on. +say + Write in chat on behalf of the server. +tell + Write to the player on behalf of the server. +centerprint