Skip to content

Commit

Permalink
Documentation|Readme|Console: Use @code rather than @cmd in examples
Browse files Browse the repository at this point in the history
@cmd now translates to a cmdlink template in the wiki.
  • Loading branch information
skyjake committed Apr 7, 2013
1 parent 1bed686 commit fc533af
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion doomsday/client/data/cphelp.txt
Expand Up @@ -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).
Expand Down
6 changes: 3 additions & 3 deletions doomsday/doc/engine/command/setres.ame
Expand Up @@ -14,8 +14,8 @@

@seealso
@list{
@item listdisplaymodes
@item setfullres
@item setwinres
@item @cmd{listdisplaymodes}
@item @cmd{setfullres}
@item @cmd{setwinres}
}
}
4 changes: 2 additions & 2 deletions doomsday/doc/readme/network.ame
Expand Up @@ -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}

Expand All @@ -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}

8 changes: 4 additions & 4 deletions doomsday/doc/readme/resources.ame
Expand Up @@ -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
Expand Down Expand Up @@ -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}.


Expand Down
2 changes: 1 addition & 1 deletion doomsday/doc/server/manpage.ame
Expand Up @@ -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).


Expand Down
2 changes: 1 addition & 1 deletion doomsday/doc/shell-text/shell-text.ame
Expand Up @@ -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.

$*
Expand Down

0 comments on commit fc533af

Please sign in to comment.