en-US/PowerShellToolsPro.Cmdlets.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <!-- Module: PowerShellProTools Version: 1.0.70 --> <!-- All Commands--> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!-- Command--> <command:details> <command:name>Install-PoshProToolsLicense</command:name> <maml:description> <maml:para></maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Install</command:verb> <command:noun>PoshProToolsLicense</command:noun> <dev:version /> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Install-PoshProToolsLicense</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>License</maml:name> <maml:description> <maml:para>Specifies the license test for a PowerShell Pro Tools license.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>License</maml:name> <maml:description> <maml:para>Specifies the license test for a PowerShell Pro Tools license.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!-- Command--> <command:details> <command:name>Merge-Script</command:name> <maml:description> <maml:para>Packages scripts into an executable or single PS1 script.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Merge</command:verb> <command:noun>Script</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Packages scripts into an executable or single PS1 script. Specify the root script to package to produce a .NET executable that hosts the script. You can choose to bundle dot sourced scripts automatically using the Bundle switch. You can also bundle multiple PS1s into a single PS1 by changing the OutputType to Script.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Merge-Script</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Script</maml:name> <maml:description> <maml:para>The root script to package.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>The directory to output scripts or executables from this command.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>The type of output. This can be either Executable or Script. Executable is default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">OutputType</command:parameterValue> <dev:type> <maml:name>OutputType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Bundle</maml:name> <maml:description> <maml:para>Whether or not to bundle dot sourced scripts. If this switch is specified, the bundler will try and locate dot sourced scripts and include them with the package. This operation is recursive. Bundling can locate scripts relative to the root script and can expand the $PSScriptRoot variable.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Script</maml:name> <maml:description> <maml:para>The root script to package.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputPath</maml:name> <maml:description> <maml:para>The directory to output scripts or executables from this command.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>The type of output. This can be either Executable or Script. Executable is default.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">OutputType</command:parameterValue> <dev:type> <maml:name>OutputType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Bundle</maml:name> <maml:description> <maml:para>Whether or not to bundle dot sourced scripts. If this switch is specified, the bundler will try and locate dot sourced scripts and include them with the package. This operation is recursive. Bundling can locate scripts relative to the root script and can expand the $PSScriptRoot variable.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para>Package a script into an executable</maml:para> </maml:introduction> <dev:code>C:\PS> Merge-Script -Script .\MyScript.ps1</dev:code> <dev:remarks> <maml:para>Outputs an executable, .\MyScript.exe, to the same location as the specified script.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para>Packages a script and outputs it to the specified path.</maml:para> </maml:introduction> <dev:code>C:\PS> Merge-Script -Script .\MyScript.ps1 -OutputPath .\outDir</dev:code> <dev:remarks> <maml:para>Packages a script and outputs it to the specified path.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 3</maml:title> <maml:introduction> <maml:para>Bundles and packages a script and its dependencies into an executable.</maml:para> </maml:introduction> <dev:code>C:\PS> Merge-Script -Script .\MyScript.ps1 -OutputPath .\outDir -Bundle</dev:code> <dev:remarks> <maml:para>Merge-Script searches for dot sourced files in the MyScript.ps1 file and includes them with the package. This operation is recusive, thus if a dot sourced script dot sources another script, that script will also be included.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 4</maml:title> <maml:introduction> <maml:para>Bundles a script as a single PS1</maml:para> </maml:introduction> <dev:code>C:\PS> Merge-Script -Script .\MyScript.ps1 -OutputPath .\outDir -Bundle -OutputType Script</dev:code> <dev:remarks> <maml:para>Merge-Script searches for dot sourced files in the MyScript.ps1 file and includes them with the package. This operation is recusive, thus if a dot sourced script dot sources another script, that script will also be included. Specifying Script as the OutputType produces a PS1 file rather than an executable.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Generated by: SAPIEN PowerShell HelpWriter 2017 v2.1.34--> </helpItems> |