From fc533afe4576f13aeac4d5b8e9e31c8bc89a1c72 Mon Sep 17 00:00:00 2001 From: skyjake Date: Sun, 7 Apr 2013 21:13:38 +0300 Subject: [PATCH] Documentation|Readme|Console: Use @code rather than @cmd in examples @cmd now translates to a cmdlink template in the wiki. --- doomsday/client/data/cphelp.txt | 2 +- doomsday/doc/engine/command/setres.ame | 6 +++--- doomsday/doc/readme/network.ame | 4 ++-- doomsday/doc/readme/resources.ame | 8 ++++---- doomsday/doc/server/manpage.ame | 2 +- doomsday/doc/shell-text/shell-text.ame | 2 +- 6 files changed, 12 insertions(+), 12 deletions(-) diff --git a/doomsday/client/data/cphelp.txt b/doomsday/client/data/cphelp.txt index 2868b2b78b..5269f51c70 100644 --- a/doomsday/client/data/cphelp.txt +++ b/doomsday/client/data/cphelp.txt @@ -324,7 +324,7 @@ inf = Params: setname (name)\nFor example, 'setname "my name"'. [setres] desc = Change display mode resolution or window size. -inf = USAGE:\nsetres (width) (height)\nThe window retains its current mode, adjusting the display mode if in fullscreen and the window size if in a windowed mode.\nEXAMPLES:\nChange resolution to 1024 x 768: 'setres 1024 768'\nSEE ALSO:\n- listdisplaymodes\n- setfullres\n- setwinres\n +inf = USAGE:\nsetres (width) (height)\nThe window retains its current mode, adjusting the display mode if in fullscreen and the window size if in a windowed mode.\nEXAMPLES:\nChange resolution to 1024 x 768: 'setres 1024 768'\nSEE ALSO:\n- 'listdisplaymodes'\n- 'setfullres'\n- 'setwinres'\n [settics] desc = Set number of game tics per second (default: 35). diff --git a/doomsday/doc/engine/command/setres.ame b/doomsday/doc/engine/command/setres.ame index eb5966a497..fcdd528270 100644 --- a/doomsday/doc/engine/command/setres.ame +++ b/doomsday/doc/engine/command/setres.ame @@ -14,8 +14,8 @@ @seealso @list{ - @item listdisplaymodes - @item setfullres - @item setwinres + @item @cmd{listdisplaymodes} + @item @cmd{setfullres} + @item @cmd{setwinres} } } diff --git a/doomsday/doc/readme/network.ame b/doomsday/doc/readme/network.ame index b9bf2a5161..bfc6f05431 100644 --- a/doomsday/doc/readme/network.ame +++ b/doomsday/doc/readme/network.ame @@ -105,7 +105,7 @@ servers, check that your firewall isn't blocking these UDP ports on either end. You can see information about the network subsystem status with the command: -@samp{@cmd{net info}} +@code{net info} @subsec{Server} @@ -124,5 +124,5 @@ client only needs to be able to reach the server via the server's TCP port. A server running on the same computer can be connected to with the following command: -@samp{@cmd{connect localhost}} +@code{connect localhost} diff --git a/doomsday/doc/readme/resources.ame b/doomsday/doc/readme/resources.ame index 6ec365a905..0fb3597e89 100644 --- a/doomsday/doc/readme/resources.ame +++ b/doomsday/doc/readme/resources.ame @@ -79,10 +79,10 @@ A virtual directory mapping is defined using the @opt{-vdmap} option. It takes the source and destination directories as parameters. For example: @ifdef{WIN32}{ - @samp{@cmd{-vdmap "D:\Games\MyAuto" "C:\Doomsday\Data\jDoom\Auto"}} + @code{-vdmap "D:\Games\MyAuto" "C:\Doomsday\Data\jDoom\Auto"} } @else{ - @samp{@cmd{-vdmap /home/username/myauto /usr/share/doomsday/data/jdoom/auto}} + @code{-vdmap /home/username/myauto /usr/share/doomsday/data/jdoom/auto} } You can define an unlimited number of virtual directory mappings using @@ -178,11 +178,11 @@ that contains the current directory and all its subdirectories plus a @file{DD_DIREC} lump that has (with a high probability) a unique lump name for each file. You can invoke the utility like this: -@samp{@cmd{ wadtool myfiles.wad /data/jdoom/textures/ }} +@code{ wadtool myfiles.wad /data/jdoom/textures/ } This would create a WAD file that contains all the files from the current directory. When writing the @file{DD_DIREC} table, the prefix -"/data/jdoom/textures/" would be added to each file name. @cmd{wadtool} is +"/data/jdoom/textures/" would be added to each file name. @bin{wadtool} is available in the Doomsday source repository under @file{/tools/wadtool}. diff --git a/doomsday/doc/server/manpage.ame b/doomsday/doc/server/manpage.ame index 2f5508c21c..392cbbd55c 100644 --- a/doomsday/doc/server/manpage.ame +++ b/doomsday/doc/server/manpage.ame @@ -37,7 +37,7 @@ at startup. More files can be loaded at runtime with the @cmd{load} command. } -In addition to these, @cmd{doomsday-server} supports many of the command line +In addition to these, @bin{doomsday-server} supports many of the command line options of doomsday(6). diff --git a/doomsday/doc/shell-text/shell-text.ame b/doomsday/doc/shell-text/shell-text.ame index 134118b2e4..66f23ed4ae 100644 --- a/doomsday/doc/shell-text/shell-text.ame +++ b/doomsday/doc/shell-text/shell-text.ame @@ -18,7 +18,7 @@ $ Extra formatting macros. @chapter{ Options } -This version of @cmd{doomsday-shell-text} does not support any command line +This version of @bin{doomsday-shell-text} does not support any command line options. $*