UDN
Search public documentation:
HelpCommandlet
日本語訳
中国翻译
한국어
Interested in the Unreal Engine?
Visit the Unreal Technology site.
Looking for jobs and company info?
Check out the Epic games site.
Questions about support via UDN?
Contact the UDN Staff
中国翻译
한국어
Interested in the Unreal Engine?
Visit the Unreal Technology site.
Looking for jobs and company info?
Check out the Epic games site.
Questions about support via UDN?
Contact the UDN Staff
UE3 Home > Commandlets > How to use the Help Commandlet
How to use the Help Commandlet
Overview
help
commandlet is used to find out which commandlets are available to run, their purpose, and what those commandlets expect for parameters.
Operation
Syntax
The syntax is as follows:[GameName].exe help <list | commandletname | webhelp commandletname>
Parameters
list - Lists all commandlets that are availablecommandlet name - Displays help information for the specified commandlet
webhelp - Launches a browser with the URL of the web page that documents the specified commandlet
Examples
game.exe help listThe output looks something like:
Core.Help - This commandlet displays help information on other commandlets Engine.SmokeTest - This commandlet runs a series of tests to validate a build Editor.CutDownContent - Removes unused content from packages Editor.Make - Rebuild UnrealScript packages Editor.PkgInfo - Display information about Unreal packages Editor.ScaleAudioVolume - Scales the volume of audio data across all packages Editor.StripSource - Removes source code from compiled script packagesTo look at the help information for a specific commandlet, run:
game.exe help <commandlet name>Doing so for the help commandlet yields:
Name: Core.Help Description: This commandlet displays help information on other commandlets Usage: gamename.exe help <list | commandletname | webhelp commandletname> Options: list - Lists all commandlets that are available commandlet name - Displays help information for the specified commandlet webhelp - Launches a browser with the URL of the web page that documents the commandletIf a commandlet has a UDN document, you can view it by using the webhelp option like:
game.exe help webhelp helpThe above command will view this page.